Home
Main website
Display Sidebar
Hide Ads
Recent Changes
View Source:
cvs(1)
Edit
PageHistory
Diff
Info
LikePages
CVS !!!CVS NAME SYNOPSIS NOTE DESCRIPTION ESSENTIAL COMMANDS OPTIONS CVS OPTIONS USAGE CVS STARTUP FILE CVS COMMAND SUMMARY COMMON COMMAND OPTIONS CVS COMMANDS FILES ENVIRONMENT VARIABLES AUTHORS SEE ALSO ---- !!NAME cvs - Concurrent Versions System !!SYNOPSIS __cvs__ [[ ''cvs_options'' ] ''cvs_command'' [[ ''command_options'' ] [[ ''command_args'' ] !!NOTE This manpage is a summary of some of the features of __cvs__ but for more in-depth documentation, consult the Cederqvist manual (as described in the SEE ALSO section of this manpage). !!DESCRIPTION CVS is a version control system, which allows you to keep old versions of files (usually source code), keep a log of who, when, and why changes occurred, etc., like RCS or SCCS. Unlike the simpler systems, CVS does not just operate on one file at a time or one directory at a time, but operates on hierarchical collections of directories consisting of version controlled files. CVS helps to manage releases and to control the concurrent editing of source files among multiple authors. CVS allows triggers to enable/log/control various operations and works well over a wide area network. __cvs__ keeps a single copy of the master sources. This copy is called the source ``repository''; it contains all the information to permit extracting previous software releases at any time based on either a symbolic revision tag, or a date in the past. !!ESSENTIAL COMMANDS __cvs__ provides a rich variety of commands (''cvs_command'' in the Synopsis), each of which often has a wealth of options, to satisfy the many needs of source management in distributed environments. However, you don't have to master every detail to do useful work with __cvs__; in fact, five commands are sufficient to use (and contribute to) the source repository. __cvs checkout__ ''modules''... A necessary preliminary for most __cvs__ work: creates your private copy of the source for ''modules'' (named collections of source; you can also use a path relative to the source repository here). You can work with this copy without interfering with others' work. At least one subdirectory level is always created. __cvs update__ Execute this command from ''within'' your private source directory when you wish to update your copies of source files from changes that other developers have made to the source in the repository. __cvs add__ ''file''... Use this command to enroll new files in __cvs__ records of your working directory. The files will be added to the repository the next time you run `__cvs commit__'. Note: You should use the `__cvs import__' command to bootstrap new sources into the source repository. `__cvs add__' is only used for new files to an already checked-out module. __cvs remove__ ''file''... Use this command (after erasing any files listed) to declare that you wish to eliminate files from the repository. The removal does not affect others until you run `__cvs commit__'. __cvs commit__ ''file''... Use this command when you wish to ``publish'' your changes to other developers, by incorporating them in the source repository. !!OPTIONS The __cvs__ command line can include ''cvs_options'', which apply to the overall __cvs__ program; a ''cvs_command'', which specifies a particular action on the source repository; and ''command_options'' and ''command_arguments'' to fully specify what the ''cvs_command'' will do. ''Warning:'' you must be careful of precisely where you place options relative to the ''cvs_command''. The same option can mean different things depending on whether it is in the ''cvs_options'' position (to the left of a __cvs__ command) or in the ''command_options'' position (to the right of a __cvs__ command). There are only two situations where you may omit ''cvs_command'': `__cvs -H__' or `__cvs --help__' elicits a list of available commands, and `__cvs -v__' or `__cvs --version__' displays version information on __cvs__ itself. !!CVS OPTIONS As of release 1.6, __cvs__ supports GNU style long options as well as short options. Only a few long options are currently supported, these are listed in brackets after the short options whose functions they duplicate. Use these options to control the overall __cvs__ program: __-H [[ --help ]__ Display usage information about the specified ''cvs_command'' (but do not actually execute the command). If you don't specify a command name, `__cvs -H__' displays a summary of all the commands available. __-Q__ Causes the command to be ''really'' quiet; the command will generate output only for serious problems. __-q__ Causes the command to be somewhat quiet; informational messages, such as reports of recursion through subdirectories, are suppressed. __-b__ ''bindir'' Use ''bindir'' as the directory where RCS programs are located (CVS 1.9 and older). Overrides the setting of the RCSBIN environment variable. This value should be specified as an absolute pathname. __-d__ ''CVS_root_directory'' Use ''CVS_root_directory'' as the root directory pathname of the master source repository. Overrides the setting of the CVSROOT environment variable. This value should be specified as an absolute pathname. __-e__ ''editor'' Use ''editor'' to enter revision log information. Overrides the setting of the CVSEDITOR , VISUAL , and EDITOR environment variables. __-f__ Do not read the __cvs__ startup file (''~/.cvsrc''). __-l__ Do not log the ''cvs_command'' in the command history (but execute it anyway). See the description of the __history__ command for information on command history. __-n__ Do not change any files. Attempt to execute the ''cvs_command'', but only to issue reports; do not remove, update, or merge any existing files, or create any new files. __-t__ Trace program execution; display messages showing the steps of __cvs__ activity. Particularly useful with __-n__ to explore the potential impact of an unfamiliar command. __-r__ Makes new working files read-only. Same effect as if the CVSREAD environment variable is set. __-v [[ --version ]__ Displays version and copyright information for __cvs__. __-w__ Makes new working files read-write (default). Overrides the setting of the CVSREAD environment variable. __-x__ Encrypt all communication between the client and the server. As of this writing, this is only implemented when using a Kerberos connection. __-z__ ''compression-level'' When transferring files across the network use __gzip__ with compression level ''compression-level'' to compress and de-compress data as it is transferred. Requires the presence of the GNU __gzip__ program in the current search path at both ends of the link. !!USAGE Except when requesting general help with `__cvs -H__', you must specify a ''cvs_command'' to __cvs__ to select a specific release control function to perform. Each __cvs__ command accepts its own collection of options and arguments. However, many options are available across several commands. You can display a usage summary for each command by specifying the __-H__ option with the command. !!CVS STARTUP FILE Normally, when CVS starts up, it reads the ''.cvsrc'' file from the home directory of the user reading it. This startup procedure can be turned off with the __-f__ flag. The ''.cvsrc'' file lists CVS commands with a list of arguments, one command per line. For example, the following line in ''.cvsrc'': diff -c will mean that the `__cvs diff__' command will always be passed the -c option in addition to any other options that are specified in the command line (in this case it will have the effect of producing context sensitive diffs for all executions of `__cvs diff__' ). !!CVS COMMAND SUMMARY Here are brief descriptions of all the __cvs__ commands: __add__ Add a new file or directory to the repository, pending a `__cvs commit__' on the same file. Can only be done from within sources created by a previous `__cvs checkout__' invocation. Use `__cvs import__' to place whole new hierarchies of sources under __cvs__ control. (Does not directly affect repository; changes working directory.) __admin__ Execute control functions on the source repository. (Changes repository directly; uses working directory without changing it.) __checkout__ Make a working directory of source files for editing. (Creates or changes working directory.) __commit__ Apply to the source repository changes, additions, and deletions from your working directory. (Changes repository.) __diff__ Show differences between files in working directory and source repository, or between two revisions in source repository. (Does not change either repository or working directory.) __export__ Prepare copies of a set of source files for shipment off site. Differs from `__cvs checkout__' in that no __cvs__ administrative directories are created (and therefore `__cvs commit__' cannot be executed from a directory prepared with `__cvs export__'), and a symbolic tag must be specified. (Does not change repository; creates directory similar to working directories). __history__ Show reports on __cvs__ commands that you or others have executed on a particular file or directory in the source repository. (Does not change repository or working directory.) History logs are kept only if enabled by creation of the `__$CVSROOT/CVSROOT/history__' file; see __cvs__(__5__). __import__ Incorporate a set of updates from off-site into the source repository, as a ``vendor branch''. (Changes repository.) __init__ Initialize a repository by adding the CVSROOT subdirectory and some default control files. You must use this command or initialize the repository in some other way before you can use it. __log__ Display log information. (Does not change repository or working directory.) __rdiff__ Prepare a collection of diffs as a patch file between two releases in the repository. (Does not change repository or working directory.) __release__ Cancel a `__cvs checkout__', abandoning any changes. (Can delete working directory; no effect on repository.) __remove__ Remove files from the source repository, pending a `__cvs commit__' on the same files. (Does not directly affect repository; changes working directory.) __rtag__ Explicitly specify a symbolic tag for particular revisions of files in the source repository. See also `__cvs tag__'. (Changes repository directly; does not require or affect working directory.) __status__ Show current status of files: latest version, version in working directory, whether working version has been edited and, optionally, symbolic tags in the RCS file. (Does not change repository or working directory.) __tag__ Specify a symbolic tag for files in the repository. By default, tags the revisions that were last synchronized with your working directory. (Changes repository directly; uses working directory without changing it.) __update__ Bring your working directory up to date with changes from the repository. Merges are performed automatically when possible; a warning is issued if manual resolution is required for conflicting changes. (Changes working directory; does not change repository.) !!COMMON COMMAND OPTIONS This section describes the ''command_options'' that are available across several __cvs__ commands. Not all commands support all of these options; each option is only supported for commands where it makes sense. However, when a command has one of these options you can count on the same meaning for the option as in other commands. (Other command options, which are listed with the individual commands, may have different meanings from one __cvs__ command to another.) ''Warning:'' the __history__ command is an exception; it supports many options that conflict even with these standard options. __-D__ ''date_spec'' Use the most recent revision no later than ''date_spec'' (a single argument, date description specifying a date in the past). A wide variety of date formats are supported, in particular ISO ( ''date_spec'' is interpreted as being in the local timezone, unless a specific timezone is specified. The specification is ``sticky'' when you use it to make a private copy of a source file; that is, when you get a working file using __-D__, __cvs__ records the date you specified, so that further updates in the same directory will use the same date (unless you explicitly override it; see the description of the __update__ command). __-D__ is available with the __checkout__, __diff__, __history__, __export__, __rdiff__, __rtag__, and __update__ commands. Examples of valid date specifications include: __1 month ago 2 hours ago 400000 seconds ago last year last Monday yesterday a fortnight ago 3/31/92 10:00:07 PST January 23, 1987 10:05pm 22:00 GMT __ __-f__ When you specify a particular date or tag to __cvs__ commands, they normally ignore files that do not contain the tag (or did not exist on the date) that you specified. Use the __-f__ option if you want files retrieved even when there is no match for the tag or date. (The most recent version is used in this situation.) __-f__ is available with these commands: __checkout__, __export__, __rdiff__, __rtag__, and __update__. __-k__ ''kflag'' Alter the default processing of keywords. The __-k__ option is available with the __add__, __checkout__, __diff__, __export__, __rdiff__, and __update__ commands. Your ''kflag'' specification is ``sticky'' when you use it to create a private copy of a source file; that is, when you use this option with the __checkout__ or __update__ commands, __cvs__ associates your selected ''kflag'' with the file, and continues to use it with future __update__ commands on the same file until you specify otherwise. Some of the more useful ''kflag''s are -ko and -kb (for binary files), and -kv which is useful for an __export__ where you wish to retain keyword information after an __import__ at some other site. __-l__ Local; run only in current working directory, rather than recurring through subdirectories. Available with the following commands: __checkout__, __commit__, __diff__, __export__, __remove__, __rdiff__, __rtag__, __status__, __tag__, and __update__. ''Warning:'' this is not the same as the overall `__cvs -l__' option, which you can specify to the ''left'' of a __cvs__ command! __-n__ Do ''not'' run any __checkout__/__commit__/__tag__/__update__ program. (A program can be specified to run on each of these activities, in the modules database; this option bypasses it.) Available with the __checkout__, __commit__, __export__, and __rtag__ commands. ''Warning:'' this is not the same as the overall `__cvs -n__' option, which you can specify to the ''left'' of a __cvs__ command! __-P__ Prune (remove) directories that are empty after being updated, on __checkout__, or __update__. Normally, an empty directory (one that is void of revision-controlled files) is left alone. Specifying __-P__ will cause these directories to be silently removed from your checked-out sources. This does not remove the directory from the repository, only from your checked out copy. Note that this option is implied by the __-r__ or __-D__ options of __checkout__ and __export__. __-p__ Pipe the files retrieved from the repository to standard output, rather than writing them in the current directory. Available with the __checkout__ and __update__ commands. __-r__ ''tag'' Use the revision specified by the ''tag'' argument instead of the default ``head'' revision. As well as arbitrary tags defined with the __tag__ or __rtag__ command, two special tags are always available: `__HEAD__' refers to the most recent version available in the repository, and `__BASE__' refers to the revision you last checked out into the current working directory. The ''tag'' specification is ``sticky'' when you use this option with `__cvs checkout__' or `__cvs update__' to make your own copy of a file: __cvs__ remembers the ''tag'' and continues to use it on future __update__ commands, until you specify otherwise. ''tag'' can be either a symbolic or numeric tag. Specifying the __-q__ global option along with the __-r__ command option is often useful, to suppress the warning messages when the RCS file does not contain the specified tag. __-r__ is available with the __checkout__, __commit__, __diff__, __history__, __export__, __rdiff__, __rtag__, and __update__ commands. ''Warning:'' this is not the same as the overall `__cvs -r__' option, which you can specify to the ''left'' of a __cvs__ command! !!CVS COMMANDS Here (finally) are details on all the __cvs__ commands and the options each accepts. The summary lines at the top of each command's description highlight three kinds of things: Command Options and Arguments Special options are described in detail below; common command options may appear only in the summary line. Working Directory, or Repository? Some __cvs__ commands require a working directory to operate; some require a repository. Also, some commands ''change'' the repository, some change the working directory, and some change nothing. Synonyms Many commands have synonyms, which you may find easier to remember (or type) than the principal name. __add__ [[__-k__ ''kflag''] [[__-m '__''message''__'__] ''files...'' ''Requires:'' repository, working directory.'' Changes:'' working directory.'' Synonym:'' __new__ Use the __add__ command to create a new file or directory in the source repository. The files or directories specified with __add__ must already exist in the current directory (which must have been created with the __checkout__ command). To add a whole new directory hierarchy to the source repository (for example, files received from a third-party vendor), use the `__cvs import__' command instead. If the argument to `__cvs add__' refers to an immediate sub-directory, the directory is created at the correct place in the source repository, and the necessary __cvs__ administration files are created in your working directory. If the directory already exists in the source repository, `__cvs add__' still creates the administration files in your version of the directory. This allows you to use `__cvs add__' to add a particular directory to your private sources even if someone else created that directory after your __checkout__ of the sources. You can do the following: __example% mkdir new_directory example% cvs add new_directory example% cvs update new_directory __ An alternate approach using `__cvs update__' might be: __example% cvs update -d new_directory __ (To add ''any available'' new directories to your working directory, it's probably simpler to use `__cvs checkout__' or `__cvs update -d__'.) The added files are not placed in the source repository until you use `__cvs commit__' to make the change permanent. Doing a `__cvs add__' on a file that was removed with the `__cvs remove__' command will resurrect the file, if no `__cvs commit__' command intervened. You will have the opportunity to specify a logging message, as usual, when you use `__cvs commit__' to make the new file permanent. If you'd like to have another logging message associated with just ''creation'' of the file (for example, to describe the file's purpose), you can specify it with the `__-m__ ''message''' option to the __add__ command. The `__-k kflag__' option specifies the default way that this file will be checked out. The `__kflag__' argument is stored in the RCS file and can be changed with `__cvs admin__'. Specifying `__-ko__' is useful for checking in binaries that shouldn't have keywords expanded. __admin__ [[''rcs-options''] ''files...'' ''Requires:'' repository, working directory.'' Changes:'' repository.'' Synonym:'' __rcs__ This is the __cvs__ interface to assorted administrative facilities, similar to __rcs__(__1__). This command works recursively, so extreme care should be used. __checkout__ [[__options__] ''modules''... ''Requires:'' repository.'' Changes:'' working directory.'' Synonyms:'' __co__, __get__ Make a working directory containing copies of the source files specified by ''modules''. You must execute `__cvs checkout__' before using most of the other __cvs__ commands, since most of them operate on your working directory. ''modules'' are either symbolic names (themselves defined as the module `__modules__' in the source repository; see __cvs__(__5__)) for some collection of source directories and files, or paths to directories or files in the repository. Depending on the ''modules'' you specify, __checkout__ may recursively create directories and populate them with the appropriate source files. You can then edit these source files at any time (regardless of whether other software developers are editing their own copies of the sources); update them to include new changes applied by others to the source repository; or commit your work as a permanent change to the repository. Note that __checkout__ is used to create directories. The top-level directory created is always added to the directory where __checkout__ is invoked, and usually has the same name as the specified ''module''. In the case of a ''module'' alias, the created sub-directory may have a different name, but you can be sure that it will be a sub-directory, and that __checkout__ will show the relative path leading to each file as it is extracted into your private work area (unless you specify the __-Q__ global option). Running `__cvs checkout__' on a directory that was already built by a prior __checkout__ is also permitted, and has the same effect as specifying the __-d__ option to the __update__ command described below. The ''options'' permitted with `__cvs checkout__' include the standard command options __-P__, __-f__, __-k__ ''kflag'' , __-l__, __-n__, __-p__, __-r__ ''tag'', and __-D__ ''date''. In addition to those, you can use these special command options with __checkout__: Use the __-A__ option to reset any sticky tags, dates, or __-k__ options. (If you get a working file using one of the __-r__, __-D__, or __-k__ options, __cvs__ remembers the corresponding tag, date, or ''kflag'' and continues using it on future updates; use the __-A__ option to make __cvs__ forget these specifications, and retrieve the ``head'' version of the file). The __-j__ ''branch'' option merges the changes made between the resulting revision and the revision that it is based on (e.g., if the tag refers to a branch, __cvs__ will merge all changes made in that branch into your working file). With two __-j__ options, __cvs__ will merge in the changes between the two respective revisions. This can be used to ``remove'' a certain delta from your working file. In addition, each __-j__ option can contain on optional date specification which, when used with branches, can limit the chosen revision to one within a specific date. An optional date is specified by adding a colon (:) to the tag. An example might be what `__cvs import__' tells you to do when you have just imported sources that have conflicts with local changes: __example% cvs checkout -jTAG:yesterday -jTAG module __ Use the __-N__ option with `__-d__ ''dir''' to avoid shortening module paths in your working directory. (Normally, __cvs__ shortens paths as much as possible when you specify an explicit target directory.) Use the __-c__ option to copy the module file, sorted, to the standard output, instead of creating or modifying any files or directories in your working directory. Use the __-d__ ''dir'' option to create a directory called ''dir'' for the working files, instead of using the module name. Unless you also use __-N__, the paths created under ''dir'' will be as short as possible. Use the __-s__ option to display per-module status information stored with the __-s__ option within the modules file. __commit__ [[__-lnR__] [[__-m__ '''log_message''' | __-f__ ''file''] [[__-r__ ''revision''] [[''files...''] ''Requires:'' working directory, repository.'' Changes:'' repository.'' Synonym:'' __ci__ Use `__cvs commit__' when you want to incorporate changes from your working source files into the general source repository. If you don't specify particular ''files'' to commit, all of the files in your working current directory are examined. __commit__ is careful to change in the repository only those files that you have really changed. By default (or if you explicitly specify the __-R__ option), files in subdirectories are also examined and committed if they have changed; you can use the __-l__ option to limit __commit__ to the current directory only. Sometimes you may want to force a file to be committed even though it is unchanged; this is achieved with the __-f__ flag, which also has the effect of disabling recursion (you can turn it back on with __-R__ of course). __commit__ verifies that the selected files are up to date with the current revisions in the source repository; it will notify you, and exit without committing, if any of the specified files must be made current first with `__cvs update__'. __commit__ does not call the __update__ command for you, but rather leaves that for you to do when the time is right. When all is well, an editor is invoked to allow you to enter a log message that will be written to one or more logging programs and placed in the source repository file. You can instead specify the log message on the command line with the __-m__ option, thus suppressing the editor invocation, or use the __-F__ option to specify that the argument ''file'' contains the log message. The __-r__ option can be used to commit to a particular symbolic or numeric revision. For example, to bring all your files up to the revision ``3.0'' (including those that haven't changed), you might do: __example% cvs commit -r3.0 __ __cvs__ will only allow you to commit to a revision that is on the main trunk (a revision with a single dot). However, you can also commit to a branch revision (one that has an even number of dots) with the __-r__ option. To create a branch revision, one typically use the __-b__ option of the __rtag__ or __tag__ commands. Then, either __checkout__ or __update__ can be used to base your sources on the newly created branch. From that point on, all __commit__ changes made within these working sources will be automatically added to a branch revision, thereby not perturbing main-line development in any way. For example, if you had to create a patch to the 1.2 version of the product, even though the 2.0 version is already under development, you might do: __example% cvs rtag -b -rFCS1_2 FCS1_2_Patch product_module example% cvs checkout -rFCS1_2_Patch product_module example% cd product_module [[[[ hack away ]] example% cvs commit __ Say you have been working on some extremely experimental software, based on whatever revision you happened to checkout last week. If others in your group would like to work on this software with you, but without disturbing main-line development, you could commit your change to a new branch. Others can then checkout your experimental stuff and utilize the full benefit of __cvs__ conflict resolution. The scenario might look like: __example% cvs tag -b EXPR1 example% cvs update -rEXPR1 [[[[ hack away ]] example% cvs commit __ Others would simply do `__cvs checkout -rEXPR1 whatever_module__' to work with you on the experimental change. __diff__ [[__-kl__] [[''rcsdiff_options''] [[[[__-r__ ''rev1'' | __-D__ ''date1''] [[__-r__ ''rev2'' | __-D__ ''date2'']] [[''files...''] ''Requires:'' working directory, repository.'' Changes:'' nothing. You can compare your working files with revisions in the source repository, with the `__cvs diff__' command. If you don't specify a particular revision, your files are compared with the revisions they were based on. You can also use the standard __cvs__ command option __-r__ to specify a particular revision to compare your files with. Finally, if you use __-r__ twice, you can see differences between two revisions in the repository. You can also specify __-D__ options to diff against a revision in the past. The __-r__ and __-D__ options can be mixed together with at most two options ever specified. See __rcsdiff__(__1__) for a list of other accepted options. If you don't specify any files, __diff__ will display differences for all those files in the current directory (and its subdirectories, unless you use the standard option __-l__) that differ from the corresponding revision in the source repository (i.e. files that ''you'' have changed), or that differ from the revision specified. __export__ [[-__flNnQq__] __-r__ ''rev''|__-D__ ''date'' [[__-d__ ''dir''] [[__-k__ ''kflag''] ''module''... ''Requires:'' repository.'' Changes:'' current directory. This command is a variant of `__cvs checkout__'; use it when you want a copy of the source for ''module'' without the __cvs__ administrative directories. For example, you might use `__cvs export__' to prepare source for shipment off-site. This command ''requires'' that you specify a date or tag (with __-D__ or __-r__), so that you can count on reproducing the source you ship to others. The only non-standard options are `__-d__ ''dir''' (write the source into directory ''dir'') and `__-N__' (don't shorten module paths). These have the same meanings as the same options in `__cvs checkout__'. The __-kv__ option is useful when __export__ is used. This causes any keywords to be expanded such that an __import__ done at some other site will not lose the keyword revision information. Other ''kflag''s may be used with `__cvs export__' and are described in __co__(__1__). __history__ [[__-__''report''] [[__-__''flags''] [[__-__''options args''] [[''files''...] ''Requires:'' the file `__$CVSROOT/CVSROOT/history__''' Changes:'' nothing.__ cvs__ keeps a history file that tracks each use of the __checkout__, __commit__, __rtag__, __update__, and __release__ commands. You can use `__cvs history__' to display this information in various formats. ''Warning:'' `__cvs history__' uses `__-f__', `__-l__', `__-n__', and `__-p__' in ways that conflict with the descriptions in COMMON COMMAND OPTIONS . Several options (shown above as __-__''report'') control what kind of report is generated: __-c__ Report on each time __commit__ was used (i.e., each time the repository was modified). __-m__ ''module'' Report on a particular ''module''. (You can meaningfully use __-m__ more than once on the command line.) __-o__ Report on checked-out modules. __-T__ Report on all tags. __-x__ ''type'' Extract a particular set of record types ''X'' from the __cvs__ history. The types are indicated by single letters, which you may specify in combination. Certain commands have a single record type: __checkout__ (type `O'), __release__ (type `F'), and __rtag__ (type `T'). One of four record types may result from an __update__: `W', when the working copy of a file is deleted during update (because it was gone from the repository); `U', when a working file was copied from the repository; `P', like `U', but the CVS server sent a patch instead of the whole file; `G', when a merge was necessary and it succeeded; and 'C', when a merge was necessary but collisions were detected (requiring manual merging). Finally, one of three record types results from __commit__: `M', when a file was modified; `A', when a file is first added; and `R', when a file is removed. __-e__ Everything (all record types); equivalent to specifying `__-xMACFPROGWUT__'. __-z__ ''zone'' Use time zone ''zone'' when outputting history records. The zone name __LT__ stands for local time; numeric offsets stand for hours and minutes ahead of UTC. For example, __+0530__ stands for 5 hours and 30 minutes ahead of (i.e. east of) UTC. The options shown as __-__''flags'' constrain the report without requiring option arguments: __-a__ Show data for all users (the default is to show data only for the user executing `__cvs history__'). __-l__ Show last modification only. __-w__ Show only the records for modifications done from the same working directory where `__cvs history__' is executing. The options shown as __-__''options args'' constrain the report based on an argument: __-b__ ''str'' Show data back to a record containing the string ''str'' in either the module name, the file name, or the repository path. __-D__ ''date'' Show data since ''date''. __-p__ ''repository'' Show data for a particular source repository (you can specify several __-p__ options on the same command line). __-r__ ''rev'' Show records referring to revisions since the revision or tag named ''rev'' appears in individual RCS files. Each RCS file is searched for the revision or tag. __-t__ ''tag'' Show records since tag ''tag'' was last added to the history file. This differs from the __-r__ flag above in that it reads only the history file, not the RCS files, and is much faster. __-u__ ''name'' Show records for user ''name''. __import__ [[__-__''options''] ''repository vendortag releasetag''... ''Requires:'' Repository, source distribution directory.'' Changes:'' repository. Use `__cvs import__' to incorporate an entire source distribution from an outside source (e.g., a source vendor) into your source repository directory. You can use this command both for initial creation of a repository, and for wholesale updates to the module form the outside source. The ''repository'' argument gives a directory name (or a path to a directory) under the CVS root directory for repositories; if the directory did not exist, __import__ creates it. When you use __import__ for updates to source that has been modified in your source repository (since a prior __import__), it will notify you of any files that conflict in the two branches of development; use `__cvs checkout -j__' to reconcile the differences, as __import__ instructs you to do. By default, certain file names are ignored during `__cvs import__': names associated with CVS administration, or with other common source control systems; common names for patch files, object files, archive files, and editor backup files; and other names that are usually artifacts of assorted utilities. For an up to date list of ignored file names, see the Cederqvist manual (as described in the SEE ALSO section of this manpage). The outside source is saved in a first-level branch, by default `__1.1.1__'. Updates are leaves of this branch; for example, files from the first imported collection of source will be revision `__1.1.1.1__', then files from the first imported update will be revision `__1.1.1.2__', and so on. At least three arguments are required. ''repository'' is needed to identify the collection of source. ''vendortag'' is a tag for the entire branch (e.g., for `__1.1.1__'). You must also specify at least one ''releasetag'' to identify the files at the leaves created each time you execute `__cvs import__'. One of the standard __cvs__ command options is available: __-m__ ''message''. If you do not specify a logging message with __-m__, your editor is invoked (as with __commit__) to allow you to enter one. There are three additional special options. Use `__-d__' to specify that each file's time of last modification should be used for the checkin date and time. Use `__-b__ ''branch''' to specify a first-level branch other than `__1.1.1__'. Use `__-I__ ''name''' to specify file names that should be ignored during __import__. You can use this option repeatedly. To avoid ignoring any files at all (even those ignored by default), specify `__-I !__'. __log__ [[__-l__] ''rlog-options [[files''...] ''Requires:'' repository, working directory.'' Changes:'' nothing.'' Synonym:'' __rlog__ Display log information for ''files''. Among the more useful options are __-h__ to display only the header (including tag definitions, but omitting most of the full log); __-r__ to select logs on particular revisions or ranges of revisions; and __-d__ to select particular dates or date ranges. See __rlog__(__1__) for full explanations. This command is recursive by default, unless the __-l__ option is specified. __rdiff__ [[__-__''flags''] [[__-V__ ''vn''] [[__-r__ ''t''|__-D__ ''d'' [[__-r__ ''t2''|__-D__ ''d2'']] ''modules...'' ''Requires:'' repository.'' Changes:'' nothing.'' Synonym:'' __patch__ Builds a Larry Wall format __patch__(__1__) file between two releases, that can be fed directly into the __patch__ program to bring an old release up-to-date with the new release. (This is one of the few __cvs__ commands that operates directly from the repository, and doesn't require a prior __checkout__.) The diff output is sent to the standard output device. You can specify (using the standard __-r__ and __-D__ options) any combination of one or two revisions or dates. If only one revision or date is specified, the patch file reflects differences between that revision or date and the current ``head'' revisions in the RCS file. Note that if the software release affected is contained in more than one directory, then it may be necessary to specify the __-p__ option to the __patch__ command when patching the old sources, so that __patch__ is able to find the files that are located in other directories. The standard option ''flags'' __-f__, and __-l__ are available with this command. There are also several special options flags: If you use the __-s__ option, no patch output is produced. Instead, a summary of the changed or added files between the two releases is sent to the standard output device. This is useful for finding out, for example, which files have changed between two dates or revisions. If you use the __-t__ option, a diff of the top two revisions is sent to the standard output device. This is most useful for seeing what the last change to a file was. If you use the __-u__ option, the patch output uses the newer ``unidiff'' format for context diffs. You can use __-c__ to explicitly specify the `__diff -c__' form of context diffs (which is the default), if you like. __release__ [[__-dQq__] ''modules''... ''Requires:'' Working directory.'' Changes:'' Working directory, history log. This command is meant to safely cancel the effect of `__cvs checkout'.__' Since __cvs__ doesn't lock files, it isn't strictly necessary to use this command. You can always simply delete your working directory, if you like; but you risk losing changes you may have forgotten, and you leave no trace in the __cvs__ history file that you've abandoned your checkout. Use `__cvs release__' to avoid these problems. This command checks that no un-committed changes are present; that you are executing it from immediately above, or inside, a __cvs__ working directory; and that the repository recorded for your files is the same as the repository defined in the module database. If all these conditions are true, `__cvs release__' leaves a record of its execution (attesting to your intentionally abandoning your checkout) in the __cvs__ history log. You can use the __-d__ flag to request that your working copies of the source files be deleted if the __release__ succeeds. __remove__ [[__-lR__] [[''files...''] ''Requires:'' Working directory.'' Changes:'' Working directory.'' Synonyms:'' __rm__, __delete__ Use this command to declare that you wish to remove ''files'' from the source repository. Like most __cvs__ commands, `__cvs remove__' works on files in your working directory, not directly on the repository. As a safeguard, it also requires that you first erase the specified files from your working directory. The files are not actually removed until you apply your changes to the repository with __commit__; at that point, the corresponding RCS files in the source repository are ''moved'' into the `__Attic__' directory (also within the source repository). This command is recursive by default, scheduling all physically removed files that it finds for removal by the next __commit__. Use the __-l__ option to avoid this recursion, or just specify that actual files that you wish remove to consider. __rtag__ [[__-falnRQq__] [[__-b__] [[__-d__] [[__-r__ ''tag'' | __-D__ ''date''] ''symbolic_tag modules...'' ''Requires:'' repository.'' Changes:'' repository.'' Synonym:'' __rfreeze__ You can use this command to assign symbolic tags to particular, explicitly specified source versions in the repository. `__cvs rtag__' works directly on the repository contents (and requires no prior __checkout__). Use `__cvs tag__' instead, to base the selection of versions to tag on the contents of your working directory. In general, tags (often the symbolic names of software distributions) should not be removed, but the __-d__ option is available as a means to remove completely obsolete symbolic names if necessary (as might be the case for an Alpha release, say). `__cvs rtag__' will not move a tag that already exists. With the __-F__ option, however, `__cvs rtag__' will re-locate any instance of ''symbolic_tag'' that already exists on that file to the new repository versions. Without the __-F__ option, attempting to use `__cvs rtag__' to apply a tag that already exists on that file will produce an error message. The __-b__ option makes the tag a ``branch'' tag, allowing concurrent, isolated development. This is most useful for creating a patch to a previously released software distribution. You can use the standard __-r__ and __-D__ options to tag only those files that already contain a certain tag. This method would be used to rename a tag: tag only the files identified by the old tag, then delete the old tag, leaving the new tag on exactly the same files as the old tag. __rtag__ executes recursively by default, tagging all subdirectories of ''modules'' you specify in the argument. You can restrict its operation to top-level directories with the standard __-l__ option; or you can explicitly request recursion with __-R__. The modules database can specify a program to execute whenever a tag is specified; a typical use is to send electronic mail to a group of interested parties. If you want to bypass that program, use the standard __-n__ option. Use the __-a__ option to have __rtag__ look in the `__Attic__' for removed files that contain the specified tag. The tag is removed from these files, which makes it convenient to re-use a symbolic tag as development continues (and files get removed from the up-coming distribution). __status__ [[__-lRqQ__] [[__-v__] [[''files''...] ''Requires:'' working directory, repository.'' Changes:'' nothing. Display a brief report on the current status of ''files'' with respect to the source repository, including any ``sticky'' tags, dates, or __-k__ options. (``Sticky'' options will restrict how `__cvs update__' operates until you reset them; see the description of `__cvs update -A...__'.) You can also use this command to anticipate the potential impact of a `__cvs update__' on your working source directory. If you do not specify any ''files'' explicitly, reports are shown for all files that __cvs__ has placed in your working directory. You can limit the scope of this search to the current directory itself (not its subdirectories) with the standard __-l__ option flag; or you can explicitly request recursive status reports with the __-R__ option. The __-v__ option causes the symbolic tags for the RCS file to be displayed as well. __tag__ [[__-lQqR__] [[__-F__] [[__-b__] [[__-d__] [[__-r__ ''tag'' | __-D__ ''date''] [[__-f__] ''symbolic_tag'' [[''files''...] ''Requires:'' working directory, repository.'' Changes:'' repository.'' Synonym:'' __freeze__ Use this command to assign symbolic tags to the nearest repository versions to your working sources. The tags are applied immediately to the repository, as with __rtag__. One use for tags is to record a ``snapshot'' of the current sources when the software freeze date of a project arrives. As bugs are fixed after the freeze date, only those changed sources that are to be part of the release need be re-tagged. The symbolic tags are meant to permanently record which revisions of which files were used in creating a software distribution. The __checkout__, __export__ and __update__ commands allow you to extract an exact copy of a tagged release at any time in the future, regardless of whether files have been changed, added, or removed since the release was tagged. You can use the standard __-r__ and __-D__ options to tag only those files that already contain a certain tag. This method would be used to rename a tag: tag only the files identified by the old tag, then delete the old tag, leaving the new tag on exactly the same files as the old tag. Specifying the __-f__ flag in addition to the __-r__ or __-D__ flags will tag those files named on the command line even if they do not contain the old tag or did not exist on the specified date. By default (without a __-r__ or __-D__ flag) the versions to be tagged are supplied implicitly by the __cvs__ records of your working files' history rather than applied explicitly. If you use `__cvs tag -d__ ''symbolic_tag''__...__', the symbolic tag you specify is ''deleted'' instead of being added. ''Warning'': Be very certain of your ground before you delete a tag; doing this effectively discards some historical information, which may later turn out to have been valuable. `__cvs tag__' will not move a tag that already exists. With the __-F__ option, however, `__cvs tag__' will re-locate any instance of ''symbolic_tag'' that already exists on that file to the new repository versions. Without the __-F__ option, attempting to use `__cvs tag__' to apply a tag that already exists on that file will produce an error message. The __-b__ option makes the tag a ``branch'' tag, allowing concurrent, isolated development. This is most useful for creating a patch to a previously released software distribution. Normally, __tag__ executes recursively through subdirectories; you can prevent this by using the standard __-l__ option, or specify the recursion explicitly by using __-R__. __update__ [[__-ACdflPpQqR__] [[__-d__] [[__-r__ ''tag''|__-D__ ''date''] ''files...'' ''Requires:'' repository, working directory.'' Changes:'' working directory. After you've run __checkout__ to create your private copy of source from the common repository, other developers will continue changing the central source. From time to time, when it is convenient in your development process, you can use the __update__ command from within your working directory to reconcile your work with any revisions applied to the source repository since your last __checkout__ or __update__. __update__ keeps you informed of its progress by printing a line for each file, prefaced with one of the characters `__U P A R M C ?__' to indicate the status of the file: __U__ ''file'' The file was brought ''up to date'' with respect to the repository. This is done for any file that exists in the repository but not in your source, and for files that you haven't changed but are not the most recent versions available in the repository. __P__ ''file'' Like `U', but the CVS server sends a patch instead of an entire file. These two things accomplish the same thing. __A__ ''file'' The file has been ''added'' to your private copy of the sources, and will be added to the source repository when you run `__cvs commit__' on the file. This is a reminder to you that the file needs to be committed. __R__ ''file'' The file has been ''removed'' from your private copy of the sources, and will be removed from the source repository when you run `__cvs commit__' on the file. This is a reminder to you that the file needs to be committed. __M__ ''file'' The file is ''modified'' in your working directory. `__M__' can indicate one of two states for a file you're working on: either there were no modifications to the same file in the repository, so that your file remains as you last saw it; or there were modifications in the repository as well as in your copy, but they were ''merged'' successfully, without conflict, in your working directory. __C__ ''file'' A ''conflict'' was detected while trying to merge your changes to ''file'' with changes from the source repository. ''file'' (the copy in your working directory) is now the result of merging the two versions; an unmodified copy of your file is also in your working directory, with the name `__.#__''file''__.__''version''', where ''version'' is the revision that your modified file started from. (Note that some systems automatically purge files that begin with `__.#__' if they have not been accessed for a few days. If you intend to keep a copy of your original file, it is a very good idea to rename it.) __?__ ''file'' ''file'' is in your working directory, but does not correspond to anything in the source repository, and is not in the list of files for __cvs__ to ignore (see the description of the __-I__ option). Use the __-A__ option to reset any sticky tags, dates, or __-k__ options. (If you get a working copy of a file by using one of the __-r__, __-D__, or __-k__ options, __cvs__ remembers the corresponding tag, date, or ''kflag'' and continues using it on future updates; use the __-A__ option to make __cvs__ forget these specifications, and retrieve the ``head'' version of the file). The __-j__''branch'' option merges the changes made between the resulting revision and the revision that it is based on (e.g., if the tag refers to a branch, __cvs__ will merge all changes made in that branch into your working file). With two __-j__ options, __cvs__ will merge in the changes between the two respective revisions. This can be used to ``remove'' a certain delta from your working file. E.g., If the file foo.c is based on revision 1.6 and I want to remove the changes made between 1.3 and 1.5, I might do: __example% cvs update -j1.5 -j1.3 foo.c # note the order... __ In addition, each __-j__ option can contain on optional date specification which, when used with branches, can limit the chosen revision to one within a specific date. An optional date is specified by adding a colon (:) to the tag. __-jSymbolic_Tag:Date_Specifier __ Use the __-d__ option to create any directories that exist in the repository if they're missing from the working directory. (Normally, update acts only on directories and files that were already enrolled in your working directory.) This is useful for updating directories that were created in the repository since the initial __checkout__; but it has an unfortunate side effect. If you deliberately avoided certain directories in the repository when you created your working directory (either through use of a module name or by listing explicitly the files and directories you wanted on the command line), then updating with __-d__ will create those directories, which may not be what you want. Use __-I__ ''name'' to ignore files whose names match ''name'' (in your working directory) during the update. You can specify __-I__ more than once on the command line to specify several files to ignore. By default, __update__ ignores files whose names match certain patterns; for an up to date list of ignored file names, see the Cederqvist manual (as described in the SEE ALSO section of this manpage). Use `__-I !__' to avoid ignoring any files at all. Use the `__-C__' option to overwrite locally modified files with clean copies from the repository (the modified file is saved in `__.#__''file''__.__''revision''', however). The standard __cvs__ command options __-f__, __-k__, __-l__, __-P__, __-p__, and __-r__ are also available with __update__. !!FILES For more detailed information on __cvs__ supporting files, see __cvs__(__5__). ''Files in home directories:'' .cvsrc The __cvs__ initialisation file. Lines in this file can be used to specify default options for each __cvs__ command. For example the line `__diff -c__' will ensure that `__cvs diff__' is always passed the __-c__ option in addition to any other options passed on the command line. .cvswrappers Specifies wrappers to be used in addition to those specified in the CVSROOT/cvswrappers file in the repository. ''Files in working directories:'' CVS A directory of __cvs__ administrative files. ''Do not delete.'' CVS/Entries List and status of files in your working directory. CVS/Entries.Backup A backup of `__CVS/Entries__'. CVS/Entries.Static Flag: do not add more entries on `__cvs update__'. CVS/Root Pathname to the repository ( CVSROOT ) location at the time of checkout. This file is used instead of the CVSROOT environment variable if the environment variable is not set. A warning message will be issued when the contents of this file and the CVSROOT environment variable differ. The file may be over-ridden by the presence of the CVS_IGNORE_REMOTE_ROOT environment variable. CVS/Repository Pathname to the corresponding directory in the source repository. CVS/Tag Contains the per-directory ``sticky'' tag or date information. This file is created/updated when you specify __-r__ or __-D__ to the __checkout__ or __update__ commands, and no files are specified. CVS/Checkin.prog Name of program to run on `__cvs commit__'. CVS/Update.prog Name of program to run on `__cvs update__'. ''Files in source repositories:'' $CVSROOT/CVSROOT Directory of global administrative files for repository. CVSROOT/commitinfo,v Records programs for filtering `__cvs commit__' requests. CVSROOT/cvswrappers,v Records __cvs__ wrapper commands to be used when checking files into and out of the repository. Wrappers allow the file or directory to be processed on the way in and out of CVS. The intended uses are many, one possible use would be to reformat a C file before the file is checked in, so all of the code in the repository looks the same. CVSROOT/editinfo,v Records programs for editing/validating `__cvs commit__' log entries. CVSROOT/history Log file of __cvs__ transactions. CVSROOT/loginfo,v Records programs for piping `__cvs commit__' log entries. CVSROOT/modules,v Definitions for modules in this repository. CVSROOT/rcsinfo,v Records pathnames to templates used during a `__cvs commit__' operation. CVSROOT/taginfo,v Records programs for validating/logging `__cvs tag__' and `__cvs rtag__' operations. MODULE/Attic Directory for removed source files. #cvs.lock A lock directory created by __cvs__ when doing sensitive changes to the source repository. #cvs.tfl.''pid'' Temporary lock file for repository. #cvs.rfl.''pid'' A read lock. #cvs.wfl.''pid'' A write lock. !!ENVIRONMENT VARIABLES CVSROOT Should contain the full pathname to the root of the __cvs__ source repository (where the RCS files are kept). This information must be available to __cvs__ for most commands to execute; if CVSROOT is not set, or if you wish to override it for one invocation, you can supply it on the command line: `__cvs -d__ ''cvsroot cvs_command''__...__' You may not need to set CVSROOT if your __cvs__ binary has the right path compiled in; use `__cvs -v__' to display all compiled-in paths. CVSREAD If this is set, __checkout__ and __update__ will try hard to make the files in your working directory read-only. When this is not set, the default behavior is to permit modification of your working files. RCSBIN Specifies the full pathname where to find RCS programs, such as __co__(__1__) and __ci__(__1__) (CVS 1.9 and older). CVSEDITOR Specifies the program to use for recording log messages during __commit__. If not set, the VISUAL and EDITOR environment variables are tried (in that order). If neither is set, a system-dependent default editor (e.g., __vi__) is used. CVS_IGNORE_REMOTE_ROOT If this variable is set then __cvs__ will ignore all references to remote repositories in the CVS/Root file. CVS_RSH __cvs__ uses the contents of this variable to determine the name of the remote shell command to use when starting a __cvs__ server. If this variable is not set then `__rsh__' is used. CVS_SERVER __cvs__ uses the contents of this variable to determine the name of the __cvs__ server command. If this variable is not set then `__cvs__' is used. CVSWRAPPERS This variable is used by the `__cvswrappers__' script to determine the name of the wrapper file, in addition to the wrappers defaults contained in the repository (CVSROOT/cvswrappers) and the user's home directory (~/.cvswrappers). !!AUTHORS Dick Grune Original author of the __cvs__ shell script version posted to __comp.sources.unix__ in the volume6 release of December, 1986. Credited with much of the __cvs__ conflict resolution algorithms. Brian Berliner Coder and designer of the __cvs__ program itself in April, 1989, based on the original work done by Dick. Jeff Polk Helped Brian with the design of the __cvs__ module and vendor branch support and author of the __checkin__(__1__) shell script (the ancestor of `__cvs import__'). And many others too numerous to mention here. !!SEE ALSO The most comprehensive manual for CVS is Version Management with CVS by Per Cederqvist et al. Depending on your system, you may be able to get it with the __info cvs__ command or it may be available as cvs.ps (postscript), cvs.texinfo (texinfo source), or cvs.html. For CVS updates, more information on documentation, software related to CVS, development of CVS, and more, see: __http://www.cyclic.com http://www.loria.fr/~molli/cvs-index.html__ __ci__(__1__), __co__(__1__), __cvs__(__5__), __cvsbug__(__8__), __diff__(__1__), __grep__(__1__), __patch__(__1__), __rcs__(__1__), __rcsdiff__(__1__), __rcsmerge__(__1__), __rlog__(__1__). ----
12 pages link to
cvs(1)
:
CommitteeMeetingTopics.2004-05-19
rcs2log(1)
Man1c
cvs-makerepos(1)
flea(1)
SIGPIPE
muttbug(1)
PatchNotes
ENOTEMPTY
SubVersion
CVSHowto
CVS
This page is a man page (or other imported legacy content). We are unable to automatically determine the license status of this page.
