source: basicnet/netprogs/subversion.xml@ e5243605

<?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 subversion-download-http "http://subversion.tigris.org/tarballs/subversion-&subversion-version;.tar.bz2">
  <!ENTITY subversion-download-ftp  " ">
  <!ENTITY subversion-md5sum        "6e557ae65b6b8d7577cc7704ede85a23">
  <!ENTITY subversion-size          "6.7 MB">
  <!ENTITY subversion-buildsize     "182 MB (additional 577 MB to run all test suites)">
  <!ENTITY subversion-time          "1.24 SBU (add 0.90 SBU for SWIG bindings and 6.45 SBU to run test suites)">
  <!ENTITY svn-neon-version         "0.24.7">
]>

<sect1 id="subversion" xreflabel="Subversion-&subversion-version;">
<sect1info>
<othername>$LastChangedBy$</othername>
<date>$Date$</date>
</sect1info>
<?dbhtml filename="subversion.html"?>
<title>Subversion-&subversion-version;</title>
<indexterm zone="subversion">
<primary sortas="a-Subversion">Subversion</primary></indexterm>

<sect2>
<title>Introduction to <application>Subversion</application></title>

<para><application>Subversion</application> is a version control system 
that is designed to be a compelling replacement for 
<application><acronym>CVS</acronym></application> in the open source 
community. It extends and enhances 
<application><acronym>CVS</acronym></application>' feature set, while 
maintaining a similar interface for those already familiar 
with <application><acronym>CVS</acronym></application>. These instructions 
install the client and server software used to manipulate a 
<application>Subversion</application> repository. Creation of a repository is 
covered at <xref linkend="svnserver"/>.</para>

<sect3><title>Package information</title>
<itemizedlist spacing='compact'>
<listitem><para>Download (HTTP): 
<ulink url="&subversion-download-http;"/></para></listitem>
<listitem><para>Download (FTP): 
<ulink url="&subversion-download-ftp;"/></para></listitem>
<listitem><para>Download MD5 sum: 
&subversion-md5sum;</para></listitem>
<listitem><para>Download size: 
&subversion-size;</para></listitem>
<listitem><para>Estimated disk space required: 
&subversion-buildsize;</para></listitem>
<listitem><para>Estimated build time: 
&subversion-time;</para></listitem></itemizedlist>
</sect3>

<sect3><title><application>Subversion</application> dependencies</title>
<sect4><title>Required</title>
<para><xref linkend="libxml2"/> (only if using the bundled version of 
<application>neon</application>)</para>
</sect4>

<sect4><title>Optional</title>
<para><xref linkend="python"/> (required to run the full test suite), 
<xref linkend="apache"/>, 
<xref linkend="openssh"/> (runtime only), 
<ulink url="http://www.webdav.org/neon/">neon-&svn-neon-version;</ulink>, 
<xref linkend="j2sdk"/> (to build the <application>JAVA</application> 
bindings), 
<ulink url="http://www.junit.org/">JUnit</ulink> (for running the 
<application>JAVA</application> bindings test suite and requires 
<xref linkend="unzip"/>), 
<ulink url="http://www.inet.no/dante/">Dante</ulink> (alternate 
<application>JAVA</application> compiler), 
<ulink url="http://oss.software.ibm.com/developerworks/opensource/jikes/">
Jikes</ulink> (another alternate 
<application>JAVA</application> compiler) and 
inetd or <xref linkend="xinetd"/> (server only)</para>
</sect4>

<sect4><title>Optional for the bundled version of 
<application>neon</application></title>
<para><xref linkend="pkgconfig"/>, 
<xref linkend="openssl"/>, 
<xref linkend="heimdal"/> or <xref linkend="mitkrb"/></para>
</sect4>

<sect4><title>Optional for the bundled version of 
<application>Apache Portable Runtime</application></title>
<para><xref linkend="expat"/> and 
<xref linkend="gdbm"/></para>
</sect4>

<sect4><title>Optional to build the <application>SWIG</application> 
bindings</title>
<para><ulink url="http://www.swig.org">SWIG</ulink> and 
<xref linkend="python"/></para>
</sect4>
</sect3>

</sect2>

<sect2>
<title>Installation of <application>Subversion</application></title>

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

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

<para>If you passed the <option>--enable-javahl</option> parameter to 
<command>configure</command> and wish to build the 
<application>JAVA</application> <application>Subversion</application> 
bindings, issue the following command:</para>

