Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch)
[privoxy.git] / doc / webserver / user-manual / installation.html
index 192498f..c73538e 100644 (file)
@@ -1,20 +1,20 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
 <HTML
 ><HEAD
 ><TITLE
 >Installation</TITLE
 ><META
 NAME="GENERATOR"
-CONTENT="Modular DocBook HTML Stylesheet Version 1.64
-"><LINK
+CONTENT="Modular DocBook HTML Stylesheet Version 1.7"><LINK
 REL="HOME"
-TITLE="Privoxy User Manual"
+TITLE="Privoxy 3.0.3 User Manual"
 HREF="index.html"><LINK
 REL="PREVIOUS"
 TITLE="Introduction"
 HREF="introduction.html"><LINK
 REL="NEXT"
-TITLE="Quickstart to Using Privoxy"
-HREF="quickstart.html"><LINK
+TITLE="Note to Upgraders"
+HREF="upgradersnote.html"><LINK
 REL="STYLESHEET"
 TYPE="text/css"
 HREF="../p_doc.css"></HEAD
@@ -28,6 +28,7 @@ ALINK="#0000FF"
 ><DIV
 CLASS="NAVHEADER"
 ><TABLE
+SUMMARY="Header navigation table"
 WIDTH="100%"
 BORDER="0"
 CELLPADDING="0"
@@ -36,7 +37,7 @@ CELLSPACING="0"
 ><TH
 COLSPAN="3"
 ALIGN="center"
->Privoxy User Manual</TH
+>Privoxy 3.0.3 User Manual</TH
 ></TR
 ><TR
 ><TD
@@ -45,6 +46,7 @@ ALIGN="left"
 VALIGN="bottom"
 ><A
 HREF="introduction.html"
+ACCESSKEY="P"
 >Prev</A
 ></TD
 ><TD
@@ -57,7 +59,8 @@ WIDTH="10%"
 ALIGN="right"
 VALIGN="bottom"
 ><A
-HREF="quickstart.html"
+HREF="upgradersnote.html"
+ACCESSKEY="N"
 >Next</A
 ></TD
 ></TR
@@ -71,7 +74,7 @@ CLASS="SECT1"
 CLASS="SECT1"
 ><A
 NAME="INSTALLATION"
->3. Installation</A
+>2. Installation</A
 ></H1
 ><P
 > <SPAN
@@ -83,38 +86,10 @@ CLASS="APPLICATION"
  <A
 HREF="http://sourceforge.net/projects/ijbswa/"
 TARGET="_top"
->Privoxy Project Page</A
+>Privoxy Project
+ Page</A
 >.</P
 ><P
-> If you like to live on the bleeding edge and are not afraid of using
- possibly unstable development versions, you can check out the up-to-the-minute
- version directly from <A
-HREF="http://sourceforge.net/cvs/?group_id=11118"
-TARGET="_top"
->the
- CVS repository</A
-> or simply download <A
-HREF="http://cvs.sourceforge.net/cvstarballs/ijbswa-cvsroot.tar.gz"
-TARGET="_top"
->the nightly CVS
- tarball.</A
-></P
-><P
-> At present, <SPAN
-CLASS="APPLICATION"
->Privoxy</SPAN
-> is known to run on Win32, Mac
- OSX, OS/2, AmigaOS, Linux (RedHat, Suse, Debian), FreeBSD, NetBSD, BeOS, and
- many flavors of Unix.</P
-><DIV
-CLASS="SECT2"
-><H2
-CLASS="SECT2"
-><A
-NAME="INSTALLATION-PACKAGES"
->3.1. Binary Packages</A
-></H2
-><P
 > Note: If you have a previous <SPAN
 CLASS="APPLICATION"
 >Junkbuster</SPAN
@@ -123,32 +98,42 @@ CLASS="APPLICATION"
 CLASS="APPLICATION"
 >Privoxy</SPAN
 > installation on your system, you
- will need to remove it.  Some platforms do this for you as part 
- of their installation procedure. (See below for your platform).</P
-><P
-> In any case <I
+ will need to remove it.  On some platforms, this may be done for you as part
+ of their installation procedure. (See below for your platform). In any case
+ <SPAN
+CLASS="emphasis"
+><I
 CLASS="EMPHASIS"
