Version Management with CVS - the CVS manual by Per Cederqvist et al. Paperback (6"x9"), 216 pages, 8 figures ISBN 0954161718 RRP £19.95 ($29.95) Get a printed copy>>>

Version Management with CVS Buy the book here! >>> support free documentation

G Quick reference to CVS commands

This appendix describes how to invoke CVS, with references to where each command or feature is described in detail. For other references run the cvs --help command, or see section .

A CVS command looks like:

cvs [ global_options ] command [ command_options ]
  [ command_args ]

Global options:

--allow-root=rootdir

Specify legal CVSROOT directory (server only) (not in CVS 1.9 and older). See section 17.1.1 Setting up the server for password authentication.

-a

Authenticate all communication (client only) (not in CVS 1.9 and older). See section A.4 Global options.

-b

Specify RCS location (CVS 1.9 and older). See section A.4 Global options.

-d root

Specify the CVSROOT. See section 2 The Repository.

-e editor

Edit messages with editor. See section 1.3.2 Committing your changes.

-f

Do not read the ‘~/.cvsrc’ file. See section A.4 Global options.

-H

--help

Print a help message. See section A.4 Global options.

-n

Do not change any files. See section A.4 Global options.

-Q

Be really quiet. See section A.4 Global options.

-q

Be somewhat quiet. See section A.4 Global options.

-r

Make new working files read-only. See section A.4 Global options.

-s variable=value

Set a user variable. See section B.10 Expansions in administrative files.

-T tempdir

Put temporary files in tempdir. See section A.4 Global options.

-t

Trace CVS execution. See section A.4 Global options.

-v

--version

Display version and copyright information for CVS.

-w

Make new working files read-write. See section A.4 Global options.

-x

Encrypt all communication (client only). See section A.4 Global options.

-z gzip-level

Set the compression level (client only). See section A.4 Global options.

Keyword expansion modes (see section 12.4 Substitution modes):

-kkv  $Id: file1,v 1.1 1993/12/09 03:21:13 joe Exp $
-kkvl $Id: file1,v 1.1 1993/12/09 03:21:13 joe Exp harry $
-kk   $Id$
-kv   file1,v 1.1 1993/12/09 03:21:13 joe Exp
-ko   no expansion
-kb   no expansion, file is binary

Keywords (see section 12.1 Keyword List):

$Author: joe $
$Date: 1993/12/09 03:21:13 $
$Header: /home/files/file1,v 1.1 1993/12/09 03:21:13 joe
  Exp harry $
$Id: file1,v 1.1 1993/12/09 03:21:13 joe Exp harry $
$Locker: harry $
$Name: snapshot_1_14 $
$RCSfile: file1,v $
$Revision: 1.1 $
$Source: /home/files/file1,v $
$State: Exp $
$Log: file1,v $
Revision 1.1  1993/12/09 03:30:17  joe
Initial revision

Commands, command options, and command arguments:

add [options] [files...]

Add a new file/directory. See section 7.1 Adding files to a directory.

-k kflag

Set keyword expansion.

-m msg

Set file description.

admin [options] [files...]

Administration of history files in the repository. See section A.6 admin--Administration.

-b[rev]

Set default branch. See section 13.3 Reverting to the latest vendor release.

-cstring

Set comment leader.

-ksubst

Set keyword substitution. See section 12 Keyword substitution.

-l[rev]

Lock revision rev, or latest revision.

-mrev:msg

Replace the log message of revision rev with msg.

-orange

Delete revisions from the repository. See section A.6.1 admin options.

-q

Run quietly; do not print diagnostics.

-sstate[:rev]

Set the state. See section A.6.1 admin options for more information on possible states.

-t

Set file description from standard input.

-tfile

Set file description from file.

-t-string

Set file description to string.

-u[rev]

Unlock revision rev, or latest revision.

annotate [options] [files...]

Show last revision where each line was modified. See section A.7 annotate--What revision modified each line of a file?.

-D date

Annotate the most recent revision no later than date. See section A.5 Common command options.

-F

Force annotation of binary files. (Without this option, binary files are skipped with a message.)

-f

Use head revision if tag/date not found. See section A.5 Common command options.

-l

Local; run only in current working directory. See section 6 Recursive behavior.

-R

Operate recursively (default). See section 6 Recursive behavior.

-r tag

Annotate revision tag. See section A.5 Common command options.

checkout [options] modules...

Get a copy of the sources. See section A.8 checkout--Check out sources for editing.

-A

Reset any sticky tags/date/options. See section 4.9 Sticky tags and section 12 Keyword substitution.

-c

