<div id="Environment-variables"></div>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">|[cvs: Reference manual for Administrative files#config  &lt; ]|</td>
<td valign="middle" align="left">|[cvs: Compatibility between CVS Versions#Compatibility  &gt; ]|</td>
<td valign="middle" align="left"> &nbsp; </td>
<td valign="middle" align="left">|[cvs: Reference manual for Administrative files#Administrative-files  &lt;&lt; ]|</td>
<td valign="middle" align="left">|[[cvs#Top| Up ]]|</td>
<td valign="middle" align="left">|[cvs: Compatibility between CVS Versions#Compatibility  &gt;&gt; ]|</td>
<td valign="middle" align="left"> &nbsp; </td>
<td valign="middle" align="left"> &nbsp; </td>
<td valign="middle" align="left"> &nbsp; </td>
<td valign="middle" align="left"> &nbsp; </td>
<td valign="middle" align="left">|[[cvs#Top|Top]]|</td>
<td valign="middle" align="left">|[cvs: Table of Contents#SEC_Contents Contents]|</td>
<td valign="middle" align="left">|[cvs: Index#Index Index]|</td>
<td valign="middle" align="left">|[cvs: About this Manual#SEC_About  ? ]|</td>
</tr></table>
<div id="All-environment-variables-which-affect-CVS"></div>
== All environment variables which affect CVS ==
<div id="index-Environment-variables"></div>
<div id="index-Reference-manual-for-variables"></div>

<p>This is a complete list of all environment variables
that affect <small>CVS</small>.
</p>
<dl compact="compact">
<dd><div id="index-CVSIGNORE_002c-environment-variable"></div>
</dd>
<dt> <code>$CVSIGNORE</code></dt>
<dd><p>A whitespace-separated list of file name patterns that
<small>CVS</small> should ignore. See section [cvs: Reference manual for Administrative files#cvsignore Ignoring files via cvsignore].
</p>
<div id="index-CVSWRAPPERS_002c-environment-variable-1"></div>
</dd>
<dt> <code>$CVSWRAPPERS</code></dt>
<dd><p>A whitespace-separated list of file name patterns that
<small>CVS</small> should treat as wrappers. See section [cvs: Reference manual for Administrative files#Wrappers The cvswrappers file].
</p>
<div id="index-CVSREAD_002c-environment-variable"></div>
<div id="index-Read_002donly-files_002c-and-CVSREAD"></div>
</dd>
<dt> <code>$CVSREAD</code></dt>
<dd><p>If this is set, <code>checkout</code> and <code>update</code> 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.
</p>
<div id="index-CVSREADONLYFS_002c-environment-variable"></div>
</dd>
<dt> <code>$CVSREADONLYFS</code></dt>
<dd><p>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 CDROM repository.
</p>
<p>It has the same effect as if the &lsquo;<samp>-R</samp>&rsquo; command-line
option is used. This can also allow the use of
read-only NFS repositories.
</p>
</dd>
<dt> <code>$CVSUMASK</code></dt>
<dd><p>Controls permissions of files in the repository.  See
[cvs: The Repository#File-permissions File permissions].
</p>
</dd>
<dt> <code>$CVSROOT</code></dt>
<dd><p>Should contain the full pathname to the root of the <small>CVS</small>
source repository (where the <small>RCS</small> files are
kept).  This information must be available to <small>CVS</small> for
most commands to execute; if <code>$CVSROOT</code> is not set,
or if you wish to override it for one invocation, you
can supply it on the command line: &lsquo;<samp>cvs -d cvsroot
cvs_command&hellip;</samp>&rsquo; Once you have checked out a working
directory, <small>CVS</small> stores the appropriate root (in
the file &lsquo;<tt>CVS/Root</tt>&rsquo;), so normally you only need to
worry about this when initially checking out a working
directory.
</p>
</dd>
<dt> <code>$CVSEDITOR</code></dt>
<dd><div id="index-CVSEDITOR_002c-environment-variable-1"></div>
</dd>
<dt> <code>$EDITOR</code></dt>
<dd><div id="index-EDITOR_002c-environment-variable-1"></div>
</dd>
<dt> <code>$VISUAL</code></dt>
<dd><div id="index-VISUAL_002c-environment-variable-1"></div>
<p>Specifies the program to use for recording log messages
during commit.  <code>$CVSEDITOR</code> overrides
<code>$EDITOR</code>, which overrides <code>$VISUAL</code>.
See [cvs: Overview#Committing-your-changes Committing your changes] for more or
[cvs: Guide to CVS commands#Global-options Global options] for alternative ways of specifying a
log editor.
</p>
<div id="index-PATH_002c-environment-variable"></div>
</dd>
<dt> <code>$PATH</code></dt>
<dd><p>If <code>$RCSBIN</code> is not set, and no path is compiled
into <small>CVS</small>, it will use <code>$PATH</code> to try to find all
programs it uses.
</p>
<div id="index-HOME_002c-environment-variable"></div>
</dd>
<dt> <code>$HOME</code></dt>
<dd><div id="index-HOMEPATH_002c-environment-variable"></div>
</dd>
<dt> <code>$HOMEPATH</code></dt>
<dd><div id="index-HOMEDRIVE_002c-environment-variable"></div>
</dd>
<dt> <code>$HOMEDRIVE</code></dt>
<dd><p>Used to locate the directory where the &lsquo;<tt>.cvsrc</tt>&rsquo;
file, and other such files, are searched.  On Unix, <small>CVS</small>
just checks for <code>HOME</code>.  On Windows NT, the system will
set <code>HOMEDRIVE</code>, for example to &lsquo;<samp>d:</samp>&rsquo; and <code>HOMEPATH</code>,
for example to &lsquo;<tt>\joe</tt>&rsquo;.  On Windows 95, you&rsquo;ll
probably need to set <code>HOMEDRIVE</code> and <code>HOMEPATH</code> yourself.
</p>
<div id="index-CVS_005fRSH_002c-environment-variable"></div>
</dd>
<dt> <code>$CVS_RSH</code></dt>
<dd><p>Specifies the external program which <small>CVS</small> connects with,
when <code>:ext:</code> access method is specified.
see section [cvs: The Repository#Connecting-via-rsh Connecting with rsh].
</p>
</dd>
<dt> <code>$CVS_SERVER</code></dt>
<dd><p>Used in client-server mode when accessing a remote
repository using <small>RSH</small>.  It specifies the name of
the program to start on the server side (and any
necessary arguments) when accessing a remote repository
using the <code>:ext:</code>, <code>:fork:</code>, or <code>:server:</code> access methods.
The default value for <code>:ext:</code> and <code>:server:</code> is <code>cvs</code>;
the default value for <code>:fork:</code> is the name used to run the client.
see section [cvs: The Repository#Connecting-via-rsh Connecting with rsh]
</p>
</dd>
<dt> <code>$CVS_PASSFILE</code></dt>
<dd><p>Used in client-server mode when accessing the <code>cvs
login server</code>.  Default value is &lsquo;<tt>$HOME/.cvspass</tt>&rsquo;.
see section [cvs: The Repository#Password-authentication-client Using the client with password authentication]
</p>
</dd>
<dt> <code>$CVS_CLIENT_PORT</code></dt>
<dd><p>Used in client-server mode to set the port to use when accessing the server
via Kerberos, GSSAPI, or <small>CVS</small>&rsquo;s password authentication protocol
if the port is not specified in the CVSROOT.
see section [cvs: The Repository#Remote-repositories Remote repositories]
</p>
<div id="index-CVS_005fRCMD_005fPORT_002c-environment-variable"></div>
</dd>
<dt> <code>$CVS_RCMD_PORT</code></dt>
<dd><p>Used in client-server mode.  If set, specifies the port
number to be used when accessing the <small>RCMD</small> demon on
the server side. (Currently not used for Unix clients).
</p>
<div id="index-CVS_005fCLIENT_005fLOG_002c-environment-variable"></div>
</dd>
<dt> <code>$CVS_CLIENT_LOG</code></dt>
<dd><p>Used for debugging only in client-server
mode.  If set, everything sent to the server is logged
into &lsquo;<tt><code>$CVS_CLIENT_LOG</code>.in</tt>&rsquo; and everything
sent from the server is logged into
&lsquo;<tt><code>$CVS_CLIENT_LOG</code>.out</tt>&rsquo;.
</p>
<div id="index-CVS_005fSERVER_005fSLEEP_002c-environment-variable"></div>
</dd>
<dt> <code>$CVS_SERVER_SLEEP</code></dt>
<dd><p>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.
</p>
<div id="index-CVS_005fIGNORE_005fREMOTE_005fROOT_002c-environment-variable"></div>
</dd>
<dt> <code>$CVS_IGNORE_REMOTE_ROOT</code></dt>
<dd><p>For <small>CVS</small> 1.10 and older, setting this variable
prevents <small>CVS</small> from overwriting the &lsquo;<tt>CVS/Root</tt>&rsquo;
file when the &lsquo;<samp>-d</samp>&rsquo; global option is specified.
Later versions of <small>CVS</small> do not rewrite
&lsquo;<tt>CVS/Root</tt>&rsquo;, so <code>CVS_IGNORE_REMOTE_ROOT</code> has no
effect.
</p>
<div id="index-CVS_005fLOCAL_005fBRANCH_005fNUM_002c-environment-variable"></div>
</dd>
<dt> <code>$CVS_LOCAL_BRANCH_NUM</code></dt>
<dd><p>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
<code>CVS_LOCAL_BRANCH_NUM</code> 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.
</p>
<div id="index-COMSPEC_002c-environment-variable"></div>
</dd>
<dt> <code>$COMSPEC</code></dt>
<dd><p>Used under OS/2 only.  It specifies the name of the
command interpreter and defaults to <small>CMD.EXE</small>.
</p>
<div id="index-TMPDIR_002c-environment-variable"></div>
</dd>
<dt> <code>$TMPDIR</code></dt>
<dd><div id="index-TMP_002c-environment-variable"></div>
</dd>
<dt> <code>$TMP</code></dt>
<dd><div id="index-TEMP_002c-environment-variable"></div>
</dd>
<dt> <code>$TEMP</code></dt>
<dd><div id="index-Temporary-files_002c-location-of"></div>
<p>Directory in which temporary files are located.
The <small>CVS</small> server uses
<code>TMPDIR</code>.  See section [cvs: Guide to CVS commands#Global-options Global options], for a
description of how to specify this.
Some parts of <small>CVS</small> will always use &lsquo;<tt>/tmp</tt>&rsquo; (via
the <code>tmpnam</code> function provided by the system).
</p>
<p>On Windows NT, <code>TMP</code> is used (via the <code>_tempnam</code>
function provided by the system).
</p>
<p>The <code>patch</code> program which is used by the <small>CVS</small>
client uses <code>TMPDIR</code>, and if it is not set, uses
&lsquo;<tt>/tmp</tt>&rsquo; (at least with GNU patch 2.1).  Note that
if your server and client are both running <small>CVS</small>
1.9.10 or later, <small>CVS</small> will not invoke an external
<code>patch</code> program.
</p>
<div id="index-CVS_005fPID_002c-environment-variable"></div>
</dd>
<dt> <code>$CVS_PID</code></dt>
<dd><p>This is the process identification (aka pid) number of
the <small>CVS</small> process. It is often useful in the
programs and/or scripts specified by the
&lsquo;<tt>commitinfo</tt>&rsquo;, &lsquo;<tt>verifymsg</tt>&rsquo;, &lsquo;<tt>loginfo</tt>&rsquo;
files.
</p></dd>
</dl>

<hr size="6">
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">|[cvs: Reference manual for Administrative files#Administrative-files  &lt;&lt; ]|</td>
<td valign="middle" align="left">|[cvs: Compatibility between CVS Versions#Compatibility  &gt;&gt; ]|</td>
<td valign="middle" align="left"> &nbsp; </td>
<td valign="middle" align="left"> &nbsp; </td>
<td valign="middle" align="left"> &nbsp; </td>
<td valign="middle" align="left"> &nbsp; </td>
<td valign="middle" align="left"> &nbsp; </td>
<td valign="middle" align="left">|[[cvs#Top|Top]]|</td>
<td valign="middle" align="left">|[cvs: Table of Contents#SEC_Contents Contents]|</td>
<td valign="middle" align="left">|[cvs: Index#Index Index]|</td>
<td valign="middle" align="left">|[cvs: About this Manual#SEC_About  ? ]|</td>
</tr></table>
This document was generated by <em>a tester</em> on <em>a sunny day</em> using [http://www.nongnu.org/texi2html/ <em>texi2html</em>].
