This file belongs into
ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/
- $Id: user-manual.sgml,v 1.78 2002/04/17 18:04:16 oes Exp $
+ $Id: user-manual.sgml,v 1.82 2002/04/18 12:04:50 oes Exp $
Written by and Copyright (C) 2001 the SourceForge
Privoxy team. http://www.privoxy.org/
<artheader>
<title>Privoxy User Manual</title>
-<pubdate>$Id: user-manual.sgml,v 1.78 2002/04/17 18:04:16 oes Exp $</pubdate>
+<pubdate>$Id: user-manual.sgml,v 1.82 2002/04/18 12:04:50 oes Exp $</pubdate>
<authorgroup>
<author>
<!-- ~~~~~ New section ~~~~~ -->
<sect1 id="installation"><title>Installation</title>
+
<para>
<application>Privoxy</application> is available both in convenient pre-compiled
packages for a wide range of operating systems, and as raw source code.
For most users, we recommend using the packages, which can be downloaded from our
<ulink url="http://sourceforge.net/projects/ijbswa/">Privoxy Project Page</ulink>.
</para>
+
<para>
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
<!-- ~~~~~ New section ~~~~~ -->
<sect2 id="installation-packages"><title>Binary Packages</title>
+
+<para>
+ Note: If you have a previous <application>Junkbuster</application> or
+ <application>Privoxy</application> installation on your system, you
+ will either need to remove it, or that might be done by the setup
+ procedure. (See below for your platform).
+</para>
+
<para>
- Binary packages can be downloaded from our <ulink
- url="http://sourceforge.net/projects/ijbswa/">Privoxy Project Page</ulink>.
+ In any case <emphasis>be sure to backup your old configuration
+ if it is valuable to you.</emphasis> In that case, also see the
+ <link linkend="upgradersnote">note to upgraders</link>.
</para>
<para>
- How to install them depends on your operating system:
+ How to install the binary packages depends on your operating system:
</para>
<!-- ~~~~~ New section ~~~~~ -->
<para>
Note that if you have a <application>Junkbuster</application> RPM installed
on your system, you need to remove it first, because the packages conflict.
+ Otherwise, RPM will try removing Junkbuster automaticaly, before installing
+ privoxy.
</para>
</sect3>
<!-- ~~~~~ New section ~~~~~ -->
-<sect3 id="installation-pack-bintgz"><title>Solaris, NetBSD, HP-UX</title>
-
+<sect3 id="installation-deb"><title>Debian</title>
<para>
- Create a new directory, <literal>cd</literal> to it, then unzip and
- untar the archive. For the most part, you'll have to figure out where
- things go. FIXME.
+ FIXME.
</para>
</sect3>
</para>
</sect3>
+<!-- ~~~~~ New section ~~~~~ -->
+<sect3 id="installation-pack-bintgz"><title>Solaris, NetBSD, FreeBSD, HP-UX</title>
+
+<para>
+ Create a new directory, <literal>cd</literal> to it, then unzip and
+ untar the archive. For the most part, you'll have to figure out where
+ things go. FIXME.
+</para>
+</sect3>
+
<!-- ~~~~~ New section ~~~~~ -->
<sect3 id="installation-os2"><title>OS/2</title>
<para>
- Just double-click the WarpIN self-installing archive, which will guide
- you through the installation process. A shadow of the
+ First, make sure that no previous installations of
+ <application>Junkbuster</application> and / or
+ <application>Privoxy</application> are left on your
+ system.
+</para>
+
+<para>
+ Then, just double-click the WarpIN self-installing archive, which will
+ guide you through the installation process. A shadow of the
<application>Privoxy</application> executable will be placed in your
startup folder so it will start automatically whenever OS/2 starts.
</para>
</sect3>
<!-- ~~~~~ New section ~~~~~ -->
-<sect3 id="installation-deb"><title>Debian</title>
+<sect3 id="installation-mac"><title>Max OSX</title>
<para>
FIXME.
</para>
<!-- include buildsource.sgml boilerplate: -->
&buildsource;
<!-- end boilerplate -->
-
-<para>
- For more detailed instructions, on how to build Redhat and SuSE RPMs,
- Windows self-extracting installers etc, and for building from CVS sources,
- please consult the <ulink url="../developer-manual/newrelease.html">developer
- manual</ulink>.
-</para>
</sect2>
</sect1>
<para>
The main config file controls all aspects of <application>Privoxy</application>'s
- operation that are not location dependent (i.e. they apply to all URLs, no matter
+ operation that are not location dependent (i.e. they apply universally, no matter
where you may be surfing).
</para>
<para>
Now, your users can set their browser's proxy to use either
host-a or host-b and be able to browse the internal content
- on both isp-a or isp-b.
+ of both isp-a and isp-b.
</para>
<para>
<para>
Note that some actions like cookie suppression or script disabling may
render some sites unusable, which rely on these techniques to work properly.
- Finding the right mix of actions is not easy and a matter of personal
+ Finding the right mix of actions is not easy and certainly a matter of personal
taste. In general, it can be said that the more <quote>aggressive</quote>
your default settings (in the top section of the actions file) are,
the more exceptions for <quote>trusted</quote> sites you will have to
<sect3>
<title>Patterns</title>
<para>
- Generally, a pattern has the form <domain>/<path>, where both the
- <domain> and <path> part are optional. If you only specify a
- domain part, the <quote>/</quote> can be left out:
+ Generally, a pattern has the form <literal><domain>/<path></literal>,
+ where both the <literal><domain></literal> and <literal><path></literal>
+ are optional. (This is why the pattern <literal>/</literal> matches all URLs).
</para>
<variablelist>
<varlistentry>
- <term><literal>www.example.com</literal></term>
+ <term><literal>www.example.com/</literal></term>
<listitem>
<para>
- is a domain only pattern and will match any request to <literal>www.example.com</literal>,
+ is a domain-only pattern and will match any request to <literal>www.example.com</literal>,
regardless of which document on that server is requested.
</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><literal>www.example.com/</literal></term>
+ <term><literal>www.example.com</literal></term>
<listitem>
<para>
- means exactly the same.
+ means exactly the same. For domain-only patterns, the trailing <literal>/</literal> may
+ be omitted.
</para>
</listitem>
</varlistentry>
</para>
<para>
- Note that the pattern is automatically left-anchored at the <quote>/</quote>,
+ Note that the path pattern is automatically left-anchored at the <quote>/</quote>,
i.e. it matches as if it would start with a <quote>^</quote>.
</para>
</simplelist>
<simplelist>
<member>
- <emphasis>no-popups</emphasis>: Kill all popups in JS and HTML
+ <emphasis>content-cookies</emphasis>: Kill cookies that come in the HTML or JS content
+ </member>
+ </simplelist>
+ <simplelist>
+ <member>
+ <emphasis>popups</emphasis>: Kill all popups in JS and HTML
</member>
</simplelist>
<simplelist>
<member>
- <emphasis>frameset-borders</emphasis>: Give frames a border
+ <emphasis>frameset-borders</emphasis>: Give frames a border and make them resizable
</member>
</simplelist>
<simplelist>
</simplelist>
<simplelist>
<member>
- <emphasis>no-refresh</emphasis>: Automatic refresh sucks on auto-dialup lines
+ <emphasis>refresh-tags</emphasis>: Kill automatic refresh tags (for dial-on-demand setups)
</member>
</simplelist>
<simplelist>
</simplelist>
<simplelist>
<member>
- <emphasis>nimda</emphasis>: Remove (virus) Nimda code.
+ <emphasis>nimda</emphasis>: Remove Nimda (virus) code.
+ </member>
+ </simplelist>
+ <simplelist>
+ <member>
+ <emphasis>banners-by-size</emphasis>: Kill banners by size (<emphasis>very</emphasis> efficient!)
</member>
</simplelist>
<simplelist>
<member>
- <emphasis>banners-by-size</emphasis>: Kill banners by size
+ <emphasis>shockwave-flash</emphasis>: Kill embedded Shockwave Flash objects
</member>
</simplelist>
<simplelist>
</simplelist>
</blockquote>
+
<para>
Note: Filtering requires buffering the page content, which may appear to slow down
page rendering since nothing is displayed until all content has passed
Temple Place - Suite 330, Boston, MA 02111-1307, USA.
$Log: user-manual.sgml,v $
+ Revision 1.82 2002/04/18 12:04:50 oes
+ Cosmetics
+
+ Revision 1.81 2002/04/18 11:50:24 oes
+ Extended Install section - needs fixing by packagers
+
+ Revision 1.80 2002/04/18 10:45:19 oes
+ Moved text to buildsource.sgml, renamed some filters, details
+
+ Revision 1.79 2002/04/18 03:18:06 hal9
+ Spellcheck, and minor touchups.
+
Revision 1.78 2002/04/17 18:04:16 oes
Proofreading part 2
projects / privoxy.git / blobdiff