Output the module database. See section A.8.1 checkout options.

-D date

Check out revisions as of date (is sticky). See section A.5 Common command options.

-d dir

Check out into dir. See section A.8.1 checkout options.

-f

Use head revision if tag/date not found. See section A.5 Common command options.

-j rev

Merge in changes. See section A.8.1 checkout options.

-k kflag

Use kflag keyword expansion. See section 12.4 Substitution modes.

-l

Local; run only in current working directory. See section 6 Recursive behavior.

-N

Don't "shorten" module paths if -d specified. See section A.8.1 checkout options.

-n

Do not run module program (if any). See section A.8.1 checkout options.

-P

Prune empty directories. See section 7.5 Moving and renaming directories.

-p

Check out files to standard output (avoids stickiness). See section A.8.1 checkout options.

-R

Operate recursively (default). See section 6 Recursive behavior.

-r tag

Checkout revision tag (is sticky). See section A.5 Common command options.

-s

Like -c, but include module status. See section A.8.1 checkout options.

commit [options] [files...]

Check changes into the repository. See section A.9 commit--Check files into the repository.

-F file

Read log message from file. See section A.9.1 commit options.

-f

Force the file to be committed; disables recursion. See section A.9.1 commit options.

-l

Local; run only in current working directory. See section 6 Recursive behavior.

-m msg

Use msg as log message. See section A.9.1 commit options.

-n

Do not run module program (if any). See section A.9.1 commit options.

-R

Operate recursively (default). See section 6 Recursive behavior.

-r rev

Commit to rev. See section A.9.1 commit options.

diff [options] [files...]

Show differences between revisions. See section A.10 diff--Show differences between revisions. In addition to the options shown below, accepts a wide variety of options to control output style, for example ‘-c’ for context diffs.

-D date1

Diff revision for date against working file. See section A.10.1 diff options.

-D date2

Diff rev1/date1 against date2. See section A.10.1 diff options.

-l

Local; run only in current working directory. See section 6 Recursive behavior.

-N

Include diffs for added and removed files. See section A.10.1 diff options.

-R

Operate recursively (default). See section 6 Recursive behavior.

-r rev1

Diff revision for rev1 against working file. See section A.10.1 diff options.

-r rev2

Diff rev1/date1 against rev2. See section A.10.1 diff options.

edit [options] [files...]

Get ready to edit a watched file. See section 10.6.3 How to edit a file which is being watched.

-a actions

Specify actions for temporary watch, where actions is edit, unedit, commit, all, or none. See section 10.6.3 How to edit a file which is being watched.

-l

Local; run only in current working directory. See section 6 Recursive behavior.

-R

Operate recursively (default). See section 6 Recursive behavior.

editors [options] [files...]

See who is editing a watched file. See section 10.6.4 Information about who is watching and editing.

-l

Local; run only in current working directory. See section 6 Recursive behavior.

-R

Operate recursively (default). See section 6 Recursive behavior.

export [options] modules...

Export files from CVS. See section A.11 export--Export sources from CVS, similar to checkout.

-D date

Check out revisions as of date. See section A.5 Common command options.

-d dir

Check out into dir. See section A.11.1 export options.

-f

Use head revision if tag/date not found. See section A.5 Common command options.

-k kflag

Use kflag keyword expansion. See section 12.4 Substitution modes.

-l

Local; run only in current working directory. See section 6 Recursive behavior.

-N

Don't "shorten" module paths if -d specified. See section A.11.1 export options.

-n

Do not run module program (if any). See section A.11.1 export options.

-R

Operate recursively (default). See section 6 Recursive behavior.

-r tag

Checkout revision tag. See section A.5 Common command options.

history [options] [files...]

Show repository access history. See section A.12 history--Show status of files and users.

-a

All users (default is self). See section A.12.1 history options.

-b str

Back to record with str in module/file/repos field. See section A.12.1 history options.

-c

Report on committed (modified) files. See section A.12.1 history options.

-D date

Since date. See section A.12.1 history options.

-e

Report on all record types. See section A.12.1 history options.

-l

Last modified (committed or modified report). See section A.12.1 history options.

-m module

Report on module (repeatable). See section A.12.1 history options.

-n module

In module. See section A.12.1 history options.

-o

Report on checked out modules. See section A.12.1 history options.

-p repository

In repository. See section A.12.1 history options.

-r rev

Since revision rev. See section A.12.1 history options.

-T

Produce report on all TAGs. See section A.12.1 history options.

-t tag

Since tag record placed in history file (by anyone). See section A.12.1 history options.

-u user

For user user (repeatable). See section A.12.1 history options.

