Rebuild documentation for the new config directives in 3.0.20
[privoxy.git] / doc / webserver / user-manual / installation.html
index ad3e77d..0620ee1 100644 (file)
@@ -6,7 +6,7 @@
   <title>Installation</title>
   <meta name="GENERATOR" content=
   "Modular DocBook HTML Stylesheet Version 1.79">
-  <link rel="HOME" title="Privoxy 3.0.19 User Manual" href="index.html">
+  <link rel="HOME" title="Privoxy 3.0.20 User Manual" href="index.html">
   <link rel="PREVIOUS" title="Introduction" href="introduction.html">
   <link rel="NEXT" title="What's New in this Release" href="whatsnew.html">
   <link rel="STYLESHEET" type="text/css" href="../p_doc.css">
@@ -20,7 +20,7 @@
     <table summary="Header navigation table" width="100%" border="0"
     cellpadding="0" cellspacing="0">
       <tr>
-        <th colspan="3" align="center">Privoxy 3.0.19 User Manual</th>
+        <th colspan="3" align="center">Privoxy 3.0.20 User Manual</th>
       </tr>
 
       <tr>
@@ -65,7 +65,7 @@
         "INSTALLATION-PACK-RPM">2.1.1. Red Hat and Fedora RPMs</a></h3>
 
         <p>RPMs can be installed with <tt class="LITERAL">rpm -Uvh
-        privoxy-3.0.19-1.rpm</tt>, and will use <tt class=
+        privoxy-3.0.20-1.rpm</tt>, and will use <tt class=
         "FILENAME">/etc/privoxy</tt> for the location of configuration
         files.</p>
 
@@ -77,7 +77,7 @@
 
         <p>If you have problems with failed dependencies, try rebuilding the
         SRC RPM: <tt class="LITERAL">rpm --rebuild
-        privoxy-3.0.19-1.src.rpm</tt>. This will use your locally installed
+        privoxy-3.0.20-1.src.rpm</tt>. This will use your locally installed
         libraries and RPM version.</p>
 
         <p>Also note that if you have a <span class=
         <h3 class="SECT3"><a name="INSTALLATION-MAC" id=
         "INSTALLATION-MAC">2.1.6. Mac OS X</a></h3>
 
