2 .\" Set p to 1 if your formatter can handle pic output.
8 .Id $FreeBSD: src/gnu/usr.bin/rcs/rcs/rcsfile.5,v 1.5.2.1 2001/07/22 11:01:34 dd Exp $
9 .Id $DragonFly: src/gnu/usr.bin/rcs/rcs/rcsfile.5,v 1.3 2007/01/17 17:56:23 y0netan1 Exp $
13 .TH RCSFILE 5 \*(Dt GNU
15 rcsfile \- format of RCS file
18 contents are described by the grammar
21 The text is free format: space, backspace, tab, newline, vertical
22 tab, form feed, and carriage return (collectively,
24 have no significance except in strings.
25 However, white space cannot appear within an id, num, or sym,
26 and an \*r file must end with a newline.
28 Strings are enclosed by
30 If a string contains a
33 otherwise, strings can contain arbitrary binary data.
35 The meta syntax uses the following conventions: `|' (bar) separates
36 alternatives; `{' and `}' enclose optional phrases; `{' and `}*' enclose
37 phrases that can be repeated zero or more times;
38 `{' and '}+' enclose phrases that must appear at least once and can be
40 Terminal symbols are in
42 nonterminal symbols are in
45 .nr w \w'\f3deltatext\fP '
46 .nr y \w'\f3newphrase\fP '
48 .nr x \w'\f3branches\fP'
49 .nr y \w'{ \f3comment\fP'
51 .nr y \w'\f3{ branch\fP'
53 .ta \nwu +\w'::= 'u +\nxu+\w' 'u
56 \f2rcstext\fP ::= \f2admin\fP {\f2delta\fP}* \f2desc\fP {\f2deltatext\fP}*
58 \f2admin\fP ::= \f3head\fP {\f2num\fP}\f3;\fP
59 { \f3branch\fP {\f2num\fP}\f3;\fP }
60 \f3access\fP {\f2id\fP}*\f3;\fP
61 \f3symbols\fP {\f2sym\fP \f3:\fP \f2num\fP}*\f3;\fP
62 \f3locks\fP {\f2id\fP \f3:\fP \f2num\fP}*\f3;\fP {\f3strict ;\fP}
63 { \f3comment\fP {\f2string\fP}\f3;\fP }
64 { \f3expand\fP {\f2string\fP}\f3;\fP }
67 \f2delta\fP ::= \f2num\fP
68 \f3date\fP \f2num\fP\f3;\fP
69 \f3author\fP \f2id\fP\f3;\fP
70 \f3state\fP {\f2id\fP}\f3;\fP
71 \f3branches\fP {\f2num\fP}*\f3;\fP
72 \f3next\fP {\f2num\fP}\f3;\fP
73 { \f3commitid\fP \f2id\fP\f3;\fP }
76 \f2desc\fP ::= \f3desc\fP \f2string\fP
78 \f2deltatext\fP ::= \f2num\fP
79 \f3log\fP \f2string\fP
81 \f3text\fP \f2string\fP
83 \f2num\fP ::= {\f2digit\fP | \f3.\fP}+
85 \f2digit\fP ::= \f30\fP | \f31\fP | \f32\fP | \f33\fP | \f34\fP | \f35\fP | \f36\fP | \f37\fP | \f38\fP | \f39\fP
87 \f2id\fP ::= {\f2num\fP} \f2idchar\fP {\f2idchar\fP | \f2num\fP}*
89 \f2sym\fP ::= {\f2digit\fP}* \f2idchar\fP {\f2idchar\fP | \f2digit\fP}*
91 \f2idchar\fP ::= any visible graphic character except \f2special\fP
93 \f2special\fP ::= \f3$\fP | \f3,\fP | \f3.\fP | \f3:\fP | \f3;\fP | \f3@\fP
95 \f2string\fP ::= \f3@\fP{any character, with \f3@\fP doubled}*\f3@\fP
97 \f2newphrase\fP ::= \f2id\fP \f2word\fP* \f3;\fP
99 \f2word\fP ::= \f2id\fP | \f2num\fP | \f2string\fP | \f3:\fP
102 Identifiers are case sensitive. Keywords are in lower case only.
103 The sets of keywords and identifiers can overlap.
104 In most environments \*r uses the \s-1ISO\s0 8859/1 encoding:
105 visible graphic characters are codes 041\-176 and 240\-377,
106 and white space characters are codes 010\-015 and 040.
108 Dates, which appear after the
110 keyword, are of the form
111 \f2Y\fP\f3.\fP\f2mm\fP\f3.\fP\f2dd\fP\f3.\fP\f2hh\fP\f3.\fP\f2mm\fP\f3.\fP\f2ss\fP,
127 contains just the last two digits of the year
128 for years from 1900 through 1999,
129 and all the digits of years thereafter.
130 Dates use the Gregorian calendar; times use UTC.
136 token. This token is intended to be unique across
137 multiple files and is used to help group files as
138 being a part of the same logical commit.
139 This token must uniquely identify the commit
140 operation that was applied to a set of RCS files.
141 In particular, it must be unique among all the
142 commitids in this file.
146 productions in the grammar are reserved for future extensions
147 to the format of \*r files.
150 will begin with any keyword already in use.
154 nodes form a tree. All nodes whose numbers
155 consist of a single pair
156 (e.g., 2.3, 2.1, 1.3, etc.)
157 are on the trunk, and are linked through the
159 field in order of decreasing numbers.
164 node points to the head of that sequence (i.e., contains
168 node in the admin node indicates the default
169 branch (or revision) for most \*r operations.
170 If empty, the default
171 branch is the highest branch on the trunk.
175 nodes whose numbers consist of
179 (e.g., 3.1.1.1, 2.1.2.2, etc.)
180 are linked as follows.
181 All nodes whose first
183 number fields are identical are linked through the
185 field in order of increasing numbers.
186 For each such sequence,
189 node whose number is identical to the first
191 number fields of the deltas on that sequence is called the branchpoint.
194 field of a node contains a list of the
195 numbers of the first nodes of all sequences for which it is a branchpoint.
196 This list is ordered in increasing numbers.
198 The following diagram shows an example of an \*r file's organization.
212 / \ / \ | 2.1 | / \ / \
214 /1.2.1.3\ /1.3.1.1\ | | /1.2.2.2\ /1.2.2.1.1.1\
215 --------- --------- --------- --------- -------------
219 / \ | --------- / \ |
221 / \ ---------\ / / \-----------
222 /1.2.1.1\ \ / /1.2.2.1\
223 --------- \ / ---------
229 ----------------------\ /---------
249 .\" -2.0625 -4.25 1.75 0
250 .\" 0.000i 4.250i 3.812i 0.000i
257 \h'2.062i-(\w'Head'u/2u)'\v'0.125i-(0v/2u)+0v+0.22m'Head
259 \h'2.062i'\v'0.250i'\D'l0.000i 0.500i'
261 \h'2.087i'\v'0.650i'\D'l-0.025i 0.100i'
263 \h'2.062i'\v'0.750i'\D'l-0.025i -0.100i'
265 \h'1.688i'\v'1.250i'\D'l0.750i 0.000i'
267 \h'2.438i'\v'1.250i'\D'l0.000i -0.500i'
269 \h'2.438i'\v'0.750i'\D'l-0.750i 0.000i'
271 \h'1.688i'\v'0.750i'\D'l0.000i 0.500i'
274 \h'2.062i-(\w'2.1'u/2u)'\v'1.000i-(0v/2u)+0v+0.22m'2.1
276 \h'2.062i'\v'1.250i'\D'l0.000i 0.500i'
278 \h'2.087i'\v'1.650i'\D'l-0.025i 0.100i'
280 \h'2.062i'\v'1.750i'\D'l-0.025i -0.100i'
283 \h'2.062i-(\w'1.3'u/2u)'\v'2.000i-(1v/2u)+0v+0.22m'1.3
285 \h'2.062i'\v'2.250i'\D'l-0.375i -0.500i'
287 \h'1.688i'\v'1.750i'\D'l0.750i 0.000i'
289 \h'2.438i'\v'1.750i'\D'l-0.375i 0.500i'
291 \h'1.875i'\v'2.000i'\D'~-0.500i 0.000i 0.000i -0.500i'
293 \h'1.350i'\v'1.600i'\D'l0.025i -0.100i'
295 \h'1.375i'\v'1.500i'\D'l0.025i 0.100i'
298 \h'1.375i-(\w'1.3.1.1'u/2u)'\v'1.250i-(1v/2u)+1v+0.22m'1.3.1.1
300 \h'1.375i'\v'1.000i'\D'l-0.375i 0.500i'
302 \h'1.000i'\v'1.500i'\D'l0.750i 0.000i'
304 \h'1.750i'\v'1.500i'\D'l-0.375i -0.500i'
306 \h'2.062i'\v'2.250i'\D'l0.000i 0.500i'
308 \h'2.087i'\v'2.650i'\D'l-0.025i 0.100i'
310 \h'2.062i'\v'2.750i'\D'l-0.025i -0.100i'
313 \h'2.062i-(\w'1.2'u/2u)'\v'3.000i-(1v/2u)+0v+0.22m'1.2
315 \h'2.062i'\v'3.250i'\D'l-0.375i -0.500i'
317 \h'1.688i'\v'2.750i'\D'l0.750i 0.000i'
319 \h'2.438i'\v'2.750i'\D'l-0.375i 0.500i'
321 \h'1.875i'\v'3.000i'\D'~-0.500i 0.000i -0.500i 0.000i -0.500i 0.000i 0.000i -0.500i'
323 \h'0.350i'\v'2.600i'\D'l0.025i -0.100i'
325 \h'0.375i'\v'2.500i'\D'l0.025i 0.100i'
328 \h'0.375i-(\w'1.2.1.1'u/2u)'\v'2.250i-(1v/2u)+1v+0.22m'1.2.1.1
330 \h'0.375i'\v'2.000i'\D'l-0.375i 0.500i'
332 \h'0.000i'\v'2.500i'\D'l0.750i 0.000i'
334 \h'0.750i'\v'2.500i'\D'l-0.375i -0.500i'
336 \h'0.375i'\v'2.000i'\D'l0.000i -0.500i'
338 \h'0.350i'\v'1.600i'\D'l0.025i -0.100i'
340 \h'0.375i'\v'1.500i'\D'l0.025i 0.100i'
343 \h'0.375i-(\w'1.2.1.3'u/2u)'\v'1.250i-(1v/2u)+1v+0.22m'1.2.1.3
345 \h'0.375i'\v'1.000i'\D'l-0.375i 0.500i'
347 \h'0.000i'\v'1.500i'\D'l0.750i 0.000i'
349 \h'0.750i'\v'1.500i'\D'l-0.375i -0.500i'
351 \h'2.250i'\v'3.000i'\D'~0.500i 0.000i 0.000i -0.500i'
353 \h'2.725i'\v'2.600i'\D'l0.025i -0.100i'
355 \h'2.750i'\v'2.500i'\D'l0.025i 0.100i'
358 \h'2.750i-(\w'1.2.2.1'u/2u)'\v'2.250i-(1v/2u)+1v+0.22m'1.2.2.1
360 \h'2.750i'\v'2.000i'\D'l-0.375i 0.500i'
362 \h'2.375i'\v'2.500i'\D'l0.750i 0.000i'
364 \h'3.125i'\v'2.500i'\D'l-0.375i -0.500i'
366 \h'2.938i'\v'2.250i'\D'~0.500i 0.000i 0.000i -0.500i 0.000i -0.500i'
368 \h'3.413i'\v'1.350i'\D'l0.025i -0.100i'
370 \h'3.438i'\v'1.250i'\D'l0.025i 0.100i'
373 \h'3.438i-(\w'\s-21.2.2.1.1.1\s0'u/2u)'\v'1.000i-(1v/2u)+1v+0.22m'\s-21.2.2.1.1.1\s0
375 \h'3.438i'\v'0.750i'\D'l-0.375i 0.500i'
377 \h'3.062i'\v'1.250i'\D'l0.750i 0.000i'
379 \h'3.812i'\v'1.250i'\D'l-0.375i -0.500i'
381 \h'2.750i'\v'2.000i'\D'l0.000i -0.500i'
383 \h'2.725i'\v'1.600i'\D'l0.025i -0.100i'
385 \h'2.750i'\v'1.500i'\D'l0.025i 0.100i'
388 \h'2.750i-(\w'1.2.2.2'u/2u)'\v'1.250i-(1v/2u)+1v+0.22m'1.2.2.2
390 \h'2.750i'\v'1.000i'\D'l-0.375i 0.500i'
392 \h'2.375i'\v'1.500i'\D'l0.750i 0.000i'
394 \h'3.125i'\v'1.500i'\D'l-0.375i -0.500i'
396 \h'2.062i'\v'3.250i'\D'l0.000i 0.500i'
398 \h'2.087i'\v'3.650i'\D'l-0.025i 0.100i'
400 \h'2.062i'\v'3.750i'\D'l-0.025i -0.100i'
403 \h'2.062i-(\w'1.1'u/2u)'\v'4.000i-(1v/2u)+0v+0.22m'1.1
405 \h'2.062i'\v'4.250i'\D'l-0.375i -0.500i'
407 \h'1.688i'\v'3.750i'\D'l0.750i 0.000i'
409 \h'2.438i'\v'3.750i'\D'l-0.375i 0.500i'
423 Author: Walter F. Tichy,
424 Purdue University, West Lafayette, IN, 47907.
426 Manual Page Revision: \*(Rv; Release Date: \*(Dt.
428 Copyright \(co 1982, 1988, 1989 Walter F. Tichy.
430 Copyright \(co 1990, 1991, 1992, 1993, 1994, 1995 Paul Eggert.
432 rcsintro(1), ci(1), co(1), ident(1), rcs(1), rcsclean(1), rcsdiff(1),
436 \*r\*-A System for Version Control,
437 .I "Software\*-Practice & Experience"
439 7 (July 1985), 637-654.