Annotation of src/usr.bin/cvs/cvs.1, Revision 1.49
1.49 ! xsa 1: .\" $OpenBSD: cvs.1,v 1.48 2005/02/09 16:56:39 xsa Exp $
1.1 jfb 2: .\"
3: .\" Copyright (c) 2004 Jean-Francois Brousseau <jfb@openbsd.org>
1.36 xsa 4: .\" Copyright (c) 2004, 2005 Xavier Santolaria <xsa@openbsd.org>
1.1 jfb 5: .\" All rights reserved.
6: .\"
7: .\" Redistribution and use in source and binary forms, with or without
8: .\" modification, are permitted provided that the following conditions
9: .\" are met:
10: .\"
11: .\" 1. Redistributions of source code must retain the above copyright
12: .\" notice, this list of conditions and the following disclaimer.
13: .\" 2. The name of the author may not be used to endorse or promote products
14: .\" derived from this software without specific prior written permission.
15: .\"
16: .\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
17: .\" INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
18: .\" AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
19: .\" THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
20: .\" EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
21: .\" PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
22: .\" OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
23: .\" WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
24: .\" OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
25: .\" ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26: .\"
27: .Dd May 16, 2004
28: .Dt CVS 1
29: .Os
30: .Sh NAME
31: .Nm cvs
1.3 jfb 32: .Nd OpenCVS Concurrent Versioning System client
1.1 jfb 33: .Sh SYNOPSIS
34: .Nm
1.15 jmc 35: .Op Fl flQqtv
1.1 jfb 36: .Op Fl d Ar root
37: .Op Fl e Ar editor
1.20 jmc 38: .Xo
39: .Oo Fl s
40: .Ar var Ns = Ns Ar val Oc
41: .Xc
1.15 jmc 42: .Op Fl z Ar level
1.1 jfb 43: .Ar command Op Ar ...
44: .Sh DESCRIPTION
45: The
46: .Nm
47: program acts as both client and server for the use of and administration of
48: a CVS source repository.
49: CVS is used to maintain version information on files that are kept in a
50: repository.
51: Although it is more commonly used to track changes in source code, there
52: are no real limitations to the type of files that you can store in a
53: repository.
1.35 jmc 54: For a general introduction to CVS, see
55: .Xr cvsintro 7 .
1.1 jfb 56: .Pp
1.7 jfb 57: .Nm
1.35 jmc 58: reads its startup configuration file,
59: .Pa .cvsrc ,
1.7 jfb 60: from the home directory of the user who invoked it.
61: This file is used to specify implicit options passed to
62: .Nm
63: or one of its commands whenever it is invoked.
1.35 jmc 64: The defaults in the configuration file can be overridden with the
65: .Fl f
66: option (see below).
1.16 jmc 67: See
68: .Xr cvsrc 5
69: for further information.
1.7 jfb 70: .Pp
1.1 jfb 71: The following options are supported:
1.15 jmc 72: .Bl -tag -width "-e editorXX"
1.1 jfb 73: .It Fl d Ar root
74: Use
75: .Ar root
76: as the path to the root directory of the CVS repository.
77: The value must specify an absolute path.
78: .It Fl e Ar editor
79: Use the program
80: .Ar editor
81: whenever editing log information.
1.8 jmc 82: This option overrides the environment variables CVSEDITOR, VISUAL, and EDITOR.
1.1 jfb 83: .It Fl f
1.7 jfb 84: Do not read the user's configuration file on startup.
1.1 jfb 85: .It Fl l
86: Suppress logging of history information.
87: .It Fl Q
88: Be extra quiet.
89: Only error messages will be displayed.
90: .It Fl q
91: Be quiet about reporting.
1.20 jmc 92: .It Fl s Ar var Ns = Ns Ar val
93: Set the value of the internal variable
94: .Ar var
95: to the string
96: .Ar val .
1.15 jmc 97: .It Fl t
98: Trace program execution.
1.1 jfb 99: .It Fl v
100: Display version information and exit.
1.15 jmc 101: .It Fl z Ar level
102: Specify the compression level to
103: .Xr gzip 1
104: when transferring files.
105: The compression level ranges from 1 to 9,
106: with 1 being the fastest,
107: and 9 providing the best level of compression.
108: The default is 6.
1.45 xsa 109: .El
110: .Sh KEYWORD SUBSTITUTION
111: As long as you edit source files inside a working directory you
112: can always find out the state of your files via the
113: .Ic status
114: or
115: .Ic log
116: commands, but as soon as files get exported from
117: your local working copy, it becomes harder to identify which
118: revisions they are.
119: .Pp
120: .Nm
121: can use a mechanism known as
122: .Sq keyword substitution
123: to help identify the files.
124: Embedded strings of the form $keyword$ and $keyword:...$ in a file
125: are replaced with strings of the form $keyword: value$ whenever you
126: obtain a new revision of the file.
127: The possible keywords are as follows:
128: .Bl -tag -width "RevisionXXX"
1.48 xsa 129: .It $\&Author$
1.45 xsa 130: The name of the user who checked in the revision.
1.48 xsa 131: .It $\&Date$
1.45 xsa 132: The date and hour (UTC) the revision was checked in.
1.48 xsa 133: .It $\&Header$
1.45 xsa 134: Standard header containing the full pathname of the RCS
135: file, the revision number, the date (UTC), the author and the state.
1.48 xsa 136: .It $\&Id$
137: The same content as $\&Header$ but without the path
1.45 xsa 138: of the RCS file.
1.48 xsa 139: .It $\&Log$
1.45 xsa 140: The log message supplied during commit, preceded by a header
141: containing the RCS filename, the revision number, the
142: author, and the date (UTC).
1.48 xsa 143: .It $\&Name$
1.45 xsa 144: The tag name used to check out the file.
1.48 xsa 145: .It $\&RCSfile$
1.45 xsa 146: The name of the RCS file, but without a path.
1.48 xsa 147: .It $\&Revision$
1.45 xsa 148: The revision number assigned to the revision.
1.48 xsa 149: .It $\&Source$
1.45 xsa 150: The full pathname of the RCS file.
1.48 xsa 151: .It $\&State$
1.45 xsa 152: The state assigned to the revision.
153: .El
154: .Pp
155: Keyword substitution has its disadvantages: sometimes the
1.48 xsa 156: literal text string $\&Author$ is wanted inside a file without
1.45 xsa 157: .Nm
158: interpreting it as a keyword and expanding it into something like
1.48 xsa 159: $\&Author$.
1.45 xsa 160: The
161: .Fl k Ar o
1.48 xsa 162: option can be used to turn off keyword substitution entirely though.
1.45 xsa 163: There is unfortunately no way to selectively turn off keyword substitution.
164: .Pp
165: Each file and working directory copy of a file have a stored
166: default substitution mode.
167: Substitution modes on files are set by the
168: .Fl k Ar mode
169: option to the
170: .Ic add
171: and
172: .Ic admin
173: commands or by the
174: .Fl k Ar mode
175: or
176: .Fl A
177: options to the
178: .Ic checkout
179: or
180: .Ic update
181: commands.
182: .Pp
183: The possible substitution modes are as follows:
184: .Bl -tag -width Ds -offset 3n
185: .It Fl k Ar b
186: Like
187: .Fl k Ar o ,
188: but also avoids the conversion of line endings.
189: This option is used to handle binary files.
190: .It Fl k Ar k
191: Does not substitute the keywords.
192: Useful with the
193: .Ic diff
194: command to avoid displaying the differences between keyword substitutions.
195: .It Fl k Ar kv
196: The default behaviour.
1.48 xsa 197: Keywords are normally substituted i.e. $\&Revision$ becomes
198: $\&Revision: 1.1 $.
1.45 xsa 199: .It Fl k Ar kvl
200: Like
201: .Fl k Ar kv ,
202: except that the locker's name is displayed along with the version
203: if the given revision is currently locked.
204: This option is normally not useful as
205: .Nm
206: does not use file locking by default.
207: .It Fl k Ar o
208: No substitutions are done.
209: This option is often used with the
210: .Ic import
211: command to guarantee that files that already contain external keywords
212: do not get modified.
213: .It Fl k Ar v
214: Substitue the value of keywords instead of keywords themselves
1.48 xsa 215: e.g. instead of $\&Revision$, only insert 1.1 and not $\&Revision: 1.1 $.
1.45 xsa 216: This option must be used with care, as it can only be used once.
217: It is often used with the
218: .Ic export
219: command to freeze the values before releasing software.
1.1 jfb 220: .El
221: .Sh COMMANDS
1.3 jfb 222: The following commands are supported by
1.44 jmc 223: .Nm :
1.7 jfb 224: .Bl -tag -width "xxxxxxxxxxxx"
1.42 xsa 225: .It Xo Ic add
226: .Op Fl k Ar mode
227: .Op Fl m Ar msg
228: .Ar file ...
1.3 jfb 229: .Xc
1.7 jfb 230: .Pp
1.42 xsa 231: Before a file is known to
232: .Nm ,
233: it must be added to the repository using this command.
1.1 jfb 234: Adding a file does not actually publish the contents of the
1.42 xsa 235: file: the
1.11 jmc 236: .Ic commit
1.42 xsa 237: command must also be used to publish it into the repository,
238: and thus let others access the file.
239: .Pp
240: Note: since directories have no versioning system, it is sufficient
241: to add them with the
242: .Ic add
243: command alone; the
244: .Ic commit
245: command is not necessary.
1.1 jfb 246: .Pp
1.35 jmc 247: The
248: .Ic add
249: command takes the following options:
250: .Bl -tag -width Ds -offset 3n
1.42 xsa 251: .It Fl k Ar mode
252: Specify the keyword substitution mode.
1.35 jmc 253: .It Fl m Ar msg
254: Attach log message
255: .Ar msg .
256: By default, no log message is required.
257: .El
1.13 jmc 258: .Pp
259: Aliases:
260: .Ic ad ,
261: .Ic new .
262: .It Ic admin
263: Administration front-end for
264: .Xr rcs 1 .
265: .Pp
266: Aliases:
267: .Ic adm ,
268: .Ic rcs .
1.26 xsa 269: .It Xo Ic annotate
270: .Op Fl flR
271: .Oo Fl D Ar date \*(Ba
272: .Fl r Ar rev Oc
273: .Op Ar file ...
274: .Xc
275: .Pp
1.23 xsa 276: For each line of any files specified, show information about its
277: last revision.
278: The information given is the last revision when a modification occurred,
279: the author's name, and the date of the revision.
1.26 xsa 280: .Pp
281: The
1.35 jmc 282: .Ic annotate
283: command takes the following options:
284: .Bl -tag -width Ds -offset 3n
285: .It Fl D Ar date
286: Show the annotations as of the latest revision no later than
287: .Ar date .
288: .It Fl f
289: Force the use of the head revision if the specified
1.26 xsa 290: tag or date is not found.
291: This can be used in combination with
292: .Fl D
293: or
294: .Fl r
295: to ensure that there is some output from the
296: .Ic annotate
297: command, even if only to show Revision 1.1 of the file.
1.35 jmc 298: .It Fl l
299: Limit the scope of the search to the local directory
300: only and disable recursive behaviour.
301: .It Fl R
302: Enable recursive behaviour.
303: This is the default.
304: .It Fl r Ar rev
305: Show annotations as of revision
1.26 xsa 306: .Ar rev
307: (can be a revision number or a tag).
1.35 jmc 308: .El
1.13 jmc 309: .Pp
310: Aliases:
311: .Ic ann .
1.11 jmc 312: .It Xo Ic checkout
1.37 xsa 313: .Op Fl AcflNnPpRs
314: .Op Fl d Ar dir
315: .Op Fl j Ar rev
316: .Op Fl k Ar mode
317: .Fl D Ar date \*(Ba
318: .Fl r Ar rev
319: .Ar module ...
1.7 jfb 320: .Xc
321: .Pp
322: The
1.11 jmc 323: .Ic checkout
1.7 jfb 324: command is used to create a local copy of one or more modules present on the
325: target CVS repository.
1.37 xsa 326: .Pp
327: The
328: .Ic checkout
329: command takes the following options:
330: .Bl -tag -width Ds -offset 3n
331: .It Fl A
1.41 xsa 332: Reset any sticky tags, dates, or keyword substitution modes that
333: have been set on the tree.
1.37 xsa 334: .It Fl c
335: Display the list of available modules.
336: .It Fl D Ar date
337: Check out as of the latest revision no later than
338: .Ar date
339: (is sticky).
340: .It Fl d Ar dir
341: Check out in directory
342: .Ar dir
343: instead of the directory bearing the same name as the
344: .Ar module .
345: .It Fl f
346: Force the use of the head revision if the specified
347: tag or date is not found.
348: .It Fl j Ar rev
349: Merge in changes made between current revision and
350: .Ar rev .
351: If two
352: .Fl j
353: options are specified, only merge the differences between the two
354: revisions of the branch.
355: This allows successive merges without having to resolve
356: already resolved conflicts again.
357: .It Fl k Ar mode
358: Specify the keyword substitution mode (is sticky).
359: .It Fl l
360: Limit the scope of the search to the local directory
361: only and disable recursive behaviour.
362: .It Fl N
363: If used in conjunction with the
364: .Fl d
365: option, files are placed in local directory
366: .Ar module ,
367: located in directory
368: .Ar dir .
369: .It Fl n
370: Do not execute programs listed in the
371: .Pa CVSROOT/modules
372: file.
373: .It Fl P
374: Prune empty directories.
375: .It Fl p
376: Check out files to standard output (avoids stickiness).
377: .It Fl R
378: Enable recursive behaviour.
379: This is the default.
380: .It Fl r Ar rev
381: Check out from a particular revision or branch (implies
382: .Fl P )
383: (is sticky).
384: .It Fl s
385: Like
386: .Fl c ,
387: but include module status.
388: .El
1.13 jmc 389: .Pp
390: Aliases:
391: .Ic co ,
392: .Ic get .
1.11 jmc 393: .It Xo Ic commit
1.3 jfb 394: .Op Fl flnR
1.27 xsa 395: .Oo Fl F Ar logfile \*(Ba
396: .Fl m Ar msg Oc
1.3 jfb 397: .Op Fl r Ar rev
1.4 jfb 398: .Op Ar file ...
1.3 jfb 399: .Xc
1.7 jfb 400: .Pp
1.1 jfb 401: The
1.11 jmc 402: .Ic commit
1.1 jfb 403: command is used to send local changes back to the server and update the
404: repository's information to reflect the changes.
1.27 xsa 405: .Pp
406: The
1.35 jmc 407: .Ic commit
408: command takes the following options:
409: .Bl -tag -width Ds -offset 3n
410: .It Fl F Ar logfile
411: Specify a
1.27 xsa 412: .Ar file
1.35 jmc 413: which contains the log message.
414: .It Fl f
415: Force a file to be committed, even though it is unchanged.
416: .It Fl l
417: Limit the scope of the search to the local directory
418: only and disable recursive behaviour.
419: .It Fl m Ar msg
420: Specify a log message on the command line (suppresses the editor invocation).
421: .It Fl n
422: Do not execute programs listed in the
423: .Pa CVSROOT/modules
424: file.
425: .It Fl R
426: Enable recursive behaviour.
427: This is the default.
428: .It Fl r Ar rev
429: Commit to a particular symbolic or numerical revision.
430: .El
1.13 jmc 431: .Pp
432: Aliases:
433: .Ic ci ,
434: .Ic com .
1.24 jfb 435: .It Xo Ic diff Op Fl cilNpu
1.3 jfb 436: .Op Fl D Ar date
437: .Op Fl r Ar rev
1.4 jfb 438: .Op Ar file ...
1.3 jfb 439: .Xc
1.7 jfb 440: .Pp
1.3 jfb 441: The
1.11 jmc 442: .Ic diff
1.3 jfb 443: command is very similar to the
444: .Xr diff 1
1.5 jfb 445: program, except that the differential comparisons that it generates are
1.3 jfb 446: between local or remote revisions of files stored in the CVS repository.
1.13 jmc 447: .Pp
448: Aliases:
449: .Ic di ,
450: .Ic dif .
1.30 xsa 451: .It Xo Ic edit Op Fl lR
452: .Op Fl a Ar action
453: .Op Ar file ...
454: .Xc
455: .Pp
456: The
457: .Ic edit
1.35 jmc 458: command is used to make a file that is being watched
459: (and therefore read-only)
1.30 xsa 460: readable and writable and to inform others that you are planning to edit it.
461: Notifications terminate when the
462: .Ic commit
463: command is issued.
464: Editing rights on the file can be given up using the
465: .Ic unedit
1.35 jmc 466: command, which terminates the temporary notifications.
1.30 xsa 467: .Pp
468: The
1.35 jmc 469: .Ic edit
470: command takes the following options:
471: .Bl -tag -width Ds -offset 3n
472: .It Fl a Ar action
473: Specify the temporary notification wanted:
474: .Pp
475: .Bl -tag -width "commitXX" -compact
1.30 xsa 476: .It Cm commit
1.35 jmc 477: Another user has committed changes to the file.
1.30 xsa 478: .It Cm edit
479: Another user has issued the
480: .Ic edit
1.35 jmc 481: command on the file.
1.30 xsa 482: .It Cm unedit
483: Another user has issued the
484: .Ic unedit
1.35 jmc 485: command on the file.
1.30 xsa 486: .It Cm all
487: All of the above.
488: .It Cm none
489: None of the above.
490: .El
491: .Pp
492: The
493: .Fl a
494: flag may appear more than once, or not at all.
495: If omitted, the action defaults to
1.31 jmc 496: .Cm all .
1.35 jmc 497: .It Fl l
498: Limit the scope of the search to the local directory
499: only and disable recursive behaviour.
500: .It Fl R
501: Enable recursive behaviour.
502: This is the default.
503: .El
1.33 xsa 504: .It Xo Ic editors
505: .Op Fl lR
1.34 xsa 506: .Op Ar file ...
1.33 xsa 507: .Xc
508: .Pp
509: The
510: .Ic editors
511: command lists the users with edition rights on a file.
512: For that, pseudo-lock mode must be enabled (see the
513: .Ic watch
514: command).
515: The e-mail address of the user editing the file, the timestamp
516: when the edition first started, the host from where the edition
517: has been requested and the path to the edited file are listed.
518: .Pp
519: The
1.35 jmc 520: .Ic editors
521: command takes the following options:
522: .Bl -tag -width Ds -offset 3n
523: .It Fl l
524: Limit the scope of the search to the local directory
525: only and disable recursive behaviour.
526: .It Fl R
527: Enable recursive behaviour.
528: This is the default.
529: .El
1.36 xsa 530: .It Xo Ic export
531: .Op Fl flNnR
532: .Op Fl d Ar dir
533: .Op Fl k Ar mode
534: .Fl D Ar date \*(Ba
535: .Fl r Ar rev
536: .Ar module ...
537: .Xc
538: .Pp
539: The
540: .Ic export
541: command extracts a copy of
542: .Ar module
543: without including the directories used for management by
544: .Nm .
545: This eases production of a software release.
546: A date or a revision must be specified for the command to be valid,
547: which ensures that later extractions can be reproduced with the same
548: options as the release.
549: .Pp
550: The checked out module's files will be placed in a directory
551: bearing the same name as the checked out module, by default.
552: .Pp
553: The
554: .Ic export
555: command takes the following options:
556: .Bl -tag -width Ds -offset 3n
557: .It Fl D Ar date
558: Export as of the latest revision no later than
559: .Ar date .
560: .It Fl d Ar dir
561: Export in directory
562: .Ar dir
563: instead of the directory bearing the same name as the
564: .Ar module .
565: .It Fl f
566: Force the use of the head revision if the specified
567: tag or date is not found.
568: This can be used in combination with
569: .Fl D
570: or
571: .Fl r
572: to ensure that the
573: .Ic export
574: command is valid.
575: .It Fl k Ar mode
576: Specify the keyword substitution mode: the
577: .Fl k Ar v
578: option is often used to avoid substitution of keywords during
579: a release cycle.
580: However, be aware that it does not handle an export containing
581: binary files correctly.
582: .It Fl l
583: Limit the scope of the search to the local directory
584: only and disable recursive behaviour.
585: .It Fl N
586: If used in conjunction with the
587: .Fl d
588: option, files are placed in local directory
589: .Ar module ,
590: located in directory
591: .Ar dir .
592: .It Fl n
593: Do not execute programs listed in the
594: .Pa CVSROOT/modules
595: file.
596: .It Fl R
597: Enable recursive behaviour.
598: This is the default.
599: .It Fl r Ar rev
600: Export from a particular symbolic or numerical revision.
601: .El
1.13 jmc 602: .Pp
603: Aliases:
604: .Ic ex ,
605: .Ic exp .
1.49 ! xsa 606: .It Xo Ic history
! 607: .Op Fl aceloTw
! 608: .Op Fl b Ar str
! 609: .Op Fl D Ar date
! 610: .Op Fl f Ar file
! 611: .Op Fl m Ar module
! 612: .Op Fl n Ar module
! 613: .Op Fl p Ar path
! 614: .Op Fl r Ar rev
! 615: .Op Fl t Ar tag
! 616: .Op Fl u Ar user
! 617: .Op Fl x Ar ACEFGMORTUW
! 618: .Op Fl z Ar tz
! 619: .Op Ar file ...
! 620: .Xc
! 621: .Pp
! 622: The
! 623: .Ic history
! 624: command is used to display the history of actions done in the
! 625: base repository.
! 626: This functionality is only available if the
! 627: .Ar CVSROOT/history
! 628: file has been created.
! 629: Only the
! 630: .Ic checkout ,
! 631: .Ic commit ,
! 632: .Ic export ,
! 633: .Ic release ,
! 634: .Ic rtag ,
! 635: and
! 636: .Ic update
! 637: commands are logged into this file.
! 638: .Pp
! 639: The
! 640: .Ic history
! 641: command takes the following options:
! 642: .Bl -tag -width Ds -offset 3n
! 643: .It Fl a
! 644: Display records for all users.
! 645: By default, only records from the user issuing the
! 646: .Ic history
! 647: command are displayed.
! 648: .It Fl b Ar str
! 649: Display everything back to a record containing the string
! 650: .Ar str
! 651: in either the module name, the file name, or the repository path.
! 652: .It Fl c
! 653: Display the archived files
! 654: .Pf ( Ic commit
! 655: command).
! 656: .It Fl D Ar date
! 657: Report no later than
! 658: .Ar date .
! 659: .It Fl e
! 660: Select all records (same as
! 661: .Fl x
! 662: with all types).
! 663: .It Fl f Ar file
! 664: Display records related to
! 665: .Ar file .
! 666: .It Fl l
! 667: Show last checkouts of modules with the
! 668: .Ic checkout
! 669: command.
! 670: .It Fl m Ar module
! 671: Look for the
! 672: .Ar module
! 673: (can be used several times).
! 674: .It Fl n Ar module
! 675: Search into the
! 676: .Ar module .
! 677: .It Fl o
! 678: Report on modules checked out by users.
! 679: .It Fl p Ar path
! 680: Display records from the base repository being in the directory
! 681: specified by the
! 682: .Ar path .
! 683: .It Fl r Ar rev
! 684: Report for a particular revision (checks in the RCS file).
! 685: .It Fl t Ar tag
! 686: Report since tag record placed in the
! 687: .Ar CVSROOT/history
! 688: file by any user.
! 689: .It Fl T
! 690: Report on all tags.
! 691: .It Fl u Ar user
! 692: Report for a specified
! 693: .Ar user .
! 694: Can be used several times to match many users.
! 695: .It Fl w
! 696: Check that records match the current working directory.
! 697: .It Fl x Ar ACEFGMORTUW
! 698: Extract by a specific record type specified by a single letter.
! 699: They can be used in combination.
! 700: The available types are as follows:
! 701: .Bl -tag -width "XXX"
! 702: .It A
! 703: A file has been added with the
! 704: .Ic add
! 705: command.
! 706: .It C
! 707: A merge has been done, but unresolved conflicts still remain.
! 708: .It E
! 709: Export.
! 710: .It F
! 711: Release.
! 712: .It G
! 713: A merge has been done without conflict.
! 714: .It M
! 715: A file has been modified (using the
! 716: .Ic commit
! 717: command).
! 718: .It O
! 719: Checkout.
! 720: .It R
! 721: A file has been removed with the
! 722: .Ic remove
! 723: command.
! 724: .It T
! 725: Rtag.
! 726: .It U
! 727: Normal update.
! 728: .It W
! 729: The file has been deleted from the directory because it does not
! 730: exist anymore in the base repository.
! 731: .El
! 732: .It Fl z Ar tz
! 733: Display records with time synchronized with the
! 734: .Ar timezone
! 735: passed as argument.
! 736: .El
! 737: .Pp
! 738: All records have the following five first columns:
! 739: .Pp
! 740: .Bl -dash -compact
! 741: .It
! 742: The record type (the
! 743: .Fl x
! 744: option).
! 745: .It
! 746: The date of the action.
! 747: .It
! 748: The time of the action.
! 749: .It
! 750: The time zone.
! 751: .It
! 752: The user who made the action.
! 753: .El
! 754: .Pp
! 755: The other columns may vary depending on the command issued.
1.13 jmc 756: .Pp
757: Aliases:
758: .Ic hi ,
759: .Ic his .
1.22 jmc 760: .It Xo Ic import
761: .Op Fl b Ar branch
762: .Op Fl m Ar msg
763: .Ar repository
764: .Ar vendortag
765: .Ar releasetag
766: .Xc
767: .Pp
1.13 jmc 768: Import sources into CVS using vendor branches.
1.22 jmc 769: .Pp
770: At least three arguments are required:
771: .Ar repository
772: specifies the location of the sources to be imported;
773: .Ar vendortag
774: is a tag for the entire branch;
775: .Ar releasetag
776: is used to identify the files you created with
1.35 jmc 777: .Ic cvs import .
778: .Pp
779: The
780: .Ic import
781: command takes the following options:
782: .Bl -tag -width Ds -offset 3n
783: .It Fl b Ar branch
784: Specify the first-level branch number.
785: .It Fl m Ar msg
786: Specify the log message to send.
787: .El
1.13 jmc 788: .Pp
789: Aliases:
790: .Ic im ,
791: .Ic imp .
792: .It Ic init
793: Create a CVS repository if it doesn't exist.
794: .It Ic kserver
795: Start a Kerberos authentication server.
796: .It Ic log
797: Print out history information for files.
798: .Pp
799: Aliases:
800: .Ic lo .
801: .It Ic login
1.35 jmc 802: Prompt for a password for an authenticating server.
1.13 jmc 803: .It Ic logout
1.35 jmc 804: Remove an entry in
805: .Pa .cvspass
806: for a remote repository.
1.13 jmc 807: .It Ic rdiff
808: Create
809: .Xr patch 1
810: format diffs between releases.
1.39 xsa 811: .It Xo Ic release
812: .Op Fl d
813: .Ar dir ...
814: .Xc
815: The
816: .Ic release
817: command indicates to
818: .Nm
819: that the working copy of a module is no longer in use and checks
820: that non archived modifications in the base repository do exist.
821: This command is not mandatory.
822: Local directories could always be removed without using it, but
823: in this case the handling of history information will no longer be
824: correct (see the
825: .Ic history
826: command).
827: .Pp
828: The
829: .Ic release
830: command takes the following options:
831: .Bl -tag -width Ds -offset 3n
832: .It Fl d Ar dir
833: Remove the directory
834: .Ar dir .
835: Be aware that this option silently removes any directories that have
836: been added to the local working copy without using the
837: .Ic add
838: command.
839: .El
840: .Pp
841: For each file not being synchronized with the base repository,
842: a single letter prefix is given to specify the state of the file.
843: The possible prefixes are as follows:
844: .Bl -tag -width "XXX"
845: .It \&?
846: The file is unknown to
847: .Nm
848: and is not in the list of files to ignore.
849: Any new directories which have not been added with the
850: .Ic add
851: command are silently ignored as well as their content.
852: .It A
853: The file has been added with the
854: .Ic add
855: command, but has not been committed to the repository with the
856: .Ic commit
857: command.
858: .It M
859: The file has been locally modified; a more recent version might
860: exist in the base repository.
861: .It R
862: The file has been removed with the
863: .Ic remove
864: command, but has not been committed to the repository with the
865: .Ic commit
866: command.
867: .It U
868: A more recent version of the file does exist but it is not
869: locally up to date.
870: .El
1.40 xsa 871: .Pp
872: Aliases:
873: .Ic re ,
874: .Ic rel .
1.18 xsa 875: .It Xo Ic remove
876: .Op Fl flR
877: .Op Ar file ...
878: .Xc
879: The
880: .Ic remove
881: command is used to inform
882: .Nm
883: that
884: .Ar file
885: is scheduled to be removed from the repository.
886: Files are not actually removed from the repository until the
887: .Ic commit
888: command has been run subsequently.
1.28 xsa 889: .Pp
890: The
1.35 jmc 891: .Ic remove
892: command takes the following options:
893: .Bl -tag -width Ds -offset 3n
894: .It Fl f
895: Force local file removal.
1.28 xsa 896: If this flag is not used, the file must be locally removed beforehand for
897: the command to be valid.
1.35 jmc 898: .It Fl l
899: Limit the scope of the search to the local directory
900: only and disable recursive behaviour.
901: .It Fl R
902: Enable recursive behaviour.
903: This is the default.
904: .El
1.18 xsa 905: .Pp
906: Aliases:
1.19 xsa 907: .Ic rm ,
908: .Ic delete .
1.13 jmc 909: .It Ic rlog
910: Print out history information for a module.
911: .It Ic rtag
912: Add a symbolic link to a module.
913: .It Ic server
914: Server mode.
1.25 xsa 915: .It Xo Ic status
916: .Op Fl lRv
917: .Op Ar file ...
918: .Xc
919: The
920: .Ic status
921: command is used to display the state of checked out files.
922: .Pp
923: The
1.35 jmc 924: .Ic status
925: command takes the following options:
926: .Bl -tag -width Ds -offset 3n
927: .It Fl l
928: Limit the scope of the search to the local directory
929: only and disable recursive behaviour.
930: .It Fl R
931: Enable recursive behaviour.
932: This is the default.
933: .It Fl v
934: Display symbolic tags for
935: .Ar file .
1.25 xsa 936: .Pp
1.35 jmc 937: The state may be one of the following:
938: .Bl -tag -width "Locally modified"
1.25 xsa 939: .It Cm Locally Added
940: The file has been added with the
941: .Ic add
942: command, but has not been committed to the repository with the
943: .Ic commit
944: command.
945: .It Cm Locally Modified
1.35 jmc 946: The file is up to date, but has been locally modified.
1.25 xsa 947: .It Cm Locally Removed
948: The file has been removed with the
949: .Ic remove
950: command, but has not been committed to the repository with the
951: .Ic commit
952: command.
953: .It Cm Needs Checkout
954: The file has not been modified; a new version is available.
955: .It Cm Needs Merge
956: The file has been modified and a newer version is available.
957: .It Cm Needs Patch
958: Same as
959: .Ic Needs Checkout
960: but, in client-server mode, only the differences are sent to save
961: network resources.
962: .It Cm Unresolved Conflict
963: A merge has been done, but unresolved conflicts still remain.
964: .It Cm Up-to-date
965: The file is up to date.
966: .El
1.35 jmc 967: .El
1.13 jmc 968: .Pp
969: Aliases:
970: .Ic st ,
971: .Ic stat .
1.21 jmc 972: .It Xo Ic tag
1.35 jmc 973: .Op Fl bdlR
1.21 jmc 974: .Op Fl r Ar old_tag
975: .Op Ar symbolic_tag
976: .Op Ar file ...
977: .Xc
978: .Pp
979: Add a symbolic tag to a checked out version of
980: .Ar file .
981: .Pp
982: The
1.35 jmc 983: .Ic tag
984: command takes the following options:
985: .Bl -tag -width Ds -offset 3n
986: .It Fl b
987: Specify a branch tag.
988: .It Fl d
989: Delete tag.
990: .It Fl l
991: Limit the scope of the search to the local directory
992: only and disable recursive behaviour.
993: .It Fl R
994: Enable recursive behaviour.
995: This is the default.
996: .It Fl r Ar old_tag
1.21 jmc 997: .Nm
998: will only tag the files with
999: .Ar symbolic_tag
1000: if they are already tagged with
1001: .Ar old_tag .
1002: When done, it will remove the old tag
1003: leaving only the new tag behind on exactly the same files.
1.35 jmc 1004: .El
1.13 jmc 1005: .Pp
1006: Aliases:
1007: .Ic ta ,
1008: .Ic freeze .
1.30 xsa 1009: .It Xo Ic unedit Op Fl lR
1010: .Op Ar file ...
1011: .Xc
1012: .Pp
1013: The
1014: .Ic unedit
1015: command is used to give up an edition on a file and thus cancel
1016: the wanted temporary notifications.
1017: If the file has been modified since the
1.13 jmc 1018: .Ic edit
1.30 xsa 1019: command has been issued,
1020: .Nm
1021: will ask if you want to go back to the previous version, and lose the
1022: modifications done on the file, or stay in edition mode on it.
1023: .Pp
1024: The
1.35 jmc 1025: .Ic unedit
1026: command takes the following options:
1027: .Bl -tag -width Ds -offset 3n
1028: .It Fl l
1029: Limit the scope of the search to the local directory
1030: only and disable recursive behaviour.
1031: .It Fl R
1032: Enable recursive behaviour.
1033: This is the default.
1034: .El
1.11 jmc 1035: .It Xo Ic update
1.38 xsa 1036: .Op Fl AdflPpR
1037: .Oo Fl D Ar date \*(Ba
1038: .Fl r Ar rev Oc
1039: .Op Fl I Ar ign
1040: .Op Fl j Ar rev
1041: .Op Fl k Ar mode
1042: .Op Fl W Ar spec
1.4 jfb 1043: .Op Ar file ...
1.3 jfb 1044: .Xc
1.7 jfb 1045: .Pp
1.3 jfb 1046: The
1.11 jmc 1047: .Ic update
1.17 david 1048: command is used to merge any of the changes that have occurred on the remote
1.3 jfb 1049: repository into the local one where the command was run.
1050: .Pp
1051: The
1.35 jmc 1052: .Ic update
1053: command takes the following options:
1054: .Bl -tag -width Ds -offset 3n
1055: .It Fl A
1.41 xsa 1056: Reset any sticky tags, dates, or keyword substitution modes that
1057: have been set on the tree.
1.38 xsa 1058: .It Fl D Ar date
1059: Update as of the latest revision no later than
1060: .Ar date
1061: (is sticky).
1062: .It Fl d
1063: Create any new directories.
1064: Without this option,
1065: .Nm
1066: does not create any new files sitting in these new directories
1067: added in the base repository since the last update of the working
1068: copy, or since the last update with the
1069: .Fl d
1070: option.
1071: .It Fl f
1072: Force the use of the head revision if the specified
1073: tag or date is not found.
1074: .It Fl I Ar ign
1075: Ignore files specified by
1076: .Ar ign .
1077: This option can be used several times on the command line.
1078: To see all files, use the
1079: .Fl I Ar !\&
1080: specification.
1081: .It Fl j Ar rev
1082: Merge in changes made between current revision and
1083: .Ar rev .
1084: If two
1085: .Fl j
1086: options are specified, only merge the differences between the two
1087: revisions of the branch.
1088: This allows successive merges without having to resolve
1089: already resolved conflicts again.
1090: .It Fl k Ar mode
1091: Specify the keyword substitution mode (is sticky).
1.35 jmc 1092: .It Fl l
1093: Limit the scope of the search to the local directory
1094: only and disable recursive behaviour.
1095: .It Fl P
1096: Prune any directories that have become empty as a result of the update.
1.38 xsa 1097: .It Fl p
1098: Send the result of the update to standard output (avoids stickiness).
1.35 jmc 1099: .It Fl R
1100: Enable recursive behaviour.
1101: This is the default.
1.38 xsa 1102: .It Fl r Ar rev
1103: Update from a particular revision or branch (is sticky).
1104: .It Fl W Ar spec
1105: Wrappers specification line.
1.35 jmc 1106: .El
1.38 xsa 1107: .Pp
1108: By default, the
1109: .Ic update
1110: command does not create new directories; the
1111: .Fl d
1112: option must be used for that.
1.29 xsa 1113: .Pp
1114: For each file updated, a single letter prefix is given to
1115: specify the state of the file.
1116: The possible prefixes are as follows:
1117: .Bl -tag -width "XXX"
1118: .It \&?
1119: The file is unknown to
1120: .Nm .
1121: .It A
1122: The file has been added with the
1123: .Ic add
1124: command, but has not been committed to the repository with the
1125: .Ic commit
1126: command.
1127: .It C
1128: A merge, with a more recent version of the file, has been done,
1129: but unresolved conflicts still remain.
1130: .It M
1131: The file has been locally modified; if a more recent version
1132: is available, the merge has been done without conflict.
1133: .It P
1134: The same as
1135: .Sq U ,
1136: but, in client-server mode, only differences are sent to save network
1137: resources.
1138: .It R
1139: The file has been removed with the
1140: .Ic remove
1141: command, but has not been committed to the repository with the
1142: .Ic commit
1143: command.
1144: .It U
1145: The file is up to date.
1146: .El
1.13 jmc 1147: .Pp
1148: Aliases:
1149: .Ic up ,
1150: .Ic upd .
1.11 jmc 1151: .It Ic version
1.3 jfb 1152: Causes
1153: .Nm
1154: to print its version information.
1.14 jfb 1155: If this command is issued within a local copy of a remote repository or
1156: if either the
1157: .Ev CVSROOT
1158: environment variable or the
1159: .Fl d
1160: flag specify a remote repository,
1.3 jfb 1161: .Nm
1162: will also connect to the server and ask it to print its version information.
1.13 jmc 1163: .Pp
1164: Aliases:
1165: .Ic ve ,
1166: .Ic ver .
1.32 xsa 1167: .It Xo Ic watch
1168: .Ar on | off | add | remove
1169: .Op Fl lR
1170: .Op Fl a Ar action
1171: .Op Ar file ...
1172: .Xc
1173: .Pp
1174: The
1175: .Ic watch
1176: command switches a file from normal mode to
1177: pseudo-lock mode as well as handling the notifications associated
1178: with it.
1179: Pseudo-lock mode means knowing who is editing a file:
1180: for that,
1181: .Nm
1182: extracts the file in read-only mode.
1183: Users must use the
1184: .Ic edit
1185: command to get the editing rights on the file.
1186: .Pp
1187: One of the following arguments to the
1188: .Ic watch
1189: command is mandatory: on, off, add, or remove.
1190: .Ar on
1191: switches the file into pseudo-lock mode;
1192: .Ar off
1193: switches it back to normal mode;
1194: .Ar add
1195: adds notifications for specific actions on the file;
1196: .Ar remove
1197: removes those notifications.
1198: .Pp
1199: The notifications are permanent.
1200: They remain in place until the
1201: .Ic watch remove
1202: command is issued while the temporary notifications are
1203: made available with the
1204: .Ic edit
1205: command.
1206: .Pp
1207: The
1.35 jmc 1208: .Ic watch
1209: command takes the following options:
1210: .Bl -tag -width Ds -offset 3n
1211: .It Fl a Ar action
1212: Specify the permanent notification wanted for
1.32 xsa 1213: .Ar add | remove :
1214: .Pp
1215: .Bl -tag -width "commitXX" -compact
1216: .It Cm commit
1.35 jmc 1217: Another user has committed changes to the file.
1.32 xsa 1218: .It Cm edit
1.35 jmc 1219: Another user is editing the file.
1.32 xsa 1220: .It Cm unedit
1.35 jmc 1221: Another user has finished editing the file.
1.32 xsa 1222: .It Cm all
1223: All of the above.
1224: .It Cm none
1225: No notification.
1226: .El
1227: .Pp
1.35 jmc 1228: If no specification is requested using the
1.32 xsa 1229: .Ar add
1230: or
1231: .Ar remove
1232: arguments, it implies the
1233: .Fl a Ar all
1234: option.
1.35 jmc 1235: .It Fl l
1236: Limit the scope of the search to the local directory
1237: only and disable recursive behaviour.
1238: .It Fl R
1239: Enable recursive behaviour.
1240: This is the default.
1241: .El
1.32 xsa 1242: .It Xo Ic watchers
1243: .Op Fl lR
1244: .Op Ar file ...
1245: .Xc
1246: .Pp
1247: The
1248: .Ic watchers
1249: command lists the users who asked for notifications as well as the
1250: notifications details.
1251: The possible notifications are as follows:
1252: .Bl -tag -width "tcommitXX"
1253: .It Cm commit
1254: Permanent watch of a commit of a new version of a file.
1255: .It Cm edit
1256: Permanent watch of the start of file edition.
1257: .It Cm tcommit
1258: Temporary watch of a commit of new version of a file.
1259: .It Cm tedit
1260: Temporary watch of the start of file edition.
1261: .It Cm tunedit
1262: Temporary watch of the end of file edition.
1263: .It Cm unedit
1264: Permanent watch of the end of file edition.
1265: .El
1266: .Pp
1267: The temporary watches are set using the
1268: .Ic edit
1269: command, until the
1270: .Ic commit
1271: or
1272: .Ic unedit
1.35 jmc 1273: command is issued on a file.
1274: .Pp
1275: The
1276: .Ic watchers
1277: command takes the following options:
1278: .Bl -tag -width Ds -offset 3n
1279: .It Fl l
1280: Limit the scope of the search to the local directory
1281: only and disable recursive behaviour.
1282: .It Fl R
1283: Enable recursive behaviour.
1284: This is the default.
1285: .El
1.1 jfb 1286: .El
1287: .Sh ENVIRONMENT
1288: .Bl -tag -width CVS_CLIENT_LOG
1.8 jmc 1289: .It Ev CVS_CLIENT_LOG
1290: This variable enables logging of all communications between the client and
1291: server when running in non-local mode.
1292: If set, this environment variable must contain a base path from which two
1293: paths will be generated by appending ".in" to the value for the server's
1294: input and ".out" for the server's output.
1.1 jfb 1295: .It Ev CVS_RSH
1296: Name of the program to use when connecting to the server through a remote
1297: shell.
1298: The default is to use the
1299: .Xr ssh 1
1300: program.
1301: .It Ev CVS_SERVER
1302: If set, gives the name of the program to invoke as a
1303: .Nm
1304: server when using remote shell.
1305: The default is to use `cvs'.
1306: .It Ev CVSEDITOR
1307: Name of the editor to use when editing commit messages.
1.8 jmc 1308: Checked before
1309: .Ev EDITOR
1310: and
1311: .Ev VISUAL .
1312: .It Ev CVSROOT
1313: When set, this variable should contain the string pointing to the root
1314: directory of the CVS repository.
1315: The contents of this variable are ignored when the
1316: .Fl d
1317: option is given or if `Root' files exist in the checked-out copy.
1.1 jfb 1318: .It Ev EDITOR
1.9 jmc 1319: Name of the editor to use when editing commit messages.
1320: This is traditionally a line-oriented editor,
1321: such as
1322: .Xr ex 1 .
1.1 jfb 1323: .It Ev VISUAL
1.9 jmc 1324: Name of the editor to use when editing commit messages.
1325: This is traditionally a screen-oriented editor,
1326: such as
1327: .Xr vi 1 .
1.8 jmc 1328: .El
1329: .Sh FILES
1330: .Bl -tag -width Ds
1331: .It Pa $HOME/.cvsrc
1332: File containing a list of implicit options to pass to certain commands.
1333: This file is read on startup unless the
1334: .Fl f
1335: option is specified.
1336: .It Pa $CVSROOT/CVSROOT
1337: Directory containing repository administrative files.
1338: .It Pa $CVSROOT/CVSROOT/loginfo
1339: File containing associations between modules and handlers for
1340: post-commit logging.
1.1 jfb 1341: .El
1342: .Sh SEE ALSO
1343: .Xr diff 1 ,
1.15 jmc 1344: .Xr gzip 1 ,
1.1 jfb 1345: .Xr patch 1 ,
1.8 jmc 1346: .Xr rcs 1 ,
1.16 jmc 1347: .Xr cvsrc 5 ,
1.35 jmc 1348: .Xr cvsintro 7 ,
1.1 jfb 1349: .Xr cvsd 8
1.8 jmc 1350: .Sh HISTORY
1351: The OpenCVS project is a BSD-licensed rewrite of the original
1352: Concurrent Versioning System written by Jean-Francois Brousseau.
1353: The original CVS code was written in large parts by Dick Grune,
1354: Brian Berliner and Jeff Polk.
1355: .Sh AUTHORS
1356: .An Jean-Francois Brousseau
1357: .An Vincent Labrecque
1358: .An Joris Vink
1.43 jfb 1359: .An Xavier Santolaria
1.2 jfb 1360: .Sh CAVEATS
1361: This CVS implementation does not fully conform to the GNU CVS version.
1.3 jfb 1362: In some cases, this was done explicitly because GNU CVS has inconsistencies
1.2 jfb 1363: or ambiguous behaviour.
1.3 jfb 1364: Some things have also been left out or modified to enhance the overall
1365: security of the system.
1366: .Pp
1367: Among other things, support for the pserver connection mechanism has been
1368: dropped because of security issues with the authentication mechanism.
![[BACK]](/icons/back.gif){kind=icon}
Return to cvs.1 CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [local] / src / usr.bin / cvs