DOC HOME SITE MAP MAN PAGES GNU INFO SEARCH
 

(cvs.info.gz) Invoking CVS

Info Catalog (cvs.info.gz) CVS commands (cvs.info.gz) Top (cvs.info.gz) Administrative files
 
 Appendix B 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  Index.
 
    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  Password authentication server.
 
 `-a'
      Authenticate all communication (client only) (not in CVS 1.9 and
      older).  See  Global options.
 
 `-b'
      Specify RCS location (CVS 1.9 and older).  See  Global
      options.
 
 `-d ROOT'
      Specify the CVSROOT.  See  Repository.
 
 `-e EDITOR'
      Edit messages with EDITOR.  See  Committing your changes.
 
 `-f'
      Do not read the `~/.cvsrc' file.  See  Global options.
 
 `-H'
 `--help'
      Print a help message.  See  Global options.
 
 `-n'
      Do not change any files.  See  Global options.
 
 `-Q'
      Be really quiet.  See  Global options.
 
 `-q'
      Be somewhat quiet.  See  Global options.
 
 `-r'
      Make new working files read-only.  See  Global options.
 
 `-s VARIABLE=VALUE'
      Set a user variable.  See  Variables.
 
 `-T TEMPDIR'
      Put temporary files in TEMPDIR.  See  Global options.
 
 `-t'
      Trace CVS execution.  See  Global options.
 
 `-v'
 
 `--version'
      Display version and copyright information for CVS.
 
 `-w'
      Make new working files read-write.  See  Global options.
 
 `-x'
      Encrypt all communication (client only).  See  Global
      options.
 
 `-z GZIP-LEVEL'
      Set the compression level (client only).  See  Global
      options.
 
    Keyword expansion modes ( 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 ( Keyword list):
 
      $Author: joe $
      $Date: 1993/12/09 03:21:13 $
      $CVSHeader: files/file1,v 1.1 1993/12/09 03:21:13 joe Exp harry $
      $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  Adding files.
 
     `-k KFLAG'
           Set keyword expansion.
 
     `-m MSG'
           Set file description.
 
 `admin [OPTIONS] [FILES...]'
      Administration of history files in the repository.  See 
      admin.
 
     `-b[REV]'
           Set default branch.  See  Reverting local changes.
 
     `-cSTRING'
           Set comment leader.
 
     `-kSUBST'
           Set keyword substitution.  See  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  admin
           options.
 
     `-q'
           Run quietly; do not print diagnostics.
 
     `-sSTATE[:REV]'
           Set the state.
 
     `-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 
      annotate.
 
     `-D DATE'
           Annotate the most recent revision no later than DATE.  See
            Common 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  Common
           options.
 
     `-l'
           Local; run only in current working directory.  
           Recursive behavior.
 
     `-R'
           Operate recursively (default).   Recursive behavior.
 
     `-r TAG[:DATE]'
           Annotate revisions specified by TAG or, when DATE is specified
           and TAG is a branch tag, the version from the branch TAG as it
           existed on DATE.  See  Common options.
 
 `checkout [OPTIONS] MODULES...'
      Get a copy of the sources.  See  checkout.
 
     `-A'
           Reset any sticky tags/date/options.  See  Sticky tags
           and  Keyword substitution.
 
     `-c'
           Output the module database.  See  checkout options.
 
     `-D DATE'
           Check out revisions as of DATE (is sticky).  See  Common
           options.
 
     `-d DIR'
           Check out into DIR.  See  checkout options.
 
     `-f'
           Use head revision if tag/date not found.  See  Common
           options.
 
     `-j TAG[:DATE]'
           Merge in the change specified by TAG, or when DATE is
           specified and TAG is a branch tag, the version from the
           branch TAG as it existed on DATE.  See  checkout
           options.
 
     `-k KFLAG'
           Use KFLAG keyword expansion.  See  Substitution modes.
 
     `-l'
           Local; run only in current working directory.  
           Recursive behavior.
 
     `-N'
           Don't "shorten" module paths if -d specified.  See 
           checkout options.
 
     `-n'
           Do not run module program (if any).  See  checkout
           options.
 
     `-P'
           Prune empty directories.  See  Moving directories.
 
     `-p'
           Check out files to standard output (avoids stickiness).  See
            checkout options.
 
     `-R'
           Operate recursively (default).   Recursive behavior.
 
     `-r TAG[:DATE]'
           Checkout the revision already tagged with TAG or, when DATE is
           specified and TAG is a branch tag, the version from the
           branch TAG as it existed on DATE.  This .  See  Common
           options.
 
     `-s'
           Like -c, but include module status.  See  checkout
           options.
 
 `commit [OPTIONS] [FILES...]'
      Check changes into the repository.  See  commit.
 
     `-c'
           Check for valid edits before committing.  Requires a CVS
           client and server both version 1.12.10 or greater.
 
     `-F FILE'
           Read log message from FILE.  See  commit options.
 
     `-f'
           Force the file to be committed; disables recursion.  See
            commit options.
 
     `-l'
           Local; run only in current working directory.  See 
           Recursive behavior.
 
     `-m MSG'
           Use MSG as log message.  See  commit options.
 
     `-n'
           Do not run module program (if any).  See  commit
           options.
 
     `-R'
           Operate recursively (default).   Recursive behavior.
 
     `-r REV'
           Commit to REV.  See  commit options.
 
 `diff [OPTIONS] [FILES...]'
      Show differences between revisions.  See  diff.  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  diff
           options.
 
     `-D DATE2'
           Diff REV1/DATE1 against DATE2.  See  diff options.
 
     `-l'
           Local; run only in current working directory.  See 
           Recursive behavior.
 
     `-N'
           Include diffs for added and removed files.  See  diff
           options.
 
     `-R'
           Operate recursively (default).   Recursive behavior.
 
     `-r TAG1[:DATE1]'
           Diff the revisions specified by TAG1 or, when DATE1 is
           specified and TAG1 is a branch tag, the version from the
           branch TAG1 as it existed on DATE1, against the working file.
           See  diff options and  Common options.
 
     `-r TAG2[:DATE2]'
           Diff the revisions specified by TAG2 or, when DATE2 is
           specified and TAG2 is a branch tag, the version from the
           branch TAG2 as it existed on DATE2, against REV1/DATE1.  See
            diff options and  Common options.
 
 `edit [OPTIONS] [FILES...]'
      Get ready to edit a watched file.  See  Editing files.
 
     `-a ACTIONS'
           Specify actions for temporary watch, where ACTIONS is `edit',
           `unedit', `commit', `all', or `none'.  See  Editing
           files.
 
     `-c'
           Check edits: Edit fails if someone else is already editting
           the file.  Requires a CVS client and server both of version
           1.12.10 or greater.
 
     `-f'
           Force edit; ignore other edits.  Added in CVS 1.12.10.
 
     `-l'
           Local; run only in current working directory.  See 
           Recursive behavior.
 
     `-R'
           Operate recursively (default).   Recursive behavior.
 
 `editors [OPTIONS] [FILES...]'
      See who is editing a watched file.  See  Watch information.
 
     `-l'
           Local; run only in current working directory.  See 
           Recursive behavior.
 
     `-R'
           Operate recursively (default).   Recursive behavior.
 
 `export [OPTIONS] MODULES...'
      Export files from CVS.  See  export.
 
     `-D DATE'
           Check out revisions as of DATE.  See  Common options.
 
     `-d DIR'
           Check out into DIR.  See  export options.
 
     `-f'
           Use head revision if tag/date not found.  See  Common
           options.
 
     `-k KFLAG'
           Use KFLAG keyword expansion.  See  Substitution modes.
 
     `-l'
           Local; run only in current working directory.  
           Recursive behavior.
 
     `-N'
           Don't "shorten" module paths if -d specified.  See 
           export options.
 
     `-n'
           Do not run module program (if any).  See  export
           options.
 
     `-R'
           Operate recursively (default).   Recursive behavior.
 
     `-r TAG[:DATE]'
           Export the revisions specified by TAG or, when DATE is
           specified and TAG is a branch tag, the version from the
           branch TAG as it existed on DATE.  See  Common options.
 
 `history [OPTIONS] [FILES...]'
      Show repository access history.  See  history.
 
     `-a'
           All users (default is self).  See  history options.
 
     `-b STR'
           Back to record with STR in module/file/repos field.  See
            history options.
 
     `-c'
           Report on committed (modified) files.  See  history
           options.
 
     `-D DATE'
           Since DATE.  See  history options.
 
     `-e'
           Report on all record types.  See  history options.
 
     `-l'
           Last modified (committed or modified report).  See 
           history options.
 
     `-m MODULE'
           Report on MODULE (repeatable).  See  history options.
 
     `-n MODULE'
           In MODULE.  See  history options.
 
     `-o'
           Report on checked out modules.  See  history options.
 
     `-p REPOSITORY'
           In REPOSITORY.  See  history options.
 
     `-r REV'
           Since revision REV.  See  history options.
 
     `-T'
           Produce report on all TAGs.  See  history options.
 
     `-t TAG'
           Since tag record placed in history file (by anyone).  See
            history options.
 
     `-u USER'
           For user USER (repeatable).  See  history options.
 
     `-w'
           Working directory must match.  See  history options.
 
     `-x TYPES'
           Report on TYPES, one or more of `TOEFWUPCGMAR'.  See 
           history options.
 
     `-z ZONE'
           Output for time zone ZONE.  See  history options.
 
 `import [OPTIONS] REPOSITORY VENDOR-TAG RELEASE-TAGS...'
      Import files into CVS, using vendor branches.  See  import.
 
     `-b BRA'
           Import to vendor branch BRA.  See  Multiple vendor
           branches.
 
     `-d'
           Use the file's modification time as the time of import.  See
            import options.
 
     `-k KFLAG'
           Set default keyword substitution mode.  See  import
           options.
 
     `-m MSG'
           Use MSG for log message.  See  import options.
 
     `-I IGN'
           More files to ignore (! to reset).  See  import
           options.
 
     `-W SPEC'
           More wrappers.  See  import options.
 
 `init'
      Create a CVS repository if it doesn't exist.  See  Creating a
      repository.
 
 `kserver'
      Kerberos authenticated server.  See  Kerberos authenticated.
 
 `log [OPTIONS] [FILES...]'
      Print out history information for files.  See  log.
 
     `-b'
           Only list revisions on the default branch.  See  log
           options.
 
     `-d DATES'
           Specify dates (D1<D2 for range, D for latest before).  See
            log options.
 
     `-h'
           Only print header.  See  log options.
 
     `-l'
           Local; run only in current working directory.  See 
           Recursive behavior.
 
     `-N'
           Do not list tags.  See  log options.
 
     `-R'
           Only print name of RCS file.  See  log options.
 
     `-rREVS'
           Only list revisions REVS.  See  log options.
 
     `-s STATES'
           Only list revisions with specified states.  See  log
           options.
 
     `-t'
           Only print header and descriptive text.  See  log
           options.
 
     `-wLOGINS'
           Only list revisions checked in by specified logins.  See
            log options.
 
 `login'
      Prompt for password for authenticating server.  See  Password
      authentication client.
 
 `logout'
      Remove stored password for authenticating server.  See 
      Password authentication client.
 
 `pserver'
      Password authenticated server.  See  Password authentication
      server.
 
 `rannotate [OPTIONS] [MODULES...]'
      Show last revision where each line was modified.  See 
      annotate.
 
     `-D DATE'
           Annotate the most recent revision no later than DATE.  See
            Common 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  Common
           options.
 
     `-l'
           Local; run only in current working directory.  
           Recursive behavior.
 
     `-R'
           Operate recursively (default).   Recursive behavior.
 
     `-r TAG[:DATE]'
           Annotate the revision specified by TAG or, when DATE is
           specified and TAG is a branch tag, the version from the
           branch TAG as it existed on DATE.  See  Common options.
 
 `rdiff [OPTIONS] MODULES...'
      Show differences between releases.  See  rdiff.
 
     `-c'
           Context diff output format (default).  See  rdiff
           options.
 
     `-D DATE'
           Select revisions based on DATE.  See  Common options.
 
     `-f'
           Use head revision if tag/date not found.  See  Common
           options.
 
     `-l'
           Local; run only in current working directory.  See 
           Recursive behavior.
 
     `-R'
           Operate recursively (default).   Recursive behavior.
 
     `-r TAG[:DATE]'
           Select the revisions specified by TAG or, when DATE is
           specified and TAG is a branch tag, the version from the
           branch TAG as it existed on DATE.  See  diff options
           and  Common options.
 
     `-s'
           Short patch - one liner per file.  See  rdiff options.
 
     `-t'
           Top two diffs - last change made to the file.  See  diff
           options.
 
     `-u'
           Unidiff output format.  See  rdiff options.
 
     `-V VERS'
           Use RCS Version VERS for keyword expansion (obsolete).  See
            rdiff options.
 
 `release [OPTIONS] DIRECTORY'
      Indicate that a directory is no longer in use.  See 
      release.
 
     `-d'
           Delete the given directory.  See  release options.
 
 `remove [OPTIONS] [FILES...]'
      Remove an entry from the repository.  See  Removing files.
 
     `-f'
           Delete the file before removing it.  See  Removing
           files.
 
     `-l'
           Local; run only in current working directory.  See 
           Recursive behavior.
 
     `-R'
           Operate recursively (default).   Recursive behavior.
 
 `rlog [OPTIONS] [FILES...]'
      Print out history information for modules.  See  log.
 
     `-b'
           Only list revisions on the default branch.  See  log
           options.
 
     `-d DATES'
           Specify dates (D1<D2 for range, D for latest before).  See
            log options.
 
     `-h'
           Only print header.  See  log options.
 
     `-l'
           Local; run only in current working directory.  See 
           Recursive behavior.
 
     `-N'
           Do not list tags.  See  log options.
 
     `-R'
           Only print name of RCS file.  See  log options.
 
     `-rREVS'
           Only list revisions REVS.  See  log options.
 
     `-s STATES'
           Only list revisions with specified states.  See  log
           options.
 
     `-t'
           Only print header and descriptive text.  See  log
           options.
 
     `-wLOGINS'
           Only list revisions checked in by specified logins.  See
            log options.
 
 `rtag [OPTIONS] TAG MODULES...'
      Add a symbolic tag to a module.  See  Revisions and 
      Branching and merging.
 
     `-a'
           Clear tag from removed files that would not otherwise be
           tagged.  See  Tagging add/remove.
 
     `-b'
           Create a branch named TAG.  See  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  Tagging by date/tag.
 
     `-d'
           Delete TAG.  See  Modifying tags.
 
     `-F'
           Move TAG if it already exists.  See  Modifying tags.
 
     `-f'
           Force a head revision match if tag/date not found.  See 
           Tagging by date/tag.
 
     `-l'
           Local; run only in current working directory.  See 
           Recursive behavior.
 
     `-n'
           No execution of tag program.  See  Common options.
 
     `-R'
           Operate recursively (default).   Recursive behavior.
 
     `-r TAG[:DATE]'
           Tag the revision already tagged with TAG or, when DATE is
           specified and TAG is a branch tag, the version from the
           branch TAG as it existed on DATE.  See  Tagging by
           date/tag and  Common options.
 
 `server'
      Rsh server.  See  Connecting via rsh.
 
 `status [OPTIONS] FILES...'
      Display status information in a working directory.  See  File
      status.
 
     `-l'
           Local; run only in current working directory.  See 
           Recursive behavior.
 
     `-R'
           Operate recursively (default).   Recursive behavior.
 
     `-v'
           Include tag information for file.  See  Tags.
 
 `tag [OPTIONS] TAG [FILES...]'
      Add a symbolic tag to checked out version of files.  See 
      Revisions and  Branching and merging.
 
     `-b'
           Create a branch named TAG.  See  Branching and merging.
 
     `-c'
           Check that working files are unmodified.  See  Tagging
           the working directory.
 
     `-D DATE'
           Tag revisions as of DATE.  See  Tagging by date/tag.
 
     `-d'
           Delete TAG.  See  Modifying tags.
 
     `-F'
           Move TAG if it already exists.  See  Modifying tags.
 
     `-f'
           Force a head revision match if tag/date not found.  See 
           Tagging by date/tag.
 
     `-l'
           Local; run only in current working directory.  See 
           Recursive behavior.
 
     `-R'
           Operate recursively (default).   Recursive behavior.
 
     `-r TAG[:DATE]'
           Tag the revision already tagged with TAG, or when DATE is
           specified and TAG is a branch tag, the version from the
           branch TAG as it existed on DATE.  See  Tagging by
           date/tag and  Common options.
 
 `unedit [OPTIONS] [FILES...]'
      Undo an edit command.  See  Editing files.
 
     `-l'
           Local; run only in current working directory.  See 
           Recursive behavior.
 
     `-R'
           Operate recursively (default).   Recursive behavior.
 
 `update [OPTIONS] [FILES...]'
      Bring work tree in sync with repository.  See  update.
 
     `-A'
           Reset any sticky tags/date/options.  See  Sticky tags
           and  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  Common
           options.
 
     `-d'
           Create directories.  See  update options.
 
     `-f'
           Use head revision if tag/date not found.  See  Common
           options.
 
     `-I IGN'
           More files to ignore (! to reset).  See  import
           options.
 
     `-j TAG[:DATE]'
           Merge in changes from revisions specified by TAG or, when
           DATE is specified and TAG is a branch tag, the version from
           the branch TAG as it existed on DATE.  See  update
           options.
 
     `-k KFLAG'
           Use KFLAG keyword expansion.  See  Substitution modes.
 
     `-l'
           Local; run only in current working directory.  
           Recursive behavior.
 
     `-P'
           Prune empty directories.  See  Moving directories.
 
     `-p'
           Check out files to standard output (avoids stickiness).  See
            update options.
 
     `-R'
           Operate recursively (default).   Recursive behavior.
 
     `-r TAG[:DATE]'
           Checkout the revisions specified by TAG or, when DATE is
           specified and TAG is a branch tag, the version from the
           branch TAG as it existed on DATE.  See  Common options.
 
     `-W SPEC'
           More wrappers.  See  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 
      Setting a watch.
 
      add/remove: add or remove notification on actions.  See 
      Getting Notified.
 
     `-a ACTIONS'
           Specify actions for temporary watch, where ACTIONS is `edit',
           `unedit', `commit', `all', or `none'.  See  Editing
           files.
 
     `-l'
           Local; run only in current working directory.  See 
           Recursive behavior.
 
     `-R'
           Operate recursively (default).   Recursive behavior.
 
 `watchers [OPTIONS] [FILES...]'
      See who is watching a file.  See  Watch information.
 
     `-l'
           Local; run only in current working directory.  See 
           Recursive behavior.
 
     `-R'
           Operate recursively (default).   Recursive behavior.
 
 
Info Catalog (cvs.info.gz) CVS commands (cvs.info.gz) Top (cvs.info.gz) Administrative files
automatically generated byinfo2html