-        <p>Unzip the downloaded file (you can either double-click on the zip
-        file icon from the Finder, or from the desktop if you downloaded it
-        there). Then, double-click on the package installer icon and follow
-        the installation process.</p>
+        <p>Installation instructions for the OS X platform depend upon
+        whether you downloaded a ready-built installation package (.pkg or
+        .mpkg) or have downloaded the source code.</p>
+      </div>
+
+      <div class="SECT3">
+        <h4 class="SECT3"><a name="OS-X-INSTALL-FROM-PACKAGE" id=
+        "OS-X-INSTALL-FROM-PACKAGE">2.1.7. Installation from ready-built
+        package</a></h4>
+
+        <p>The downloaded file will either be a .pkg (for OS X 10.5 upwards)
+        or a bzipped .mpkg file (for OS X 10.4). The former can be
+        double-clicked as is and the installation will start; double-clicking
+        the latter will unzip the .mpkg file which can then be double-clicked
+        to commence the installation.</p>
+
+        <p>The privoxy service will automatically start after a successful
+        installation (and thereafter every time your computer starts up)
+        however you will need to configure your web browser(s) to use it. To
+        do so, configure them to use a proxy for HTTP and HTTPS at the
+        address 127.0.0.1:8118.</p>
+
+        <p>To prevent the privoxy service from automatically starting when
+        your computer starts up, remove or rename the file <tt class=
+        "LITERAL">/Library/LaunchDaemons/org.ijbswa.privoxy.plist</tt> (on OS
+        X 10.5 and higher) or the folder named <tt class=
+        "LITERAL">/Library/StartupItems/Privoxy</tt> (on OS X 10.4
+        'Tiger').</p>
+
+        <p>To manually start or stop the privoxy service, use the scripts
+        startPrivoxy.sh and stopPrivoxy.sh supplied in /Applications/Privoxy.
+        They must be run from an administrator account, using sudo.</p>
+
+        <p>To uninstall, run /Applications/Privoxy/uninstall.command as sudo
+        from an administrator account.</p>
+      </div>
+
+      <div class="SECT3">
+        <h4 class="SECT3"><a name="OS-X-INSTALL-FROM-SOURCE" id=
+        "OS-X-INSTALL-FROM-SOURCE">2.1.8. Installation from source</a></h4>
+
+        <p>To build and install the Privoxy source code on OS X you will need
+        to obtain the macsetup module from the Privoxy Sourceforge CVS
+        repository (refer to Sourceforge help for details of how to set up a
+        CVS client to have read-only access to the repository). This module
+        contains scripts that leverage the usual open-source tools (available
+        as part of Apple's free of charge Xcode distribution or via the usual
+        open-source software package managers for OS X (MacPorts, Homebrew,
+        Fink etc.) to build and then install the privoxy binary and
+        associated files. The macsetup module's README file contains complete
+        instructions for its use.</p>
 
         <p>The privoxy service will automatically start after a successful
-        installation (in addition to every time your computer starts up). To
-        prevent the privoxy service from automatically starting when your
-        computer starts up, remove or rename the folder named <tt class=
-        "LITERAL">/Library/StartupItems/Privoxy</tt>.</p>
+        installation (and thereafter every time your computer starts up)
+        however you will need to configure your web browser(s) to use it. To
+        do so, configure them to use a proxy for HTTP and HTTPS at the
+        address 127.0.0.1:8118.</p>
+
+        <p>To prevent the privoxy service from automatically starting when
+        your computer starts up, remove or rename the file <tt class=
+        "LITERAL">/Library/LaunchDaemons/org.ijbswa.privoxy.plist</tt> (on OS
+        X 10.5 and higher) or the folder named <tt class=
+        "LITERAL">/Library/StartupItems/Privoxy</tt> (on OS X 10.4
+        'Tiger').</p>
 
         <p>To manually start or stop the privoxy service, use the Privoxy
-        Utility for Mac OS X. This application controls the privoxy service
-        (e.g. starting and stopping the service as well as uninstalling the
-        software).</p>
+        Utility for Mac OS X (also part of the macsetup module). This
+        application can start and stop the privoxy service and display its
+        log and configuration files.</p>
+
+        <p>To uninstall, run the macsetup module's uninstall.sh as sudo from
+        an administrator account.</p>
       </div>
 
       <div class="SECT3">
         <h3 class="SECT3"><a name="INSTALLATION-AMIGA" id=
-        "INSTALLATION-AMIGA">2.1.7. AmigaOS</a></h3>
+        "INSTALLATION-AMIGA">2.1.9. AmigaOS</a></h3>
 
         <p>Copy and then unpack the <tt class="FILENAME">lha</tt> archive to
         a suitable location. All necessary files will be installed into
 
       <div class="SECT3">
         <h3 class="SECT3"><a name="INSTALLATION-TBZ" id=
-        "INSTALLATION-TBZ">2.1.8. FreeBSD</a></h3>
+        "INSTALLATION-TBZ">2.1.10. FreeBSD</a></h3>
 
         <p>Privoxy is part of FreeBSD's Ports Collection, you can build and
         install it with <tt class="LITERAL">cd /usr/ports/www/privoxy; make
 
       <div class="SECT3">
         <h3 class="SECT3"><a name="INSTALLATTION-GENTOO" id=
-        "INSTALLATTION-GENTOO">2.1.9. Gentoo</a></h3>
+        "INSTALLATTION-GENTOO">2.1.11. Gentoo</a></h3>
 
         <p>Gentoo source packages (Ebuilds) for <span class=
         "APPLICATION">Privoxy</span> are contained in the Gentoo Portage Tree
 
         <p>Configuration files are in <tt class="FILENAME">/etc/privoxy</tt>,
         the documentation is in <tt class=
-        "FILENAME">/usr/share/doc/privoxy-3.0.19</tt> and the Log directory
+        "FILENAME">/usr/share/doc/privoxy-3.0.20</tt> and the Log directory
         is in <tt class="FILENAME">/var/log/privoxy</tt>.</p>
       </div>
     </div>
         <tr>
           <td>
             <pre class="SCREEN">
- tar xzvf privoxy-3.0.19-stable-src.tar.gz
- cd privoxy-3.0.19-stable
+ tar xzvf privoxy-3.0.20-beta-src.tar.gz
+ cd privoxy-3.0.20-beta
 </pre>
           </td>
         </tr>