home *** CD-ROM | disk | FTP | other *** search
/ Gold Fish 3 / goldfish_volume_3.bin / files / dev / misc / hwgrcs / man / rcsfile.man < prev    next >
Encoding:
Text File  |  1993-01-19  |  7.1 KB  |  199 lines
  1.  
  2.  
  3.  
  4. RCSFILE(5)                FILE FORMATS                 RCSFILE(5)
  5.  
  6.  
  7.  
  8. NAME
  9.      rcsfile - format of RCS file
  10.  
  11. DESCRIPTION
  12.      An RCS file's contents are described by the grammar below.
  13.  
  14.      The text is free format:  space,  backspace,  tab,  newline,
  15.      vertical  tab, form feed, and carriage return (collectively,
  16.      _w_h_i_t_e _s_p_a_c_e) have no significance except in  strings.   How-
  17.      ever, an RCS file must end in a newline character.
  18.  
  19.      Strings are enclosed by @.  If a string  contains  a  @,  it
  20.      must  be  doubled;  otherwise, strings may contain arbitrary
  21.      binary data.
  22.  
  23.      The meta syntax uses the following  conventions:  `|'  (bar)
  24.      separates   alternatives;   `{'  and  `}'  enclose  optional
  25.      phrases; `{' and `}*' enclose phrases that may  be  repeated
  26.      zero  or  more times; `{' and '}+' enclose phrases that must
  27.      appear at least once and may be repeated;  Terminal  symbols
  28.      are in boldface; nonterminal symbols are in _i_t_a_l_i_c_s.
  29.  
  30.      _r_c_s_t_e_x_t    ::=  _a_d_m_i_n {_d_e_l_t_a}* _d_e_s_c {_d_e_l_t_a_t_e_x_t}*
  31.  
  32.      _a_d_m_i_n      ::=  head       {_n_u_m};
  33.                      { branch   {_n_u_m}; }
  34.                      access     {_i_d}*;
  35.                      symbols    {_i_d : _n_u_m}*;
  36.                      locks      {_i_d : _n_u_m}*;  {strict  ;}
  37.                      { comment  {_s_t_r_i_n_g}; }
  38.                      { expand   {_s_t_r_i_n_g}; }
  39.                      { _n_e_w_p_h_r_a_s_e }*
  40.  
  41.      _d_e_l_t_a      ::=  _n_u_m
  42.                      date       _n_u_m;
  43.                      author     _i_d;
  44.                      state      {_i_d};
  45.                      branches   {_n_u_m}*;
  46.                      next       {_n_u_m};
  47.                      { _n_e_w_p_h_r_a_s_e }*
  48.  
  49.      _d_e_s_c       ::=  desc       _s_t_r_i_n_g
  50.  
  51.      _d_e_l_t_a_t_e_x_t  ::=  _n_u_m
  52.                      log        _s_t_r_i_n_g
  53.                      { _n_e_w_p_h_r_a_s_e }*
  54.                      text       _s_t_r_i_n_g
  55.  
  56.      _n_u_m        ::=  {_d_i_g_i_t{.}}+
  57.  
  58.      _d_i_g_i_t      ::=  0 | 1 | ... | 9
  59.  
  60.  
  61.  
  62.  
  63. GNU                  Last change: 1991/08/19                    1
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. RCSFILE(5)                FILE FORMATS                 RCSFILE(5)
  71.  
  72.  
  73.  
  74.      _i_d         ::=  _l_e_t_t_e_r{_i_d_c_h_a_r}*
  75.  
  76.      _l_e_t_t_e_r     ::=  any letter
  77.  
  78.      _i_d_c_h_a_r     ::=  any visible graphic character except _s_p_e_c_i_a_l
  79.  
  80.      _s_p_e_c_i_a_l    ::=  $ | , | . | : | ; | @
  81.  
  82.      _s_t_r_i_n_g     ::=  @{any character, with @ doubled}*@
  83.  
  84.      _n_e_w_p_h_r_a_s_e  ::=  _i_d _w_o_r_d* ;
  85.  
  86.      _w_o_r_d       ::=  _i_d | _n_u_m | _s_t_r_i_n_g | :
  87.  
  88.      Identifiers are case sensitive.  Keywords are in lower  case
  89.      only.  The sets of keywords and identifiers may overlap.  In
  90.      most environments RCS uses the ISO 8859/1 encoding:  letters
  91.      are  octal codes 101-132, 141-172, 300-326, 330-366 and 370-
  92.      377,  visible  graphic  characters  are  codes  041-176  and
  93.      240-377,  and  white  space characters are codes 010-015 and
  94.      040.
  95.  
  96.      The _n_e_w_p_h_r_a_s_e productions in the grammar  are  reserved  for
  97.      future  extensions to the format of RCS files.  No _n_e_w_p_h_r_a_s_e
  98.      will begin with any keyword already in use.
  99.  
  100.      The _d_e_l_t_a nodes form a tree.  All nodes whose  numbers  con-
  101.      sist of a single pair (e.g., 2.3, 2.1, 1.3, etc.) are on the
  102.      trunk, and are linked through the next  field  in  order  of
  103.      decreasing numbers.  The head field in the _a_d_m_i_n node points
  104.      to the head of that sequence  (i.e.,  contains  the  highest
  105.      pair).   The  branch  node  in  the admin node indicates the
  106.      default branch (or revision) for most  RCS  operations.   If
  107.      empty,  the  default  branch  is  the  highest branch on the
  108.      trunk.
  109.  
  110.      All _d_e_l_t_a nodes whose  numbers  consist  of  2_n  fields  (_n)
  111.      (e.g.,  3.1.1.1,  2.1.2.2, etc.) are linked as follows.  All
  112.      nodes whose first  2_n-1  number  fields  are  identical  are
  113.      linked  through  the  next  field  in  order  of  increasing
  114.      numbers.  For each  such  sequence,  the  _d_e_l_t_a  node  whose
  115.      number  is  identical to the first 2_n-2 number fields of the
  116.      deltas on that sequence  is  called  the  branchpoint.   The
  117.      branches  field  of a node contains a list of the numbers of
  118.      the first nodes of all sequences for which  it  is  a  bran-
  119.      chpoint.  This list is ordered in increasing numbers.
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129. GNU                  Last change: 1991/08/19                    2
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. RCSFILE(5)                FILE FORMATS                 RCSFILE(5)
  137.  
  138.  
  139.  
  140.      Example:
  141.  
  142.                                 Head
  143.                                   |
  144.                                   |
  145.                                   v                        / \
  146.                               ---------                   /   \
  147.         / \          / \      |       |      / \         /     \
  148.        /   \        /   \     |  2.1  |     /   \       /       \
  149.       /     \      /     \    |       |    /     \     /         \
  150.      /1.2.1.3\    /1.3.1.1\   |       |   /1.2.2.2\   /1.2.2.1.1.1\
  151.      ---------    ---------   ---------   ---------   -------------
  152.          ^            ^           |           ^             ^
  153.          |            |           |           |             |
  154.          |            |           v           |             |
  155.         / \           |       ---------      / \            |
  156.        /   \          |       \  1.3  /     /   \           |
  157.       /     \         ---------\     /     /     \-----------
  158.      /1.2.1.1\                  \   /     /1.2.2.1\
  159.      ---------                   \ /      ---------
  160.          ^                        |           ^
  161.          |                        |           |
  162.          |                        v           |
  163.          |                    ---------       |
  164.          |                    \  1.2  /       |
  165.          ----------------------\     /---------
  166.                                 \   /
  167.                                  \ /
  168.                                   |
  169.                                   |
  170.                                   v
  171.                               ---------
  172.                               \  1.1  /
  173.                                \     /
  174.                                 \   /
  175.                                  \ /
  176.  
  177.                        Fig. 1: A revision tree
  178.  
  179. IDENTIFICATION
  180.      Author: Walter F. Tichy, Purdue University, West  Lafayette,
  181.      IN, 47907.
  182.      Revision Number: 5.1; Release Date: 1991/08/19.
  183.      Copyright c 1982, 1988, 1989 by Walter F. Tichy.
  184.      Copyright c 1990, 1991 by Paul Eggert.
  185.  
  186. SEE ALSO
  187.      ci(1), co(1),  ident(1),  rcs(1),  rcsdiff(1),  rcsmerge(1),
  188.      rlog(1),
  189.      Walter  F.  Tichy,  RCS--A  System  for   Version   Control,
  190.      _S_o_f_t_w_a_r_e--_P_r_a_c_t_i_c_e & _E_x_p_e_r_i_e_n_c_e 15, 7 (July 1985), 637-654.
  191.  
  192.  
  193.  
  194.  
  195. GNU                  Last change: 1991/08/19                    3
  196.  
  197.  
  198.  
  199.