->be sure to backup your old configuration
- if it is valuable to you.</I
-> See the
- <A
-HREF="quickstart.html#UPGRADERSNOTE"
->note to upgraders</A
->.</P
+>be sure to backup your old configuration if it is valuable to
+ you.</I
+></SPAN
+> See the <A
+HREF="upgradersnote.html"
+>note to
+ upgraders</A
+> section below.</P
+><DIV
+CLASS="SECT2"
+><H2
+CLASS="SECT2"
+><A
+NAME="INSTALLATION-PACKAGES"
+>2.1. Binary Packages</A
+></H2
 ><P
-> How to install the binary packages depends on your operating system:</P
+>How to install the binary packages depends on your operating system:</P
 ><DIV
 CLASS="SECT3"
 ><H3
 CLASS="SECT3"
 ><A
 NAME="INSTALLATION-PACK-RPM"
->3.1.1. Red Hat and SuSE RPMs</A
+>2.1.1. Red Hat, SuSE and Conectiva RPMs</A
 ></H3
 ><P
-> RPMs can be installed with <TT
+> RPMs can be installed with <VAR
 CLASS="LITERAL"
->rpm -Uvh privoxy-2.9.14-1.rpm</TT
+>rpm -Uvh privoxy-3.0.3-1.rpm</VAR
 >,
  and will use <TT
 CLASS="FILENAME"
@@ -159,20 +144,28 @@ CLASS="FILENAME"
 > Note that on Red Hat, <SPAN
 CLASS="APPLICATION"
 >Privoxy</SPAN
-> will not be
- automatically started on system boot. You will need to enable that using
- <B
+> will
+ <SPAN
+CLASS="emphasis"
+><I
+CLASS="EMPHASIS"
+>not</I
+></SPAN
+> be automatically started on system boot. You will
+ need to enable that using <B
 CLASS="COMMAND"
 >chkconfig</B
->, <B
+>,
+ <B
 CLASS="COMMAND"
 >ntsysv</B
->, or similar method.</P
+>, or similar methods. Note that SuSE will 
+automatically start Privoxy in the boot process.</P
 ><P
 > If you have problems with failed dependencies, try rebuilding the SRC RPM: 
- <TT
+ <VAR
 CLASS="LITERAL"
->rpm --rebuild privoxy-2.9.14-1.src.rpm;</TT
+>rpm --rebuild privoxy-3.0.3-1.src.rpm</VAR
 >. This 
  will use your locally installed libraries and RPM version. </P
 ><P
@@ -196,10 +189,18 @@ CLASS="SECT3"
 CLASS="SECT3"
 ><A
 NAME="INSTALLATION-DEB"
->3.1.2. Debian</A
+>2.1.2. Debian</A
 ></H3
 ><P
-> FIXME.</P
+> DEBs can be installed with <VAR
+CLASS="LITERAL"
+>apt-get install privoxy</VAR
+>,
+ and will use <TT
+CLASS="FILENAME"
+>/etc/privoxy</TT
+> for the location of 
+ configuration files.</P
 ></DIV
 ><DIV
 CLASS="SECT3"
@@ -207,11 +208,13 @@ CLASS="SECT3"
 CLASS="SECT3"
 ><A
 NAME="INSTALLATION-PACK-WIN"
->3.1.3. Windows</A
+>2.1.3. Windows</A
 ></H3
 ><P
 > Just double-click the installer, which will guide you through
- the installation process.</P
+ the installation process. You will find the configuration files
+ in the same directory as you installed Privoxy in. We do not
+ use the registry of Windows. </P
 ></DIV
 ><DIV
 CLASS="SECT3"
@@ -219,15 +222,15 @@ CLASS="SECT3"
 CLASS="SECT3"
 ><A
 NAME="INSTALLATION-PACK-BINTGZ"
->3.1.4. Solaris, NetBSD, FreeBSD, HP-UX</A
+>2.1.4. Solaris, NetBSD, FreeBSD, HP-UX</A
 ></H3
 ><P
