D. All environment variables which affect CVS

This is a complete list of all environment variables that affect CVS (Windows users, please bear with this list; $VAR is equivalent to %VAR% at the Windows command prompt).

$COMSPEC

Used under OS/2 only. It specifies the name of the command interpreter and defaults to CMD.EXE.

$CVS_CLIENT_LOG

Used for debugging only in client-server mode. If set, everything sent to the server is logged into `$CVS_CLIENT_LOG.in' and everything sent from the server is logged into `$CVS_CLIENT_LOG.out'.

$CVS_CLIENT_PORT

Used in client-server mode to set the port to use when accessing the server via Kerberos, GSSAPI, or CVS's password authentication protocol if the port is not specified in the CVSROOT. see section Remote repositories

$CVSEDITOR

$EDITOR

$VISUAL

Specifies the program to use for recording log messages during commit. $CVSEDITOR overrides $EDITOR, which overrides $VISUAL. See Committing your changes for more or Global options for alternative ways of specifying a log editor.

$CVSIGNORE

A whitespace-separated list of file name patterns that CVS should ignore. See section Ignoring files via cvsignore.

$CVS_IGNORE_REMOTE_ROOT

For CVS 1.10 and older, setting this variable prevents CVS from overwriting the `CVS/Root' file when the `-d' global option is specified. Later versions of CVS do not rewrite `CVS/Root', so CVS_IGNORE_REMOTE_ROOT has no effect.

$CVS_LOCAL_BRANCH_NUM

Setting this variable allows some control over the branch number that is assigned. This is specifically to support the local commit feature of CVSup. If one sets CVS_LOCAL_BRANCH_NUM to (say) 1000 then branches the local repository, the revision numbers will look like 1.66.1000.xx. There is almost a dead-set certainty that there will be no conflicts with version numbers.

$CVS_NOBASES

When set, disables the creation of base files on checkouts. Mainly intended for testing purposes, though this can be used to save disk space if your disk space is more valuable than your bandwidth and you don't need any OpenPGP revision signature functionality.

$CVS_PASSFILE

Used in client-server mode when accessing the cvs login server. Default value is `$HOME/.cvspass'. see section Using the client with password authentication

$CVS_PID

This is the process identification (aka pid) number of the CVS process. It is often useful in the programs and/or scripts specified by the `commitinfo', `verifymsg', `loginfo' files.

$CVS_PROXY_PORT

Used in client-server mode to set the port to use when accessing a server via a web proxy, if the port is not specified in the CVSROOT. Works with GSSAPI, and the password authentication protocol. see section Remote repositories

$CVS_RCMD_PORT

Used in client-server mode. If set, specifies the port number to be used when accessing the RCMD demon on the server side. (Currently not used for Unix clients).

$CVSREAD

If this is set, checkout and update will try hard to make the files in your working directory read-only. When this is not set, the default behavior is to permit modification of your working files.

$CVSREADONLYFS

Turns on read-only repository mode. This allows one to check out from a read-only repository, such as within an anoncvs server, or from a CD-ROM repository.

It has the same effect as if the `-R' command-line option is used. This can also allow the use of read-only NFS repositories.

$CVSROOT

Should contain the full pathname to the root of the CVS source repository (where the RCS files are kept). This information must be available to CVS for most commands to execute; if $CVSROOT is not set, or if you wish to override it for one invocation, you can supply it on the command line: `cvs -d cvsroot cvs_command…' Once you have checked out a working directory, CVS stores the appropriate root (in the file `CVS/Root'), so normally you only need to worry about this when initially checking out a working directory.

$CVS_RSH

Specifies the external program which CVS connects with, when :ext: access method is specified. see section Connecting with rsh.

$CVS_SERVER

Used in client-server mode when accessing a remote repository using RSH. It specifies the name of the program to start on the server side (and any necessary arguments) when accessing a remote repository using the :ext:, :fork:, or :server: access methods. The default value for :ext: and :server: is cvs; the default value for :fork: is the name used to run the client. see section Connecting with rsh

$CVS_SERVER_SLEEP

Used only for debugging the server side in client-server mode. If set, delays the start of the server child process the specified amount of seconds so that you can attach to it with a debugger.

$CVS_SIGN_COMMITS

Force OpenPGP signatures on or off. Turning on will cause the commit to abort if the server does not support OpenPGP signatures. Without one of these options, CVS will autonegotiate signing, attempting to sign commits when the server supports it. May be overridden by the `sign' and `no-sign' method options (see section The connection method) as well as by the `--sign' and `--no-sign' global options (see section Global options).

$CVSUMASK

Controls permissions of files in the repository. See File permissions.

$CVS_VERIFY_CHECKOUTS

Force OpenPGP signature verification on checkout off, or set the failure mode. With a failure mode of `warn', the user will be warned of invalid signatures but the checkout will be allowed. With a failure mode of `fatal', the checkout will be aborted when the first corrupt file is received. If the server does not support OpenPGP signatures, a failure mode of `fatal' will disallow the entire checkout. May be overridden by the `verify' and `no-verify' method options (see section The connection method) and by the `--verify' and `--no-verify' global options (see section Global options).

$CVS_VERIFY_TEMPLATE

Use template as the command line template to verify OpenPGP signatures. Format strings in this template are substituted before the command is run:

%M

Substitute in the textmode flag (defaults to `--textmode') when a signature is being verified for a text file.

%@

Substitute in any args set via the `--verify-arg' option or the CVSROOT verify-arg method option.

%S

Substitute the name of the file containing the signature.

%s

Substitute the name of the signed file.

This template should exit with an exit code of zero if the signature is valid for the signed file and a non-zero exit code otherwise. This method option is overridden by the `verify-template' method option (see section The connection method) and the `--verify-template' global command line option (see section Global options) and defaults to something like `/usr/bin/gpg --detach-sign --output - %M %@ %S %s'.

$CVSWRAPPERS

A whitespace-separated list of file name patterns that CVS should treat as wrappers. See section The cvswrappers file.

$HOME

$HOMEPATH

$HOMEDRIVE

Used to locate the directory where the `.cvsrc' file, and other such files, are searched. On Unix, CVS just checks for HOME. On Windows NT, the system will set HOMEDRIVE, for example to `d:' and HOMEPATH, for example to `\joe'. On Windows 95, you'll probably need to set HOMEDRIVE and HOMEPATH yourself.

$PATH

If $RCSBIN is not set, and no path is compiled into CVS, it will use $PATH to try to find all programs it uses.

$TMPDIR

Directory in which temporary files are located. See section Global options, for more on setting the temporary directory.

This document was generated on September, 14 2007 using texi2html 1.76.