doc/install.xml

   1 <chapter id="install">
   2         <title>Installation</title>
   3
   4         <sect1>
   5                 <title>Precompiled packages</title>
   6
   7                 <para>Most Linux distributions come with a packaged version
   8                         of CtrlProxy. ctrlproxy is also included in the BSD ports collection.</para>
   9
  10                 <para>If you already have a packaged version of ctrlproxy installed, you can skip this chapter.</para>
  11
  12         </sect1>
  13
  14         <sect1>
  15                 <title>Supported platforms</title>
  16
  17                 <para>CtrlProxy should run on pretty much all POSIX-compatible
  18                         platforms. A version for Windows might be released in the future.
  19                 </para>
  20         </sect1>
  21
  22         <sect1>
  23                 <title>Obtaining the source code</title>
  24
  25                 <para>The source of ctrlproxy can be downloaded from <ulink url="http://www.ctrlproxy.org/">the CtrlProxy homepage</ulink>. The
  26                         source files available there can be unpacked using tar and gzip:</para>
  27
  28                 <para><screen>
  29 <prompt>$ </prompt><userinput>tar xvgz ctrlproxy-3.0.6.tar.gz</userinput>
  30 ctrlproxy-3.0.6/AUTHORS
  31 ...
  32 </screen></para>
  33
  34                 <para>If you wish to use the bleeding-edge version of ctrlproxy, you can
  35                         download the sources from Bazaar. </para>
  36
  37                 <sect2>
  38                         <title>Downloading from Bazaar</title>
  39
  40                         <para>Ctrlproxy Bazaar can be accessed by running: </para>
  41
  42                         <para><screen>
  43                                         <prompt>$ </prompt><userinput>bzr get http://people.samba.org/bzr/jelmer/ctrlproxy/trunk ctrlproxy-trunk</userinput>
  44 ...
  45 </screen>
  46                         </para>
  47
  48                         <para>Make sure you run the <filename>autogen.sh</filename> in the source directory so that the <filename>configure</filename> script is generated correctly.
  49                         </para>
  50                 </sect2>
  51         </sect1>
  52
  53         <sect1>
  54                 <title>Compiling from source</title>
  55
  56                 <para>First, run the <filename>configure</filename> script:</para>
  57
  58                 <para><screen>
  59 <prompt>$ </prompt><userinput>./configure</userinput>
  60 </screen></para>
  61
  62                 <para>If this script does not detect all libraries and headers, while
  63                         they are present, specify the locations using command line arguments
  64                         to <filename>configure</filename>. Run <command>./configure --help</command> for details.</para>
  65
  66                 <para>After <filename>configure</filename> has finished, run <command>make</command>. </para>
  67
  68                 <para>Once ctrlproxy has been built, find your system administrator
  69                         or become root yourself and run <command>make install</command>.</para>
  70
  71         </sect1>
  72 </chapter>