-> Create a new directory, <TT
+> Create a new directory, <VAR
 CLASS="LITERAL"
->cd</TT
+>cd</VAR
 > to it, then unzip and
  untar the archive. For the most part, you'll have to figure out where
- things go. FIXME.</P
+ things go. </P
 ></DIV
 ><DIV
 CLASS="SECT3"
@@ -235,7 +238,7 @@ CLASS="SECT3"
 CLASS="SECT3"
 ><A
 NAME="INSTALLATION-OS2"
->3.1.5. OS/2</A
+>2.1.5. OS/2</A
 ></H3
 ><P
 > First, make sure that no previous installations of
@@ -247,7 +250,15 @@ CLASS="APPLICATION"
 CLASS="APPLICATION"
 >Privoxy</SPAN
 > are left on your
- system. You can do this by </P
+ system. Check that no <SPAN
+CLASS="APPLICATION"
+>Junkbuster</SPAN
+>
+ or <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+> objects are in
+ your startup folder.&#13;</P
 ><P
 > Then, just double-click the WarpIN self-installing archive, which will
  guide you through the installation process. A shadow of the
@@ -269,30 +280,59 @@ CLASS="SECT3"
 CLASS="SECT3"
 ><A
 NAME="INSTALLATION-MAC"
->3.1.6. Max OSX</A
+>2.1.6. Mac OSX</A
 ></H3
 ><P
-> Unzip the downloaded package (you can either double-click on the file
- in the finder, or on the desktop if you downloaded it there).  Then,
- double-click on the package installer icon and follow the installation
- process.
+> Unzip the downloaded file (you can either double-click on the file
+ from the finder, or from the desktop if you downloaded it there).
+ Then, double-click on the package installer icon named
+ <VAR
+CLASS="LITERAL"
+>Privoxy.pkg</VAR
+>
+ and follow the installation process.
  <SPAN
 CLASS="APPLICATION"
 >Privoxy</SPAN
-> will be installed in the subdirectory
- <TT
+> will be installed in the folder
+ <VAR
 CLASS="LITERAL"
->/Applications/Privoxy.app</TT
+>/Library/Privoxy</VAR
 >.
- <SPAN
-CLASS="APPLICATION"
->Privoxy</SPAN
-> will set itself up to start 
- automatically on system bringup via
- <TT
+ It will start automatically whenever you start up.  To prevent it from
+ starting automatically, remove or rename the folder
+ <VAR
 CLASS="LITERAL"
->/System/Library/StartupItems/Privoxy</TT
->.</P
+>/Library/StartupItems/Privoxy</VAR
+>. </P
+><P
+> To start Privoxy by hand, double-click on 
+ <VAR
+CLASS="LITERAL"
+>StartPrivoxy.command</VAR
+> in the
+ <VAR
+CLASS="LITERAL"
+>/Library/Privoxy</VAR
+> folder.
+ Or, type this command in the Terminal:</P
+><P
+>  <TABLE
+BORDER="0"
+BGCOLOR="#E0E0E0"
+WIDTH="100%"
+><TR
+><TD
+><PRE
+CLASS="SCREEN"
+>  /Library/Privoxy/StartPrivoxy.command
+  </PRE
+></TD
+></TR
+></TABLE
+></P
+><P
+> You will be prompted for the administrator password.</P
 ></DIV
 ><DIV
 CLASS="SECT3"
@@ -300,7 +340,7 @@ CLASS="SECT3"
 CLASS="SECT3"
 ><A
 NAME="INSTALLATION-AMIGA"
->3.1.7. AmigaOS</A
+>2.1.7. AmigaOS</A
 ></H3
 ><P
 > Copy and then unpack the <TT
@@ -313,29 +353,53 @@ CLASS="APPLICATION"
 >
  directory, including all configuration and log files. To uninstall, just 
  remove this directory.</P
+></DIV
+><DIV
+CLASS="SECT3"
+><H3
+CLASS="SECT3"
+><A
+NAME="INSTALLATTION-GENTOO"
+>2.1.8. Gentoo</A
+></H3
 ><P
