"

NAME

cvs - Concurrent Versions System

SYNOPSIS

ccvvss [ _c_v_s___o_p_t_i_o_n_s ]
cvs_command [ command_options ] [ command_args ]

NOTE

This manpage is a summary of some of the features of ccvvss. It is auto-generated from an appendix of the CVS manual. For more in-depth documentation, please consult the Cederqvist manual (via the info CVS command or otherwise, as described in the SEE ALSO section of this manpage). Cross-references in this man page refer to nodes in the same.

CVS commands

Guide to CVS commands



This appendix describes the overall structure of ccvvss commands, and describes some commands in detail (others are described elsewhere; for a quick reference to ccvvss commands, see node `Invoking CVS' in the CVS manual).

Structure

Overall structure of CVS commands



The overall format of all ccvvss commands is:



cvs [ cvs_options ] cvs_command [ command_options ] [ command_args ]



ccvvss
The name of the ccvvss program.


ccvvss__ooppttiioonnss
Some options that affect all sub-commands of ccvvss. These are
described below.

ccvvss__ccoommmmaanndd
One of several different sub-commands. Some of the commands have
aliases that can be used instead; those aliases are noted in the reference manual for that command. There are only two situations where you may omit ccvvss__ccoommmmaanndd: ccvvss --HH elicits a list of available commands, and ccvvss --vv displays version information on ccvvss itself.

ccoommmmaanndd__ooppttiioonnss
Options that are specific for the command.


ccoommmmaanndd__aarrggss
Arguments to the commands.


There is unfortunately some confusion between ccvvss__ooppttiioonnss and ccoommmmaanndd__ooppttiioonnss. When given as a ccvvss__ooppttiioonn, some options only affect some of the commands. When given as a ccoommmmaanndd__ooppttiioonn it may have a different meaning, and be accepted by more commands. In other words, do not take the above categorization too seriously. Look at the documentation instead.

Exit status

CVS's exit status



ccvvss can indicate to the calling environment whether it succeeded or failed by setting its _e_x_i_t _s_t_a_t_u_s. The exact way of testing the exit status will vary from one operating system to another. For example in a unix shell script the $$?? variable will be 0 if the last command returned a successful exit status, or greater than 0 if the exit status indicated failure.

If ccvvss is successful, it returns a successful status; if there is an error, it prints an error message and returns a failure status. The one exception to this is the ccvvss ddiiffff command. It will return a successful status if it found no differences, or a failure status if there were differences or if there was an error. Because this behavior provides no good way to detect errors, in the future it is possible that ccvvss ddiiffff will be changed to behave like the other ccvvss commands.

~/.cvsrc

Default options and the ~/.cvsrc file



There are some ccoommmmaanndd__ooppttiioonnss that are used so often that you might have set up an alias or some other means to make sure you always specify that option. One example (the one that drove the implementation of the ..ccvvssrrcc support, actually) is that many people find the default output of the ddiiffff command to be very hard to read, and that either context diffs or unidiffs are much easier to understand.

The ~~//..ccvvssrrcc file is a way that you can add default options to ccvvss__ccoommmmaannddss within cvs, instead of relying on aliases or other shell scripts.

The format of the ~~//..ccvvssrrcc file is simple. The file is searched for a line that begins with the same name as the ccvvss__ccoommmmaanndd being executed. If a match is found, then the remainder of the line is split up (at whitespace characters) into separate options and added to the command arguments _b_e_f_o_r_e any options from the command line.

If a command has two names (e.g., cchheecckkoouutt and ccoo), the official name, not necessarily the one used on the command line, will be used to match against the file. So if this is the contents of the user's ~~//..ccvvssrrcc file:



log -N
diff -uN
rdiff -u
update -Pd
checkout -P
release -d



the command ccvvss cchheecckkoouutt ffoooo would have the --PP option added to the arguments, as well as ccvvss ccoo ffoooo.

With the example file above, the output from ccvvss ddiiffff ffoooobbaarr will be in unidiff format. ccvvss ddiiffff --cc ffoooobbaarr will provide context diffs, as usual. Getting "old" format diffs would be slightly more complicated, because ddiiffff doesn't have an option to specify use of the "old" format, so you would need ccvvss --ff ddiiffff ffoooobbaarr.

In place of the command name you can use ccvvss to specify global options (see node `Global options' in the CVS manual). For example the following line in ..ccvvssrrcc



cvs -z6



causes ccvvss to use compression level 6.

Global options



The available ccvvss__ooppttiioonnss (that are given to the left of ccvvss__ccoommmmaanndd) are:

----aallllooww--rroooott==_r_o_o_t_d_i_r
Specify legal ccvvssrroooott directory. See
see node `Password authentication server' in the CVS manual.

--aa
Authenticate all communication between the client and
the server. Only has an effect on the ccvvss client. As of this writing, this is only implemented when using a GSSAPI connection (see node `GSSAPI authenticated' in the CVS manual). Authentication prevents certain sorts of attacks involving hijacking the active ttccpp connection. Enabling authentication does not enable encryption.

--bb _b_i_n_d_i_r
In ccvvss 1.9.18 and older, this specified that
rrccss programs are in the _b_i_n_d_i_r directory. Current versions of ccvvss do not run rrccss programs; for compatibility this option is accepted, but it does nothing.

--TT _t_e_m_p_d_i_r
Use _t_e_m_p_d_i_r as the directory where temporary files are
located. Overrides the setting of the $$TTMMPPDDIIRR environment variable and any precompiled directory. This parameter should be specified as an absolute pathname. (When running client/server, --TT affects only the local process; specifying --TT for the client has no effect on the server and vice versa.)

--dd _c_v_s___r_o_o_t___d_i_r_e_c_t_o_r_y
Use _c_v_s___r_o_o_t___d_i_r_e_c_t_o_r_y as the root directory
pathname of the repository. Overrides the setting of the $$CCVVSSRROOOOTT environment variable. see node `Repository' in the CVS manual.

--ee _e_d_i_t_o_r
Use _e_d_i_t_o_r to enter revision log information. Overrides the
setting of the $$CCVVSSEEDDIITTOORR and $$EEDDIITTOORR environment variables. For more information, see see node `Committing your changes' in the CVS manual.

--ff
Do not read the ~~//..ccvvssrrcc file. This
option is most often used because of the non-orthogonality of the ccvvss option set. For example, the ccvvss lloogg option --NN (turn off display of tag names) does not have a corresponding option to turn the display on. So if you have --NN in the ~~//..ccvvssrrcc entry for lloogg, you may need to use --ff to show the tag names.

--HH
----hheellpp
Display usage information about the specified ccvvss__ccoommmmaanndd
(but do not actually execute the command). If you don't specify a command name, ccvvss --HH displays overall help for ccvvss, including a list of other help options.

--nn
Do not change any files. Attempt to execute the
ccvvss__ccoommmmaanndd, but only to issue reports; do not remove, update, or merge any existing files, or create any new files.

Note that ccvvss will not necessarily produce exactly the same output as without --nn. In some cases the output will be the same, but in other cases ccvvss will skip some of the processing that would have been required to produce the exact same output.

--QQ
Cause the command to be really quiet; the command will only
generate output for serious problems.

--qq
Cause the command to be somewhat quiet; informational messages,
such as reports of recursion through subdirectories, are suppressed.

--rr
Make new working files read-only. Same effect
as if the $$CCVVSSRREEAADD environment variable is set (see node `Environment variables' in the CVS manual). The default is to make working files writable, unless watches are on (see node `Watches' in the CVS manual).

--ss _v_a_r_i_a_b_l_e==_v_a_l_u_e
Set a user variable (see node `Variables' in the CVS manual).


--tt
Trace program execution; display messages showing the steps of
ccvvss activity. Particularly useful with --nn to explore the potential impact of an unfamiliar command.

--vv
----vveerrssiioonn
Display version and copyright information for ccvvss.


--ww
Make new working files read-write. Overrides the
setting of the $$CCVVSSRREEAADD environment variable. Files are created read-write by default, unless $$CCVVSSRREEAADD is set or --rr is given.

--xx
Encrypt all communication between the client and the
server. Only has an effect on the ccvvss client. As of this writing, this is only implemented when using a GSSAPI connection (see node `GSSAPI authenticated' in the CVS manual) or a Kerberos connection (see node `Kerberos authenticated' in the CVS manual). Enabling encryption implies that message traffic is also authenticated. Encryption support is not available by default; it must be enabled using a special configure option, ----eennaabbllee--eennccrryyppttiioonn, when you build ccvvss.

--zz _g_z_i_p_-_l_e_v_e_l
Set the compression level.
Valid levels are 1 (high speed, low compression) to 9 (low speed, high compression), or 0 to disable compression (the default). Only has an effect on the ccvvss client.



Common options

Common command options



This section describes the ccoommmmaanndd__ooppttiioonnss that are available across several ccvvss commands. These options are always given to the right of ccvvss__ccoommmmaanndd. 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 almost always count on the same behavior of the option as in other commands. (Other command options, which are listed with the individual commands, may have different behavior from one ccvvss command to the other).

TThhee hhiissttoorryy ccoommmmaanndd iiss aann eexxcceeppttiioonn;; iitt ssuuppppoorrttss mmaannyy ooppttiioonnss tthhaatt ccoonnfflliicctt eevveenn wwiitthh tthheessee ssttaannddaarrdd ooppttiioonnss..

--DD _d_a_t_e___s_p_e_c
Use the most recent revision no later than _d_a_t_e___s_p_e_c.
_d_a_t_e___s_p_e_c is a single argument, a date description specifying a date in the past.

The specification is _s_t_i_c_k_y when you use it to make a private copy of a source file; that is, when you get a working file using --DD, ccvvss records the date you specified, so that further updates in the same directory will use the same date (for more information on sticky tags/dates, see node `Sticky tags' in the CVS manual).

--DD is available with the aannnnoottaattee, cchheecckkoouutt, ddiiffff, eexxppoorrtt, hhiissttoorryy, rrddiiffff, rrttaagg, and uuppddaattee commands. (The hhiissttoorryy command uses this option in a slightly different way; see node `history options' in the CVS manual).

A wide variety of date formats are supported by ccvvss. The most standard ones are ISO8601 (from the International Standards Organization) and the Internet e-mail standard (specified in RFC822 as amended by RFC1123).

ISO8601 dates have many variants but a few examples are:



1972-09-24
1972-09-24 20:05



There are a lot more ISO8601 date formats, and ccvvss accepts many of them, but you probably don't want to hear the _w_h_o_l_e long story :-).

In addition to the dates allowed in Internet e-mail itself, ccvvss also allows some of the fields to be omitted. For example:



24 Sep 1972 20:05
24 Sep



The date is interpreted as being in the local timezone, unless a specific timezone is specified.

These two date formats are preferred. However, ccvvss currently accepts a wide variety of other date formats. They are intentionally not documented here in any detail, and future versions of ccvvss might not accept all of them.

One such format is _m_o_n_t_h//_d_a_y//_y_e_a_r. This may confuse people who are accustomed to having the month and day in the other order; 11//44//9966 is January 4, not April 1.

Remember to quote the argument to the --DD flag so that your shell doesn't interpret spaces as argument separators. A command using the --DD flag can look like this:



$ cvs diff -D "1 hour ago" cvs.texinfo



--ff
When you specify a particular date or tag to ccvvss commands, they
normally ignore files that do not contain the tag (or did not exist prior to the date) that you specified. Use the --ff option if you want files retrieved even when there is no match for the tag or date. (The most recent revision of the file will be used).

Note that even with --ff, a tag that you specify must exist (that is, in some file, not necessary in every file). This is so that ccvvss will continue to give an error if you mistype a tag name.

--ff is available with these commands: aannnnoottaattee, cchheecckkoouutt, eexxppoorrtt, rrddiiffff, rrttaagg, and uuppddaattee.

WWAARRNNIINNGG:: TThhee ccoommmmiitt aanndd rreemmoovvee ccoommmmaannddss aallssoo hhaavvee aa --ff ooppttiioonn,, bbuutt iitt hhaass aa ddiiffffeerreenntt bbeehhaavviioorr ffoorr tthhoossee ccoommmmaannddss.. SSeeee sseeee nnooddee ``ccoommmmiitt ooppttiioonnss'' iinn tthhee CCVVSS mmaannuuaall,, aanndd sseeee nnooddee ``RReemmoovviinngg ffiilleess'' iinn tthhee CCVVSS mmaannuuaall..

--kk _k_f_l_a_g
Alter the default processing of keywords.
see node `Keyword substitution' in the CVS manual, for the meaning of _k_f_l_a_g. Your _k_f_l_a_g specification is _s_t_i_c_k_y when you use it to create a private copy of a source file; that is, when you use this option with the cchheecckkoouutt or uuppddaattee commands, ccvvss associates your selected _k_f_l_a_g with the file, and continues to use it with future update commands on the same file until you specify otherwise.

The --kk option is available with the aadddd, cchheecckkoouutt, ddiiffff, rrddiiffff, iimmppoorrtt and uuppddaattee commands.

--ll
Local; run only in current working directory, rather than
recursing through subdirectories.

Available with the following commands: aannnnoottaattee, cchheecckkoouutt, ccoommmmiitt, ddiiffff, eeddiitt, eeddiittoorrss, eexxppoorrtt, lloogg, rrddiiffff, rreemmoovvee, rrttaagg, ssttaattuuss, ttaagg, uunneeddiitt, uuppddaattee, wwaattcchh, and wwaattcchheerrss.

--mm _m_e_s_s_a_g_e
Use _m_e_s_s_a_g_e as log information, instead of
invoking an editor.

Available with the following commands: aadddd, ccoommmmiitt and iimmppoorrtt.

--nn
Do not run any tag program. (A program can be
specified to run in the modules database (see node `modules' in the CVS manual); this option bypasses it).

TThhiiss iiss nnoott tthhee ssaammee aass tthhee ccvvss --nn pprrooggrraamm ooppttiioonn,, wwhhiicchh yyoouu ccaann ssppeecciiffyy ttoo tthhee lleefftt ooff aa ccvvss ccoommmmaanndd!!

Available with the cchheecckkoouutt, eexxppoorrtt, and rrttaagg commands.

--PP
Prune empty directories. See see node `Removing directories' in the CVS manual.


--pp
Pipe the files retrieved from the repository to standard output,
rather than writing them in the current directory. Available with the cchheecckkoouutt and uuppddaattee commands.

--RR
Process directories recursively. This is on by default.


Available with the following commands: aannnnoottaattee, cchheecckkoouutt, ccoommmmiitt, ddiiffff, eeddiitt, eeddiittoorrss, eexxppoorrtt, rrddiiffff, rreemmoovvee, rrttaagg, ssttaattuuss, ttaagg, uunneeddiitt, uuppddaattee, wwaattcchh, and wwaattcchheerrss.

--rr _t_a_g
Use the revision specified by the _t_a_g argument instead of the
default _h_e_a_d revision. As well as arbitrary tags defined with the ttaagg or rrttaagg command, two special tags are always available: HHEEAADD refers to the most recent version available in the repository, and BBAASSEE refers to the revision you last checked out into the current working directory.

The tag specification is sticky when you use this with cchheecckkoouutt or uuppddaattee to make your own copy of a file: ccvvss remembers the tag and continues to use it on future update commands, until you specify otherwise (for more information on sticky tags/dates, see node `Sticky tags' in the CVS manual).

The tag can be either a symbolic or numeric tag, as described in see node `Tags' in the CVS manual, or the name of a branch, as described in see node `Branching and merging' in the CVS manual. When a command expects a specific revision, the name of a branch is interpreted as the most recent revision on that branch.

Specifying the --qq global option along with the --rr command option is often useful, to suppress the warning messages when the rrccss file does not contain the specified tag.

TThhiiss iiss nnoott tthhee ssaammee aass tthhee oovveerraallll ccvvss --rr ooppttiioonn,, wwhhiicchh yyoouu ccaann ssppeecciiffyy ttoo tthhee lleefftt ooff aa ccvvss ccoommmmaanndd!!

--rr is available with the aannnnoottaattee, cchheecckkoouutt, ccoommmmiitt, ddiiffff, hhiissttoorryy, eexxppoorrtt, rrddiiffff, rrttaagg, and uuppddaattee commands.

--WW
Specify file names that should be filtered. You can
use this option repeatedly. The spec can be a file name pattern of the same type that you can specify in the ..ccvvsswwrraappppeerrss file. Available with the following commands: iimmppoorrtt, and uuppddaattee.



admin

Administration



· Requires: repository, working directory.
· Changes: repository.
· Synonym: rcs


This is the ccvvss interface to assorted administrative facilities. Some of them have questionable usefulness for ccvvss but exist for historical purposes. Some of the questionable options are likely to disappear in the future. This command _d_o_e_s work recursively, so extreme care should be used.

On unix, if there is a group named ccvvssaaddmmiinn, only members of that group can run ccvvss aaddmmiinn (except for the ccvvss aaddmmiinn --kk command, which can be run by anybody). This group should exist on the server, or any system running the non-client/server ccvvss. To disallow ccvvss aaddmmiinn for all users, create a group with no users in it. On NT, the ccvvssaaddmmiinn feature does not exist and all users can run ccvvss aaddmmiinn.

admin options



Some of these options have questionable usefulness for ccvvss but exist for historical purposes. Some even make it impossible to use ccvvss until you undo the effect!

--AA_o_l_d_f_i_l_e
Might not work together with ccvvss. Append the
access list of _o_l_d_f_i_l_e to the access list of the rrccss file.

--aa_l_o_g_i_n_s
Might not work together with ccvvss. Append the
login names appearing in the comma-separated list _l_o_g_i_n_s to the access list of the rrccss file.

--bb[[_r_e_v]]
Set the default branch to _r_e_v. In ccvvss, you
normally do not manipulate default branches; sticky tags (see node `Sticky tags' in the CVS manual) are a better way to decide which branch you want to work on. There is one reason to run ccvvss aaddmmiinn --bb: to revert to the vendor's version when using vendor branches (see node `Reverting local changes' in the CVS manual). There can be no space between --bb and its argument.

--cc_s_t_r_i_n_g
Sets the comment leader to _s_t_r_i_n_g. The comment
leader is not used by current versions of ccvvss or rrccss 5.7. Therefore, you can almost surely not worry about it. see node `Keyword substitution' in the CVS manual.

--ee[[_l_o_g_i_n_s]]
Might not work together with ccvvss. Erase the login
names appearing in the comma-separated list _l_o_g_i_n_s from the access list of the RCS file. If _l_o_g_i_n_s is omitted, erase the entire access list. There can be no space between --ee and its argument.

--II
Run interactively, even if the standard input is not a
terminal. This option does not work with the client/server ccvvss and is likely to disappear in a future release of ccvvss.

--ii
Useless with ccvvss. This creates and initializes a
new rrccss file, without depositing a revision. With ccvvss, add files with the ccvvss aadddd command (see node `Adding files' in the CVS manual).

--kk_s_u_b_s_t
Set the default keyword
substitution to _s_u_b_s_t. see node `Keyword substitution' in the CVS manual. Giving an explicit --kk option to ccvvss uuppddaattee, ccvvss eexxppoorrtt, or ccvvss cchheecckkoouutt overrides this default.

--ll[[_r_e_v]]
Lock the revision with number _r_e_v. If a branch
is given, lock the latest revision on that branch. If _r_e_v is omitted, lock the latest revision on the default branch. There can be no space between --ll and its argument.

This can be used in conjunction with the rrccsslloocckk..ppll script in the ccoonnttrriibb directory of the ccvvss source distribution to provide reserved checkouts (where only one user can be editing a given file at a time). See the comments in that file for details (and see the RREEAADDMMEE file in that directory for disclaimers about the unsupported nature of contrib). According to comments in that file, locking must set to strict (which is the default).

--LL
Set locking to strict. Strict locking means that the
owner of an RCS file is not exempt from locking for checkin. For use with ccvvss, strict locking must be set; see the discussion under the --ll option above.

--mm_r_e_v::_m_s_g
Replace the log message of revision _r_e_v with
_m_s_g.

--NN_n_a_m_e[[::[[_r_e_v]]]]
Act like --nn, except override any previous
assignment of _n_a_m_e. For use with magic branches, see see node `Magic branch numbers' in the CVS manual.

--nn_n_a_m_e[[::[[_r_e_v]]]]
Associate the symbolic name _n_a_m_e with the branch
or revision _r_e_v. It is normally better to use ccvvss ttaagg or ccvvss rrttaagg instead. Delete the symbolic name if both :: and _r_e_v are omitted; otherwise, print an error message if _n_a_m_e is already associated with another number. If _r_e_v is symbolic, it is expanded before association. A _r_e_v consisting of a branch number followed by a .. stands for the current latest revision in the branch. A :: with an empty _r_e_v stands for the current latest revision on the default branch, normally the trunk. For example, ccvvss aaddmmiinn --nn_n_a_m_e:: associates _n_a_m_e with the current latest revision of all the RCS files; this contrasts with ccvvss aaddmmiinn --nn_n_a_m_e::$$ which associates _n_a_m_e with the revision numbers extracted from keyword strings in the corresponding working files.

--oo_r_a_n_g_e
Deletes (_o_u_t_d_a_t_e_s) the revisions given by
_r_a_n_g_e.

Note that this command can be quite dangerous unless you know _e_x_a_c_t_l_y what you are doing (for example see the warnings below about how the _r_e_v_1:_r_e_v_2 syntax is confusing).

If you are short on disc this option might help you. But think twice before using it--there is no way short of restoring the latest backup to undo this command! If you delete different revisions than you planned, either due to carelessness or (heaven forbid) a ccvvss bug, there is no opportunity to correct the error before the revisions are deleted. It probably would be a good idea to experiment on a copy of the repository first.

Specify _r_a_n_g_e in one of the following ways:

_r_e_v_1::::_r_e_v_2
Collapse all revisions between rev1 and rev2, so that
ccvvss only stores the differences associated with going from rev1 to rev2, not intermediate steps. For example, after --oo 11..33::::11..55 one can retrieve revision 1.3, revision 1.5, or the differences to get from 1.3 to 1.5, but not the revision 1.4, or the differences between 1.3 and 1.4. Other examples: --oo 11..33::::11..44 and --oo 11..33::::11..33 have no effect, because there are no intermediate revisions to remove.

::::_r_e_v
Collapse revisions between the beginning of the branch
containing _r_e_v and _r_e_v itself. The branchpoint and _r_e_v are left intact. For example, --oo ::::11..33..22..66 deletes revision 1.3.2.1, revision 1.3.2.5, and everything in between, but leaves 1.3 and 1.3.2.6 intact.

_r_e_v::::
Collapse revisions between _r_e_v and the end of the
branch containing _r_e_v. Revision _r_e_v is left intact but the head revision is deleted.

_r_e_v
Delete the revision _r_e_v. For example, --oo <> 11..33 is equivalent to --oo 11..22::::11..44.

_r_e_v_1::_r_e_v_2
Delete the revisions from _r_e_v_1 to _r_e_v_2,
inclusive, on the same branch. One will not be able to retrieve _r_e_v_1 or _r_e_v_2 or any of the revisions in between. For example, the command ccvvss aaddmmiinn --ooRR__11__0011::RR__11__0022 .. is rarely useful. It means to delete revisions up to, and including, the tag R_1_02. But beware! If there are files that have not changed between R_1_02 and R_1_03 the file will have _t_h_e _s_a_m_e numerical revision number assigned to the tags R_1_02 and R_1_03. So not only will it be impossible to retrieve R_1_02; R_1_03 will also have to be restored from the tapes! In most cases you want to specify _r_e_v_1::_r_e_v_2 instead.

::_r_e_v
Delete revisions from the beginning of the
branch containing _r_e_v up to and including _r_e_v.

_r_e_v::
Delete revisions from revision _r_e_v, including
_r_e_v itself, to the end of the branch containing _r_e_v.

None of the revisions to be deleted may have branches or locks.

If any of the revisions to be deleted have symbolic names, and one specifies one of the :::: syntaxes, then ccvvss will give an error and not delete any revisions. If you really want to delete both the symbolic names and the revisions, first delete the symbolic names with ccvvss ttaagg --dd, then run ccvvss aaddmmiinn --oo. If one specifies the non-:::: syntaxes, then ccvvss will delete the revisions but leave the symbolic names pointing to nonexistent revisions. This behavior is preserved for compatibility with previous versions of ccvvss, but because it isn't very useful, in the future it may change to be like the :::: case.

Due to the way ccvvss handles branches _r_e_v cannot be specified symbolically if it is a branch. see node `Magic branch numbers' in the CVS manual, for an explanation.

Make sure that no-one has checked out a copy of the revision you outdate. Strange things will happen if he starts to edit it and tries to check it back in. For this reason, this option is not a good way to take back a bogus commit; commit a new revision undoing the bogus change instead (see node `Merging two revisions' in the CVS manual).

--qq
Run quietly; do not print diagnostics.


--ss_s_t_a_t_e[[::_r_e_v]]
Useful with ccvvss. Set the state attribute of the
revision _r_e_v to _s_t_a_t_e. If _r_e_v is a branch number, assume the latest revision on that branch. If _r_e_v is omitted, assume the latest revision on the default branch. Any identifier is acceptable for _s_t_a_t_e. A useful set of states is EExxpp (for experimental), SSttaabb (for stable), and RReell (for released). By default, the state of a new revision is set to EExxpp when it is created. The state is visible in the output from _c_v_s _l_o_g (see node `log' in the CVS manual), and in the $$LLoogg$$ and $$SSttaattee$$ keywords (see node `Keyword substitution' in the CVS manual). Note that ccvvss uses the ddeeaadd state for its own purposes (see node `Attic' in the CVS manual); to take a file to or from the ddeeaadd state use commands like ccvvss rreemmoovvee and ccvvss aadddd (see node `Adding and removing' in the CVS manual), not ccvvss aaddmmiinn --ss.

--tt[[_f_i_l_e]]
Useful with ccvvss. Write descriptive text from the
contents of the named _f_i_l_e into the RCS file, deleting the existing text. The _f_i_l_e pathname may not begin with --. The descriptive text can be seen in the output from ccvvss lloogg (see node `log' in the CVS manual). There can be no space between --tt and its argument.

If _f_i_l_e is omitted, obtain the text from standard input, terminated by end-of-file or by a line containing .. by itself. Prompt for the text if interaction is possible; see --II.

--tt--_s_t_r_i_n_g
Similar to --tt_f_i_l_e. Write descriptive text
from the _s_t_r_i_n_g into the rrccss file, deleting the existing text. There can be no space between --tt and its argument.

--UU
Set locking to non-strict. Non-strict locking means
that the owner of a file need not lock a revision for checkin. For use with ccvvss, strict locking must be set; see the discussion under the --ll option above.

--uu[[_r_e_v]]
See the option --ll above, for a discussion of
using this option with ccvvss. Unlock the revision with number _r_e_v. If a branch is given, unlock the latest revision on that branch. If _r_e_v is omitted, remove the latest lock held by the caller. Normally, only the locker of a revision may unlock it; somebody else unlocking a revision breaks the lock. This causes the original locker to be sent a ccoommmmiitt notification (see node `Getting Notified' in the CVS manual). There can be no space between --uu and its argument.

--VV_n
In previous versions of ccvvss, this option meant to
write an rrccss file which would be acceptable to rrccss version _n, but it is now obsolete and specifying it will produce an error.

--xx_s_u_f_f_i_x_e_s
In previous versions of ccvvss, this was documented
as a way of specifying the names of the rrccss files. However, ccvvss has always required that the rrccss files used by ccvvss end in ,,vv, so this option has never done anything useful.



annotate

What revision modified each line of a file?



· Synopsis: annotate [options] files...
· Requires: repository.
· Changes: nothing.


For each file in _f_i_l_e_s, print the head revision of the trunk, together with information on the last modification for each line.

annotate options



These standard options are supported by aannnnoottaattee (see node `Common options' in the CVS manual, for a complete description of them):

--ll
Local directory only, no recursion.


--RR
Process directories recursively.


--ff
Use head revision if tag/date not found.


--FF
Annotate binary files.


--rr _r_e_v_i_s_i_o_n
Annotate file as of specified revision/tag.


--DD _d_a_t_e
Annotate file as of specified date.


annotate example



For example:



$ cvs annotate ssfile
Annotations for ssfile
***************
1.1 (mary 27-Mar-96): ssfile line 1
1.2 (joe 28-Mar-96): ssfile line 2



The file ssssffiillee currently contains two lines. The ssssffiillee lliinnee 11 line was checked in by mmaarryy on March 27. Then, on March 28, jjooee added a line ssssffiillee lliinnee 22, without modifying the ssssffiillee lliinnee 11 line. This report doesn't tell you anything about lines which have been deleted or replaced; you need to use ccvvss ddiiffff for that (see node `diff' in the CVS manual).

The options to ccvvss aannnnoottaattee are listed in see node `Invoking CVS' in the CVS manual, and can be used to select the files and revisions to annotate. The options are described in more detail there and in see node `Common options' in the CVS manual.

checkout

Check out sources for editing



· Synopsis: checkout [options] modules...
· Requires: repository.
· Changes: working directory.
· Synonyms: co, get


Create or update a working directory containing copies of the source files specified by _m_o_d_u_l_e_s. You must execute cchheecckkoouutt before using most of the other ccvvss commands, since most of them operate on your working directory.

The _m_o_d_u_l_e_s are either symbolic names for some collection of source directories and files, or paths to directories or files in the repository. The symbolic names are defined in the mmoodduulleess file. see node `modules' in the CVS manual.

Depending on the modules you specify, cchheecckkoouutt 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 source repository.

Note that cchheecckkoouutt is used to create directories. The top-level directory created is always added to the directory where cchheecckkoouutt 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 cchheecckkoouutt will show the relative path leading to each file as it is extracted into your private work area (unless you specify the --QQ global option).

The files created by cchheecckkoouutt are created read-write, unless the --rr option to ccvvss (see node `Global options' in the CVS manual) is specified, the CCVVSSRREEAADD environment variable is specified (see node `Environment variables' in the CVS manual), or a watch is in effect for that file (see node `Watches' in the CVS manual).

Note that running cchheecckkoouutt on a directory that was already built by a prior cchheecckkoouutt is also permitted. This is similar to specifying the --dd option to the uuppddaattee command in the sense that new directories that have been created in the repository will appear in your work area. However, cchheecckkoouutt takes a module name whereas uuppddaattee takes a directory name. Also to use cchheecckkoouutt this way it must be run from the top level directory (where you originally ran cchheecckkoouutt from), so before you run cchheecckkoouutt to update an existing directory, don't forget to change your directory to the top level directory.

For the output produced by the cchheecckkoouutt command see see node `update output' in the CVS manual.

checkout options



These standard options are supported by cchheecckkoouutt (see node `Common options' in the CVS manual, for a complete description of them):

--DD _d_a_t_e
Use the most recent revision no later than _d_a_t_e.
This option is sticky, and implies --PP. See see node `Sticky tags' in the CVS manual, for more information on sticky tags/dates.

--ff
Only useful with the --DD _d_a_t_e or --rr <> _t_a_g flags. If no matching revision is found, retrieve the most recent revision (instead of ignoring the file).

--kk _k_f_l_a_g
Process keywords according to _k_f_l_a_g. See
see node `Keyword substitution' in the CVS manual. This option is sticky; future updates of this file in this working directory will use the same _k_f_l_a_g. The ssttaattuuss command can be viewed to see the sticky options. See see node `Invoking CVS' in the CVS manual, for more information on the ssttaattuuss command.

--ll
Local; run only in current working directory.


--nn
Do not run any checkout program (as specified
with the --oo option in the modules file; see node `modules' in the CVS manual).

--PP
Prune empty directories. See see node `Moving directories' in the CVS manual.


--pp
Pipe files to the standard output.


--RR
Checkout directories recursively. This option is on by default.


--rr _t_a_g
Use revision _t_a_g. This option is sticky, and implies --PP.
See see node `Sticky tags' in the CVS manual, for more information on sticky tags/dates.

In addition to those, you can use these special command options with cchheecckkoouutt:

--AA
Reset any sticky tags, dates, or --kk options.
Does not reset sticky --kk options on modified files. See see node `Sticky tags' in the CVS manual, for more information on sticky tags/dates.

--cc
Copy the module file, sorted, to the standard output,
instead of creating or modifying any files or directories in your working directory.

--dd _d_i_r
Create a directory called _d_i_r for the working
files, instead of using the module name. In general, using this flag is equivalent to using mmkkddiirr _d_i_r;; ccdd _d_i_r followed by the checkout command without the --dd flag.

There is an important exception, however. It is very convenient when checking out a single item to have the output appear in a directory that doesn't contain empty intermediate directories. In this case _o_n_l_y, ccvvss tries to ``shorten'' pathnames to avoid those empty directories.

For example, given a module ffoooo that contains the file bbaarr..cc, the command ccvvss ccoo --dd ddiirr ffoooo will create directory ddiirr and place bbaarr..cc inside. Similarly, given a module bbaarr which has subdirectory bbaazz wherein there is a file qquuuuxx..cc, the command ccvvss ccoo --dd ddiirr bbaarr//bbaazz will create directory ddiirr and place qquuuuxx..cc inside.

Using the --NN flag will defeat this behavior. Given the same module definitions above, ccvvss ccoo --NN --dd ddiirr ffoooo will create directories ddiirr//ffoooo and place bbaarr..cc inside, while ccvvss ccoo --NN --dd ddiirr bbaarr//bbaazz will create directories ddiirr//bbaarr//bbaazz and place qquuuuxx..cc inside.

--jj _t_a_g
With two --jj options, merge changes from the
revision specified with the first --jj option to the revision specified with the second jj option, into the working directory.

With one --jj option, merge changes from the ancestor revision to the revision specified with the --jj option, into the working directory. The ancestor revision is the common ancestor of the revision which the working directory is based on, and the revision specified in the --jj option.

In addition, each -j option can contain an 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: --jj_S_y_m_b_o_l_i_c___T_a_g::_D_a_t_e___S_p_e_c_i_f_i_e_r.

see node `Branching and merging' in the CVS manual.

--NN
Only useful together with --dd _d_i_r. With
this option, ccvvss will not ``shorten'' module paths in your working directory when you check out a single module. See the --dd flag for examples and a discussion.

--ss
Like --cc, but include the status of all modules,
and sort it by the status string. see node `modules' in the CVS manual, for info about the --ss option that is used inside the modules file to set the module status.

checkout examples



Get a copy of the module ttcc:



$ cvs checkout tc



Get a copy of the module ttcc as it looked one day ago:



$ cvs checkout -D yesterday tc



commit

Check files into the repository



· Synopsis: commit [-lRf] [-m 'log_message' |
-F file] [-r revision] [files...]
· Requires: working directory, repository.
· Changes: repository.
· Synonym: ci


Use ccoommmmiitt when you want to incorporate changes from your working source files into the source repository.

If you don't specify particular files to commit, all of the files in your working current directory are examined. ccoommmmiitt is careful to change in the repository only those files that you have really changed. By default (or if you explicitly specify the --RR option), files in subdirectories are also examined and committed if they have changed; you can use the --ll option to limit ccoommmmiitt to the current directory only.

ccoommmmiitt 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 uuppddaattee (see node `update' in the CVS manual). ccoommmmiitt does not call the uuppddaattee 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 (see node `modules' in the CVS manual, and see node `loginfo' in the CVS manual) and placed in the rrccss file inside the repository. This log message can be retrieved with the lloogg command; see see node `log' in the CVS manual. You can specify the log message on the command line with the --mm _m_e_s_s_a_g_e option, and thus avoid the editor invocation, or use the --FF _f_i_l_e option to specify that the argument file contains the log message.

commit options



These standard options are supported by ccoommmmiitt (see node `Common options' in the CVS manual, for a complete description of them):

--ll
Local; run only in current working directory.


--RR
Commit directories recursively. This is on by default.


--rr _r_e_v_i_s_i_o_n
Commit to _r_e_v_i_s_i_o_n. _r_e_v_i_s_i_o_n must be
either a branch, or a revision on the main trunk that is higher than any existing revision number (see node `Assigning revisions' in the CVS manual). You cannot commit to a specific revision on a branch.

ccoommmmiitt also supports these options:

--FF _f_i_l_e
Read the log message from _f_i_l_e, instead
of invoking an editor.

--ff
Note that this is not the standard behavior of
the --ff option as defined in see node `Common options' in the CVS manual.

Force ccvvss to commit a new revision even if you haven't made any changes to the file. If the current revision of _f_i_l_e is 1.7, then the following two commands are equivalent:



$ cvs commit -f _f_i_l_e
$ cvs commit -r 1.8 _f_i_l_e



The --ff option disables recursion (i.e., it implies --ll). To force ccvvss to commit a new revision for all files in all subdirectories, you must use --ff --RR.

--mm _m_e_s_s_a_g_e
Use _m_e_s_s_a_g_e as the log message, instead of
invoking an editor.

commit examples



Committing to a branch



You can commit to a branch revision (one that has an even number of dots) with the --rr option. To create a branch revision, use the --bb option of the rrttaagg or ttaagg commands (see node `Branching and merging' in the CVS manual). Then, either cchheecckkoouutt or uuppddaattee can be used to base your sources on the newly created branch. From that point on, all ccoommmmiitt changes made within these working sources will be automatically added to a branch revision, thereby not disturbing 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:



$ cvs rtag -b -r FCS1_2 FCS1_2_Patch product_module
$ cvs checkout -r FCS1_2_Patch product_module
$ cd product_module
[[ hack away ]]
$ cvs commit



This works automatically since the --rr option is sticky.

Creating the branch after editing



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 ccvvss conflict resolution. The scenario might look like:



[[ hacked sources are present ]]
$ cvs tag -b EXPR1
$ cvs update -r EXPR1
$ cvs commit



The uuppddaattee command will make the --rr EEXXPPRR11 option sticky on all files. Note that your changes to the files will never be removed by the uuppddaattee command. The ccoommmmiitt will automatically commit to the correct branch, because the --rr is sticky. You could also do like this:



[[ hacked sources are present ]]
$ cvs tag -b EXPR1
$ cvs commit -r EXPR1



but then, only those files that were changed by you will have the --rr EEXXPPRR11 sticky flag. If you hack away, and commit without specifying the --rr EEXXPPRR11 flag, some files may accidentally end up on the main trunk.

To work with you on the experimental change, others would simply do



$ cvs checkout -r EXPR1 whatever_module



diff

Show differences between revisions



· Synopsis: diff [-lR] [-k kflag] [format_options] [[-r rev1 | -D date1] [-r rev2 | -D date2]] [files...]
· Requires: working directory, repository.
· Changes: nothing.


The ddiiffff command is used to compare different revisions of files. The default action is to compare your working files with the revisions they were based on, and report any differences that are found.

If any file names are given, only those files are compared. If any directories are given, all files under them will be compared.

The exit status for diff is different than for other ccvvss commands; for details see node `Exit status' in the CVS manual.

diff options



These standard options are supported by ddiiffff (see node `Common options' in the CVS manual, for a complete description of them):

--DD _d_a_t_e
Use the most recent revision no later than _d_a_t_e.
See --rr for how this affects the comparison.

--kk _k_f_l_a_g
Process keywords according to _k_f_l_a_g. See
see node `Keyword substitution' in the CVS manual.

--ll
Local; run only in current working directory.


--RR
Examine directories recursively. This option is on by
default.

--rr _t_a_g
Compare with revision _t_a_g. Zero, one or two
--rr options can be present. With no --rr option, the working file will be compared with the revision it was based on. With one --rr, that revision will be compared to your current working file. With two --rr options those two revisions will be compared (and your working file will not affect the outcome in any way).

One or both --rr options can be replaced by a --DD _d_a_t_e option, described above.

The following options specify the format of the output. They have the same meaning as in GNU diff. Most options have two equivalent names, one of which is a single letter preceded by --, and the other of which is a long name preceded by ----.

--_l_i_n_e_s
Show _l_i_n_e_s (an integer) lines of context. This option does not
specify an output format by itself; it has no effect unless it is combined with --cc or --uu. This option is obsolete. For proper operation, ppaattcchh typically needs at least two lines of context.

--aa
Treat all files as text and compare them line-by-line, even if they
do not seem to be text.

--bb
Ignore trailing white space and consider all other sequences of one or
more white space characters to be equivalent.

--BB
Ignore changes that just insert or delete blank lines.


----bbiinnaarryy
Read and write data in binary mode.


----bbrriieeff
Report only whether the files differ, not the details of the
differences.

--cc
Use the context output format.


--CC _l_i_n_e_s
----ccoonntteexxtt[==_l_i_n_e_s]
Use the context output format, showing _l_i_n_e_s (an integer) lines of
context, or three if _l_i_n_e_s is not given. For proper operation, ppaattcchh typically needs at least two lines of context.

----cchhaannggeedd--ggrroouupp--ffoorrmmaatt==_f_o_r_m_a_t
Use _f_o_r_m_a_t to output a line group containing differing lines from
both files in if-then-else format. see node `Line group formats' in the CVS manual.

--dd
Change the algorithm to perhaps find a smaller set of changes. This makes
ddiiffff slower (sometimes much slower).

--ee
----eedd
Make output that is a valid eedd script.


----eexxppaanndd--ttaabbss
Expand tabs to spaces in the output, to preserve the alignment of tabs
in the input files.

--ff
Make output that looks vaguely like an eedd script but has changes
in the order they appear in the file.

--FF _r_e_g_e_x_p
In context and unified format, for each hunk of differences, show some
of the last preceding line that matches _r_e_g_e_x_p.

----ffoorrwwaarrdd--eedd
Make output that looks vaguely like an eedd script but has changes
in the order they appear in the file.

--HH
Use heuristics to speed handling of large files that have numerous
scattered small changes.

----hhoorriizzoonn--lliinneess==_l_i_n_e_s
Do not discard the last _l_i_n_e_s lines of the common prefix
and the first _l_i_n_e_s lines of the common suffix.

--ii
Ignore changes in case; consider upper- and lower-case letters
equivalent.

--II _r_e_g_e_x_p
Ignore changes that just insert or delete lines that match _r_e_g_e_x_p.


----iiffddeeff==_n_a_m_e
Make merged if-then-else output using _n_a_m_e.


----iiggnnoorree--aallll--ssppaaccee
Ignore white space when comparing lines.


----iiggnnoorree--bbllaannkk--lliinneess
Ignore changes that just insert or delete blank lines.


----iiggnnoorree--ccaassee
Ignore changes in case; consider upper- and lower-case to be the same.


----iiggnnoorree--mmaattcchhiinngg--lliinneess==_r_e_g_e_x_p
Ignore changes that just insert or delete lines that match _r_e_g_e_x_p.


----iiggnnoorree--ssppaaccee--cchhaannggee
Ignore trailing white space and consider all other sequences of one or
more white space characters to be equivalent.

----iinniittiiaall--ttaabb
Output a tab rather than a space before the text of a line in normal or
context format. This causes the alignment of tabs in the line to look normal.

--LL _l_a_b_e_l
Use _l_a_b_e_l instead of the file name in the context format
and unified format headers.

----llaabbeell==_l_a_b_e_l
Use _l_a_b_e_l instead of the file name in the context format
and unified format headers.

----lleefftt--ccoolluummnn
Print only the left column of two common lines in side by side format.


----lliinnee--ffoorrmmaatt==_f_o_r_m_a_t
Use _f_o_r_m_a_t to output all input lines in if-then-else format.
see node `Line formats' in the CVS manual.

----mmiinniimmaall
Change the algorithm to perhaps find a smaller set of changes. This
makes ddiiffff slower (sometimes much slower).

--nn
Output RCS-format diffs; like --ff except that each command
specifies the number of lines affected.

--NN
----nneeww--ffiillee
In directory comparison, if a file is found in only one directory,
treat it as present but empty in the other directory.

----nneeww--ggrroouupp--ffoorrmmaatt==_f_o_r_m_a_t
Use _f_o_r_m_a_t to output a group of lines taken from just the second
file in if-then-else format. see node `Line group formats' in the CVS manual.

----nneeww--lliinnee--ffoorrmmaatt==_f_o_r_m_a_t
Use _f_o_r_m_a_t to output a line taken from just the second file in
if-then-else format. see node `Line formats' in the CVS manual.

----oolldd--ggrroouupp--ffoorrmmaatt==_f_o_r_m_a_t
Use _f_o_r_m_a_t to output a group of lines taken from just the first
file in if-then-else format. see node `Line group formats' in the CVS manual.

----oolldd--lliinnee--ffoorrmmaatt==_f_o_r_m_a_t
Use _f_o_r_m_a_t to output a line taken from just the first file in
if-then-else format. see node `Line formats' in the CVS manual.

--pp
Show which C function each change is in.


----rrccss
Output RCS-format diffs; like --ff except that each command
specifies the number of lines affected.

----rreeppoorrtt--iiddeennttiiccaall--ffiilleess
--ss
Report when two files are the same.


----sshhooww--cc--ffuunnccttiioonn
Show which C function each change is in.


----sshhooww--ffuunnccttiioonn--lliinnee==_r_e_g_e_x_p
In context and unified format, for each hunk of differences, show some
of the last preceding line that matches _r_e_g_e_x_p.

----ssiiddee--bbyy--ssiiddee
Use the side by side output format.


----ssppeeeedd--llaarrggee--ffiilleess
Use heuristics to speed handling of large files that have numerous
scattered small changes.

----ssuupppprreessss--ccoommmmoonn--lliinneess
Do not print common lines in side by side format.


--tt
Expand tabs to spaces in the output, to preserve the alignment of tabs
in the input files.

--TT
Output a tab rather than a space before the text of a line in normal or
context format. This causes the alignment of tabs in the line to look normal.

----tteexxtt
Treat all files as text and compare them line-by-line, even if they
do not appear to be text.

--uu
Use the unified output format.


----uunncchhaannggeedd--ggrroouupp--ffoorrmmaatt==_f_o_r_m_a_t
Use _f_o_r_m_a_t to output a group of common lines taken from both files
in if-then-else format. see node `Line group formats' in the CVS manual.

----uunncchhaannggeedd--lliinnee--ffoorrmmaatt==_f_o_r_m_a_t
Use _f_o_r_m_a_t to output a line common to both files in if-then-else
format. see node `Line formats' in the CVS manual.

--UU _l_i_n_e_s
----uunniiffiieedd[==_l_i_n_e_s]
Use the unified output format, showing _l_i_n_e_s (an integer) lines of
context, or three if _l_i_n_e_s is not given. For proper operation, ppaattcchh typically needs at least two lines of context.

--ww
Ignore white space when comparing lines.


--WW _c_o_l_u_m_n_s
----wwiiddtthh==_c_o_l_u_m_n_s
Use an output width of _c_o_l_u_m_n_s in side by side format.


--yy
Use the side by side output format.


Line group formats



Line group formats let you specify formats suitable for many applications that allow if-then-else input, including programming languages and text formatting languages. A line group format specifies the output format for a contiguous group of similar lines.

For example, the following command compares the TeX file mmyyffiillee with the original version from the repository, and outputs a merged file in which old regions are surrounded by \\bbeeggiinn{{eemm}}-\\eenndd{{eemm}} lines, and new regions are surrounded by \\bbeeggiinn{{bbff}}-\\eenndd{{bbff}} lines.



cvs diff \
--old-group-format='\begin{em}
%<\end{em}
' \
--new-group-format='\begin{bf}
%>\end{bf}
' \
myfile



The following command is equivalent to the above example, but it is a little more verbose, because it spells out the default line group formats.



cvs diff \
--old-group-format='\begin{em}
%<\end{em}
' \
--new-group-format='\begin{bf}
%>\end{bf}
' \
--unchanged-group-format='%=' \
--changed-group-format='\begin{em}
%<\end{em}
\begin{bf}
%>\end{bf}
' \
myfile



Here is a more advanced example, which outputs a diff listing with headers containing line numbers in a ``plain English'' style.



cvs diff \
--unchanged-group-format='' \
--old-group-format='-------- %dn line%(n=1?:s) deleted at %df:
%<' \
--new-group-format='-------- %dN line%(N=1?:s) added after %de:
%>' \
--changed-group-format='-------- %dn line%(n=1?:s) changed at %df:
%<-------- to:
%>' \
myfile



To specify a line group format, use one of the options listed below. You can specify up to four line group formats, one for each kind of line group. You should quote _f_o_r_m_a_t, because it typically contains shell metacharacters.

----oolldd--ggrroouupp--ffoorrmmaatt==_f_o_r_m_a_t
These line groups are hunks containing only lines from the first file.
The default old group format is the same as the changed group format if it is specified; otherwise it is a format that outputs the line group as-is.

----nneeww--ggrroouupp--ffoorrmmaatt==_f_o_r_m_a_t
These line groups are hunks containing only lines from the second
file. The default new group format is same as the changed group format if it is specified; otherwise it is a format that outputs the line group as-is.

----cchhaannggeedd--ggrroouupp--ffoorrmmaatt==_f_o_r_m_a_t
These line groups are hunks containing lines from both files. The
default changed group format is the concatenation of the old and new group formats.

----uunncchhaannggeedd--ggrroouupp--ffoorrmmaatt==_f_o_r_m_a_t
These line groups contain lines common to both files. The default
unchanged group format is a format that outputs the line group as-is.

In a line group format, ordinary characters represent themselves; conversion specifications start with %% and have one of the following forms.

%%<<
stands for the lines from the first file, including the trailing newline.
Each line is formatted according to the old line format (see node `Line formats' in the CVS manual).

%%>>
stands for the lines from the second file, including the trailing newline.
Each line is formatted according to the new line format.

%%==
stands for the lines common to both files, including the trailing newline.
Each line is formatted according to the unchanged line format.

%%%%
stands for %%.


%%cc''_C''
where _C is a single character, stands for _C.
_C may not be a backslash or an apostrophe. For example, %%cc''::'' stands for a colon, even inside the then-part of an if-then-else format, which a colon would normally terminate.

%%cc''\\_O''
where _O is a string of 1, 2, or 3 octal digits,
stands for the character with octal code _O. For example, %%cc''\\00'' stands for a null character.

_F_n
where _F is a pprriinnttff conversion specification and _n is one
of the following letters, stands for _n's value formatted with _F.

ee
The line number of the line just before the group in the old file.


ff
The line number of the first line in the group in the old file;
equals _e + 1.

ll
The line number of the last line in the group in the old file.


mm
The line number of the line just after the group in the old file;
equals _l + 1.

nn
The number of lines in the group in the old file; equals _l - _f + 1.


EE,, FF,, LL,, MM,, NN
Likewise, for lines in the new file.




The pprriinnttff conversion specification can be %%dd, %%oo, %%xx, or %%XX, specifying decimal, octal, lower case hexadecimal, or upper case hexadecimal output respectively. After the %% the following options can appear in sequence: a -- specifying left-justification; an integer specifying the minimum field width; and a period followed by an optional integer specifying the minimum number of digits. For example, %%55ddNN prints the number of new lines in the group in a field of width 5 characters, using the pprriinnttff format ""%%55dd"".

((_A==_B??_T::_E))
If _A equals _B then _T else _E.
_A and _B are each either a decimal constant or a single letter interpreted as above. This format spec is equivalent to _T if _A's value equals _B's; otherwise it is equivalent to _E.

For example, %%((NN==00??nnoo::%%ddNN)) lliinnee%%((NN==11??::ss)) is equivalent to nnoo lliinneess if _N (the number of lines in the group in the new file) is 0, to 11 lliinnee if _N is 1, and to %%ddNN lliinneess otherwise.

Line formats



Line formats control how each line taken from an input file is output as part of a line group in if-then-else format.

For example, the following command outputs text with a one-column change indicator to the left of the text. The first column of output is -- for deleted lines, || for added lines, and a space for unchanged lines. The formats contain newline characters where newlines are desired on output.



cvs diff \
--old-line-format='-%l
' \
--new-line-format='|%l
' \
--unchanged-line-format=' %l
' \
myfile



To specify a line format, use one of the following options. You should quote _f_o_r_m_a_t, since it often contains shell metacharacters.

----oolldd--lliinnee--ffoorrmmaatt==_f_o_r_m_a_t
formats lines just from the first file.


----nneeww--lliinnee--ffoorrmmaatt==_f_o_r_m_a_t
formats lines just from the second file.


----uunncchhaannggeedd--lliinnee--ffoorrmmaatt==_f_o_r_m_a_t
formats lines common to both files.


----lliinnee--ffoorrmmaatt==_f_o_r_m_a_t
formats all lines; in effect, it sets all three above options simultaneously.


In a line format, ordinary characters represent themselves; conversion specifications start with %% and have one of the following forms.

%%ll
stands for the contents of the line, not counting its trailing
newline (if any). This format ignores whether the line is incomplete.

%%LL
stands for the contents of the line, including its trailing newline
(if any). If a line is incomplete, this format preserves its incompleteness.

%%%%
stands for %%.


%%cc''_C''
where _C is a single character, stands for _C.
_C may not be a backslash or an apostrophe. For example, %%cc''::'' stands for a colon.

%%cc''\\_O''
where _O is a string of 1, 2, or 3 octal digits,
stands for the character with octal code _O. For example, %%cc''\\00'' stands for a null character.

_Fnn
where _F is a pprriinnttff conversion specification,
stands for the line number formatted with _F. For example, %%..55ddnn prints the line number using the pprriinnttff format ""%%..55dd"". see node `Line group formats' in the CVS manual, for more about printf conversion specifications.



The default line format is %%ll followed by a newline character.

If the input contains tab characters and it is important that they line up on output, you should ensure that %%ll or %%LL in a line format is just after a tab stop (e.g. by preceding %%ll or %%LL with a tab character), or you should use the --tt or ----eexxppaanndd--ttaabbss option.

Taken together, the line and line group formats let you specify many different formats. For example, the following command uses a format similar to ddiiffff's normal format. You can tailor this command to get fine control over ddiiffff's output.



cvs diff \
--old-line-format='< %l
' \
--new-line-format='> %l
' \
--old-group-format='%df%(f=l?:,%dl)d%dE
%<' \
--new-group-format='%dea%dF%(F=L?:,%dL)
%>' \
--changed-group-format='%df%(f=l?:,%dl)c%dF%(F=L?:,%dL)
%<--
%>' \
--unchanged-group-format='' \
myfile



diff examples



The following line produces a Unidiff (--uu flag) between revision 1.14 and 1.19 of bbaacckkeenndd..cc. Due to the --kkkk flag no keywords are substituted, so differences that only depend on keyword substitution are ignored.



$ cvs diff -kk -u -r 1.14 -r 1.19 backend.c



Suppose the experimental branch EXPR1 was based on a set of files tagged RELEASE_1_0. To see what has happened on that branch, the following can be used:



$ cvs diff -r RELEASE_1_0 -r EXPR1



A command like this can be used to produce a context diff between two releases:



$ cvs diff -c -r RELEASE_1_0 -r RELEASE_1_1 > diffs



If you are maintaining ChangeLogs, a command like the following just before you commit your changes may help you write the ChangeLog entry. All local modifications that have not yet been committed will be printed.



$ cvs diff -u | less



export

Export sources from CVS, similar to checkout



· Synopsis: export [-flNnR] [-r rev|-D date] [-k subst] [-d dir] module...
· Requires: repository.
· Changes: current directory.


This command is a variant of cchheecckkoouutt; use it when you want a copy of the source for module without the ccvvss administrative directories. For example, you might use eexxppoorrtt to prepare source for shipment off-site. This command requires that you specify a date or tag (with --DD or --rr), so that you can count on reproducing the source you ship to others (and thus it always prunes empty directories).

One often would like to use --kkvv with ccvvss eexxppoorrtt. This causes any keywords to be expanded such that an import done at some other site will not lose the keyword revision information. But be aware that doesn't handle an export containing binary files correctly. Also be aware that after having used --kkvv, one can no longer use the iiddeenntt command (which is part of the rrccss suite--see ident(1)) which looks for keyword strings. If you want to be able to use iiddeenntt you must not use --kkvv.

export options



These standard options are supported by eexxppoorrtt (see node `Common options' in the CVS manual, for a complete description of them):

--DD _d_a_t_e
Use the most recent revision no later than _d_a_t_e.


--ff
If no matching revision is found, retrieve the most
recent revision (instead of ignoring the file).

--ll
Local; run only in current working directory.


--nn
Do not run any checkout program.


--RR
Export directories recursively. This is on by default.


--rr _t_a_g
Use revision _t_a_g.


In addition, these options (that are common to cchheecckkoouutt and eexxppoorrtt) are also supported:

--dd _d_i_r
Create a directory called _d_i_r for the working
files, instead of using the module name. see node `checkout options' in the CVS manual, for complete details on how ccvvss handles this flag.

--kk _s_u_b_s_t
Set keyword expansion mode (see node `Substitution modes' in the CVS manual).


--NN
Only useful together with --dd _d_i_r.
see node `checkout options' in the CVS manual, for complete details on how ccvvss handles this flag.

history

Show status of files and users



· Synopsis: history [-report] [-flags] [-options args] [files...]
· Requires: the file $$CCVVSSRROOOOTT//CCVVSSRROOOOTT//hhiissttoorryy
· Changes: nothing.


ccvvss can keep a history file that tracks each use of the cchheecckkoouutt, ccoommmmiitt, rrttaagg, uuppddaattee, and rreelleeaassee commands. You can use hhiissttoorryy to display this information in various formats.

Logging must be enabled by creating the file $$CCVVSSRROOOOTT//CCVVSSRROOOOTT//hhiissttoorryy.

hhiissttoorryy uusseess --ff,, --ll,, --nn,, aanndd --pp iinn wwaayyss tthhaatt ccoonnfflliicctt wwiitthh tthhee nnoorrmmaall uussee iinnssiiddee ccvvss ((sseeee nnooddee ``CCoommmmoonn ooppttiioonnss'' iinn tthhee CCVVSS mmaannuuaall))..

history options



Several options (shown above as --rreeppoorrtt) control what kind of report is generated:

--cc
Report on each time commit was used (i.e., each time
the repository was modified).

--ee
Everything (all record types). Equivalent to
specifying --xx with all record types. Of course, --ee will also include record types which are added in a future version of ccvvss; if you are writing a script which can only handle certain record types, you'll want to specify --xx.

--mm _m_o_d_u_l_e
Report on a particular module. (You can meaningfully
use --mm more than once on the command line.)

--oo
Report on checked-out modules. This is the default report type.


--TT
Report on all tags.


--xx _t_y_p_e
Extract a particular set of record types _t_y_p_e from the ccvvss
history. The types are indicated by single letters, which you may specify in combination.

Certain commands have a single record type:

FF
release
OO
checkout
EE
export
TT
rtag


One of five record types may result from an update:

CC
A merge was necessary but collisions were
detected (requiring manual merging).
GG
A merge was necessary and it succeeded.
UU
A working file was copied from the repository.
PP
A working file was patched to match the repository.
WW
The working copy of a file was deleted during
update (because it was gone from the repository).

One of three record types results from commit:

AA
A file was added for the first time.
MM
A file was modified.
RR
A file was removed.


The options shown as --ffllaaggss constrain or expand the report without requiring option arguments:

--aa
Show data for all users (the default is to show data
only for the user executing hhiissttoorryy).

--ll
Show last modification only.


--ww
Show only the records for modifications done from the
same working directory where hhiissttoorryy is executing.

The options shown as --ooppttiioonnss _a_r_g_s constrain the report based on an argument:

--bb _s_t_r
Show data back to a record containing the string
_s_t_r in either the module name, the file name, or the repository path.

--DD _d_a_t_e
Show data since _d_a_t_e. This is slightly different
from the normal use of --DD _d_a_t_e, which selects the newest revision older than _d_a_t_e.

--ff _f_i_l_e
Show data for a particular file
(you can specify several --ff options on the same command line). This is equivalent to specifying the file on the command line.

--nn _m_o_d_u_l_e
Show data for a particular module
(you can specify several --nn options on the same command line).

--pp _r_e_p_o_s_i_t_o_r_y
Show data for a particular source repository (you
can specify several --pp options on the same command line).

--rr _r_e_v
Show records referring to revisions since the revision
or tag named _r_e_v appears in individual rrccss files. Each rrccss file is searched for the revision or tag.

--tt _t_a_g
Show records since tag _t_a_g was last added to the
history file. This differs from the --rr flag above in that it reads only the history file, not the rrccss files, and is much faster.

--uu _n_a_m_e
Show records for user _n_a_m_e.


--zz _t_i_m_e_z_o_n_e
Show times in the selected records using the specified
time zone instead of UTC.

import

Import sources into CVS, using vendor branches



· Synopsis: import [-options] repository vendortag releasetag...
· Requires: Repository, source distribution directory.
· Changes: repository.


Use iimmppoorrtt 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 from the outside source. see node `Tracking sources' in the CVS manual, for a discussion on this subject.

The _r_e_p_o_s_i_t_o_r_y argument gives a directory name (or a path to a directory) under the ccvvss 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 cchheecckkoouutt --jj to reconcile the differences, as import instructs you to do.

If ccvvss decides a file should be ignored (see node `cvsignore' in the CVS manual), it does not import it and prints II followed by the filename (see node `import output' in the CVS manual, for a complete description of the output).

If the file $$CCVVSSRROOOOTT//CCVVSSRROOOOTT//ccvvsswwrraappppeerrss exists, any file whose names match the specifications in that file will be treated as packages and the appropriate filtering will be performed on the file/directory before being imported. see node `Wrappers' in the CVS manual.

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. _r_e_p_o_s_i_t_o_r_y is needed to identify the collection of source. _v_e_n_d_o_r_t_a_g is a tag for the entire branch (e.g., for 1.1.1). You must also specify at least one _r_e_l_e_a_s_e_t_a_g to uniquely identify the files at the leaves created each time you execute iimmppoorrtt. The _r_e_l_e_a_s_e_t_a_g should be new, not previously existing in the repository file, and uniquely identify the imported release,

Note that iimmppoorrtt does _n_o_t change the directory in which you invoke it. In particular, it does not set up that directory as a ccvvss working directory; if you want to work with the sources import them first and then check them out into a different directory (see node `Getting the source' in the CVS manual).

import options



This standard option is supported by iimmppoorrtt (see node `Common options' in the CVS manual, for a complete description):

--mm _m_e_s_s_a_g_e
Use _m_e_s_s_a_g_e as log information, instead of
invoking an editor.

There are the following additional special options.

--bb _b_r_a_n_c_h
See see node `Multiple vendor branches' in the CVS manual.


--kk _s_u_b_s_t
Indicate the keyword expansion mode desired. This
setting will apply to all files created during the import, but not to any files that previously existed in the repository. See see node `Substitution modes' in the CVS manual, for a list of valid --kk settings.

--II _n_a_m_e
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 !'.

_n_a_m_e can be a file name pattern of the same type that you can specify in the ..ccvvssiiggnnoorree file. see node `cvsignore' in the CVS manual.

--WW _s_p_e_c
Specify file names that should be filtered during
import. You can use this option repeatedly.

_s_p_e_c can be a file name pattern of the same type that you can specify in the ..ccvvsswwrraappppeerrss file. see node `Wrappers' in the CVS manual.

import output



iimmppoorrtt keeps you informed of its progress by printing a line for each file, preceded by one character indicating the status of the file:

UU _f_i_l_e
The file already exists in the repository and has not been locally
modified; a new revision has been created (if necessary).

NN _f_i_l_e
The file is a new file which has been added to the repository.


CC _f_i_l_e
The file already exists in the repository but has been locally modified;
you will have to merge the changes.

II _f_i_l_e
The file is being ignored (see node `cvsignore' in the CVS manual).


LL _f_i_l_e
The file is a symbolic link; ccvvss iimmppoorrtt ignores symbolic links.
People periodically suggest that this behavior should be changed, but if there is a consensus on what it should be changed to, it doesn't seem to be apparent. (Various options in the mmoodduulleess file can be used to recreate symbolic links on checkout, update, etc.; see node `modules' in the CVS manual.)

import examples



See see node `Tracking sources' in the CVS manual, and see node `From files' in the CVS manual.

log

Print out log information for files



· Synopsis: log [options] [files...]
· Requires: repository, working directory.
· Changes: nothing.


Display log information for files. lloogg used to call the rrccss utility rrlloogg. Although this is no longer true in the current sources, this history determines the format of the output and the options, which are not quite in the style of the other ccvvss commands.

The output includes the location of the rrccss file, the _h_e_a_d revision (the latest revision on the trunk), all symbolic names (tags) and some other things. For each revision, the revision number, the author, the number of lines added/deleted and the log message are printed. All times are displayed in Coordinated Universal Time (UTC). (Other parts of ccvvss print times in the local timezone).

lloogg uusseess --RR iinn aa wwaayy tthhaatt ccoonnfflliiccttss wwiitthh tthhee nnoorrmmaall uussee iinnssiiddee ccvvss ((sseeee nnooddee ``CCoommmmoonn ooppttiioonnss'' iinn tthhee CCVVSS mmaannuuaall))..

log options



By default, lloogg prints all information that is available. All other options restrict the output. Note that the revision selection options (--dd, --rr, --ss, and --ww) have no effect, other than possibly causing a search for files in Attic directories, when used in conjunction with the options that restrict the output to only lloogg header fields (--bb, --hh, --RR, and --tt) unless the --SS option is also specified.

--bb
Print information about the revisions on the default
branch, normally the highest branch on the trunk.

--dd _d_a_t_e_s
Print information about revisions with a checkin
date/time in the range given by the semicolon-separated list of dates. The date formats accepted are those accepted by the --DD option to many other ccvvss commands (see node `Common options' in the CVS manual). Dates can be combined into ranges as follows:

_d_1<<_d_2
_d_2>>_d_1
Select the revisions that were deposited between
_d_1 and _d_2.

<<_d
_d>>
Select all revisions dated _d or earlier.


_d<<
>>_d
Select all revisions dated _d or later.


_d
Select the single, latest revision dated _d or
earlier.

The >> or << characters may be followed by == to indicate an inclusive range rather than an exclusive one.

Note that the separator is a semicolon (;).

--hh
Print only the name of the rrccss file, name
of the file in the working directory, head, default branch, access list, locks, symbolic names, and suffix.

--ll
Local; run only in current working directory. (Default
is to run recursively).

--NN
Do not print the list of tags for this file. This
option can be very useful when your site uses a lot of tags, so rather than "more"'ing over 3 pages of tag information, the log information is presented without tags at all.

--RR
Print only the name of the rrccss file.


--rr_r_e_v_i_s_i_o_n_s
Print information about revisions given in the
comma-separated list _r_e_v_i_s_i_o_n_s of revisions and ranges. The following table explains the available range formats:

_r_e_v_1::_r_e_v_2
Revisions _r_e_v_1 to _r_e_v_2 (which must be on
the same branch).

_r_e_v_1::::_r_e_v_2
The same, but excluding _r_e_v_1.


::_r_e_v
::::_r_e_v
Revisions from the beginning of the branch up to
and including _r_e_v.

_r_e_v::
Revisions starting with _r_e_v to the end of the
branch containing _r_e_v.

_r_e_v::::
Revisions starting just after _r_e_v to the end of the
branch containing _r_e_v.

_b_r_a_n_c_h
An argument that is a branch means all revisions on
that branch.

_b_r_a_n_c_h_1::_b_r_a_n_c_h_2
_b_r_a_n_c_h_1::::_b_r_a_n_c_h_2
A range of branches means all revisions
on the branches in that range.

_b_r_a_n_c_h..
The latest revision in _b_r_a_n_c_h.


A bare --rr with no revisions means the latest revision on the default branch, normally the trunk. There can be no space between the --rr option and its argument.

--SS
Suppress the header if no revisions are selected.


--ss _s_t_a_t_e_s
Print information about revisions whose state
attributes match one of the states given in the comma-separated list _s_t_a_t_e_s. Individual states may be any text string, though ccvvss commonly only uses two states, EExxpp and ddeeaadd. See see node `admin options' in the CVS manual for more information.

--tt
Print the same as --hh, plus the descriptive text.


--ww_l_o_g_i_n_s
Print information about revisions checked in by users
with login names appearing in the comma-separated list _l_o_g_i_n_s. If _l_o_g_i_n_s is omitted, the user's login is assumed. There can be no space between the --ww option and its argument.

lloogg prints the intersection of the revisions selected with the options --dd, --ss, and --ww, intersected with the union of the revisions selected by --bb and --rr.

log examples



Contributed examples are gratefully accepted.

rdiff

'patch' format diffs between releases



· 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 ppaattcchh program to bring an old release up-to-date with the new release. (This is one of the few ccvvss 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 --rr and --DD 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 rrccss file.

Note that if the software release affected is contained in more than one directory, then it may be necessary to specify the --pp option to the ppaattcchh command when patching the old sources, so that ppaattcchh is able to find the files that are located in other directories.

rdiff options



These standard options are supported by rrddiiffff (see node `Common options' in the CVS manual, for a complete description of them):

--DD _d_a_t_e
Use the most recent revision no later than _d_a_t_e.


--ff
If no matching revision is found, retrieve the most
recent revision (instead of ignoring the file).

--kk _k_f_l_a_g
Process keywords according to _k_f_l_a_g. See
see node `Keyword substitution' in the CVS manual.

--ll
Local; don't descend subdirectories.


--pp
Show which C function each change is in.


--RR
Examine directories recursively. This option is on by default.


--rr _t_a_g
Use revision _t_a_g.


In addition to the above, these options are available:

--cc
Use the context diff format. This is the default format.


--ss
Create a summary change report instead of a patch. The
summary includes information about files that were changed or added between the releases. It is sent to the standard output device. This is useful for finding out, for example, which files have changed between two dates or revisions.

--tt
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.

--uu
Use the unidiff format for the context diffs.
Remember that old versions of the ppaattcchh program can't handle the unidiff format, so if you plan to post this patch to the net you should probably not use --uu.

--VV _v_n
Expand keywords according to the rules current in
rrccss version _v_n (the expansion format changed with rrccss version 5). Note that this option is no longer accepted. ccvvss will always expand keywords the way that rrccss version 5 does.

rdiff examples



Suppose you receive mail from foo@example.net asking for an update from release 1.2 to 1.4 of the tc compiler. You have no such patches on hand, but with ccvvss that can easily be fixed with a command such as this:



$ cvs rdiff -c -r FOO1_2 -r FOO1_4 tc | \
$$ Mail -s 'The patches you asked for' foo@example.net



Suppose you have made release 1.3, and forked a branch called RR__11__33ffiixx for bug fixes. RR__11__33__11 corresponds to release 1.3.1, which was made some time ago. Now, you want to see how much development has been done on the branch. This command can be used:



$ cvs patch -s -r R_1_3_1 -r R_1_3fix module-name
cvs rdiff: Diffing module-name
File ChangeLog,v changed from revision 1.52.2.5 to 1.52.2.6
File foo.c,v changed from revision 1.52.2.3 to 1.52.2.4
File bar.h,v changed from revision 1.29.2.1 to 1.2



release

Indicate that a Module is no longer in use



· release [-d] directories...
· Requires: Working directory.
· Changes: Working directory, history log.


This command is meant to safely cancel the effect of ccvvss cchheecckkoouutt. Since ccvvss 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 ccvvss history file (see node `history file' in the CVS manual) that you've abandoned your checkout.

Use ccvvss rreelleeaassee to avoid these problems. This command checks that no uncommitted changes are present; that you are executing it from immediately above a ccvvss 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, ccvvss rreelleeaassee leaves a record of its execution (attesting to your intentionally abandoning your checkout) in the ccvvss history log.

release options



The rreelleeaassee command supports one command option:

--dd
Delete your working copy of the file if the release
succeeds. If this flag is not given your files will remain in your working directory.

WWAARRNNIINNGG:: TThhee rreelleeaassee ccoommmmaanndd ddeelleetteess aallll ddiirreeccttoorriieess aanndd ffiilleess rreeccuurrssiivveellyy.. TThhiiss hhaass tthhee vveerryy sseerriioouuss ssiiddee--eeffffeecctt tthhaatt aannyy ddiirreeccttoorryy tthhaatt yyoouu hhaavvee ccrreeaatteedd iinnssiiddee yyoouurr cchheecckkeedd--oouutt ssoouurrcceess,, aanndd nnoott aaddddeedd ttoo tthhee rreeppoossiittoorryy ((uussiinngg tthhee aadddd ccoommmmaanndd;; sseeee nnooddee ``AAddddiinngg ffiilleess'' iinn tthhee CCVVSS mmaannuuaall)) wwiillll bbee ssiilleennttllyy ddeelleetteedd----eevveenn iiff iitt iiss nnoonn--eemmppttyy!!

release output



Before rreelleeaassee releases your sources it will print a one-line message for any file that is not up-to-date.

UU _f_i_l_e
PP _f_i_l_e
There exists a newer revision of this file in the
repository, and you have not modified your local copy of the file (UU and PP mean the same thing).

AA _f_i_l_e
The file has been added to your private copy of the
sources, but has not yet been committed to the repository. If you delete your copy of the sources this file will be lost.

RR _f_i_l_e
The file has been removed from your private copy of the
sources, but has not yet been removed from the repository, since you have not yet committed the removal. see node `commit' in the CVS manual.

MM _f_i_l_e
The file is modified in your working directory. There
might also be a newer revision inside the repository.

?? _f_i_l_e
_f_i_l_e is in your working directory, but does not
correspond to anything in the source repository, and is not in the list of files for ccvvss to ignore (see the description of the --II option, and see node `cvsignore' in the CVS manual). If you remove your working sources, this file will be lost.

release examples



Release the ttcc directory, and delete your local working copy of the files.



$ cd .. # You must stand immediately above the
# sources when you issue ccvvss rreelleeaassee.
$ cvs release -d tc
You have [0] altered files in this repository.
Are you sure you want to release (and delete) directory `tc': y
$



update

Bring work tree in sync with repository



· update [-ACdflPpR] [-I name] [-j rev [-j rev]] [-k kflag] [-r tag|-D date] [-W spec] 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 uuppddaattee 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 options



These standard options are available with uuppddaattee (see node `Common options' in the CVS manual, for a complete description of them):

--DD ddaattee
Use the most recent revision no later than _d_a_t_e.
This option is sticky, and implies --PP. See see node `Sticky tags' in the CVS manual, for more information on sticky tags/dates.

--ff
Only useful with the --DD _d_a_t_e or --rr <> _t_a_g flags. If no matching revision is found, retrieve the most recent revision (instead of ignoring the file).

--kk _k_f_l_a_g
Process keywords according to _k_f_l_a_g. See
see node `Keyword substitution' in the CVS manual. This option is sticky; future updates of this file in this working directory will use the same _k_f_l_a_g. The ssttaattuuss command can be viewed to see the sticky options. See see node `Invoking CVS' in the CVS manual, for more information on the ssttaattuuss command.

--ll
Local; run only in current working directory. see node `Recursive behavior' in the CVS manual.


--PP
Prune empty directories. See see node `Moving directories' in the CVS manual.


--pp
Pipe files to the standard output.


--RR
Update directories recursively (default). see node `Recursive
behavior' in the CVS manual.

--rr rreevv
Retrieve revision/tag _r_e_v. This option is sticky,
and implies --PP. See see node `Sticky tags' in the CVS manual, for more information on sticky tags/dates.

These special options are also available with uuppddaattee.

--AA
Reset any sticky tags, dates, or --kk options.
Does not reset sticky --kk options on modified files. See see node `Sticky tags' in the CVS manual, for more information on sticky tags/dates.

--CC
Overwrite locally modified files with clean copies from
the repository (the modified file is saved in ..##_f_i_l_e.._r_e_v_i_s_i_o_n, however).

--dd
Create any directories that exist in the repository if
they're missing from the working directory. Normally, uuppddaattee 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 --dd will create those directories, which may not be what you want.

--II _n_a_m_e
Ignore files whose names match _n_a_m_e (in your
working directory) during the update. You can specify --II more than once on the command line to specify several files to ignore. Use --II !! to avoid ignoring any files at all. see node `cvsignore' in the CVS manual, for other ways to make ccvvss ignore some files.

--WW_s_p_e_c
Specify file names that should be filtered during
update. You can use this option repeatedly.

_s_p_e_c can be a file name pattern of the same type that you can specify in the ..ccvvsswwrraappppeerrss file. see node `Wrappers' in the CVS manual.

--jj_r_e_v_i_s_i_o_n
With two --jj options, merge changes from the
revision specified with the first --jj option to the revision specified with the second jj option, into the working directory.

With one --jj option, merge changes from the ancestor revision to the revision specified with the --jj option, into the working directory. The ancestor revision is the common ancestor of the revision which the working directory is based on, and the revision specified in the --jj option.

Note that using a single --jj _t_a_g_n_a_m_e option rather than --jj _b_r_a_n_c_h_n_a_m_e to merge changes from a branch will often not remove files which were removed on the branch. see node `Merging adds and removals' in the CVS manual, for more.

In addition, each --jj option can contain an 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: --jj_S_y_m_b_o_l_i_c___T_a_g::_D_a_t_e___S_p_e_c_i_f_i_e_r.

see node `Branching and merging' in the CVS manual.



update output



uuppddaattee and cchheecckkoouutt keep you informed of their progress by printing a line for each file, preceded by one character indicating the status of the file:

UU _f_i_l_e
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 working directory, and for files that you haven't changed but are not the most recent versions available in the repository.

PP _f_i_l_e
Like UU, but the ccvvss server sends a patch instead of an entire
file. This accomplishes the same thing as UU using less bandwidth.

AA _f_i_l_e
The file has been added to your private copy of the
sources, and will be added to the source repository when you run ccoommmmiitt on the file. This is a reminder to you that the file needs to be committed.

RR _f_i_l_e
The file has been removed from your private copy of the
sources, and will be removed from the source repository when you run ccoommmmiitt on the file. This is a reminder to you that the file needs to be committed.

MM _f_i_l_e
The file is modified in your working directory.


MM 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.

ccvvss will print some messages if it merges your work, and a backup copy of your working file (as it looked before you ran uuppddaattee) will be made. The exact name of that file is printed while uuppddaattee runs.

CC _f_i_l_e
A conflict was detected while trying to merge your
changes to _f_i_l_e with changes from the source repository. _f_i_l_e (the copy in your working directory) is now the result of attempting to merge the two revisions; an unmodified copy of your file is also in your working directory, with the name ..##_f_i_l_e.._r_e_v_i_s_i_o_n where _r_e_v_i_s_i_o_n is the revision that your modified file started from. Resolve the conflict as described in see node `Conflicts example' in the CVS manual. (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.) Under vvmmss, the file name starts with ____ rather than ..##.

?? _f_i_l_e
_f_i_l_e is in your working directory, but does not
correspond to anything in the source repository, and is not in the list of files for ccvvss to ignore (see the description of the --II option, and see node `cvsignore' in the CVS manual).

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 ccvvss iimmppoorrtt).
Larry Jones, Derek R. Price, and Mark D. Baushke
Have helped maintain cvs for many years.
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.pdf (Portable Document Format), 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://cvs.nongnu.org


ci(1), co(1), cvs(5), cvsbug(8), diff(1), grep(1), patch(1), rcs(1), rcsdiff(1), rcsmerge(1), rlog(1).