[d47e7ea9] | 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
[6732c094] | 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
[d47e7ea9] | 4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
| 5 | %general-entities;
|
---|
| 6 |
|
---|
[5d678ec] | 7 | <!ENTITY cvs-download-http "http://ftp.gnu.org/non-gnu/cvs/source/stable/&cvs-version;/cvs-&cvs-version;.tar.bz2">
|
---|
| 8 | <!ENTITY cvs-download-ftp "ftp://ftp.gnu.org/non-gnu/cvs/source/stable/&cvs-version;/cvs-&cvs-version;.tar.bz2">
|
---|
[07a1a61] | 9 | <!ENTITY cvs-md5sum "f24043a640509aff1aa28871dd345762">
|
---|
| 10 | <!ENTITY cvs-size "2.9 MB">
|
---|
| 11 | <!ENTITY cvs-buildsize "32.3 MB">
|
---|
[5d678ec] | 12 | <!ENTITY cvs-time "0.3 SBU (additional ~20 SBU to run the test suite)">
|
---|
[d47e7ea9] | 13 | ]>
|
---|
| 14 |
|
---|
[9635613] | 15 | <sect1 id="cvs" xreflabel="CVS-&cvs-version;">
|
---|
[b3497e4] | 16 | <?dbhtml filename="cvs.html"?>
|
---|
| 17 |
|
---|
| 18 | <sect1info>
|
---|
| 19 | <othername>$LastChangedBy$</othername>
|
---|
| 20 | <date>$Date$</date>
|
---|
| 21 | </sect1info>
|
---|
| 22 |
|
---|
| 23 | <title>CVS-&cvs-version;</title>
|
---|
[bab92281] | 24 |
|
---|
[b3497e4] | 25 | <indexterm zone="cvs">
|
---|
| 26 | <primary sortas="a-CVS">CVS</primary>
|
---|
| 27 | </indexterm>
|
---|
[bab92281] | 28 |
|
---|
[b3497e4] | 29 | <sect2 role="package">
|
---|
| 30 | <title>Introduction to CVS</title>
|
---|
| 31 |
|
---|
[919683dc] | 32 | <para><application>CVS</application> is the Concurrent Versions System.
|
---|
[f9461f8] | 33 | This is a version control system useful for projects using a central
|
---|
| 34 | repository to hold files and then track all changes made to those files.
|
---|
| 35 | These instructions install the client used to manipulate the repository,
|
---|
| 36 | creation of a repository is covered at <xref linkend="cvsserver"/>.</para>
|
---|
[bab92281] | 37 |
|
---|
[b3497e4] | 38 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 39 | <itemizedlist spacing="compact">
|
---|
| 40 | <listitem>
|
---|
| 41 | <para>Download (HTTP): <ulink url="&cvs-download-http;"/></para>
|
---|
| 42 | </listitem>
|
---|
| 43 | <listitem>
|
---|
| 44 | <para>Download (FTP): <ulink url="&cvs-download-ftp;"/></para>
|
---|
| 45 | </listitem>
|
---|
| 46 | <listitem>
|
---|
| 47 | <para>Download MD5 sum: &cvs-md5sum;</para>
|
---|
| 48 | </listitem>
|
---|
| 49 | <listitem>
|
---|
| 50 | <para>Download size: &cvs-size;</para>
|
---|
| 51 | </listitem>
|
---|
| 52 | <listitem>
|
---|
| 53 | <para>Estimated disk space required: &cvs-buildsize;</para>
|
---|
| 54 | </listitem>
|
---|
| 55 | <listitem>
|
---|
[dc6715a] | 56 | <para>Estimated build time: &cvs-time;</para>
|
---|
| 57 | </listitem>
|
---|
[b3497e4] | 58 | </itemizedlist>
|
---|
[bab92281] | 59 |
|
---|
[b3497e4] | 60 | <bridgehead renderas="sect3">Additional Downloads</bridgehead>
|
---|
| 61 | <itemizedlist spacing='compact'>
|
---|
| 62 | <listitem>
|
---|
| 63 | <para>Recommended patch: <ulink
|
---|
| 64 | url="&patch-root;/cvs-&cvs-version;-zlib-1.patch"/></para>
|
---|
| 65 | </listitem>
|
---|
| 66 | </itemizedlist>
|
---|
[bab92281] | 67 |
|
---|
[b3497e4] | 68 | <bridgehead renderas="sect3">CVS Dependencies</bridgehead>
|
---|
[bab92281] | 69 |
|
---|
[b3497e4] | 70 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
[4dbbf634] | 71 | <para role="optional"><xref linkend="gdbm"/>,
|
---|
[17e6d48] | 72 | <xref linkend="tcsh"/>,
|
---|
[07a1a61] | 73 | <xref linkend="openssh"/>,
|
---|
[b3497e4] | 74 | <ulink url="http://www.pdc.kth.se/kth-krb/">krb4</ulink>,
|
---|
[bab92281] | 75 | <xref linkend="mitkrb"/> or <xref linkend="heimdal"/>
|
---|
[b136a6d] | 76 | (for the GSSAPI libraries),
|
---|
[ce2bf7d] | 77 | <xref linkend="gs"/> or <xref linkend="espgs"/>, and
|
---|
[7f5c97e] | 78 | an <xref linkend="server-mail"/> (that provides a
|
---|
[5d678ec] | 79 | <command>sendmail</command> command)</para>
|
---|
[b3497e4] | 80 |
|
---|
[07a1a61] | 81 | <para><application>CVS</application> will invoke a default text editor to
|
---|
| 82 | create a commit message if the <parameter>-m "Commit message"</parameter>
|
---|
| 83 | parameter was not used when changes are committed to a respository.
|
---|
| 84 | <application>CVS</application> looks for the following text editors, in the
|
---|
| 85 | order shown below, during configuration to determine the default. This
|
---|
| 86 | default can always be overridden by the <envar>CVSEDITOR</envar> or
|
---|
| 87 | <envar>EDITOR</envar> environment variables and can be specified directly
|
---|
| 88 | by passing the <option>--with-editor=<replaceable><desired text
|
---|
| 89 | editor></replaceable></option> parameter to the
|
---|
| 90 | <command>configure</command> script.</para>
|
---|
| 91 |
|
---|
| 92 | <itemizedlist spacing='compact'>
|
---|
| 93 | <listitem>
|
---|
| 94 | <para><xref linkend="vim"/></para>
|
---|
| 95 | </listitem>
|
---|
| 96 | <listitem>
|
---|
| 97 | <para><xref linkend="emacs"/></para>
|
---|
| 98 | </listitem>
|
---|
| 99 | <listitem>
|
---|
| 100 | <para><xref linkend="nano"/></para>
|
---|
| 101 | </listitem>
|
---|
| 102 | <listitem>
|
---|
| 103 | <para><xref linkend="pine"/> (for Pico)</para>
|
---|
| 104 | </listitem>
|
---|
| 105 | </itemizedlist>
|
---|
| 106 |
|
---|
| 107 |
|
---|
[061ec9d] | 108 | <para condition="html" role="usernotes">User Notes:
|
---|
| 109 | <ulink url="&blfs-wiki;/cvs"/></para>
|
---|
| 110 |
|
---|
[b3497e4] | 111 | </sect2>
|
---|
| 112 |
|
---|
| 113 | <sect2 role="installation">
|
---|
| 114 | <title>Installation of CVS</title>
|
---|
| 115 |
|
---|
[f9461f8] | 116 | <para>By default <application>CVS</application> is statically linked
|
---|
| 117 | against the <application>Zlib</application> library included in its source
|
---|
| 118 | tree. This makes it exposed to possible security vulnerabilities in that
|
---|
| 119 | library. If you want to modify <application>CVS</application> to use the
|
---|
| 120 | system shared <application>Zlib</application> library, apply the following
|
---|
| 121 | patch:</para>
|
---|
[b3497e4] | 122 |
|
---|
| 123 | <screen><userinput>patch -Np1 -i ../cvs-&cvs-version;-zlib-1.patch</userinput></screen>
|
---|
| 124 |
|
---|
[339fbfb9] | 125 | <para>Install <application>CVS</application> by running
|
---|
[b3497e4] | 126 | the following commands:</para>
|
---|
| 127 |
|
---|
| 128 | <screen><userinput>./configure --prefix=/usr &&
|
---|
[b136a6d] | 129 | make</userinput></screen>
|
---|
| 130 |
|
---|
[520f6b4f] | 131 | <para>If you have <xref linkend="tetex"/> installed and wish to create
|
---|
[07a1a61] | 132 | DVI, Postscript, HTML or text docs from the documentation source files,
|
---|
| 133 | issue the following command:</para>
|
---|
| 134 |
|
---|
| 135 | <screen><userinput>make -C doc html txt dvi ps</userinput></screen>
|
---|
[f9461f8] | 136 |
|
---|
[5d678ec] | 137 | <para>To test the results, issue: <command>make check</command>. This will
|
---|
[07a1a61] | 138 | take quite a while. If you don't have <command>rsh</command> configured for
|
---|
| 139 | access to the host you are building on (or you didn't pass the
|
---|
| 140 | <option>--with-rsh=</option> parameter to the <command>configure</command>
|
---|
| 141 | script, some tests may fail. If you passed the
|
---|
| 142 | <option>--with-rsh=ssh</option> parameter to enable <command>ssh</command>
|
---|
| 143 | as the default remote shell program, you'll need to issue the following
|
---|
| 144 | command so that the tests will complete without any failures:</para>
|
---|
| 145 |
|
---|
| 146 | <screen><userinput>sed -e 's/rsh};/ssh};/' \
|
---|
| 147 | -e 's/g=rw,o=r$/g=r,o=r/' \
|
---|
| 148 | -i src/sanity.sh</userinput></screen>
|
---|
[b136a6d] | 149 |
|
---|
| 150 | <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
|
---|
| 151 |
|
---|
| 152 | <screen role='root'><userinput>make install &&
|
---|
| 153 | install -v -m755 -d /usr/share/doc/cvs-&cvs-version; &&
|
---|
[5d678ec] | 154 | install -v -m644 FAQ README /usr/share/doc/cvs-&cvs-version; &&
|
---|
[f147ee8] | 155 | install -v -m644 doc/*.pdf /usr/share/doc/cvs-&cvs-version;</userinput></screen>
|
---|
[f9461f8] | 156 |
|
---|
| 157 | <para>If you created any additional documentation, install it by issuing
|
---|
[07a1a61] | 158 | the following commands as the
|
---|
[f9461f8] | 159 | <systemitem class="username">root</systemitem> user:</para>
|
---|
| 160 |
|
---|
[07a1a61] | 161 | <screen role='root'><userinput>install -v -m644 doc/*.{ps,dvi,txt} /usr/share/doc/cvs-&cvs-version; &&
|
---|
| 162 | install -v -m755 -d /usr/share/doc/cvs-&cvs-version;/html/cvs{,client} &&
|
---|
| 163 | install -v -m644 doc/cvs.html/* \
|
---|
| 164 | /usr/share/doc/cvs-&cvs-version;/html/cvs &&
|
---|
| 165 | install -v -m644 doc/cvsclient.html/* \
|
---|
| 166 | /usr/share/doc/cvs-&cvs-version;/html/cvsclient</userinput></screen>
|
---|
[b3497e4] | 167 |
|
---|
| 168 | </sect2>
|
---|
| 169 |
|
---|
| 170 | <sect2 role="configuration">
|
---|
| 171 | <title>Configuring CVS</title>
|
---|
[bab92281] | 172 |
|
---|
[b3497e4] | 173 | <sect3 id="cvs-config">
|
---|
| 174 | <title>Config Files</title>
|
---|
[bab92281] | 175 |
|
---|
[b3497e4] | 176 | <para><filename>~/.cvsrc</filename>, <filename>~/.cvswrappers</filename>,
|
---|
| 177 | and <filename>~/.cvspass</filename>.</para>
|
---|
[bab92281] | 178 |
|
---|
[b3497e4] | 179 | <indexterm zone="cvs cvs-config">
|
---|
| 180 | <primary sortas="e-AA.cvsrc">~/.cvsrc</primary>
|
---|
| 181 | </indexterm>
|
---|
[bab92281] | 182 |
|
---|
[b3497e4] | 183 | <indexterm zone="cvs cvs-config">
|
---|
| 184 | <primary sortas="e-AA.cvswrappers">~/.cvswrappers</primary>
|
---|
| 185 | </indexterm>
|
---|
[bab92281] | 186 |
|
---|
[b3497e4] | 187 | <indexterm zone="cvs cvs-config">
|
---|
| 188 | <primary sortas="e-AA.cvspass">~/.cvspass</primary>
|
---|
| 189 | </indexterm>
|
---|
[bab92281] | 190 |
|
---|
[b3497e4] | 191 | </sect3>
|
---|
| 192 |
|
---|
| 193 | <sect3>
|
---|
| 194 | <title>Configuration Information</title>
|
---|
| 195 |
|
---|
| 196 | <para><filename>~/.cvsrc</filename> is the main
|
---|
| 197 | <application>CVS</application> configuration file.
|
---|
[339fbfb9] | 198 | This file is used by users to specify defaults for different
|
---|
| 199 | <command>cvs</command> commands. For example, to make all
|
---|
| 200 | <command>cvs diff</command> commands run with <option>-u</option>, a user
|
---|
| 201 | would add <option>diff -u</option> to their <filename>.cvsrc</filename>
|
---|
| 202 | file.</para>
|
---|
[b3497e4] | 203 |
|
---|
[17e6d48] | 204 | <para><filename>~/.cvswrappers</filename> specifies wrappers to be used in
|
---|
[bab92281] | 205 | addition to those specified in the <filename>CVSROOT/cvswrappers</filename>
|
---|
[b3497e4] | 206 | file in the repository.</para>
|
---|
[bab92281] | 207 |
|
---|
[07a1a61] | 208 | <para><filename>~/.cvspass</filename> contains passwords used to complete
|
---|
[b3497e4] | 209 | logins to servers.</para>
|
---|
[bab92281] | 210 |
|
---|
[b3497e4] | 211 | </sect3>
|
---|
| 212 |
|
---|
| 213 | </sect2>
|
---|
| 214 |
|
---|
| 215 | <sect2 role="content">
|
---|
| 216 | <title>Contents</title>
|
---|
[bab92281] | 217 |
|
---|
[b3497e4] | 218 | <segmentedlist>
|
---|
| 219 | <segtitle>Installed Programs</segtitle>
|
---|
| 220 | <segtitle>Installed Libraries</segtitle>
|
---|
| 221 | <segtitle>Installed Directories</segtitle>
|
---|
[bab92281] | 222 |
|
---|
[b3497e4] | 223 | <seglistitem>
|
---|
| 224 | <seg>cvs, cvsbug, and rcs2log</seg>
|
---|
| 225 | <seg>None</seg>
|
---|
[b136a6d] | 226 | <seg>/usr/share/cvs and /usr/share/doc/cvs-&cvs-version;</seg>
|
---|
[b3497e4] | 227 | </seglistitem>
|
---|
| 228 | </segmentedlist>
|
---|
[bab92281] | 229 |
|
---|
[b3497e4] | 230 | <variablelist>
|
---|
| 231 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 232 | <?dbfo list-presentation="list"?>
|
---|
| 233 | <?dbhtml list-presentation="table"?>
|
---|
[bab92281] | 234 |
|
---|
[b3497e4] | 235 | <varlistentry id="cvs-prog">
|
---|
| 236 | <term><command>cvs</command></term>
|
---|
| 237 | <listitem>
|
---|
[919683dc] | 238 | <para>is the main program file for the concurrent versions system.</para>
|
---|
[b3497e4] | 239 | <indexterm zone="cvs cvs-prog">
|
---|
| 240 | <primary sortas="b-cvs">cvs</primary>
|
---|
| 241 | </indexterm>
|
---|
| 242 | </listitem>
|
---|
| 243 | </varlistentry>
|
---|
[bab92281] | 244 |
|
---|
[b3497e4] | 245 | <varlistentry id="cvsbug">
|
---|
| 246 | <term><command>cvsbug</command></term>
|
---|
| 247 | <listitem>
|
---|
[bab92281] | 248 | <para>is used to send problem reports about <application>CVS</application>
|
---|
[b3497e4] | 249 | to a central support site.</para>
|
---|
| 250 | <indexterm zone="cvs cvsbug">
|
---|
| 251 | <primary sortas="b-cvsbug">cvsbug</primary>
|
---|
| 252 | </indexterm>
|
---|
| 253 | </listitem>
|
---|
| 254 | </varlistentry>
|
---|
[bab92281] | 255 |
|
---|
[b3497e4] | 256 | <varlistentry id="rcs2log">
|
---|
| 257 | <term><command>rcs2log</command></term>
|
---|
| 258 | <listitem>
|
---|
[17e6d48] | 259 | <para>is a symlink to the contributed RCS to Change Log
|
---|
[b136a6d] | 260 | generator.</para>
|
---|
[b3497e4] | 261 | <indexterm zone="cvs rcs2log">
|
---|
| 262 | <primary sortas="b-rcs2log">rcs2log</primary>
|
---|
| 263 | </indexterm>
|
---|
| 264 | </listitem>
|
---|
| 265 | </varlistentry>
|
---|
| 266 | </variablelist>
|
---|
[bab92281] | 267 |
|
---|
[b3497e4] | 268 | </sect2>
|
---|
[bab92281] | 269 |
|
---|
[f45b1953] | 270 | </sect1>
|
---|