-w

Working directory must match. See section A.12.1 history options.

-x types

Report on types, one or more of TOEFWUPCGMAR. See section A.12.1 history options.

-z zone

Output for time zone zone. See section A.12.1 history options.

import [options] repository vendor-tag release-tags...

Import files into CVS, using vendor branches. See section A.13 import--Import sources into CVS, using vendor branches.

-b bra

Import to vendor branch bra. See section 13.6 Multiple vendor branches.

-d

Use the file's modification time as the time of import. See section A.13.1 import options.

-k kflag

Set default keyword substitution mode. See section A.13.1 import options.

-m msg

Use msg for log message. See section A.13.1 import options.

-I ign

More files to ignore (! to reset). See section A.13.1 import options.

-W spec

More wrappers. See section A.13.1 import options.

init

Create a CVS repository if it doesn't exist. See section 2.3 Creating a repository.

kserver

Kerberos authenticated server. See section 17.3 Direct connection with Kerberos.

log [options] [files...]

Print out history information for files. See section A.14 log--Print out log information for files.

-b

Only list revisions on the default branch. See section A.14.1 log options.

-d dates

Specify dates (d1<d2 for range, d for latest before). See section A.14.1 log options.

-h

Only print header. See section A.14.1 log options.

-l

Local; run only in current working directory. See section 6 Recursive behavior.

-N

Do not list tags. See section A.14.1 log options.

-R

Only print name of RCS file. See section A.14.1 log options.

-rrevs

Only list revisions revs. See section A.14.1 log options.

-s states

Only list revisions with specified states. See section A.14.1 log options.

-t

Only print header and descriptive text. See section A.14.1 log options.

-wlogins

Only list revisions checked in by specified logins. See section A.14.1 log options.

login

Prompt for password for authenticating server. See section 17.1.2 Using the client with password authentication.

logout

Remove stored password for authenticating server. See section 17.1.2 Using the client with password authentication.

pserver

Password authenticated server. See section 17.1.1 Setting up the server for password authentication.

rannotate [options] [modules...]

Show last revision where each line was modified. See section A.7 annotate--What revision modified each line of a file?.

-D date

Annotate the most recent revision no later than date. See section A.5 Common command options.

-F

Force annotation of binary files. (Without this option, binary files are skipped with a message.)

-f

Use head revision if tag/date not found. See section A.5 Common command options.

-l

Local; run only in current working directory. See section 6 Recursive behavior.

-R

Operate recursively (default). See section 6 Recursive behavior.

-r tag

Annotate revision tag. See section A.5 Common command options.

rdiff [options] modules...

Show differences between releases. See section A.15 rdiff---'patch' format diffs between releases.

-c

Context diff output format (default). See section A.15.1 rdiff options.

-D date

Select revisions based on date. See section A.5 Common command options.

-f

Use head revision if tag/date not found. See section A.5 Common command options.

-l

Local; run only in current working directory. See section 6 Recursive behavior.

-R

Operate recursively (default). See section 6 Recursive behavior.

-r rev

Select revisions based on rev. See section A.5 Common command options.

-s

Short patch - one liner per file. See section A.15.1 rdiff options.

-t

Top two diffs - last change made to the file. See section A.10.1 diff options.

-u

Unidiff output format. See section A.15.1 rdiff options.

-V vers

Use RCS Version vers for keyword expansion (obsolete). See section A.15.1 rdiff options.

release [options] directory

Indicate that a directory is no longer in use. See section A.16 release--Indicate that a Module is no longer in use.

-d

Delete the given directory. See section A.16.1 release options.

remove [options] [files...]

Remove an entry from the repository. See section 7.2 Removing files.

-f

Delete the file before removing it. See section 7.2 Removing files.

-l

Local; run only in current working directory. See section 6 Recursive behavior.

-R

Operate recursively (default). See section 6 Recursive behavior.

rlog [options] [files...]

Print out history information for modules. See section A.14 log--Print out log information for files.

-b

Only list revisions on the default branch. See section A.14.1 log options.

-d dates

Specify dates (d1<d2 for range, d for latest before). See section A.14.1 log options.

-h

Only print header. See section A.14.1 log options.

-l

Local; run only in current working directory. See section 6 Recursive behavior.

-N

Do not list tags. See section A.14.1 log options.

-R

Only print name of RCS file. See section A.14.1 log options.

-rrevs

Only list revisions revs. See section A.14.1 log options.

-s states

Only list revisions with specified states. See section A.14.1 log options.

-t

Only print header and descriptive text. See section A.14.1 log options.

-wlogins

