home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 22 gnu / 22-gnu.zip / rcs567x.zip / doc / rcsfile.man < prev    next >
Text File  |  1994-03-22  |  9KB  |  199 lines
  1.  
  2.  
  3.  
  4. RCSFILE(5)                                             RCSFILE(5)
  5.  
  6.  
  7. NNAAMMEE
  8.        rcsfile - format of RCS file
  9.  
  10. DDEESSCCRRIIPPTTIIOONN
  11.        An RCS file's contents are described by the grammar below.
  12.  
  13.        The text is free format: space, backspace,  tab,  newline,
  14.        vertical  tab,  form  feed,  and  carriage return (collec-
  15.        tively,  _w_h_i_t_e  _s_p_a_c_e)  have  no  significance  except  in
  16.        strings.  However, white space cannot appear within an id,
  17.        num, or sym, and an RCS file must end with a newline.
  18.  
  19.        Strings are enclosed by @@.  If a string contains a  @@,  it
  20.        must  be doubled; otherwise, strings can 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 can be repeated
  26.        zero or more times; `{' and '}+' enclose phrases that must
  27.        appear at least once and can be repeated; Terminal symbols
  28.        are in bboollddffaaccee; 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     ::=  hheeaadd       {_n_u_m};;
  33.                       { bbrraanncchh   {_n_u_m};; }
  34.                       aacccceessss     {_i_d}*;;
  35.                       ssyymmbboollss    {_s_y_m :: _n_u_m}*;;
  36.                       lloocckkss      {_i_d :: _n_u_m}*;;  {ssttrriicctt  ;;}
  37.                       { ccoommmmeenntt  {_s_t_r_i_n_g};; }
  38.                       { eexxppaanndd   {_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.                       ddaattee       _n_u_m;;
  43.                       aauutthhoorr     _i_d;;
  44.                       ssttaattee      {_i_d};;
  45.                       bbrraanncchheess   {_n_u_m}*;;
  46.                       nneexxtt       {_n_u_m};;
  47.                       { _n_e_w_p_h_r_a_s_e }*
  48.  
  49.        _d_e_s_c      ::=  ddeesscc       _s_t_r_i_n_g
  50.  
  51.        _d_e_l_t_a_t_e_x_t ::=  _n_u_m
  52.                       lloogg        _s_t_r_i_n_g
  53.                       { _n_e_w_p_h_r_a_s_e }*
  54.                       tteexxtt       _s_t_r_i_n_g
  55.  
  56.        _n_u_m       ::=  {_d_i_g_i_t | ..}+
  57.  
  58.        _d_i_g_i_t     ::=  00 | 11 | 22 | 33 | 44 | 55 | 66 | 77 | 88 | 99
  59.  
  60.        _i_d        ::=  {_n_u_m} _i_d_c_h_a_r {_i_d_c_h_a_r | _n_u_m}*
  61.  
  62.  
  63.  
  64. GNU                         1994/03/17                          1
  65.  
  66.  
  67.  
  68.  
  69.  
  70. RCSFILE(5)                                             RCSFILE(5)
  71.  
  72.  
  73.        _s_y_m       ::=  {_d_i_g_i_t}* _i_d_c_h_a_r {_i_d_c_h_a_r | _d_i_g_i_t}*
  74.  
  75.        _i_d_c_h_a_r    ::=  any visible graphic character except _s_p_e_c_i_a_l
  76.  
  77.        _s_p_e_c_i_a_l   ::=  $$ | ,, | .. | :: | ;; | @@
  78.  
  79.        _s_t_r_i_n_g    ::=  @@{any character, with @@ doubled}*@@
  80.  
  81.        _n_e_w_p_h_r_a_s_e ::=  _i_d _w_o_r_d* ;;
  82.  
  83.        _w_o_r_d      ::=  _i_d | _n_u_m | _s_t_r_i_n_g | ::
  84.  
  85.        Identifiers  are  case  sensitive.   Keywords are in lower
  86.        case only.  The sets of keywords and identifiers can over-
  87.        lap.   In most environments RCS uses the ISO 8859/1 encod-
  88.        ing: visible graphic  characters  are  codes  041-176  and
  89.        240-377,  and white space characters are codes 010-015 and
  90.        040.
  91.  
  92.        Dates, which appear after the ddaattee  keyword,  are  of  the
  93.        form  _Y.._m_m.._d_d.._h_h.._m_m.._s_s,  where _Y is the year, _m_m the month
  94.        (01-12), _d_d the day (00-31), _h_h the hour (00-23),  _m_m  the
  95.        minute  (00-59),  and  _s_s  the second (00-60).  _Y contains
  96.        just the last two digits of the year for years  from  1900
  97.        through  1999,  and  all  the  digits of years thereafter.
  98.        Dates use the Gregorian calendar; times use UTC.
  99.  
  100.        The _n_e_w_p_h_r_a_s_e productions in the grammar are reserved  for
  101.        future  extensions  to  the  format of RCS files.  No _n_e_w_-
  102.        _p_h_r_a_s_e will begin with any keyword already in use.
  103.  
  104.        The _d_e_l_t_a nodes form a tree.  All nodes whose numbers con-
  105.        sist  of a single pair (e.g., 2.3, 2.1, 1.3, etc.)  are on
  106.        the trunk, and are linked through the nneexxtt field in  order
  107.        of  decreasing  numbers.  The hheeaadd field in the _a_d_m_i_n node
  108.        points to the head of that sequence  (i.e.,  contains  the
  109.        highest  pair).   The  bbrraanncchh node in the admin node indi-
  110.        cates the default branch (or revision) for most RCS opera-
  111.        tions.  If empty, the default branch is the highest branch
  112.        on the trunk.
  113.  
  114.        All _d_e_l_t_a nodes whose numbers consist of 2_n fields  (_n>=2)
  115.        (e.g.,  3.1.1.1,  2.1.2.2,  etc.)   are linked as follows.
  116.        All nodes whose first 2_n-1 number fields are identical are
  117.        linked  through the nneexxtt field in order of increasing num-
  118.        bers.  For each such sequence, the _d_e_l_t_a node whose number
  119.        is identical to the first 2_n-2 number fields of the deltas
  120.        on that sequence is called the branchpoint.  The  bbrraanncchheess
  121.        field  of  a  node  contains  a list of the numbers of the
  122.        first nodes of all sequences for which  it  is  a  branch-
  123.        point.  This list is ordered in increasing numbers.
  124.  
  125.        The  following  diagram  shows an example of an RCS file's
  126.        organization.
  127.  
  128.  
  129.  
  130. GNU                         1994/03/17                          2
  131.  
  132.  
  133.  
  134.  
  135.  
  136. RCSFILE(5)                                             RCSFILE(5)
  137.  
  138.  
  139.                                   Head
  140.                                     |
  141.                                     |
  142.                                     v                        / \
  143.                                 ---------                   /   \
  144.           / \          / \      |       |      / \         /     \
  145.          /   \        /   \     |  2.1  |     /   \       /       \
  146.         /     \      /     \    |       |    /     \     /         \
  147.        /1.2.1.3\    /1.3.1.1\   |       |   /1.2.2.2\   /1.2.2.1.1.1\
  148.        ---------    ---------   ---------   ---------   -------------
  149.            ^            ^           |           ^             ^
  150.            |            |           |           |             |
  151.            |            |           v           |             |
  152.           / \           |       ---------      / \            |
  153.          /   \          |       \  1.3  /     /   \           |
  154.         /     \         ---------\     /     /     \-----------
  155.        /1.2.1.1\                  \   /     /1.2.2.1\
  156.        ---------                   \ /      ---------
  157.            ^                        |           ^
  158.            |                        |           |
  159.            |                        v           |
  160.            |                    ---------       |
  161.            |                    \  1.2  /       |
  162.            ----------------------\     /---------
  163.                                   \   /
  164.                                    \ /
  165.                                     |
  166.                                     |
  167.                                     v
  168.                                 ---------
  169.                                 \  1.1  /
  170.                                  \     /
  171.                                   \   /
  172.                                    \ /
  173.  
  174.  
  175.  
  176. IIDDEENNTTIIFFIICCAATTIIOONN
  177.        Author:  Walter  F.   Tichy,   Purdue   University,   West
  178.        Lafayette, IN, 47907.
  179.        Revision Number: 5.5; Release Date: 1994/03/17.
  180.        Copyright (C) 1982, 1988, 1989 Walter F. Tichy.
  181.        Copyright (C) 1990, 1991, 1992, 1993, 1994 Paul Eggert.
  182.  
  183. SSEEEE AALLSSOO
  184.        rcsintro(1),  ci(1), co(1), ident(1), rcs(1), rcsclean(1),
  185.        rcsdiff(1), rcsmerge(1), rlog(1)
  186.        Walter  F.  Tichy,  RCS--A  System  for  Version  Control,
  187.        _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  1155,  7  (July  1985),
  188.        637-654.
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.  
  196. GNU                         1994/03/17                          3
  197.  
  198.  
  199.