source: basicnet/netprogs/cvs.xml@ b136a6d

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
   "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;

  <!ENTITY cvs-download-http "https://ccvs.cvshome.org/files/documents/19/861/cvs-&cvs-version;.tar.bz2">
  <!ENTITY cvs-download-ftp  " ">
  <!ENTITY cvs-md5sum        "9e215c0ee3bb7dfb76515d7cd81a3742">
  <!ENTITY cvs-size          "2.4 MB">
  <!ENTITY cvs-buildsize     "22 MB">
  <!ENTITY cvs-time          "0.3 SBU (additional 19.1 SBU to run the test suite)">
]>

<sect1 id="cvs" xreflabel="CVS-&cvs-version;">
  <?dbhtml filename="cvs.html"?>

  <sect1info>
    <othername>$LastChangedBy$</othername>
    <date>$Date$</date>
  </sect1info>

  <title>CVS-&cvs-version;</title>
  
  <indexterm zone="cvs">
    <primary sortas="a-CVS">CVS</primary>
  </indexterm>
  
  <sect2 role="package">
    <title>Introduction to CVS</title>

    <para><application>CVS</application> is the Concurrent Versioning System. 
    This is a version control system useful for projects using a central repository 
    to hold files and then track all changes made to those files. These instructions 
    install the client used to manipulate the repository, creation of a repository is 
    covered at <xref linkend="cvsserver"/>.</para>
    
    <bridgehead renderas="sect3">Package Information</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>Download (HTTP): <ulink url="&cvs-download-http;"/></para>
      </listitem>
      <listitem>
        <para>Download (FTP): <ulink url="&cvs-download-ftp;"/></para>
      </listitem>
      <listitem>
        <para>Download MD5 sum: &cvs-md5sum;</para>
      </listitem>
      <listitem>
        <para>Download size: &cvs-size;</para>
      </listitem>
      <listitem>
        <para>Estimated disk space required: &cvs-buildsize;</para>
      </listitem>
      <listitem>
        <para>Estimated build time: &cvs-time;</para>
      </listitem>
    </itemizedlist>
    
    <bridgehead renderas="sect3">Additional Downloads</bridgehead>
    <itemizedlist spacing='compact'>
      <listitem>
        <para>Recommended patch: <ulink
        url="&patch-root;/cvs-&cvs-version;-zlib-1.patch"/></para>
      </listitem>
    </itemizedlist>
    
    <bridgehead renderas="sect3">CVS Dependencies</bridgehead>
    
    <bridgehead renderas="sect4">Optional</bridgehead>
    <para><xref linkend="gdbm"/>, 
    <xref linkend="tcsh"/>, 
    <ulink url="http://www.pdc.kth.se/kth-krb/">krb4</ulink>,
    <xref linkend="mitkrb"/> or <xref linkend="heimdal"/> 
    (for the GSSAPI libraries),
    <xref linkend="gs"/> or <xref linkend="espgs"/>,
    <ulink url="../server/mail.html">MTA</ulink> and
    <xref linkend="vim"/></para>

  </sect2>

  <sect2 role="installation">
    <title>Installation of CVS</title>

    <para>By default <application>CVS</application>
    is statically linked against the zlib library included in its source
    tree. This makes it exposed to possible security vulnerabilities in that
    library. If you want to modify CVS to use the newest system shared zlib
    library apply the following patch:</para>

<screen><userinput>patch -Np1 -i ../cvs-&cvs-version;-zlib-1.patch</userinput></screen>

    <para>Install <application>cvs</application> by running 
    the following commands:</para>

<screen><userinput>./configure --prefix=/usr &amp;&amp;
make</userinput></screen>

    <para>To test the results, issue: <command>make check</command>.</para>

    <para>Now, as the <systemitem class="username">root</systemitem> user:</para>

<screen role='root'><userinput>make install &amp;&amp;
install -v -m755 -d /usr/share/doc/cvs-&cvs-version; &amp;&amp;
install -v -m644 doc/cvs{,client}.ps /usr/share/doc/cvs-&cvs-version;</userinput></screen>

  </sect2>

  <sect2 role="configuration">
    <title>Configuring CVS</title>
    
    <sect3 id="cvs-config">
      <title>Config Files</title>
      
      <para><filename>~/.cvsrc</filename>, <filename>~/.cvswrappers</filename>,
      and <filename>~/.cvspass</filename>.</para>
      
      <indexterm zone="cvs cvs-config">
        <primary sortas="e-AA.cvsrc">~/.cvsrc</primary>
      </indexterm>
      
      <indexterm zone="cvs cvs-config">
        <primary sortas="e-AA.cvswrappers">~/.cvswrappers</primary>
      </indexterm>
      
      <indexterm zone="cvs cvs-config">
        <primary sortas="e-AA.cvspass">~/.cvspass</primary>
      </indexterm>
      
    </sect3>

    <sect3>
      <title>Configuration Information</title>

      <para><filename>~/.cvsrc</filename> is the main
      <application>CVS</application> configuration file.
      This file is used by users to specify defaults for different <command>cvs
      </command> commands, for example to make all <command>cvs diff</command> 
      commands run with <userinput>-u</userinput>, a user would add <userinput>
      diff -u</userinput> to their <filename>.cvsrc</filename> file.</para>

      <para><filename>~/.cvswrappers</filename> specifies wrappers to be used in 
      addition to those specified in the <filename>CVSROOT/cvswrappers</filename> 
      file in the repository.</para>
      
      <para><filename>~/.cvspass</filename> can hold passwords to complete
      logins to servers.</para>
      
    </sect3>

  </sect2>

  <sect2 role="content">
    <title>Contents</title>
    
    <segmentedlist>
      <segtitle>Installed Programs</segtitle>
      <segtitle>Installed Libraries</segtitle>
      <segtitle>Installed Directories</segtitle>
      
      <seglistitem>
        <seg>cvs, cvsbug, and rcs2log</seg>
        <seg>None</seg>
        <seg>/usr/share/cvs and /usr/share/doc/cvs-&cvs-version;</seg>
      </seglistitem>
    </segmentedlist>
    
    <variablelist>
      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
      <?dbfo list-presentation="list"?>
      <?dbhtml list-presentation="table"?>
     
      <varlistentry id="cvs-prog">
        <term><command>cvs</command></term>
        <listitem>
          <para>is the main program file for the concurrent versioning system.</para>
          <indexterm zone="cvs cvs-prog">
            <primary sortas="b-cvs">cvs</primary>
          </indexterm>
        </listitem>
      </varlistentry>
      
      <varlistentry id="cvsbug">
        <term><command>cvsbug</command></term>
        <listitem>
          <para>is used to send problem reports about <application>CVS</application> 
          to a central support site.</para>
          <indexterm zone="cvs cvsbug">
            <primary sortas="b-cvsbug">cvsbug</primary>
          </indexterm>
        </listitem>
      </varlistentry>
      
      <varlistentry id="rcs2log">
        <term><command>rcs2log</command></term>
        <listitem>
          <para>is a symlink to the contributed RCS to Change Log 
          generator.</para>
          <indexterm zone="cvs rcs2log">
            <primary sortas="b-rcs2log">rcs2log</primary>
          </indexterm>
        </listitem>
      </varlistentry>
    </variablelist>
    
  </sect2>
  
</sect1>