-> Start <SPAN
+> Gentoo source packages (Ebuilds) for <SPAN
 CLASS="APPLICATION"
 >Privoxy</SPAN
-> (with RUN &#60;&#62;NIL:) in your
- <TT
-CLASS="FILENAME"
->startnet</TT
-> script (AmiTCP), in
- <TT
-CLASS="FILENAME"
->s:user-startup</TT
-> (RoadShow), as startup program in your
- startup script (Genesis), or as startup action (Miami and MiamiDx). 
+> are 
+ contained in the Gentoo  Portage Tree (they are not on the download page, 
+ but there is a Gentoo section, where you can see when a new 
  <SPAN
 CLASS="APPLICATION"
 >Privoxy</SPAN
-> will automatically quit when you quit your
- TCP/IP stack (just ignore the harmless warning your TCP/IP stack may display that
- <SPAN
+> Version is added to the  Portage Tree).</P
+><P
+> Before installing <SPAN
 CLASS="APPLICATION"
 >Privoxy</SPAN
-> is still running).</P
+> under Gentoo just do 
+ first <VAR
+CLASS="LITERAL"
+>emerge rsync</VAR
+> to get the latest changes from the 
+ Portage tree. With <VAR
+CLASS="LITERAL"
+>emerge privoxy</VAR
+> you install the latest 
+ version.</P
+><P
+> Configuration files are in <TT
+CLASS="FILENAME"
+>/etc/privoxy</TT
+>, the 
+ documentation is in <TT
+CLASS="FILENAME"
+>/usr/share/doc/privoxy-3.0.3</TT
+>
+ and the Log directory is in <TT
+CLASS="FILENAME"
+>/var/log/privoxy</TT
+>.</P
 ></DIV
 ></DIV
 ><DIV
@@ -344,22 +408,61 @@ CLASS="SECT2"
 CLASS="SECT2"
 ><A
 NAME="INSTALLATION-SOURCE"
->3.2. Building from Source</A
+>2.2. Building from Source</A
 ></H2
 ><P
+> The most convenient way to obtain the <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+> sources
+ is to download the source tarball from our <A
+HREF="http://sf.net/projects/ijbswa/"
+TARGET="_top"
+>project
+ page</A
+>.</P
+><P
+> If you like to live on the bleeding edge and are not afraid of using
+ possibly unstable development versions, you can check out the up-to-the-minute
+ version directly from <A
+HREF="http://sourceforge.net/cvs/?group_id=11118"
+TARGET="_top"
+>the
+ CVS repository</A
+> or simply download <A
+HREF="http://cvs.sourceforge.net/cvstarballs/ijbswa-cvsroot.tar.bz2"
+TARGET="_top"
+>the nightly CVS
+ tarball.</A
+></P
+><P
 > To build <SPAN
 CLASS="APPLICATION"
 >Privoxy</SPAN
 > from source, 
- autoheader, autoconf, <A
+ <A
+HREF="http://www.gnu.org/software/autoconf/autoconf.html"
+TARGET="_top"
+>autoconf</A
+>,
+ <A
 HREF="http://www.gnu.org/software/make/make.html"
 TARGET="_top"
 >GNU make
  (gmake)</A
->, and, of course, a C compiler are required.</P
+>, and, of course, a C compiler like <A
+HREF="http://www.gnu.org/software/gcc/gcc.html"
+TARGET="_top"
+>gcc</A
+> are required.</P
 ><P
 > When building from a source tarball (either release version or
- nightly CVS tarball), first unpack the source: </P
+ <A
+HREF="http://cvs.sourceforge.net/cvstarballs/ijbswa-cvsroot.tar.bz2"
+TARGET="_top"
+>nightly CVS
+ tarball</A
+>), first unpack the source: </P
 ><P
 > <TABLE
 BORDER="0"
@@ -369,9 +472,8 @@ WIDTH="100%"
 ><TD
 ><PRE
 CLASS="SCREEN"
-> tar xzvf privoxy-2.9.14-beta-src* [.tgz or .tar.gz]
- cd privoxy-2.9.14-beta
- </PRE
+> tar xzvf privoxy-3.0.3-src* [.tgz or .tar.gz]
+ cd privoxy-3.0.3</PRE
 ></TD
 ></TR
 ></TABLE
