[BACK]Return to cvs.1 CVS log [TXT][DIR] Up to [local] / src / usr.bin / cvs

Annotation of src/usr.bin/cvs/cvs.1, Revision 1.54

1.54    ! david       1: .\"    $OpenBSD: cvs.1,v 1.53 2005/02/25 17:35:21 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
1.54    ! david     214: Substitute 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.53      xsa       435: .It Xo Ic diff
                    436: .Op Fl cilNpRu
                    437: .Oo Oo Fl D
                    438: .Ar date1 \*(Ba
                    439: .Fl r Ar rev1 Oc
                    440: .Oo Fl D Ar date2 \*(Ba
                    441: .Fl r Ar rev2 Oc Oc
                    442: .Op Fl k Ar mode
1.4       jfb       443: .Op Ar file ...
1.3       jfb       444: .Xc
1.7       jfb       445: .Pp
1.3       jfb       446: The
1.11      jmc       447: .Ic diff
1.3       jfb       448: command is very similar to the
                    449: .Xr diff 1
1.5       jfb       450: program, except that the differential comparisons that it generates are
1.3       jfb       451: between local or remote revisions of files stored in the CVS repository.
1.53      xsa       452: .Pp
                    453: The
                    454: .Ic diff
                    455: command takes the following options:
                    456: .Bl -tag -width Ds -offset 3n
                    457: .It Fl c
                    458: Produces a diff with three lines of context.
                    459: See
                    460: .Xr diff 1
                    461: for more information.
                    462: .It Xo Fl D Ar date1
                    463: .Op Fl D Ar date2
                    464: .Xc
                    465: Differences between the revision at
                    466: .Ar date1
                    467: and the working copy or
                    468: .Ar date1
                    469: and
                    470: .Ar date2
                    471: (if specified).
                    472: .It Fl i
                    473: Ignore the case of letters.
                    474: For example,
                    475: .Sq A
                    476: will compare equal to
                    477: .Sq a .
                    478: .It Fl k Ar mode
                    479: Specify the keyword substitution mode.
                    480: .It Fl l
                    481: Limit the scope of the search to the local directory
                    482: only and disable recursive behaviour.
                    483: .It Fl N
                    484: Include added or removed files.
                    485: .It Fl p
                    486: With unified and context diffs, show with each change the first
                    487: 40 characters of the last line before the context beginning with
                    488: a letter, an underscore or a dollar sign.
                    489: See
                    490: .Xr diff 1
                    491: for more information.
                    492: .It Fl R
                    493: Enable recursive behaviour.
                    494: This is the default.
                    495: .It Xo Fl r Ar rev1
                    496: .Op Fl r Ar rev2
                    497: .Xc
                    498: Differences between revision
                    499: .Ar rev1
                    500: and the working copy or
                    501: .Ar rev1
                    502: and
                    503: .Ar rev2
                    504: (if specified).
                    505: .It Fl u
                    506: Produces a unified diff with three lines of context.
                    507: See
                    508: .Xr diff 1
                    509: for more information.
                    510: .El
1.13      jmc       511: .Pp
                    512: Aliases:
                    513: .Ic di ,
                    514: .Ic dif .
1.30      xsa       515: .It Xo Ic edit Op Fl lR
                    516: .Op Fl a Ar action
                    517: .Op Ar file ...
                    518: .Xc
                    519: .Pp
                    520: The
                    521: .Ic edit
1.35      jmc       522: command is used to make a file that is being watched
                    523: (and therefore read-only)
1.30      xsa       524: readable and writable and to inform others that you are planning to edit it.
                    525: Notifications terminate when the
                    526: .Ic commit
                    527: command is issued.
                    528: Editing rights on the file can be given up using the
                    529: .Ic unedit
1.35      jmc       530: command, which terminates the temporary notifications.
1.30      xsa       531: .Pp
                    532: The
1.35      jmc       533: .Ic edit
                    534: command takes the following options:
                    535: .Bl -tag -width Ds -offset 3n
                    536: .It Fl a Ar action
                    537: Specify the temporary notification wanted:
                    538: .Pp
                    539: .Bl -tag -width "commitXX" -compact
1.30      xsa       540: .It Cm commit
1.35      jmc       541: Another user has committed changes to the file.
1.30      xsa       542: .It Cm edit
                    543: Another user has issued the
                    544: .Ic edit
1.35      jmc       545: command on the file.
1.30      xsa       546: .It Cm unedit
                    547: Another user has issued the
                    548: .Ic unedit
1.35      jmc       549: command on the file.
1.30      xsa       550: .It Cm all
                    551: All of the above.
                    552: .It Cm none
                    553: None of the above.
                    554: .El
                    555: .Pp
                    556: The
                    557: .Fl a
                    558: flag may appear more than once, or not at all.
                    559: If omitted, the action defaults to
1.31      jmc       560: .Cm all .
1.35      jmc       561: .It Fl l
                    562: Limit the scope of the search to the local directory
                    563: only and disable recursive behaviour.
                    564: .It Fl R
                    565: Enable recursive behaviour.
                    566: This is the default.
                    567: .El
1.33      xsa       568: .It Xo Ic editors
                    569: .Op Fl lR
1.34      xsa       570: .Op Ar file ...
1.33      xsa       571: .Xc
                    572: .Pp
                    573: The
                    574: .Ic editors
                    575: command lists the users with edition rights on a file.
                    576: For that, pseudo-lock mode must be enabled (see the
                    577: .Ic watch
                    578: command).
                    579: The e-mail address of the user editing the file, the timestamp
                    580: when the edition first started, the host from where the edition
                    581: has been requested and the path to the edited file are listed.
                    582: .Pp
                    583: The
1.35      jmc       584: .Ic editors
                    585: command takes the following options:
                    586: .Bl -tag -width Ds -offset 3n
                    587: .It Fl l
                    588: Limit the scope of the search to the local directory
                    589: only and disable recursive behaviour.
                    590: .It Fl R
                    591: Enable recursive behaviour.
                    592: This is the default.
                    593: .El
1.36      xsa       594: .It Xo Ic export
                    595: .Op Fl flNnR
                    596: .Op Fl d Ar dir
                    597: .Op Fl k Ar mode
                    598: .Fl D Ar date \*(Ba
                    599: .Fl r Ar rev
                    600: .Ar module ...
                    601: .Xc
                    602: .Pp
                    603: The
                    604: .Ic export
                    605: command extracts a copy of
                    606: .Ar module
                    607: without including the directories used for management by
                    608: .Nm .
                    609: This eases production of a software release.
                    610: A date or a revision must be specified for the command to be valid,
                    611: which ensures that later extractions can be reproduced with the same
                    612: options as the release.
                    613: .Pp
                    614: The checked out module's files will be placed in a directory
                    615: bearing the same name as the checked out module, by default.
                    616: .Pp
                    617: The
                    618: .Ic export
                    619: command takes the following options:
                    620: .Bl -tag -width Ds -offset 3n
                    621: .It Fl D Ar date
                    622: Export as of the latest revision no later than
                    623: .Ar date .
                    624: .It Fl d Ar dir
                    625: Export in directory
                    626: .Ar dir
                    627: instead of the directory bearing the same name as the
                    628: .Ar module .
                    629: .It Fl f
                    630: Force the use of the head revision if the specified
                    631: tag or date is not found.
                    632: This can be used in combination with
                    633: .Fl D
                    634: or
                    635: .Fl r
                    636: to ensure that the
                    637: .Ic export
                    638: command is valid.
                    639: .It Fl k Ar mode
                    640: Specify the keyword substitution mode: the
                    641: .Fl k Ar v
                    642: option is often used to avoid substitution of keywords during
                    643: a release cycle.
                    644: However, be aware that it does not handle an export containing
                    645: binary files correctly.
                    646: .It Fl l
                    647: Limit the scope of the search to the local directory
                    648: only and disable recursive behaviour.
                    649: .It Fl N
                    650: If used in conjunction with the
                    651: .Fl d
                    652: option, files are placed in local directory
                    653: .Ar module ,
                    654: located in directory
                    655: .Ar dir .
                    656: .It Fl n
                    657: Do not execute programs listed in the
                    658: .Pa CVSROOT/modules
                    659: file.
                    660: .It Fl R
                    661: Enable recursive behaviour.
                    662: This is the default.
                    663: .It Fl r Ar rev
                    664: Export from a particular symbolic or numerical revision.
                    665: .El
1.13      jmc       666: .Pp
                    667: Aliases:
                    668: .Ic ex ,
                    669: .Ic exp .
1.49      xsa       670: .It Xo Ic history
                    671: .Op Fl aceloTw
                    672: .Op Fl b Ar str
                    673: .Op Fl D Ar date
                    674: .Op Fl f Ar file
                    675: .Op Fl m Ar module
                    676: .Op Fl n Ar module
                    677: .Op Fl p Ar path
                    678: .Op Fl r Ar rev
                    679: .Op Fl t Ar tag
                    680: .Op Fl u Ar user
                    681: .Op Fl x Ar ACEFGMORTUW
                    682: .Op Fl z Ar tz
                    683: .Op Ar file ...
                    684: .Xc
                    685: .Pp
                    686: The
                    687: .Ic history
                    688: command is used to display the history of actions done in the
                    689: base repository.
                    690: This functionality is only available if the
1.50      xsa       691: .Pa CVSROOT/history
1.49      xsa       692: file has been created.
                    693: Only the
                    694: .Ic checkout ,
                    695: .Ic commit ,
                    696: .Ic export ,
                    697: .Ic release ,
                    698: .Ic rtag ,
                    699: and
                    700: .Ic update
                    701: commands are logged into this file.
                    702: .Pp
                    703: The
                    704: .Ic history
                    705: command takes the following options:
                    706: .Bl -tag -width Ds -offset 3n
                    707: .It Fl a
                    708: Display records for all users.
                    709: By default, only records from the user issuing the
                    710: .Ic history
                    711: command are displayed.
                    712: .It Fl b Ar str
                    713: Display everything back to a record containing the string
                    714: .Ar str
                    715: in either the module name, the file name, or the repository path.
                    716: .It Fl c
                    717: Display the archived files
                    718: .Pf ( Ic commit
                    719: command).
                    720: .It Fl D Ar date
                    721: Report no later than
                    722: .Ar date .
                    723: .It Fl e
                    724: Select all records (same as
                    725: .Fl x
                    726: with all types).
                    727: .It Fl f Ar file
                    728: Display records related to
                    729: .Ar file .
                    730: .It Fl l
                    731: Show last checkouts of modules with the
                    732: .Ic checkout
                    733: command.
                    734: .It Fl m Ar module
                    735: Look for the
                    736: .Ar module
                    737: (can be used several times).
                    738: .It Fl n Ar module
                    739: Search into the
                    740: .Ar module .
                    741: .It Fl o
                    742: Report on modules checked out by users.
                    743: .It Fl p Ar path
                    744: Display records from the base repository being in the directory
                    745: specified by the
                    746: .Ar path .
                    747: .It Fl r Ar rev
                    748: Report for a particular revision (checks in the RCS file).
                    749: .It Fl t Ar tag
                    750: Report since tag record placed in the
1.50      xsa       751: .Pa CVSROOT/history
1.49      xsa       752: file by any user.
                    753: .It Fl T
                    754: Report on all tags.
                    755: .It Fl u Ar user
                    756: Report for a specified
                    757: .Ar user .
                    758: Can be used several times to match many users.
                    759: .It Fl w
                    760: Check that records match the current working directory.
                    761: .It Fl x Ar ACEFGMORTUW
                    762: Extract by a specific record type specified by a single letter.
                    763: They can be used in combination.
                    764: The available types are as follows:
                    765: .Bl -tag -width "XXX"
                    766: .It A
                    767: A file has been added with the
                    768: .Ic add
                    769: command.
                    770: .It C
                    771: A merge has been done, but unresolved conflicts still remain.
                    772: .It E
                    773: Export.
                    774: .It F
                    775: Release.
                    776: .It G
                    777: A merge has been done without conflict.
                    778: .It M
                    779: A file has been modified (using the
                    780: .Ic commit
                    781: command).
                    782: .It O
                    783: Checkout.
                    784: .It R
                    785: A file has been removed with the
                    786: .Ic remove
                    787: command.
                    788: .It T
                    789: Rtag.
                    790: .It U
                    791: Normal update.
                    792: .It W
                    793: The file has been deleted from the directory because it does not
                    794: exist anymore in the base repository.
                    795: .El
                    796: .It Fl z Ar tz
                    797: Display records with time synchronized with the
                    798: .Ar timezone
                    799: passed as argument.
                    800: .El
                    801: .Pp
                    802: All records have the following five first columns:
                    803: .Pp
                    804: .Bl -dash -compact
                    805: .It
                    806: The record type (the
                    807: .Fl x
                    808: option).
                    809: .It
                    810: The date of the action.
                    811: .It
                    812: The time of the action.
                    813: .It
                    814: The time zone.
                    815: .It
                    816: The user who made the action.
                    817: .El
                    818: .Pp
1.51      xsa       819: The other columns vary depending on the command issued:
                    820: .Pp
                    821: For records coming from the
                    822: .Ic rtag
                    823: command, the additional columns are as follows:
                    824: .Bd -literal -offset indent
                    825: <module> [<tag>:<argument>] {<working directory>}
                    826: .Ed
                    827: .Pp
                    828: For records coming from the
                    829: .Ic checkout
                    830: and
                    831: .Ic export
                    832: commands, the additional columns are as follows:
                    833: .Bd -literal -offset indent
                    834: <request> <repository> =<module>= <working directory>
                    835: .Ed
                    836: .Pp
                    837: For records coming from the
                    838: .Ic release
                    839: command, the additional columns are as follows:
                    840: .Bd -literal -offset indent
                    841: =<module>= <working directory>
                    842: .Ed
                    843: .Pp
                    844: For records coming from the
                    845: .Ic commit
                    846: and
                    847: .Ic update
                    848: commands, the additional columns are as follows:
                    849: .Bd -literal -offset indent
                    850: <version> <file> <module> == <working directory>
                    851: .Ed
1.13      jmc       852: .Pp
                    853: Aliases:
                    854: .Ic hi ,
                    855: .Ic his .
1.22      jmc       856: .It Xo Ic import
                    857: .Op Fl b Ar branch
                    858: .Op Fl m Ar msg
                    859: .Ar repository
                    860: .Ar vendortag
                    861: .Ar releasetag
                    862: .Xc
                    863: .Pp
1.13      jmc       864: Import sources into CVS using vendor branches.
1.22      jmc       865: .Pp
                    866: At least three arguments are required:
                    867: .Ar repository
                    868: specifies the location of the sources to be imported;
                    869: .Ar vendortag
                    870: is a tag for the entire branch;
                    871: .Ar releasetag
                    872: is used to identify the files you created with
1.35      jmc       873: .Ic cvs import .
                    874: .Pp
                    875: The
                    876: .Ic import
                    877: command takes the following options:
                    878: .Bl -tag -width Ds -offset 3n
                    879: .It Fl b Ar branch
                    880: Specify the first-level branch number.
                    881: .It Fl m Ar msg
                    882: Specify the log message to send.
                    883: .El
1.13      jmc       884: .Pp
                    885: Aliases:
                    886: .Ic im ,
                    887: .Ic imp .
                    888: .It Ic init
                    889: Create a CVS repository if it doesn't exist.
                    890: .It Ic kserver
                    891: Start a Kerberos authentication server.
1.52      xsa       892: .It Xo Ic log
                    893: .Op Fl bhlNRt
                    894: .Op Fl d Ar dates
                    895: .Op Fl r Ar revs
                    896: .Op Fl s Ar state
                    897: .Op Fl w Ar users
                    898: .Op Ar file ...
                    899: .Xc
                    900: .Pp
                    901: The
                    902: .Ic log
                    903: command displays information on a
                    904: .Ar file
                    905: such as its different revisions, description, different tags,
                    906: as well as the comments, dates, and authors of these revisions.
                    907: By default, the
                    908: .Ic log
                    909: command displays all the available information; the options are only
                    910: used to restrict the displayed information.
                    911: .Pp
                    912: The
                    913: .Ic log
                    914: command takes the following options:
                    915: .Bl -tag -width Ds -offset 3n
                    916: .It Fl b
                    917: List revisions of the default branch only.
                    918: .It Fl d Ar dates
                    919: Specify revisions with dates matching the specification.
                    920: The specification might be as follows:
                    921: .Bl -tag -width "XXXXXXXXXXXXXX"
                    922: .It D1>D2 or D2>D1
                    923: Select all revisions between
                    924: .Ar \&D1
                    925: and
                    926: .Ar D2 .
                    927: .It <D or D>
                    928: Select all revisions before
                    929: .Ar D .
                    930: .It >D or D<
                    931: Select all revisions after
                    932: .Ar D .
                    933: .It D
                    934: Select the latest revision before or equal to
                    935: .Ar D .
                    936: .El
                    937: .Pp
                    938: The
                    939: .Sq \*(Gt
                    940: and
                    941: .Sq \*(Lt
                    942: characters can be followed by the
                    943: .Sq =
                    944: character to imply an inclusive specification.
                    945: Several specifications can be used by separating them with the
                    946: .Sq \&;
                    947: character.
                    948: .It Fl h
                    949: Print header only.
                    950: .It Fl l
                    951: Limit the scope of the search to the local directory only.
                    952: .It Fl N
                    953: Do not list tags.
                    954: .It Fl R
                    955: Print name of RCS file only.
                    956: .It Fl r Ar revs
                    957: Specify revision(s) to list:
                    958: .Bl -tag -width "XXXXXXXXXXXXXXX"
                    959: .It REV1,REV2,...,
                    960: A list of revisions is specified by separating names or numbers
                    961: of revisions by the
                    962: .Sq \&,
                    963: character.
                    964: .It REV1:REV2
                    965: List all revisions between
                    966: .Ar REV1
                    967: and
                    968: .Ar REV2
                    969: (they must be on the same branch).
                    970: .It :REV
                    971: List all revisions since the beginning of the branch until
                    972: .Ar REV
                    973: included.
                    974: .It REV:
                    975: List all revisions of the branch beginning with
                    976: .Ar REV .
                    977: .It BRANCH
                    978: List all revisions of a branch.
                    979: .It BRANCH.
                    980: List the latest revision of the branch
                    981: .Ar BRANCH .
                    982: .It BRANCH1:BRANCH2
                    983: List all revisions of branches between
                    984: .Ar BRANCH1
                    985: and
                    986: .Ar BRANCH2 .
                    987: .El
                    988: .Pp
                    989: Without argument, the
                    990: .Fl r
                    991: option means the latest revision of the default branch.
                    992: .It Fl s Ar state
                    993: List revisions of the specified
                    994: .Ar state
                    995: only.
                    996: Several states can be listed by separating them with the
                    997: .Sq \&,
                    998: character.
                    999: .It Fl t
                   1000: Print header and description only.
                   1001: .It Fl w Ar users
                   1002: Do not list revisions made by specified
                   1003: .Ar users .
                   1004: Usernames should be separated by the
                   1005: .Sq \&,
                   1006: character.
                   1007: .El
1.13      jmc      1008: .Pp
                   1009: Aliases:
                   1010: .Ic lo .
                   1011: .It Ic login
1.35      jmc      1012: Prompt for a password for an authenticating server.
1.13      jmc      1013: .It Ic logout
1.35      jmc      1014: Remove an entry in
                   1015: .Pa .cvspass
                   1016: for a remote repository.
1.13      jmc      1017: .It Ic rdiff
                   1018: Create
                   1019: .Xr patch 1
                   1020: format diffs between releases.
1.39      xsa      1021: .It Xo Ic release
                   1022: .Op Fl d
                   1023: .Ar dir ...
                   1024: .Xc
                   1025: The
                   1026: .Ic release
                   1027: command indicates to
                   1028: .Nm
                   1029: that the working copy of a module is no longer in use and checks
                   1030: that non archived modifications in the base repository do exist.
                   1031: This command is not mandatory.
                   1032: Local directories could always be removed without using it, but
                   1033: in this case the handling of history information will no longer be
                   1034: correct (see the
                   1035: .Ic history
                   1036: command).
                   1037: .Pp
                   1038: The
                   1039: .Ic release
                   1040: command takes the following options:
                   1041: .Bl -tag -width Ds -offset 3n
                   1042: .It Fl d Ar dir
                   1043: Remove the directory
                   1044: .Ar dir .
                   1045: Be aware that this option silently removes any directories that have
                   1046: been added to the local working copy without using the
                   1047: .Ic add
                   1048: command.
                   1049: .El
                   1050: .Pp
                   1051: For each file not being synchronized with the base repository,
                   1052: a single letter prefix is given to specify the state of the file.
                   1053: The possible prefixes are as follows:
                   1054: .Bl -tag -width "XXX"
                   1055: .It \&?
                   1056: The file is unknown to
                   1057: .Nm
                   1058: and is not in the list of files to ignore.
                   1059: Any new directories which have not been added with the
                   1060: .Ic add
                   1061: command are silently ignored as well as their content.
                   1062: .It A
                   1063: The file has been added with the
                   1064: .Ic add
                   1065: command, but has not been committed to the repository with the
                   1066: .Ic commit
                   1067: command.
                   1068: .It M
                   1069: The file has been locally modified; a more recent version might
                   1070: exist in the base repository.
                   1071: .It R
                   1072: The file has been removed with the
                   1073: .Ic remove
                   1074: command, but has not been committed to the repository with the
                   1075: .Ic commit
                   1076: command.
                   1077: .It U
                   1078: A more recent version of the file does exist but it is not
                   1079: locally up to date.
                   1080: .El
1.40      xsa      1081: .Pp
                   1082: Aliases:
                   1083: .Ic re ,
                   1084: .Ic rel .
1.18      xsa      1085: .It Xo Ic remove
                   1086: .Op Fl flR
                   1087: .Op Ar file ...
                   1088: .Xc
                   1089: The
                   1090: .Ic remove
                   1091: command is used to inform
                   1092: .Nm
                   1093: that
                   1094: .Ar file
                   1095: is scheduled to be removed from the repository.
                   1096: Files are not actually removed from the repository until the
                   1097: .Ic commit
                   1098: command has been run subsequently.
1.28      xsa      1099: .Pp
                   1100: The
1.35      jmc      1101: .Ic remove
                   1102: command takes the following options:
                   1103: .Bl -tag -width Ds -offset 3n
                   1104: .It Fl f
                   1105: Force local file removal.
1.28      xsa      1106: If this flag is not used, the file must be locally removed beforehand for
                   1107: the command to be valid.
1.35      jmc      1108: .It Fl l
                   1109: Limit the scope of the search to the local directory
                   1110: only and disable recursive behaviour.
                   1111: .It Fl R
                   1112: Enable recursive behaviour.
                   1113: This is the default.
                   1114: .El
1.18      xsa      1115: .Pp
                   1116: Aliases:
1.19      xsa      1117: .Ic rm ,
                   1118: .Ic delete .
1.13      jmc      1119: .It Ic rlog
                   1120: Print out history information for a module.
                   1121: .It Ic rtag
                   1122: Add a symbolic link to a module.
                   1123: .It Ic server
                   1124: Server mode.
1.25      xsa      1125: .It Xo Ic status
                   1126: .Op Fl lRv
                   1127: .Op Ar file ...
                   1128: .Xc
                   1129: The
                   1130: .Ic status
                   1131: command is used to display the state of checked out files.
                   1132: .Pp
                   1133: The
1.35      jmc      1134: .Ic status
                   1135: command takes the following options:
                   1136: .Bl -tag -width Ds -offset 3n
                   1137: .It Fl l
                   1138: Limit the scope of the search to the local directory
                   1139: only and disable recursive behaviour.
                   1140: .It Fl R
                   1141: Enable recursive behaviour.
                   1142: This is the default.
                   1143: .It Fl v
                   1144: Display symbolic tags for
                   1145: .Ar file .
1.25      xsa      1146: .Pp
1.35      jmc      1147: The state may be one of the following:
                   1148: .Bl -tag -width "Locally modified"
1.25      xsa      1149: .It Cm Locally Added
                   1150: The file has been added with the
                   1151: .Ic add
                   1152: command, but has not been committed to the repository with the
                   1153: .Ic commit
                   1154: command.
                   1155: .It Cm Locally Modified
1.35      jmc      1156: The file is up to date, but has been locally modified.
1.25      xsa      1157: .It Cm Locally Removed
                   1158: The file has been removed with the
                   1159: .Ic remove
                   1160: command, but has not been committed to the repository with the
                   1161: .Ic commit
                   1162: command.
                   1163: .It Cm Needs Checkout
                   1164: The file has not been modified; a new version is available.
                   1165: .It Cm Needs Merge
                   1166: The file has been modified and a newer version is available.
                   1167: .It Cm Needs Patch
                   1168: Same as
                   1169: .Ic Needs Checkout
                   1170: but, in client-server mode, only the differences are sent to save
                   1171: network resources.
                   1172: .It Cm Unresolved Conflict
                   1173: A merge has been done, but unresolved conflicts still remain.
                   1174: .It Cm Up-to-date
                   1175: The file is up to date.
                   1176: .El
1.35      jmc      1177: .El
1.13      jmc      1178: .Pp
                   1179: Aliases:
                   1180: .Ic st ,
                   1181: .Ic stat .
1.21      jmc      1182: .It Xo Ic tag
1.35      jmc      1183: .Op Fl bdlR
1.21      jmc      1184: .Op Fl r Ar old_tag
                   1185: .Op Ar symbolic_tag
                   1186: .Op Ar file ...
                   1187: .Xc
                   1188: .Pp
                   1189: Add a symbolic tag to a checked out version of
                   1190: .Ar file .
                   1191: .Pp
                   1192: The
1.35      jmc      1193: .Ic tag
                   1194: command takes the following options:
                   1195: .Bl -tag -width Ds -offset 3n
                   1196: .It Fl b
                   1197: Specify a branch tag.
                   1198: .It Fl d
                   1199: Delete tag.
                   1200: .It Fl l
                   1201: Limit the scope of the search to the local directory
                   1202: only and disable recursive behaviour.
                   1203: .It Fl R
                   1204: Enable recursive behaviour.
                   1205: This is the default.
                   1206: .It Fl r Ar old_tag
1.21      jmc      1207: .Nm
                   1208: will only tag the files with
                   1209: .Ar symbolic_tag
                   1210: if they are already tagged with
                   1211: .Ar old_tag .
                   1212: When done, it will remove the old tag
                   1213: leaving only the new tag behind on exactly the same files.
1.35      jmc      1214: .El
1.13      jmc      1215: .Pp
                   1216: Aliases:
                   1217: .Ic ta ,
                   1218: .Ic freeze .
1.30      xsa      1219: .It Xo Ic unedit Op Fl lR
                   1220: .Op Ar file ...
                   1221: .Xc
                   1222: .Pp
                   1223: The
                   1224: .Ic unedit
                   1225: command is used to give up an edition on a file and thus cancel
                   1226: the wanted temporary notifications.
                   1227: If the file has been modified since the
1.13      jmc      1228: .Ic edit
1.30      xsa      1229: command has been issued,
                   1230: .Nm
                   1231: will ask if you want to go back to the previous version, and lose the
                   1232: modifications done on the file, or stay in edition mode on it.
                   1233: .Pp
                   1234: The
1.35      jmc      1235: .Ic unedit
                   1236: command takes the following options:
                   1237: .Bl -tag -width Ds -offset 3n
                   1238: .It Fl l
                   1239: Limit the scope of the search to the local directory
                   1240: only and disable recursive behaviour.
                   1241: .It Fl R
                   1242: Enable recursive behaviour.
                   1243: This is the default.
                   1244: .El
1.11      jmc      1245: .It Xo Ic update
1.38      xsa      1246: .Op Fl AdflPpR
                   1247: .Oo Fl D Ar date \*(Ba
                   1248: .Fl r Ar rev Oc
                   1249: .Op Fl I Ar ign
                   1250: .Op Fl j Ar rev
                   1251: .Op Fl k Ar mode
                   1252: .Op Fl W Ar spec
1.4       jfb      1253: .Op Ar file ...
1.3       jfb      1254: .Xc
1.7       jfb      1255: .Pp
1.3       jfb      1256: The
1.11      jmc      1257: .Ic update
1.17      david    1258: command is used to merge any of the changes that have occurred on the remote
1.3       jfb      1259: repository into the local one where the command was run.
                   1260: .Pp
                   1261: The
1.35      jmc      1262: .Ic update
                   1263: command takes the following options:
                   1264: .Bl -tag -width Ds -offset 3n
                   1265: .It Fl A
1.41      xsa      1266: Reset any sticky tags, dates, or keyword substitution modes that
                   1267: have been set on the tree.
1.38      xsa      1268: .It Fl D Ar date
                   1269: Update as of the latest revision no later than
                   1270: .Ar date
                   1271: (is sticky).
                   1272: .It Fl d
                   1273: Create any new directories.
                   1274: Without this option,
                   1275: .Nm
                   1276: does not create any new files sitting in these new directories
                   1277: added in the base repository since the last update of the working
                   1278: copy, or since the last update with the
                   1279: .Fl d
                   1280: option.
                   1281: .It Fl f
                   1282: Force the use of the head revision if the specified
                   1283: tag or date is not found.
                   1284: .It Fl I Ar ign
                   1285: Ignore files specified by
                   1286: .Ar ign .
                   1287: This option can be used several times on the command line.
                   1288: To see all files, use the
                   1289: .Fl I Ar !\&
                   1290: specification.
                   1291: .It Fl j Ar rev
                   1292: Merge in changes made between current revision and
                   1293: .Ar rev .
                   1294: If two
                   1295: .Fl j
                   1296: options are specified, only merge the differences between the two
                   1297: revisions of the branch.
                   1298: This allows successive merges without having to resolve
                   1299: already resolved conflicts again.
                   1300: .It Fl k Ar mode
                   1301: Specify the keyword substitution mode (is sticky).
1.35      jmc      1302: .It Fl l
                   1303: Limit the scope of the search to the local directory
                   1304: only and disable recursive behaviour.
                   1305: .It Fl P
                   1306: Prune any directories that have become empty as a result of the update.
1.38      xsa      1307: .It Fl p
                   1308: Send the result of the update to standard output (avoids stickiness).
1.35      jmc      1309: .It Fl R
                   1310: Enable recursive behaviour.
                   1311: This is the default.
1.38      xsa      1312: .It Fl r Ar rev
                   1313: Update from a particular revision or branch (is sticky).
                   1314: .It Fl W Ar spec
                   1315: Wrappers specification line.
1.35      jmc      1316: .El
1.38      xsa      1317: .Pp
                   1318: By default, the
                   1319: .Ic update
                   1320: command does not create new directories; the
                   1321: .Fl d
                   1322: option must be used for that.
1.29      xsa      1323: .Pp
                   1324: For each file updated, a single letter prefix is given to
                   1325: specify the state of the file.
                   1326: The possible prefixes are as follows:
                   1327: .Bl -tag -width "XXX"
                   1328: .It \&?
                   1329: The file is unknown to
                   1330: .Nm .
                   1331: .It A
                   1332: The file has been added with the
                   1333: .Ic add
                   1334: command, but has not been committed to the repository with the
                   1335: .Ic commit
                   1336: command.
                   1337: .It C
                   1338: A merge, with a more recent version of the file, has been done,
                   1339: but unresolved conflicts still remain.
                   1340: .It M
                   1341: The file has been locally modified; if a more recent version
                   1342: is available, the merge has been done without conflict.
                   1343: .It P
                   1344: The same as
                   1345: .Sq U ,
                   1346: but, in client-server mode, only differences are sent to save network
                   1347: resources.
                   1348: .It R
                   1349: The file has been removed with the
                   1350: .Ic remove
                   1351: command, but has not been committed to the repository with the
                   1352: .Ic commit
                   1353: command.
                   1354: .It U
                   1355: The file is up to date.
                   1356: .El
1.13      jmc      1357: .Pp
                   1358: Aliases:
                   1359: .Ic up ,
                   1360: .Ic upd .
1.11      jmc      1361: .It Ic version
1.3       jfb      1362: Causes
                   1363: .Nm
                   1364: to print its version information.
1.14      jfb      1365: If this command is issued within a local copy of a remote repository or
                   1366: if either the
                   1367: .Ev CVSROOT
                   1368: environment variable or the
                   1369: .Fl d
                   1370: flag specify a remote repository,
1.3       jfb      1371: .Nm
                   1372: will also connect to the server and ask it to print its version information.
1.13      jmc      1373: .Pp
                   1374: Aliases:
                   1375: .Ic ve ,
                   1376: .Ic ver .
1.32      xsa      1377: .It Xo Ic watch
                   1378: .Ar on | off | add | remove
                   1379: .Op Fl lR
                   1380: .Op Fl a Ar action
                   1381: .Op Ar file ...
                   1382: .Xc
                   1383: .Pp
                   1384: The
                   1385: .Ic watch
                   1386: command switches a file from normal mode to
                   1387: pseudo-lock mode as well as handling the notifications associated
                   1388: with it.
                   1389: Pseudo-lock mode means knowing who is editing a file:
                   1390: for that,
                   1391: .Nm
                   1392: extracts the file in read-only mode.
                   1393: Users must use the
                   1394: .Ic edit
                   1395: command to get the editing rights on the file.
                   1396: .Pp
                   1397: One of the following arguments to the
                   1398: .Ic watch
                   1399: command is mandatory: on, off, add, or remove.
                   1400: .Ar on
                   1401: switches the file into pseudo-lock mode;
                   1402: .Ar off
                   1403: switches it back to normal mode;
                   1404: .Ar add
                   1405: adds notifications for specific actions on the file;
                   1406: .Ar remove
                   1407: removes those notifications.
                   1408: .Pp
                   1409: The notifications are permanent.
                   1410: They remain in place until the
                   1411: .Ic watch remove
                   1412: command is issued while the temporary notifications are
                   1413: made available with the
                   1414: .Ic edit
                   1415: command.
                   1416: .Pp
                   1417: The
1.35      jmc      1418: .Ic watch
                   1419: command takes the following options:
                   1420: .Bl -tag -width Ds -offset 3n
                   1421: .It Fl a Ar action
                   1422: Specify the permanent notification wanted for
1.32      xsa      1423: .Ar add | remove :
                   1424: .Pp
                   1425: .Bl -tag -width "commitXX" -compact
                   1426: .It Cm commit
1.35      jmc      1427: Another user has committed changes to the file.
1.32      xsa      1428: .It Cm edit
1.35      jmc      1429: Another user is editing the file.
1.32      xsa      1430: .It Cm unedit
1.35      jmc      1431: Another user has finished editing the file.
1.32      xsa      1432: .It Cm all
                   1433: All of the above.
                   1434: .It Cm none
                   1435: No notification.
                   1436: .El
                   1437: .Pp
1.35      jmc      1438: If no specification is requested using the
1.32      xsa      1439: .Ar add
                   1440: or
                   1441: .Ar remove
                   1442: arguments, it implies the
                   1443: .Fl a Ar all
                   1444: option.
1.35      jmc      1445: .It Fl l
                   1446: Limit the scope of the search to the local directory
                   1447: only and disable recursive behaviour.
                   1448: .It Fl R
                   1449: Enable recursive behaviour.
                   1450: This is the default.
                   1451: .El
1.32      xsa      1452: .It Xo Ic watchers
                   1453: .Op Fl lR
                   1454: .Op Ar file ...
                   1455: .Xc
                   1456: .Pp
                   1457: The
                   1458: .Ic watchers
                   1459: command lists the users who asked for notifications as well as the
                   1460: notifications details.
                   1461: The possible notifications are as follows:
                   1462: .Bl -tag -width "tcommitXX"
                   1463: .It Cm commit
                   1464: Permanent watch of a commit of a new version of a file.
                   1465: .It Cm edit
                   1466: Permanent watch of the start of file edition.
                   1467: .It Cm tcommit
                   1468: Temporary watch of a commit of new version of a file.
                   1469: .It Cm tedit
                   1470: Temporary watch of the start of file edition.
                   1471: .It Cm tunedit
                   1472: Temporary watch of the end of file edition.
                   1473: .It Cm unedit
                   1474: Permanent watch of the end of file edition.
                   1475: .El
                   1476: .Pp
                   1477: The temporary watches are set using the
                   1478: .Ic edit
                   1479: command, until the
                   1480: .Ic commit
                   1481: or
                   1482: .Ic unedit
1.35      jmc      1483: command is issued on a file.
                   1484: .Pp
                   1485: The
                   1486: .Ic watchers
                   1487: command takes the following options:
                   1488: .Bl -tag -width Ds -offset 3n
                   1489: .It Fl l
                   1490: Limit the scope of the search to the local directory
                   1491: only and disable recursive behaviour.
                   1492: .It Fl R
                   1493: Enable recursive behaviour.
                   1494: This is the default.
                   1495: .El
1.1       jfb      1496: .El
                   1497: .Sh ENVIRONMENT
                   1498: .Bl -tag -width CVS_CLIENT_LOG
1.8       jmc      1499: .It Ev CVS_CLIENT_LOG
                   1500: This variable enables logging of all communications between the client and
                   1501: server when running in non-local mode.
                   1502: If set, this environment variable must contain a base path from which two
                   1503: paths will be generated by appending ".in" to the value for the server's
                   1504: input and ".out" for the server's output.
1.1       jfb      1505: .It Ev CVS_RSH
                   1506: Name of the program to use when connecting to the server through a remote
                   1507: shell.
                   1508: The default is to use the
                   1509: .Xr ssh 1
                   1510: program.
                   1511: .It Ev CVS_SERVER
                   1512: If set, gives the name of the program to invoke as a
                   1513: .Nm
                   1514: server when using remote shell.
                   1515: The default is to use `cvs'.
                   1516: .It Ev CVSEDITOR
                   1517: Name of the editor to use when editing commit messages.
1.8       jmc      1518: Checked before
                   1519: .Ev EDITOR
                   1520: and
                   1521: .Ev VISUAL .
                   1522: .It Ev CVSROOT
                   1523: When set, this variable should contain the string pointing to the root
                   1524: directory of the CVS repository.
                   1525: The contents of this variable are ignored when the
                   1526: .Fl d
                   1527: option is given or if `Root' files exist in the checked-out copy.
1.1       jfb      1528: .It Ev EDITOR
1.9       jmc      1529: Name of the editor to use when editing commit messages.
                   1530: This is traditionally a line-oriented editor,
                   1531: such as
                   1532: .Xr ex 1 .
1.1       jfb      1533: .It Ev VISUAL
1.9       jmc      1534: Name of the editor to use when editing commit messages.
                   1535: This is traditionally a screen-oriented editor,
                   1536: such as
                   1537: .Xr vi 1 .
1.8       jmc      1538: .El
                   1539: .Sh FILES
                   1540: .Bl -tag -width Ds
                   1541: .It Pa $HOME/.cvsrc
                   1542: File containing a list of implicit options to pass to certain commands.
                   1543: This file is read on startup unless the
                   1544: .Fl f
                   1545: option is specified.
                   1546: .It Pa $CVSROOT/CVSROOT
                   1547: Directory containing repository administrative files.
                   1548: .It Pa $CVSROOT/CVSROOT/loginfo
                   1549: File containing associations between modules and handlers for
                   1550: post-commit logging.
1.1       jfb      1551: .El
                   1552: .Sh SEE ALSO
                   1553: .Xr diff 1 ,
1.15      jmc      1554: .Xr gzip 1 ,
1.1       jfb      1555: .Xr patch 1 ,
1.8       jmc      1556: .Xr rcs 1 ,
1.16      jmc      1557: .Xr cvsrc 5 ,
1.35      jmc      1558: .Xr cvsintro 7 ,
1.1       jfb      1559: .Xr cvsd 8
1.8       jmc      1560: .Sh HISTORY
                   1561: The OpenCVS project is a BSD-licensed rewrite of the original
                   1562: Concurrent Versioning System written by Jean-Francois Brousseau.
                   1563: The original CVS code was written in large parts by Dick Grune,
                   1564: Brian Berliner and Jeff Polk.
                   1565: .Sh AUTHORS
                   1566: .An Jean-Francois Brousseau
                   1567: .An Vincent Labrecque
                   1568: .An Joris Vink
1.43      jfb      1569: .An Xavier Santolaria
1.2       jfb      1570: .Sh CAVEATS
                   1571: This CVS implementation does not fully conform to the GNU CVS version.
1.3       jfb      1572: In some cases, this was done explicitly because GNU CVS has inconsistencies
1.2       jfb      1573: or ambiguous behaviour.
1.3       jfb      1574: Some things have also been left out or modified to enhance the overall
                   1575: security of the system.
                   1576: .Pp
                   1577: Among other things, support for the pserver connection mechanism has been
                   1578: dropped because of security issues with the authentication mechanism.