<screen><userinput><command>make javahl</command></userinput></screen>

<para>If you passed the <option>--with-swig</option> and 
<option>--enable-swig-bindings</option> parameters to 
<command>configure</command> and wish to build the 
<application>SWIG</application> <application>Perl</application> and 
<application>Python</application> <application>Subversion</application> 
bindings, issue the following commands:</para>

<screen><userinput><command>make swig-pl &amp;&amp;
make swig-py</command></userinput></screen>

<para>Now, as the root user:</para>

<screen><userinput role='root'><command>make install &amp;&amp;
install -v -d -m755 /usr/share/doc/subversion-&subversion-version; &amp;&amp;
cp -v -R doc/* /usr/share/doc/subversion-&subversion-version;</command></userinput></screen>

<note><para>If you have <application>Apache</application> installed, pass
the <option>--with-apr=/usr</option> and <option>--with-apr-util=/usr</option> 
switches to the <command>configure</command> script. Otherwise, 
<application>Subversion</application> will overwrite
<acronym>APR</acronym> and <acronym>APR</acronym>-utils from the 
<application>Apache</application> installation with its own
files. You may also need to pass <option>--with-apxs=/usr/sbin/apxs</option> 
as <command>apxs</command> might not be in an unprivileged user's 
<envar>PATH</envar> and won't be properly discovered.</para></note>

<para>If you built the <application>JAVA</application> 
<application>Subversion</application> bindings, issue the following command 
as the root user to install them:</para>

<screen><userinput role='root'><command>make install-javahl</command></userinput></screen>

<para>If you built the <application>SWIG</application> 
<application>Perl</application> and <application>Python</application> 
<application>Subversion</application> bindings, issue the following commands 
as the root user to install them:</para>

<screen><userinput role='root'><command>make install-swig-pl &amp;&amp;
make install-swig-py &amp;&amp;
echo /usr/lib/svn-python \
    > /usr/lib/python2.4/site-packages/subversion.pth</command></userinput></screen>

</sect2>

<sect2>
<title>Command explanations</title>

<para><option>--with-ssl</option>: This switch enables 
<application>Open<acronym>SSL</acronym></application> support in 
<application>neon</application> (only required if you use the bundled version 
of <application>neon</application>).</para>

</sect2>

<sect2>
<title>Configuring <application>Subversion</application></title>

<sect3 id="subversion-config"><title>Config files</title>
<para><filename>~/.subversion/config</filename> and 
<filename>/etc/subversion/config</filename></para>
<indexterm zone="subversion subversion-config">
<primary sortas="e-AA.subversion/config">~/.subversion/config</primary>
</indexterm>
<indexterm zone="subversion subversion-config">
<primary sortas="e-etc-subversion-config">/etc/subversion/config</primary>
</indexterm>
</sect3>

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

<para><filename>/etc/subversion/config</filename> is the 
<application>Subversion</application> system-wide configuration file.
This file is used to specify defaults for different 
<command>svn</command> commands.</para>

<para><filename>~/.subversion/config</filename> is the user's personal 
configuration file. It is used to override the system-wide defaults 
set in <filename>/etc/subversion/config</filename>.</para>
</sect3>

</sect2>

<sect2>
<title>Contents</title>

<segmentedlist>
<segtitle>Installed Programs</segtitle>
<segtitle>Installed Libraries</segtitle>
<segtitle>Installed Directories</segtitle>
<seglistitem>
<seg>svn, svnadmin, svndumpfilter, svnlook, svnserve, svnversion and 
optionally, neon-config</seg>
<seg>libsvn*.[so,a] and optionally, libneon.[so,a] and the mod_dav_svn.so 
and mod_authz_svn.so <application>Apache 
<acronym>HTTP</acronym></application> <acronym>DSO</acronym> modules</seg>
<seg>/etc/subversion, /usr/include/neon (optional), /usr/include/subversion-1, 
/usr/lib/perl5/site_perl/5.8.6/i686-linux/auto/SVN (optional), 
/usr/lib/perl5/site_perl/5.8.6/i686-linux/SVN (optional), 
/usr/lib/svn-javahl (optional), /usr/lib/svn-python (optional), 
/usr/share/doc/neon-&svn-neon-version; (optional) and 
/usr/share/doc/subversion-&subversion-version;</seg>
</seglistitem>
</segmentedlist>

<variablelist>
<bridgehead renderas="sect3">Short Descriptions</bridgehead>
<?dbfo list-presentation="list"?>

<varlistentry id="svn">
<term><command>svn</command></term>
<listitem><para>is a command-line client program used to access 
<application>Subversion</application> repositories.</para>
<indexterm zone="subversion svn">
<primary sortas="b-svn">svn</primary></indexterm>
</listitem>
</varlistentry>

<varlistentry id="svnadmin">
<term><command>svnadmin</command></term>
<listitem><para>is a tool for creating, tweaking or repairing a
<application>Subversion</application> repository.</para>
<indexterm zone="subversion svnadmin">
<primary sortas="b-svnadmin">svnadmin</primary></indexterm>
</listitem>
</varlistentry>

<varlistentry id="svndumpfilter">
<term><command>svndumpfilter</command></term>
<listitem><para>is a program for filtering 
<application>Subversion</application> repository dumpfile format 
streams.</para>
<indexterm zone="subversion svndumpfilter">
<primary sortas="b-svndumpfilter">svndumpfilter</primary></indexterm>
</listitem>
</varlistentry>

<varlistentry id="svnlook">
<term><command>svnlook</command></term>
<listitem><para>is a tool for inspecting a 
<application>Subversion</application> repository.</para>
<indexterm zone="subversion svnlook">
<primary sortas="b-svnlook">svnlook</primary></indexterm>
</listitem>
</varlistentry>

<varlistentry id="svnserve">
<term><command>svnserve</command></term>
<listitem><para>is a custom standalone server program, able to run as a 
daemon process or invoked by <acronym>SSH</acronym>.</para>
<indexterm zone="subversion svnserve">
<primary sortas="b-svnserve">svnserve</primary></indexterm>
</listitem>
</varlistentry>

<varlistentry id="svnversion">
<term><command>svnversion</command></term>
<listitem><para>is used to report the version number and state of a 
working <application>Subversion</application> repository copy.</para>
<indexterm zone="subversion svnversion">
<primary sortas="b-svnversion">svnversion</primary></indexterm>
</listitem>
</varlistentry>

<varlistentry id="neon-config">
<term><command>neon-config</command></term>
<listitem><para>is a script which provides information about an installed 
copy of the <application>neon</application> library.</para>
<indexterm zone="subversion neon-config">
<primary sortas="b-neon-config">neon-config</primary></indexterm>
</listitem>
</varlistentry>

<varlistentry id="libsvn_star">
<term><filename class='libraryfile'>libsvn_*.[so,a]</filename></term>
<listitem><para>are the support libraries used by the 
<application>Subversion</application> programs.</para>
<indexterm zone="subversion libsvn_star">
<primary sortas="c-libsvn_star">libsvn_*.[so,a]</primary></indexterm>
</listitem>
</varlistentry>

<varlistentry id="libneon">
<term><filename class='libraryfile'>libneon.[so,a]</filename></term>
<listitem><para>is used as a high-level interface to common 
<acronym>HTTP</acronym> and Web<acronym>DAV</acronym> methods.</para>
<indexterm zone="subversion libneon">
<primary sortas="c-libneon">libneon.[so,a]</primary></indexterm>
</listitem>
</varlistentry>

<varlistentry id="mod_authz_svn">
<term><filename class='libraryfile'>mod_authz_svn.so</filename></term>
<listitem><para>is a plug-in module for the <application>Apache</application>
<acronym>HTTP</acronym> server, used to authenticate users to a 
<application>Subversion</application> repository over the Internet or an 
intranet.</para>
<indexterm zone="subversion mod_authz_svn">
<primary sortas="c-mod_authz_svn">mod_authz_svn.so</primary></indexterm>
</listitem>
</varlistentry>

<varlistentry id="mod_dav_svn">
<term><filename class='libraryfile'>mod_dav_svn.so</filename></term>
<listitem><para>is a plug-in module for the <application>Apache</application> 
<acronym>HTTP</acronym> server, used to make a 
<application>Subversion</application> repository available to others over the 
Internet or an intranet.</para>
<indexterm zone="subversion mod_dav_svn">
<primary sortas="c-mod_authz_svn">mod_dav_svn.so</primary></indexterm>
</listitem>
</varlistentry>
</variablelist>

</sect2>

</sect1>