@@ -391,8 +493,7 @@ WIDTH="100%"
 CLASS="SCREEN"
 >  cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
   cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co current
-  cd current
- </PRE
+  cd current</PRE
 ></TD
 ></TR
 ></TABLE
@@ -420,15 +521,14 @@ CLASS="SCREEN"
  make             # (the make from gnu, gmake for *BSD) 
  su 
  make -n install  # (to see where all the files will go)
- make install     # (to really install)
- </PRE
+ make install     # (to really install)</PRE
 ></TD
 ></TR
 ></TABLE
 ></P
 ><P
 >  If you have gnu make, you can have the first four steps 
-  automatically done for you by just typing</P
+  automatically done for you by just typing:</P
 ><P
 > <TABLE
 BORDER="0"
@@ -438,8 +538,7 @@ WIDTH="100%"
 ><TD
 ><PRE
 CLASS="SCREEN"
->  make
- </PRE
+>  make</PRE
 ></TD
 ></TR
 ></TABLE
@@ -455,12 +554,68 @@ TARGET="_top"
 >developer manual</A
 >.</P
 ></DIV
+><DIV
+CLASS="SECT2"
+><H2
+CLASS="SECT2"
+><A
+NAME="INSTALLATION-KEEPUPDATED"
+>2.3. Keeping your Installation Up-to-Date</A
+></H2
+><P
+> As user feedback comes in and development continues, we will make updated versions
+ of both the main <A
+HREF="actions-file.html"
+>actions file</A
+> (as a <A
+HREF="http://sourceforge.net/project/showfiles.php?group_id=11118&release_id=103670"
+TARGET="_top"
+>separate
+ package</A
+>) and the software itself (including the actions file) available for
+ download.</P
+><P
+> If you wish to receive an email notification whenever we release updates of
+ <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+> or the actions file, <A
+HREF="http://lists.sourceforge.net/lists/listinfo/ijbswa-announce/"
+TARGET="_top"
+>subscribe
+ to our announce  mailing list</A
+>, ijbswa-announce@lists.sourceforge.net.</P
+><P
+> In order not to loose your personal changes and adjustments when updating
+ to the latest <VAR
+CLASS="LITERAL"
+>default.action</VAR
+> file we <SPAN
+CLASS="emphasis"
+><I
+CLASS="EMPHASIS"
+>strongly
+ recommend</I
+></SPAN
+> that you use <VAR
+CLASS="LITERAL"
+>user.action</VAR
+> for your
+ customization of <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+>. See the <A
+HREF="actions-file.html"
+>Chapter on actions files</A
+> for details.</P
+></DIV
 ></DIV
 ><DIV
 CLASS="NAVFOOTER"
 ><HR
 ALIGN="LEFT"
 WIDTH="100%"><TABLE
+SUMMARY="Footer navigation table"
 WIDTH="100%"
 BORDER="0"
 CELLPADDING="0"
@@ -472,6 +627,7 @@ ALIGN="left"
 VALIGN="top"
 ><A
 HREF="introduction.html"
+ACCESSKEY="P"
 >Prev</A
 ></TD
 ><TD
@@ -480,6 +636,7 @@ ALIGN="center"
 VALIGN="top"
 ><A
 HREF="index.html"
+ACCESSKEY="H"
 >Home</A
 ></TD
 ><TD
@@ -487,7 +644,8 @@ WIDTH="33%"
 ALIGN="right"
 VALIGN="top"
 ><A
-HREF="quickstart.html"
+HREF="upgradersnote.html"
+ACCESSKEY="N"
 >Next</A
 ></TD
 ></TR
@@ -506,10 +664,7 @@ VALIGN="top"
 WIDTH="33%"
 ALIGN="right"
 VALIGN="top"
->Quickstart to Using <SPAN
-CLASS="APPLICATION"
->Privoxy</SPAN
-></TD
+>Note to Upgraders</TD
 ></TR
 ></TABLE
 ></DIV