Only list revisions checked in by specified logins. See section A.14.1 log options.

rtag [options] tag modules...

Add a symbolic tag to a module. See section 4 Revisions and section 5 Branching and merging.

-a

Clear tag from removed files that would not otherwise be tagged. See section 4.8 Tagging and adding and removing files.

-b

Create a branch named tag. See section 5 Branching and merging.

-B

Used in conjunction with -F or -d, enables movement and deletion of branch tags. Use with extreme caution.

-D date

Tag revisions as of date. See section 4.6 Specifying what to tag by date or revision.

-d

Delete tag. See section 4.7 Deleting, moving, and renaming tags.

-F

Move tag if it already exists. See section 4.7 Deleting, moving, and renaming tags.

-f

Force a head revision match if tag/date not found. See section 4.6 Specifying what to tag by date or revision.

-l

Local; run only in current working directory. See section 6 Recursive behavior.

-n

No execution of tag program. See section A.5 Common command options.

-R

Operate recursively (default). See section 6 Recursive behavior.

-r rev

Tag existing tag rev. See section 4.6 Specifying what to tag by date or revision.

server

Rsh server. See section 2.4.1 Connecting with rsh and ssh.

status [options] files...

Display status information in a working directory. See section 10.1 File status.

-l

Local; run only in current working directory. See section 6 Recursive behavior.

-R

Operate recursively (default). See section 6 Recursive behavior.

-v

Include tag information for file. See section 4.4 Tags--Symbolic revisions.

tag [options] tag [files...]

Add a symbolic tag to checked out version of files. See section 4 Revisions and section 5 Branching and merging.

-b

Create a branch named tag. See section 5 Branching and merging.

-c

Check that working files are unmodified. See section 4.5 Specifying what to tag from the working directory.

-D date

Tag revisions as of date. See section 4.6 Specifying what to tag by date or revision.

-d

Delete tag. See section 4.7 Deleting, moving, and renaming tags.

-F

Move tag if it already exists. See section 4.7 Deleting, moving, and renaming tags.

-f

Force a head revision match if tag/date not found. See section 4.6 Specifying what to tag by date or revision.

-l

Local; run only in current working directory. See section 6 Recursive behavior.

-R

Operate recursively (default). See section 6 Recursive behavior.

-r rev

Tag existing tag rev. See section 4.6 Specifying what to tag by date or revision.

unedit [options] [files...]

Undo an edit command. See section 10.6.3 How to edit a file which is being watched.

-l

Local; run only in current working directory. See section 6 Recursive behavior.

-R

Operate recursively (default). See section 6 Recursive behavior.

update [options] [files...]

Bring work tree in sync with repository. See section A.17 update--Bring work tree in sync with repository.

-A

Reset any sticky tags/date/options. See section 4.9 Sticky tags and section 12 Keyword substitution.

-C

Overwrite locally modified files with clean copies from the repository (the modified file is saved in ‘.#file.revision’, however).

-D date

Check out revisions as of date (is sticky). See section A.5 Common command options.

-d

Create directories. See section A.17.1 update options.

-f

Use head revision if tag/date not found. See section A.5 Common command options.

-I ign

More files to ignore (! to reset). See section A.13.1 import options.

-j rev

Merge in changes. See section A.17.1 update options.

-k kflag

Use kflag keyword expansion. See section 12.4 Substitution modes.

-l

Local; run only in current working directory. See section 6 Recursive behavior.

-P

Prune empty directories. See section 7.5 Moving and renaming directories.

-p

Check out files to standard output (avoids stickiness). See section A.17.1 update options.

-R

Operate recursively (default). See section 6 Recursive behavior.

-r tag

Checkout revision tag (is sticky). See section A.5 Common command options.

-W spec

More wrappers. See section A.13.1 import options.

version

Display the version of CVS being used. If the repository is remote, display both the client and server versions.

watch [on|off|add|remove] [options] [files...]

on/off: turn on/off read-only checkouts of files. See section 10.6.1 Telling CVS to watch certain files. add/remove: add or remove notification on actions. See section 10.6.2 Telling CVS to notify you.

-a actions

Specify actions for temporary watch, where actions is edit, unedit, commit, all, or none. See section 10.6.3 How to edit a file which is being watched.

-l

Local; run only in current working directory. See section 6 Recursive behavior.

-R

Operate recursively (default). See section 6 Recursive behavior.

watchers [options] [files...]

See who is watching a file. See section 10.6.4 Information about who is watching and editing.

-l

Local; run only in current working directory. See section 6 Recursive behavior.

-R

Operate recursively (default). See section 6 Recursive behavior.