8 .\" Full space in nroff; half space in troff
15 .RB ` "\|\\$1\|" '\\$2
18 cvs \- Concurrent Versions System
21 \fBcvs\fP [ \fIcvs_options\fP ]
29 This manpage is a summary of some of the features of
31 but it may no longer be kept up-to-date.
32 For more current and in-depth documentation, please consult the
33 Cederqvist manual (via the
36 as described in the SEE ALSO section of this manpage).
38 .IX "revision control system" "\fLcvs\fR"
39 .IX cvs "" "\fLcvs\fP \- concurrent versions system"
40 .IX "concurrent versions system \- \fLcvs\fP"
41 .IX "release control system" "cvs command" "" "\fLcvs\fP \- concurrent versions system"
42 .IX "source control system" "cvs command" "" "\fLcvs\fP \- concurrent versions system"
43 .IX revisions "cvs command" "" "\fLcvs\fP \- source control"
44 CVS is a version control system, which allows you to keep old versions
45 of files (usually source code), keep a log of who, when, and why
46 changes occurred, etc., like RCS or SCCS. Unlike the simpler systems,
47 CVS does not just operate on one file at a time or one directory at a
48 time, but operates on hierarchical collections of directories
49 consisting of version controlled files. CVS helps to manage releases
50 and to control the concurrent editing of source files among multiple
51 authors. CVS allows triggers to enable/log/control various
52 operations and works well over a wide area network.
55 keeps a single copy of the master sources.
56 This copy is called the source ``repository''; it contains all the
57 information to permit extracting previous software releases at any
58 time based on either a symbolic revision tag, or a date in the past.
59 .SH "ESSENTIAL COMMANDS"
61 provides a rich variety of commands (\fIcvs_command\fP in the
62 Synopsis), each of which often has a wealth of options, to satisfy the
63 many needs of source management in distributed environments. However,
64 you don't have to master every detail to do useful work with
66 in fact, five commands are sufficient to use (and contribute to)
67 the source repository.
69 \fBcvs checkout\fP \fImodules\fP\|.\|.\|.
70 A necessary preliminary for most \fBcvs\fP work: creates your private
71 copy of the source for \fImodules\fP (named collections of source; you
72 can also use a path relative to the source repository here). You can
73 work with this copy without interfering with others' work. At least
74 one subdirectory level is always created.
77 Execute this command from \fIwithin\fP your private source
78 directory when you wish to update your copies of source files from
79 changes that other developers have made to the source in the
82 \fBcvs add\fP \fIfile\fP\|.\|.\|.
83 Use this command to enroll new files in \fBcvs\fP records of your
84 working directory. The files will be added to the repository the next
90 command to bootstrap new sources into the source repository.
92 is only used for new files to an already checked-out module.
94 \fBcvs remove\fP \fIfile\fP\|.\|.\|.
95 Use this command (after erasing any files listed) to declare that you
96 wish to eliminate files from the repository. The removal does not
97 affect others until you run
100 \fBcvs commit\fP \fIfile\fP\|.\|.\|.
101 Use this command when you wish to ``publish'' your changes to other
102 developers, by incorporating them in the source repository.
106 command line can include
108 which apply to the overall
112 which specifies a particular action on the source repository; and
116 to fully specify what the
121 you must be careful of precisely where you place options relative to the
123 The same option can mean different things depending on whether it
126 position (to the left of a
130 position (to the right of a
134 There are only two situations where you may omit
139 elicits a list of available commands, and
143 displays version information on \fBcvs\fP itself.
150 style long options as well as short options. Only
151 a few long options are currently supported, these are listed in
152 brackets after the short options whose functions they duplicate.
154 Use these options to control the overall
159 Display usage information about the specified
161 (but do not actually execute the command). If you don't specify a
164 displays a summary of all the commands available.
167 Causes the command to be
169 quiet; the command will generate output only for serious problems.
172 Causes the command to be somewhat quiet; informational messages, such
173 as reports of recursion through subdirectories, are suppressed.
175 \fB\-b\fP \fIbindir\fP
178 as the directory where
180 programs are located (CVS 1.9 and older).
181 Overrides the setting of the
183 environment variable.
184 This value should be specified as an absolute pathname.
186 \fB\-d\fP \fICVS_root_directory\fP
188 .I CVS_root_directory
189 as the root directory pathname of the master
191 Overrides the setting of the
193 environment variable.
194 This value should be specified as an absolute pathname.
196 \fB\-e\fP \fIeditor\fP
199 to enter revision log information.
200 Overrides the setting of the
206 environment variables.
211 startup file (\fI~/.cvsrc\fP).
214 Do not change any files. Attempt to execute the
216 but only to issue reports; do not remove, update, or merge any
217 existing files, or create any new files.
220 Trace program execution; display messages showing the steps of
222 activity. Particularly useful with
224 to explore the potential impact of an unfamiliar command.
227 Makes new working files read-only.
228 Same effect as if the
230 environment variable is set.
233 Turns on read-only repository mode. This allows one to check out from a
234 read-only repository, such as within an anoncvs server, or from a CDROM
236 Same effect as if the
238 environment variable is set. Using
240 can also considerably speed up checkout's over NFS.
243 Displays version and copyright information for
247 Makes new working files read-write (default).
248 Overrides the setting of the
250 environment variable.
253 Forces group-write perms on working files. This option is typically
254 used when you have multiple users sharing a single checked out source
255 tree, allowing them to operate their shells with a less dangerous umask.
256 To use this feature, create a directory to hold the checked-out source
257 tree, set it to a private group, and set up the directory such that
258 files created under it inherit the group id of the directory. This occurs
259 automatically with FreeBSD. With SysV you must typically set the SGID bit
260 on the directory. The users who are to share the checked out tree must
261 be placed in that group. Note that the sharing of a single checked-out
262 source tree is very different from giving several users access to a common
263 CVS repository. Access to a common CVS repository already maintains shared
264 group-write perms and does not require this option.
266 To use the option transparently, simply place the line 'cvs -g' in your
267 ~/.cvsrc file. Doing this is not recommended unless you firewall all your
268 source checkouts within a private group or within a private mode 0700
272 Encrypt all communication between the client and the server. As of
273 this writing, this is only implemented when using a Kerberos
276 \fB\-z\fP \fIcompression\-level\fP
277 When transferring files across the network use
279 with compression level \fIcompression\-level\fP to compress and
280 de-compress data as it is transferred. Requires the presence of
284 program in the current search path at both ends of the link.
286 Except when requesting general help with
292 to select a specific release control function to perform.
295 command accepts its own collection of options and arguments.
296 However, many options are available across several commands.
297 You can display a usage summary for each command by specifying the
299 option with the command.
300 .SH "CVS STARTUP FILE"
301 Normally, when CVS starts up, it reads the
303 file from the home directory of the user reading it. This startup
304 procedure can be turned off with the
310 file lists CVS commands with a list of arguments, one command per
311 line. For example, the following line in \fI.cvsrc\fP:
317 command will always be passed the \-c option in addition to any
318 other options that are specified in the command line (in this case
319 it will have the effect of producing context sensitive diffs for
324 Global options are specified using the \fBcvs\fP keyword. For example,
331 commands will behave as thought he \-q global option had been supplied.
332 .SH "CVS COMMAND SUMMARY"
333 Here are brief descriptions of all the
338 Add a new file or directory to the repository, pending a
341 Can only be done from within sources created by a previous
346 to place whole new hierarchies of sources under
349 (Does not directly affect repository; changes
354 control functions on the source repository. (Changes
355 repository directly; uses working directory without changing it.)
358 Make a working directory of source files for editing. (Creates or changes
362 Apply to the source repository changes, additions, and deletions from your
363 working directory. (Changes repository.)
366 Show differences between files in working directory and source
367 repository, or between two revisions in source repository.
368 (Does not change either repository or working directory.)
371 Prepare copies of a set of source files for shipment off site.
376 administrative directories are created (and therefore
378 cannot be executed from a directory prepared with
380 and a symbolic tag must be specified.
381 (Does not change repository; creates directory similar to working
387 commands that you or others have executed on a particular file or
388 directory in the source repository. (Does not change repository or
389 working directory.) History logs are kept only if enabled by creation
391 .` "$CVSROOT/CVSROOT/history"
396 Incorporate a set of updates from off-site into the source repository,
397 as a ``vendor branch''. (Changes repository.)
400 Initialize a repository by adding the CVSROOT subdirectory and some default
401 control files. You must use this command or initialize the repository in
402 some other way before you can use it.
407 (Does not change repository or working directory.)
410 Prepare a collection of diffs as a patch file between two releases in
411 the repository. (Does not change repository or working directory.)
416 abandoning any changes.
417 (Can delete working directory; no effect on repository.)
420 Remove files from the source repository, pending a
422 on the same files. (Does not directly affect repository;
423 changes working directory.)
426 Explicitly specify a symbolic tag for particular revisions of files in the
427 source repository. See also
429 (Changes repository directly; does not require or affect
433 Show current status of files: latest version, version in working
434 directory, whether working version has been edited and, optionally,
437 file. (Does not change
438 repository or working directory.)
441 Specify a symbolic tag for files in the repository. By default, tags
443 that were last synchronized with your working directory. (Changes
444 repository directly; uses working directory without changing it.)
447 Bring your working directory up to date with changes from the
448 repository. Merges are performed automatically when possible; a
449 warning is issued if manual resolution is required for conflicting
450 changes. (Changes working directory; does not change repository.)
451 .SH "COMMON COMMAND OPTIONS"
452 This section describes the
454 that are available across several
456 commands. Not all commands support all of these options; each option
457 is only supported for commands where it makes sense. However, when
458 a command has one of these options you can count on the same meaning
459 for the option as in other commands. (Other command
460 options, which are listed with the individual commands, may have
461 different meanings from one
467 command is an exception;
468 it supports many options that conflict
469 even with these standard options.
471 \fB\-D\fP \fIdate_spec\fP
472 Use the most recent revision no later than \fIdate_spec\fP (a single
473 argument, date description specifying a date in the
474 past). A wide variety of date formats are supported, in particular
475 ISO ("1972-09-24 20:05") or Internet ("24 Sep 1972 20:05").
476 The \fIdate_spec\fP is interpreted as being in the local timezone, unless a
477 specific timezone is specified.
478 The specification is ``sticky'' when you use it to make a
479 private copy of a source file; that is, when you get a working file
480 using \fB\-D\fP, \fBcvs\fP records the date you
481 specified, so that further updates in the same directory will use the
482 same date (unless you explicitly override it; see the description of
483 the \fBupdate\fP command).
485 is available with the
486 .BR checkout ", " diff ", " history ", " export ", "
487 .BR rdiff ", " rtag ", and "
490 Examples of valid date specifications include:
502 January 23, 1987 10:05pm
509 When you specify a particular date or tag to \fBcvs\fP commands, they
510 normally ignore files that do not contain the tag (or did not exist on
511 the date) that you specified. Use the \fB\-f\fP option if you want
512 files retrieved even when there is no match for the tag or date. (The
513 most recent version is used in this situation.)
515 is available with these commands:
516 .BR checkout ", " export ", "
517 .BR rdiff ", " rtag ", and " update .
519 \fB\-k\fP \fIkflag\fP
521 processing of keywords.
522 The \fB\-k\fP option is available with the
523 .BR add ", " checkout ", " diff ", " rdiff ", " export ", and "
525 commands. Your \fIkflag\fP specification is ``sticky'' when you use
526 it to create a private copy of a source file; that is, when you use
527 this option with the \fBcheckout\fP or \fBupdate\fP commands,
528 \fBcvs\fP associates your selected \fIkflag\fP with the file, and
529 continues to use it with future \fBupdate\fP commands on the same file
530 until you specify otherwise.
532 Some of the more useful \fIkflag\fPs are \-ko and \-kb (for binary files),
533 and \-kv which is useful for an
535 where you wish to retain keyword information after an
540 Local; run only in current working directory, rather than recurring through
541 subdirectories. Available with the following commands:
542 .BR checkout ", " commit ", " diff ", "
543 .BR export ", " remove ", " rdiff ", " rtag ", "
544 .BR status ", " tag ", and " update .
550 .BR checkout / commit / tag / update
551 program. (A program can be specified to run on each of these
552 activities, in the modules database; this option bypasses it.)
554 .BR checkout ", " export ", and "
561 option, which you can specify to the
568 Prune (remove) directories that are empty after being updated, on
569 .BR checkout ", or " update .
570 Normally, an empty directory (one that is void of revision-controlled
571 files) is left alone.
574 will cause these directories to be silently removed from your checked-out
576 This does not remove the directory from the repository, only from your
578 Note that this option is implied by the
583 .BR checkout " and " export .
586 Create/Update CVS/Template by copying it from the (local) repository.
587 This option is useful for developers maintaining a local cvs repository
588 but committing to a remote repository. By maintaining CVS/Template the
589 remote commits will still be able to bring up the proper template in the
590 commit editor session.
592 .BR checkout " and " update
596 Pipe the files retrieved from the repository to standard output,
597 rather than writing them in the current directory. Available with the
598 .BR checkout " and " update
602 Use the revision specified by the
604 argument instead of the default ``head'' revision. As well as
605 arbitrary tags defined with the \fBtag\fP or \fBrtag\fP command, two
606 special tags are always available:
609 recent version available in the repository, and
611 refers to the revision you last checked out into the current working
614 The \fItag\fP specification is ``sticky'' when you use
620 make your own copy of a file: \fBcvs\fP remembers the \fItag\fP and
621 continues to use it on future \fBupdate\fP commands, until you specify
624 can be either a symbolic or numeric tag.
625 When a command expects a specific revision,
626 the name of a branch is interpreted as the most recent
627 revision on that branch.
630 global option along with the
632 command option is often useful, to suppress the warning messages when the
634 file does not contain the specified tag.
636 is available with the
637 .BR annotate ", " checkout ", "
638 .BR commit ", " diff ", " history ", " export ", " rdiff ", "
639 .BR rtag ", and " update
645 option, which you can specify to the
651 Here (finally) are details on all the
653 commands and the options each accepts. The summary lines at the top
654 of each command's description highlight three kinds of things:
656 \ \ \ \ Command Options and Arguments
657 Special options are described in detail below; common command options
658 may appear only in the summary line.
660 \ \ \ \ Working Directory, or Repository?
661 Some \fBcvs\fP commands require a working directory to operate; some
662 require a repository. Also, some commands \fIchange\fP the
663 repository, some change the working directory, and some change
667 Many commands have synonyms, which you may find easier to
668 remember (or type) than the principal name.
671 \fBadd\fP [\fB\-k\fP \fIkflag\fP] [\fB\-m '\fP\fImessage\fP\fB'\fP] \fIfiles.\|.\|.\fP
673 repository, working directory.
683 command to create a new file or directory in the
685 The files or directories specified with
687 must already exist in the current directory (which must have been created
691 To add a whole new directory hierarchy to the source repository
692 (for example, files received from a third-party vendor), use the
698 refers to an immediate sub-directory, the directory is
699 created at the correct place in the
700 source repository, and the necessary
702 administration files are created in your working directory.
703 If the directory already exists in the source repository,
705 still creates the administration files in your version of the directory.
706 This allows you to use
708 to add a particular directory to your private sources even if
709 someone else created that directory after your
711 of the sources. You can do the following:
716 example% mkdir new_directory
717 example% cvs add new_directory
718 example% cvs update new_directory
723 An alternate approach using
730 example% cvs update -d new_directory
735 (To add \fIany available\fP new directories to your working directory, it's
736 probably simpler to use
741 The added files are not placed in the
742 source repository until you use
744 to make the change permanent.
747 on a file that was removed with the
749 command will resurrect the file, if no
753 You will have the opportunity to specify a logging message, as usual,
756 to make the new file permanent. If you'd like to have another
757 logging message associated with just
759 of the file (for example, to describe the file's purpose), you can
761 .` "\-m \fImessage\fP"
768 option specifies the default way that this
769 file will be checked out.
772 argument is stored in the
774 file and can be changed with
778 is useful for checking in binaries that
782 \fBadmin\fP [\fIrcs-options\fP] \fIfiles.\|.\|.\fP
784 repository, working directory.
794 interface to assorted administrative
795 facilities, similar to
797 This command works recursively, so extreme care should be
800 \fBcheckout\fP [\fBoptions\fP] \fImodules\fP.\|.\|.
810 Make a working directory containing copies of the source files specified by
814 before using most of the other
816 commands, since most of them operate on your working directory.
818 \fImodules\fP are either symbolic names (themselves defined as the
821 in the source repository; see
823 for some collection of source directories and files, or paths to
824 directories or files in the repository.
830 may recursively create directories and populate them with the appropriate
832 You can then edit these source files at any time (regardless of whether
833 other software developers are editing their own copies of the sources);
834 update them to include new changes applied by others to the source
835 repository; or commit your work as a permanent change to the
840 is used to create directories.
841 The top-level directory created is always added to the directory
844 is invoked, and usually has the same name as the specified
848 alias, the created sub-directory may have a different name, but you can be
849 sure that it will be a sub-directory, and that
851 will show the relative path leading to each file as it is extracted into
852 your private work area (unless you specify the
858 on a directory that was already built by a prior
860 is also permitted, and
861 has the same effect as specifying the
865 command described below.
871 include the standard command options
872 .BR \-P ", " \-f ", "
875 .BR \-l ", " \-n ", " \-p ", "
881 In addition to those, you can use these special command options
887 option to reset any sticky tags, dates, or
889 options. (If you get a working file using one of the
890 \fB\-r\fP, \fB\-D\fP, or \fB\-k\fP options, \fBcvs\fP remembers the
891 corresponding tag, date, or \fIkflag\fP and continues using it on
892 future updates; use the \fB\-A\fP option to make \fBcvs\fP forget these
893 specifications, and retrieve the ``head'' version of the file).
894 Does not reset sticky
896 options on modified files.
900 option merges the changes made between the
901 resulting revision and the revision that it is based on (e.g., if
902 the tag refers to a branch,
904 will merge all changes made in that branch into your working file).
906 With two \fB-j\fP options,
908 will merge in the changes between the two respective revisions.
909 This can be used to ``remove'' a certain delta from your working file.
911 In addition, each \fB-j\fP option can contain on optional date
912 specification which, when used with branches, can limit the chosen
913 revision to one within a specific date.
914 An optional date is specified by adding a colon (:) to the tag.
915 An example might be what
917 tells you to do when you have
918 just imported sources that have conflicts with local changes:
923 example% cvs checkout -jTAG:yesterday -jTAG module
932 to avoid shortening module paths in your working directory. (Normally, \fBcvs\fP shortens paths as much as possible when you specify an explicit target directory.)
936 option to copy the module file, sorted, to the standard output,
937 instead of creating or modifying any files or directories in your
942 option to create a directory called
944 for the working files, instead of using the module name. Unless you
945 also use \fB\-N\fP, the paths created under \fIdir\fP will be as short
950 option to display per-module status information stored with
953 option within the modules file.
955 \fBcommit\fP [\fB\-lR\fP] [\fB\-m\fP '\fIlog_message\fP' | \fB\-F\fP \fIfile\fP] [\fB\-r\fP \fIrevision\fP] [\fIfiles.\|.\|.\fP]
957 working directory, repository.
967 when you want to incorporate changes from your working source
968 files into the general source repository.
970 If you don't specify particular \fIfiles\fP to commit, all
971 of the files in your working current directory are examined.
973 is careful to change in the repository only those files that you have
974 really changed. By default (or if you explicitly specify the
977 in subdirectories are also examined and committed if they have
978 changed; you can use the
982 to the current directory only.
983 Sometimes you may want to force a file to be committed even though it
984 is unchanged; this is achieved with the
986 flag, which also has the effect of disabling recursion (you can turn
992 verifies that the selected files are up to date with the current revisions
993 in the source repository; it will notify you, and exit without
994 committing, if any of the specified files must be made current first
1000 command for you, but rather leaves that for you to do when
1003 When all is well, an editor is invoked to allow you to enter a log
1004 message that will be written to one or more logging programs and placed in the
1005 source repository file.
1006 You can instead specify the log message on the command line with the
1008 option, thus suppressing the editor invocation, or use the
1010 option to specify that the argument \fIfile\fP contains the log message.
1014 option can be used to commit to a particular symbolic or numeric revision.
1015 For example, to bring all your files up to the
1016 revision ``3.0'' (including those that haven't changed), you might do:
1021 example% cvs commit -r3.0
1027 will only allow you to commit to a revision that is on the main trunk (a
1028 revision with a single dot).
1029 However, you can also commit to a branch revision (one that has an even
1030 number of dots) with the
1033 To create a branch revision, one typically use the
1039 .BR checkout " or " update
1040 can be used to base your sources on the newly created branch.
1041 From that point on, all
1043 changes made within these working sources will be automatically added
1044 to a branch revision, thereby not perturbing main-line development in any
1046 For example, if you had to create a patch to the 1.2 version of the
1047 product, even though the 2.0 version is already under development, you
1053 example% cvs rtag -b -rFCS1_2 FCS1_2_Patch product_module
1054 example% cvs checkout -rFCS1_2_Patch product_module
1055 example% cd product_module
1062 Say you have been working on some extremely experimental software, based on
1063 whatever revision you happened to checkout last week.
1064 If others in your group would like to work on this software with you, but
1065 without disturbing main-line development, you could commit your change to a
1067 Others can then checkout your experimental stuff and utilize the full
1070 conflict resolution.
1071 The scenario might look like:
1076 example% cvs tag -b EXPR1
1077 example% cvs update -rEXPR1
1084 Others would simply do
1085 .` "cvs checkout -rEXPR1 whatever_module"
1086 to work with you on the experimental change.
1088 \fBdiff\fP [\fB\-kl\fP] [\fIformat_options\fP] [[\fB\-r\fP \fIrev1\fP | \fB\-D\fP \fIdate1\fP | \fB\-j\fP \fIrev1:date1\fP] [\fB\-r\fP \fIrev2\fP | \fB\-D\fP \fIdate2\fP | \fB\-j\fP \fIrev2:date2\fP]] [\fIfiles.\|.\|.\fP]
1090 working directory, repository.
1095 You can compare your working files with revisions in the source
1096 repository, with the
1098 command. If you don't specify a particular revision, your files
1099 are compared with the revisions they were based on. You can also use
1104 to specify a particular revision to compare your files with. Finally,
1107 twice, you can see differences between two revisions in the
1109 You can also specify
1111 options to diff against a revision (on the head branch) in the past, and
1112 you can also specify
1114 options to diff against a revision relative to a branch tag in the past.
1121 options can be mixed together with at most two options ever specified.
1124 .` "cvs --help diff"
1125 for a list of supported
1126 .IR format_options .
1128 If you don't specify any files,
1130 will display differences for all those files in the current directory
1131 (and its subdirectories, unless you use the standard option
1134 differ from the corresponding revision in the source repository
1137 have changed), or that differ from the revision specified.
1139 \fBexport\fP [\-\fBf\|lNnQq\fP] \fB\-r\fP \fIrev\fP\||\|\fB\-D\fP \fIdate\fP [\fB\-d\fP \fIdir\fP] [\fB\-k\fP \fIkflag\fP] \fImodule\fP.\|.\|.
1146 This command is a variant of
1148 use it when you want a copy of the source for \fImodule\fP
1149 without the \fBcvs\fP administrative directories. For example, you
1152 to prepare source for shipment
1153 off-site. This command \fIrequires\fP that you specify a date or tag
1154 (with \fB\-D\fP or \fB\-r\fP), so that you can count on reproducing
1155 the source you ship to others.
1157 The only non-standard options are
1160 source into directory \fIdir\fP) and
1164 These have the same meanings as the same options in
1169 option is useful when
1173 keywords to be expanded such that an
1175 done at some other site will not lose the keyword revision information.
1176 Other \fIkflag\fPs may be used with
1178 and are described in
1181 \fBhistory\fP [\fB\-\fP\fIreport\fP] [\fB\-\fP\fIflags\fP] [\fB\-\fP\fIoptions args\fP] [\fIfiles\fP.\|.\|.]
1184 .` "$CVSROOT/CVSROOT/history"
1189 \fBcvs\fP keeps a history file that tracks each use of the
1190 \fBcheckout\fP, \fBcommit\fP, \fBrtag\fP, \fBupdate\fP, and \fBrelease\fP
1191 commands. You can use
1194 information in various formats.
1204 in ways that conflict with the
1207 COMMON COMMAND OPTIONS\c
1210 Several options (shown above as \fB\-\fP\fIreport\fP) control what
1211 kind of report is generated:
1214 Report on each time \fBcommit\fP was used (i.e., each time the
1215 repository was modified).
1217 \fB\ \ \ \ \ \ \-m\fP \fImodule\fP
1218 Report on a particular \fImodule\fP. (You can meaningfully use
1219 \fB\-m\fP more than once on the command line.)
1222 Report on checked-out modules.
1227 \fB\ \ \ \ \ \ \-x\fP \fItype\fP
1228 Extract a particular set of record types \fIX\fP from the \fBcvs\fP
1229 history. The types are indicated by single letters, which you may
1230 specify in combination.
1231 Certain commands have a single record type: \fBcheckout\fP (type `O'),
1232 \fBrelease\fP (type `F'), and \fBrtag\fP (type `T'). One of four
1233 record types may result from an \fBupdate\fP: `W', when the working copy
1234 of a file is deleted during update (because it was gone from the
1235 repository); `U', when a working file was copied from the
1236 repository; `G', when a merge was necessary and it succeeded; and 'C',
1237 when a merge was necessary but collisions were detected (requiring
1238 manual merging). Finally, one of three record types results from
1239 \fBcommit\fP: `M', when a file was modified; `A', when a file is first
1240 added; and `R', when a file is removed.
1243 Everything (all record types); equivalent to specifying
1246 \fB\ \ \ \ \ \ \-z\fP \fIzone\fP
1249 when outputting history records.
1252 stands for local time;
1253 numeric offsets stand for hours and minutes ahead of UTC.
1256 stands for 5 hours and 30 minutes ahead of (i.e. east of) UTC.
1259 The options shown as \fB\-\fP\fIflags\fP constrain the report without
1260 requiring option arguments:
1264 Show data for all users (the default is to show data only for the user
1269 Show last modification only.
1272 Show only the records for modifications done from the same working
1278 The options shown as \fB\-\fP\fIoptions args\fP constrain the report
1279 based on an argument:
1282 \fB\ \ \ \ \ \ \-b\fP \fIstr\fP
1283 Show data back to a record containing the string \fIstr\fP in either
1284 the module name, the file name, or the repository path.
1286 \fB\ \ \ \ \ \ \-D\fP \fIdate\fP
1287 Show data since \fIdate\fP.
1289 \fB\ \ \ \ \ \ \-p\fP \fIrepository\fP
1290 Show data for a particular source repository (you can specify several
1291 \fB\-p\fP options on the same command line).
1293 \fB\ \ \ \ \ \ \-r\fP \fIrev\fP
1294 Show records referring to revisions since the revision or tag
1295 named \fIrev\fP appears in individual RCS files.
1298 file is searched for the revision or tag.
1300 \fB\ \ \ \ \ \ \-t\fP \fItag\fP
1301 Show records since tag \fItag\fP was last added to the history file.
1302 This differs from the \fB-r\fP flag above in that it reads
1303 only the history file, not the
1305 files, and is much faster.
1307 \fB\ \ \ \ \ \ \-u\fP \fIname\fP
1308 Show records for user \fIname\fP.
1311 \fBimport\fP [\fB\-\fP\fIoptions\fP] \fIrepository vendortag releasetag\fP.\|.\|.
1313 Repository, source distribution directory.
1320 to incorporate an entire source
1321 distribution from an outside source (e.g., a source vendor) into your
1322 source repository directory. You can use this command both for
1323 initial creation of a repository, and for wholesale updates to the
1324 module form the outside source.
1326 The \fIrepository\fP argument gives a directory name (or a path to a
1327 directory) under the CVS root directory for repositories; if the
1328 directory did not exist, \fBimport\fP creates it.
1330 When you use \fBimport\fP for updates to source that has been modified in your
1331 source repository (since a prior \fBimport\fP), it
1332 will notify you of any files that conflict in the two branches of
1334 .` "cvs checkout -j"
1335 to reconcile the differences, as \fBimport\fP instructs you to do.
1337 By default, certain file names are ignored during
1339 names associated with
1341 administration, or with other common source control systems; common
1342 names for patch files, object files, archive files, and editor backup
1343 files; and other names that are usually artifacts of assorted utilities.
1344 For an up to date list of ignored file names, see the Cederqvist manual (as
1345 described in the SEE ALSO section of this manpage).
1347 The outside source is saved in a first-level
1350 Updates are leaves of this
1351 branch; for example, files from the first imported collection of
1352 source will be revision
1354 then files from the first
1355 imported update will be revision
1359 At least three arguments are required. \fIrepository\fP is needed to
1360 identify the collection of source. \fIvendortag\fP is a tag for the
1361 entire branch (e.g., for
1363 You must also specify at
1364 least one \fIreleasetag\fR to uniquely identify the files at
1365 the leaves created each time you execute
1368 \fIreleasetag\fR should be new, not previously existing in the
1369 repository file, and uniquely identify the imported release.
1373 command options is available: \fB\-m\fP
1374 \fImessage\fP. If you do not specify a logging message with
1375 \fB\-m\fP, your editor is invoked (as with \fBcommit\fP) to allow you
1378 There are three additional special options.
1382 to specify that each file's time of last modification should be used
1383 for the checkin date and time.
1386 .` "\-b \fIbranch\fP"
1387 to specify a first-level branch other
1393 to specify file names that should be
1394 ignored during \fBimport\fP. You can use this option repeatedly.
1395 To avoid ignoring any files at all (even those ignored by default),
1399 \fBlog\fP [\fB\-l\fP] \fIrlog-options [files\fP\|.\|.\|.]
1401 repository, working directory.
1409 Display log information for \fIfiles\fP.
1410 Among the more useful options are \fB\-h\fP
1411 to display only the header (including tag definitions, but omitting
1412 most of the full log); \fB\-r\fP to select logs on particular
1413 revisions or ranges of revisions; and \fB\-d\fP to select particular
1414 dates or date ranges. See
1416 for full explanations.
1417 This command is recursive by default, unless the
1419 option is specified.
1421 \fBrdiff\fP [\fB\-\fP\fIflags\fP] [\fB\-V\fP \fIvn\fP] [\fB\-r\fP \fIt\fP|\fB\-D\fP \fId\fP [\fB\-r\fP \fIt2\fP|\fB\-D\fP \fId2\fP]] \fImodules\|.\|.\|.\fP
1431 Builds a Larry Wall format
1433 file between two releases, that can be fed directly into the
1435 program to bring an old release up-to-date with the new release.
1436 (This is one of the few \fBcvs\fP commands that operates directly from
1437 the repository, and doesn't require a prior
1439 The diff output is sent to the standard output device.
1440 You can specify (using the standard \fB\-r\fP and \fB\-D\fP options)
1441 any combination of one or two revisions or dates.
1442 If only one revision or date is specified, the
1443 patch file reflects differences between that revision or date and the
1444 current ``head'' revisions in the
1448 Note that if the software release affected
1449 is contained in more than one directory, then it may be necessary to
1454 command when patching the old sources, so that
1456 is able to find the files that are located in other directories.
1458 The standard option \fIflags\fP \fB\-f\fP, and \fB\-l\fP
1459 are available with this command. There are also several
1460 special option flags:
1464 option, no patch output is produced.
1465 Instead, a summary of the changed or added files between the two
1466 releases is sent to the standard output device.
1467 This is useful for finding out, for example, which files have changed
1468 between two dates or revisions.
1472 option, a diff of the top two revisions is sent to the standard output device.
1473 This is most useful for seeing what the last change to a file was.
1477 option, the patch output uses the newer ``unidiff'' format for context
1482 to explicitly specify the
1484 form of context diffs
1485 (which is the default), if you like.
1487 \fBrelease\fP [\fB\-dQq\fP] \fImodules\fP\|.\|.\|.
1492 Working directory, history log.
1494 This command is meant to safely cancel the effect of
1498 doesn't lock files, it isn't strictly necessary to use this command.
1499 You can always simply delete your working directory, if you
1500 like; but you risk losing changes you may have forgotten, and you
1501 leave no trace in the
1503 history file that you've abandoned your checkout.
1507 to avoid these problems. This command
1508 checks that no un-committed changes are present; that you are
1509 executing it from immediately above, or inside, a \fBcvs\fP working
1510 directory; and that the repository recorded for your files is the same
1511 as the repository defined in the module database.
1513 If all these conditions are true,
1516 record of its execution (attesting to your intentionally abandoning
1517 your checkout) in the
1521 You can use the \fB\-d\fP flag to request that your working copies of
1522 the source files be deleted if the \fBrelease\fP succeeds.
1524 \fBremove\fP [\fB\-lR\fP] [\fIfiles\|.\|.\|.\fP]
1534 Use this command to declare that you wish to remove \fIfiles\fP from
1535 the source repository. Like most
1539 works on files in your working
1540 directory, not directly on the repository. As a safeguard, it also
1541 requires that you first erase the specified files from your working
1544 The files are not actually removed until you apply your changes to the
1547 at that point, the corresponding
1549 files in the source repository are
1553 directory (also within the source repository).
1555 This command is recursive by default, scheduling all physically removed
1556 files that it finds for removal by the next
1560 option to avoid this recursion, or just specify that actual files that you
1561 wish remove to consider.
1563 \fBrtag\fP [\fB\-f\|alnRQq\fP] [\fB\-b\fP] [\fB\-d\fP] [\fB\-r\fP \fItag\fP | \fB\-D\fP \fIdate\fP] \fIsymbolic_tag\fP \fImodules\|.\|.\|.\fP
1573 You can use this command to assign symbolic tags to particular,
1574 explicitly specified source versions in the repository.
1576 works directly on the repository contents (and requires no
1581 instead, to base the selection of
1582 versions to tag on the contents of your working directory.
1584 In general, tags (often the symbolic names of software distributions)
1585 should not be removed, but the
1587 option is available as a means to remove completely obsolete symbolic names
1588 if necessary (as might be the case for an Alpha release, say).
1591 will not move a tag that already exists. With the \fB\-F\fP option,
1594 will re-locate any instance of \fIsymbolic_tag\fP that already exists
1595 on that file to the new repository versions. Without the \fB\-F\fP
1596 option, attempting to use
1598 to apply a tag that already exists on that file will produce an error
1601 The \fB-b\fP option makes the tag a ``branch'' tag, allowing
1602 concurrent, isolated development.
1603 This is most useful for creating a patch to a previously released software
1606 You can use the standard \fB\-r\fP and \fB\-D\fP options to tag only those
1607 files that already contain a certain tag. This method would be used
1608 to rename a tag: tag only the files identified by the old tag, then delete the
1609 old tag, leaving the new tag on exactly the same files as the old tag.
1612 executes recursively by default, tagging all subdirectories of
1613 \fImodules\fP you specify in the argument. You can restrict its
1614 operation to top-level directories with the standard \fB\-l\fP option;
1615 or you can explicitly request recursion with \fB\-R\fP.
1617 The modules database can specify a program to execute whenever a tag
1618 is specified; a typical use is to send electronic mail to a group of
1619 interested parties. If you want to bypass that program, use the
1620 standard \fB\-n\fP option.
1628 for removed files that contain the specified tag.
1629 The tag is removed from these files, which makes it convenient to re-use a
1630 symbolic tag as development continues (and files get removed from the
1631 up-coming distribution).
1633 \fBstatus\fP [\fB\-lRqQ\fP] [\fB\-v\fP] [\fIfiles\fP\|.\|.\|.]
1635 working directory, repository.
1640 Display a brief report on the current status of \fIfiles\fP with
1641 respect to the source repository, including any ``sticky'' tags,
1642 dates, or \fB\-k\fP options. (``Sticky'' options will restrict how
1644 operates until you reset them; see the
1646 .` "cvs update \-A\|.\|.\|.".)
1648 You can also use this command to anticipate the potential impact of a
1650 on your working source directory. If you do
1651 not specify any \fIfiles\fP explicitly, reports are shown for all
1652 files that \fBcvs\fP has placed in your working directory. You can
1653 limit the scope of this search to the current directory itself (not
1654 its subdirectories) with the standard \fB\-l\fP option flag; or you
1655 can explicitly request recursive status reports with the \fB\-R\fP
1660 option causes the symbolic tags for the
1662 file to be displayed as well.
1664 \fBtag\fP [\fB\-lQqR\fP] [\fB\-F\fP] [\fB\-b\fP] [\fB\-d\fP] [\fB\-r\fP \fItag\fP | \fB\-D\fP \fIdate\fP] [\fB\-f\fP] \fIsymbolic_tag\fP [\fIfiles\fP\|.\|.\|.\|]
1666 working directory, repository.
1674 Use this command to assign symbolic tags to the nearest repository
1675 versions to your working sources. The tags are applied immediately to
1676 the repository, as with \fBrtag\fP.
1678 One potentially surprising aspect of the fact that \fBcvs tag\fP
1679 operates on the repository is that you are tagging the checked-in
1680 revisions, which may differ from locally modified files in your working
1681 directory. If you want to avoid doing this by mistake, specify the
1682 \fB-c\fP option to \fBcvs tag\fP. If there are any locally modified files, CVS
1683 will abort with an error before it tags any files.
1685 One use for tags is to record a ``snapshot'' of the current sources
1686 when the software freeze date of a project arrives. As bugs are fixed
1687 after the freeze date, only those changed sources that are to be part
1688 of the release need be re-tagged.
1690 The symbolic tags are meant to permanently record which revisions of which
1691 files were used in creating a software distribution.
1697 commands allow you to extract an exact copy of a tagged release at any time in
1698 the future, regardless of whether files have been changed, added, or removed
1699 since the release was tagged.
1701 You can use the standard \fB\-r\fP and \fB\-D\fP options to tag only those
1702 files that already contain a certain tag. This method would be used
1703 to rename a tag: tag only the files identified by the old tag, then delete the
1704 old tag, leaving the new tag on exactly the same files as the old tag.
1706 Specifying the \fB\-f\fP flag in addition to the \fB\-r\fP or \fB\-D\fP
1707 flags will tag those files named on the command line even if they do not
1708 contain the old tag or did not exist on the specified date.
1710 By default (without a \fB\-r\fP or \fB\-D\fP flag)
1711 the versions to be tagged are supplied
1712 implicitly by the \fBcvs\fP records of your working files' history
1713 rather than applied explicitly.
1716 .` "cvs tag \-d \fIsymbolic_tag\fP\|.\|.\|.",
1718 symbolic tag you specify is
1720 instead of being added. \fIWarning\fP: Be very certain of your ground
1721 before you delete a tag; doing this effectively discards some
1722 historical information, which may later turn out to have been valuable.
1725 will not move a tag that already exists. With the \fB\-F\fP option,
1728 will re-locate any instance of \fIsymbolic_tag\fP that already exists
1729 on that file to the new repository versions. Without the \fB\-F\fP
1730 option, attempting to use
1732 to apply a tag that already exists on that file will produce an error
1735 The \fB-b\fP option makes the tag a ``branch'' tag, allowing
1736 concurrent, isolated development.
1737 This is most useful for creating a patch to a previously released software
1742 executes recursively through subdirectories; you can prevent this by
1743 using the standard \fB\-l\fP option, or specify the recursion
1744 explicitly by using \fB\-R\fP.
1746 \fBupdate\fP [\fB\-ACdf\|lPpQqR\fP] [\fB\-d\fP] [\fB\-r\fP \fItag\fP|\fB\-D\fP \fIdate\fP] \fIfiles\|.\|.\|.\fP
1748 repository, working directory.
1755 to create your private copy of source from the common repository,
1756 other developers will continue changing the central source. From time
1757 to time, when it is convenient in your development process, you can
1761 from within your working directory to reconcile your work with any
1762 revisions applied to the source repository since your last
1768 keeps you informed of its progress by printing a line for each file,
1769 prefaced with one of the characters
1771 to indicate the status of the file:
1774 The file was brought \fIup to date\fP with respect to the repository.
1775 This is done for any file that exists in the repository but not in your
1776 working directory, and for files that you haven't changed but are not the most
1777 recent versions available in the repository.
1780 Like \fBU\fP, but the CVS server sends a patch instead of an entire file.
1781 This accomplishes the same thing as \fBU\fP using less bandwidth.
1784 The file has been \fIadded\fP to your private copy of the sources, and
1785 will be added to the
1786 source repository when you run
1789 This is a reminder to you that the file needs to be committed.
1792 The file has been \fIremoved\fP from your private copy of the sources, and
1793 will be removed from the
1794 source repository when you run
1797 This is a reminder to you that the file needs to be committed.
1800 The file is \fImodified\fP in your working directory.
1802 can indicate one of two states for a file you're working on: either
1803 there were no modifications to the same file in the repository, so
1804 that your file remains as you last saw it; or there were modifications
1805 in the repository as well as in your copy, but they were
1806 \fImerged\fP successfully, without conflict, in your working
1810 A \fIconflict\fP was detected while trying to merge your changes to
1811 \fIfile\fP with changes from the source repository. \fIfile\fP (the
1812 copy in your working directory) is now the result of merging
1813 the two versions; an unmodified copy of your file is also
1814 in your working directory, with the name `\fB.#\fP\fIfile\fP\fB.\fP\fIversion\fP',
1818 revision that your modified file started from.
1819 (Note that some systems automatically purge files that begin with
1822 if they have not been accessed for a few days.
1823 If you intend to keep a copy of your original file, it is a very good
1827 \fIfile\fP is in your working directory, but does not correspond to
1828 anything in the source repository, and is not in the list of files
1829 for \fBcvs\fP to ignore (see the description of the \fB\-I\fP option).
1835 option to reset any sticky tags, dates, or
1837 options. (If you get a working copy of a file by using one of the
1838 \fB\-r\fP, \fB\-D\fP, or \fB\-k\fP options, \fBcvs\fP remembers the
1839 corresponding tag, date, or \fIkflag\fP and continues using it on
1840 future updates; use the \fB\-A\fP option to make \fBcvs\fP forget these
1841 specifications, and retrieve the ``head'' version of the file).
1843 The \fB\-j\fP\fIbranch\fP option
1844 merges the changes made between the
1845 resulting revision and the revision that it is based on (e.g., if
1846 the tag refers to a branch,
1848 will merge all changes made in
1849 that branch into your working file).
1851 With two \fB-j\fP options,
1853 will merge in the changes between the two respective revisions.
1854 This can be used to ``remove'' a certain delta from your working file.
1855 E.g., If the file foo.c is based on
1856 revision 1.6 and I want to remove the changes made between 1.3 and
1862 example% cvs update -j1.5 -j1.3 foo.c # note the order...
1867 In addition, each \fB-j\fP option can contain on optional date
1868 specification which, when used with branches, can limit the chosen
1869 revision to one within a specific date.
1870 An optional date is specified by adding a colon (:) to the tag.
1875 -jSymbolic_Tag:Date_Specifier
1882 option to create any directories that exist in the repository if they're
1883 missing from the working directory. (Normally, update acts only on
1884 directories and files that were already enrolled in your
1885 working directory.) This is useful for updating directories
1886 that were created in the repository since the initial
1887 \fBcheckout\fP; but it has an unfortunate side effect. If you
1888 deliberately avoided certain directories in the repository when you
1889 created your working directory (either through use of a module name or by
1890 listing explicitly the files and directories you wanted on the
1891 command line), then updating with
1893 will create those directories, which may not be what you want.
1895 Use \fB\-I\fP \fIname\fP to ignore files whose names match \fIname\fP
1896 (in your working directory) during the update. You can specify
1897 \fB\-I\fP more than once on the command line to specify several files
1898 to ignore. By default,
1899 \fBupdate\fP ignores files whose names match certain patterns; for
1900 an up to date list of ignored file names, see the Cederqvist manual (as
1901 described in the SEE ALSO section of this manpage).
1905 to avoid ignoring any files at all.
1909 option to overwrite locally modified files with clean copies from
1910 the repository (the modified file is saved in
1911 `\fB.#\fP\fIfile\fP\fB.\fP\fIrevision\fP', however).
1913 The standard \fBcvs\fP command options \fB\-f\fP, \fB\-k\fP,
1914 \fB\-l\fP, \fB\-P\fP, \fB\-p\fP, and \fB\-r\fP
1915 are also available with \fBupdate\fP.
1918 For more detailed information on
1920 supporting files, see
1924 Files in home directories:
1929 initialization file. Lines in this file can be used to specify default
1932 command. For example the line
1936 is always passed the
1938 option in addition to any other options passed on the command line.
1941 Specifies wrappers to be used in addition to those specified in the
1942 CVSROOT/cvswrappers file in the repository.
1945 Files in working directories:
1948 A directory of \fBcvs\fP administrative files.
1953 List and status of files in your working directory.
1960 Flag: do not add more entries on
1964 Pathname to the repository (
1966 ) location at the time of checkout. This file is used instead
1969 environment variable if the environment variable is not
1970 set. A warning message will be issued when the contents of this
1973 environment variable differ. The file may be over-ridden by the
1975 .SM CVS_IGNORE_REMOTE_ROOT
1976 environment variable.
1979 Pathname to the corresponding directory in the source repository.
1982 Contains the per-directory ``sticky'' tag or date information.
1983 This file is created/updated when you specify
1991 commands, and no files are specified.
1994 Name of program to run on
1998 Name of program to run on
2002 Files in source repositories:
2005 Directory of global administrative files for repository.
2007 CVSROOT/commitinfo,v
2008 Records programs for filtering
2012 CVSROOT/cvswrappers,v
2015 wrapper commands to be used when checking files into and out of the
2016 repository. Wrappers allow the file or directory to be processed
2017 on the way in and out of CVS. The intended uses are many, one
2018 possible use would be to reformat a C file before the file is checked
2019 in, so all of the code in the repository looks the same.
2022 Records programs for editing/validating
2027 Log file of \fBcvs\fP transactions.
2030 Records programs for piping
2035 Definitions for modules in this repository.
2038 Records pathnames to templates used during a
2043 Records programs for validating/logging
2050 Directory for removed source files.
2053 A lock directory created by
2055 when doing sensitive changes to the
2059 Temporary lock file for repository.
2069 Should contain the full pathname to the root of the
2071 source repository (where the
2073 files are kept). This information must be available to \fBcvs\fP for
2074 most commands to execute; if
2076 is not set, or if you wish to override it for one invocation, you can
2077 supply it on the command line:
2078 .` "cvs \-d \fIcvsroot cvs_command\fP\|.\|.\|."
2079 You may not need to set
2081 if your \fBcvs\fP binary has the right path compiled in.
2088 will try hard to make the files in your working directory read-only.
2089 When this is not set, the default behavior is to permit modification
2090 of your working files.
2095 option is assumed, and
2097 operates in read-only repository mode.
2100 Specifies the full pathname where to find
2106 (CVS 1.9 and older).
2109 Specifies the program to use for recording log messages during
2115 environment variables are tried (in that order).
2116 If neither is set, a system-dependent default editor (e.g.,
2121 If this variable is set then
2123 will use this port in
2125 rather than the default port (cvspserver 2401).
2127 .SM CVS_IGNORE_REMOTE_ROOT
2128 If this variable is set then
2130 will ignore all references to remote repositories in the CVS/Root file.
2133 Specifies a set of default options for
2135 These options are interpreted before the startup file (\fI~/.cvsrc\fP) is read
2136 and can be overridden by explicit command line parameters.
2140 uses the contents of this variable to determine the name of the
2141 remote shell command to use when starting a
2143 server. If this variable is not set then
2149 uses the contents of this variable to determine the name of the
2151 server command. If this variable is not set then
2156 This variable is used by the
2158 script to determine the name of the wrapper file, in addition to the
2159 wrappers defaults contained in the repository
2160 .SM (CVSROOT/cvswrappers)
2161 and the user's home directory (~/.cvswrappers).
2165 Original author of the
2167 shell script version posted to
2168 .B comp.sources.unix
2169 in the volume6 release of December, 1986.
2170 Credited with much of the
2172 conflict resolution algorithms.
2175 Coder and designer of the
2177 program itself in April, 1989, based on the original work done by Dick.
2180 Helped Brian with the design of the
2182 module and vendor branch support and author of the
2184 shell script (the ancestor of
2187 And many others too numerous to mention here.
2189 The most comprehensive manual for CVS is
2190 Version Management with CVS by Per Cederqvist et al. Depending on
2191 your system, you may be able to get it with the
2193 command or it may be available as cvs.ps (postscript), cvs.texinfo
2194 (texinfo source), or cvs.html.
2196 For CVS updates, more information on documentation, software related
2197 to CVS, development of CVS, and more, see:
2199 .B http://cvs.nongnu.org
projects / FreeBSD / releng / 9.2.git / blob