http://validator.w3.org/check
fusses about 'end tag for element "P" which is not open'
if a table is inside a paragraph - eg
<p><table> ... </table></p>
docbook 3.1 turns <screen> and <programlisting> into
html <table>s, so get rid of all the enclosing <para>s
problematic constructs:
<para><figure> ... </figure></para>
<para><itemizedlist> ... </itemizedlist></para>
<para><literal> ... </literal></para>
<para><orderedlist> ... </orderedlist></para>
<para><programlisting> ... </programlisting></para>
<para><screen> ... </screen></para>
<para><simplelist> ... </simplelist></para>
--> first unpack the source:
</para>
--> first unpack the source:
</para>
<screen>
tar xzvf privoxy-&p-version;<![%p-not-stable;[-beta]]><![%p-stable;[-stable]]>-src.tar.gz
cd privoxy-&p-version;<![%p-not-stable;[-beta]]><![%p-stable;[-stable]]>
</screen>
<screen>
tar xzvf privoxy-&p-version;<![%p-not-stable;[-beta]]><![%p-stable;[-stable]]>-src.tar.gz
cd privoxy-&p-version;<![%p-not-stable;[-beta]]><![%p-stable;[-stable]]>
</screen>
<para>
For retrieving the current CVS sources, you'll need a CVS client installed.
<para>
For retrieving the current CVS sources, you'll need a CVS client installed.
documentation, which might give commands like:
</para>
documentation, which might give commands like:
</para>
<screen>
cvs -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa login
cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co current
cd current
</screen>
<screen>
cvs -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa login
cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co current
cd current
</screen>
<para>
This will create a directory named <filename>current/</filename>, which will
<para>
This will create a directory named <filename>current/</filename>, which will
<filename>/etc/passwd</filename> might then look like:
</para>
<filename>/etc/passwd</filename> might then look like:
</para>
<screen> privoxy:*:7777:7777:privoxy proxy:/no/home:/no/shell</screen>
<screen> privoxy:*:7777:7777:privoxy proxy:/no/home:/no/shell</screen>
<para>
And then <filename>/etc/group</filename>, like:
</para>
<para>
And then <filename>/etc/group</filename>, like:
</para>
<screen> privoxy:*:7777:</screen>
<screen> privoxy:*:7777:</screen>
<para>
Some binary packages may do this for you.
<para>
Some binary packages may do this for you.
Then, to build from either unpacked tarball or CVS source:
</para>
Then, to build from either unpacked tarball or CVS source:
</para>
<screen>
autoheader
autoconf
<screen>
autoheader
autoconf
su # Possibly required
make -n install # (to see where all the files will go)
make -s install # (to really install, -s to silence output)</screen>
su # Possibly required
make -n install # (to see where all the files will go)
make -s install # (to really install, -s to silence output)</screen>
<para>
Using GNU <command>make</command>, you can have the first four steps
automatically done for you by just typing:
</para>
<para>
Using GNU <command>make</command>, you can have the first four steps
automatically done for you by just typing:
</para>
<para>
in the freshly downloaded or unpacked source directory.
<para>
in the freshly downloaded or unpacked source directory.
users cannot easily bypass the proxy (e.g. <quote>Go There Anyway</quote>), or
alter their own configurations, <command>configure</command> like this:
</para>
users cannot easily bypass the proxy (e.g. <quote>Go There Anyway</quote>), or
alter their own configurations, <command>configure</command> like this:
</para>
<screen>
./configure --disable-toggle --disable-editor --disable-force</screen>
<screen>
./configure --disable-toggle --disable-editor --disable-force</screen>
<para>
Note that all of these options can also be disabled through the configuration file.
</para>
<para>
Note that all of these options can also be disabled through the configuration file.
</para>
on the <command>make</command> command line, but be sure both already exist:
</para>
on the <command>make</command> command line, but be sure both already exist:
</para>
<screen>
make -s install USER=privoxy GROUP=privoxy</screen>
<screen>
make -s install USER=privoxy GROUP=privoxy</screen>
<para>
The default installation path for <command>make install</command> is
<para>
The default installation path for <command>make install</command> is
for the previously released 3.0.25 beta which introduced client-specific
tags and included a couple of minor improvements.
</para>
for the previously released 3.0.25 beta which introduced client-specific
tags and included a couple of minor improvements.
</para>
<itemizedlist>
<listitem>
<para>
Bug fixes:
<itemizedlist>
<listitem>
<para>
Bug fixes:
<itemizedlist>
<listitem>
<para>
<itemizedlist>
<listitem>
<para>
</para>
</listitem>
</itemizedlist>
</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>
General improvements:
</listitem>
<listitem>
<para>
General improvements:
<itemizedlist>
<listitem>
<para>
<itemizedlist>
<listitem>
<para>
</para>
</listitem>
</itemizedlist>
</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>
Documentation improvements:
</listitem>
<listitem>
<para>
Documentation improvements:
<itemizedlist>
<listitem>
<para>
<itemizedlist>
<listitem>
<para>
</para>
</listitem>
</itemizedlist>
</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>
Infrastructure improvements:
</listitem>
<listitem>
<para>
Infrastructure improvements:
<itemizedlist>
<listitem>
<para>
<itemizedlist>
<listitem>
<para>
</para>
</listitem>
</itemizedlist>
</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>
Build system improvements:
</listitem>
<listitem>
<para>
Build system improvements:
<itemizedlist>
<listitem>
<para>
<itemizedlist>
<listitem>
<para>
</para>
</listitem>
</itemizedlist>
</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
<para>
Changes between <application>Privoxy 3.0.25 beta</application>
and the previous release:
</para>
<para>
Changes between <application>Privoxy 3.0.25 beta</application>
and the previous release:
</para>
<itemizedlist>
<listitem>
<para>
Bug fixes:
<itemizedlist>
<listitem>
<para>
Bug fixes:
<itemizedlist>
<listitem>
<para>
<itemizedlist>
<listitem>
<para>
</para>
</listitem>
</itemizedlist>
</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>
General improvements:
</listitem>
<listitem>
<para>
General improvements:
<itemizedlist>
<listitem>
<para>
<itemizedlist>
<listitem>
<para>
</para>
</listitem>
</itemizedlist>
</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>
Action file improvements:
</listitem>
<listitem>
<para>
Action file improvements:
<itemizedlist>
<listitem>
<para>
<itemizedlist>
<listitem>
<para>
</para>
</listitem>
</itemizedlist>
</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>
Documentation improvements:
</listitem>
<listitem>
<para>
Documentation improvements:
<itemizedlist>
<listitem>
<para>
<itemizedlist>
<listitem>
<para>
</para>
</listitem>
</itemizedlist>
</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>
Infrastructure improvements:
</listitem>
<listitem>
<para>
Infrastructure improvements:
<itemizedlist>
<listitem>
<para>
<itemizedlist>
<listitem>
<para>
</para>
</listitem>
</itemizedlist>
</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>
Build system improvements:
</listitem>
<listitem>
<para>
Build system improvements:
<itemizedlist>
<listitem>
<para>
<itemizedlist>
<listitem>
<para>
</para>
</listitem>
</itemizedlist>
</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>
Privoxy-Regression-Test:
</listitem>
<listitem>
<para>
Privoxy-Regression-Test:
<itemizedlist>
<listitem>
<para>
<itemizedlist>
<listitem>
<para>
</para>
</listitem>
</itemizedlist>
</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
Please be sure to provide the following information when reporting problems
or requesting support:
</para>
Please be sure to provide the following information when reporting problems
or requesting support:
</para>
<itemizedlist>
<listitem>
<itemizedlist>
<listitem>
is being used and the following <ulink
url="../user-manual/config.html#DEBUG">debug options</ulink> are enabled
(all of them):
is being used and the following <ulink
url="../user-manual/config.html#DEBUG">debug options</ulink> are enabled
(all of them):
<literallayout>debug 1 # Log the destination for each request Privoxy let through.
# See also debug 1024.
debug 2 # show each connection status
<literallayout>debug 1 # Log the destination for each request Privoxy let through.
# See also debug 1024.
debug 2 # show each connection status
debug 4096 # Startup banner and warnings.
debug 8192 # Non-fatal errors
debug 65536 # Log applying actions</literallayout>
debug 4096 # Startup banner and warnings.
debug 8192 # Non-fatal errors
debug 65536 # Log applying actions</literallayout>
<para>
If you are having trouble with a filter, please additionally enable
<para>
If you are having trouble with a filter, please additionally enable
<literallayout>debug 64 # debug regular expression filters</literallayout>
<literallayout>debug 64 # debug regular expression filters</literallayout>
If you suspect that Privoxy interprets the request or the response
incorrectly, please enable
If you suspect that Privoxy interprets the request or the response
incorrectly, please enable
- <literallayout>debug 32768 # log all data read from the network</literallayout>
+ <literallayout>debug 32768 # log all data read from the network</literallayout>
<para>
It's easy for us to ignore log messages that aren't relevant but missing
log messages may make it impossible to investigate a problem. If you aren't
<para>
It's easy for us to ignore log messages that aren't relevant but missing
log messages may make it impossible to investigate a problem. If you aren't
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
<para>
You don't have to tell us your actual name when filing a problem
<para>
You don't have to tell us your actual name when filing a problem
<para>
Basic Guidelines, for all branches:
</para>
<para>
Basic Guidelines, for all branches:
</para>
<itemizedlist>
<listitem><para>
Please don't commit even
<itemizedlist>
<listitem><para>
Please don't commit even
</para>
</listitem>
</itemizedlist>
</para>
</listitem>
</itemizedlist>
</para>
<para>
How do you update the webserver (i.e. the pages on privoxy.org)?
</para>
<para>
How do you update the webserver (i.e. the pages on privoxy.org)?
<orderedlist numeration="arabic">
<listitem><para>
<orderedlist numeration="arabic">
<listitem><para>
sourceforge webserver via scp.
</para></listitem>
</orderedlist>
sourceforge webserver via scp.
</para></listitem>
</orderedlist>
<para>
Finished docs should be occasionally submitted to CVS
<para>
Finished docs should be occasionally submitted to CVS
Some common elements that you likely will use:
</para>
Some common elements that you likely will use:
</para>
<simplelist>
<member>
<emphasis><para></para></emphasis>, paragraph delimiter. Most
<simplelist>
<member>
<emphasis><para></para></emphasis>, paragraph delimiter. Most
<emphasis><quote></quote></emphasis>, for, doh, quoting text.
</member>
</simplelist>
<emphasis><quote></quote></emphasis>, for, doh, quoting text.
</member>
</simplelist>
<para>
Look at any of the existing docs for examples of all these and more.
<para>
Look at any of the existing docs for examples of all these and more.
<para>
Here it is:
</para>
<para>
Here it is:
</para>
<itemizedlist>
<listitem>
<para>
<itemizedlist>
<listitem>
<para>
<para>
Tags delimiting a <emphasis>block</emphasis> of text (even small
blocks) should be on their own line. Like:
<para>
Tags delimiting a <emphasis>block</emphasis> of text (even small
blocks) should be on their own line. Like:
<literallayout>
<para>
Some text goes here.
</para>
</literallayout>
<literallayout>
<para>
Some text goes here.
</para>
</literallayout>
Tags marking individual words, or few words, should be in-line:
Tags marking individual words, or few words, should be in-line:
<literallayout>
Just to <emphasis>emphasize</emphasis>, some text goes here.
</literallayout>
<literallayout>
Just to <emphasis>emphasize</emphasis>, some text goes here.
</literallayout>
</listitem>
<listitem>
<para>
Tags should be nested and step indented for block text like: (except
in-line tags)
</listitem>
<listitem>
<para>
Tags should be nested and step indented for block text like: (except
in-line tags)
<literallayout>
<para>
<itemizedlist>
<literallayout>
<para>
<itemizedlist>
</itemizedlist>
</para>
</literallayout>
</itemizedlist>
</para>
</literallayout>
This makes it easier to find the text amongst the tags ;-)
</para>
</listitem>
This makes it easier to find the text amongst the tags ;-)
</para>
</listitem>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
custom entities are listed below. See any of the main docs for examples.
</para>
custom entities are listed below. See any of the main docs for examples.
</para>
<itemizedlist>
<listitem>
<para>
<itemizedlist>
<listitem>
<para>
</simplelist>
</listitem>
</itemizedlist>
</simplelist>
</listitem>
</itemizedlist>
<para>
There are others in various places that are defined for a specific
purpose. Read the source!
<para>
There are others in various places that are defined for a specific
purpose. Read the source!
<para><emphasis>Instead of:</emphasis></para>
<para><emphasis>Instead of:</emphasis></para>
<programlisting>
int msiis5hack = 0; int msIis5Hack = 0;
</programlisting>
<programlisting>
int msiis5hack = 0; int msIis5Hack = 0;
</programlisting>
<para><emphasis>Instead of:</emphasis></para>
<para><emphasis>Instead of:</emphasis></para>
<programlisting>
int loadsomefile(struct client_state *csp)
int loadSomeFile(struct client_state *csp)
</programlisting>
<programlisting>
int loadsomefile(struct client_state *csp)
int loadSomeFile(struct client_state *csp)
</programlisting>
(.h) extern int load_aclfile(struct client_state *csp);
(.c) int load_aclfile(struct client_state *csp)</programlisting>
(.h) extern int load_aclfile(struct client_state *csp);
(.c) int load_aclfile(struct client_state *csp)</programlisting>
- <para><emphasis>Instead of:</emphasis>
+ <para><emphasis>Instead of:</emphasis></para>
<programlisting>
(.h) extern int load_aclfile(struct client_state *); or
(.h) extern int load_aclfile();
(.c) int load_aclfile(struct client_state *csp)
</programlisting>
<programlisting>
(.h) extern int load_aclfile(struct client_state *); or
(.h) extern int load_aclfile();
(.c) int load_aclfile(struct client_state *csp)
</programlisting>
<para><emphasis>Instead of:</emphasis></para>
<para><emphasis>Instead of:</emphasis></para>
<programlisting>
#define USE_IMG_LST 1 or
#define _USE_IMAGE_LIST 1 or
<programlisting>
#define USE_IMG_LST 1 or
#define _USE_IMAGE_LIST 1 or
#define use_image_list 1 or
#define UseImageList 1
</programlisting>
#define use_image_list 1 or
#define UseImageList 1
</programlisting>
<para><emphasis>Exception:</emphasis></para>
<para><emphasis>Exception:</emphasis></para>
<programlisting>
/* This is not a local include, but requires a path element. */
#include <sys/fileName.h>
</programlisting>
<programlisting>
/* This is not a local include, but requires a path element. */
#include <sys/fileName.h>
</programlisting>
<para><emphasis>Note:</emphasis> Please! do not add "-I." to the Makefile
without a _very_ good reason. This duplicates the #include
<para><emphasis>Note:</emphasis> Please! do not add "-I." to the Makefile
without a _very_ good reason. This duplicates the #include
<sect2 id="testing-plan"><title>Testplan for releases</title>
<para>
Explain release numbers. major, minor. developer releases. etc.
<sect2 id="testing-plan"><title>Testplan for releases</title>
<para>
Explain release numbers. major, minor. developer releases. etc.
<orderedlist numeration="arabic">
<listitem><para>
Remove any existing rpm with rpm -e
</para></listitem>
<listitem><para>
Remove any file that was left over. This includes (but is not limited to)
<orderedlist numeration="arabic">
<listitem><para>
Remove any existing rpm with rpm -e
</para></listitem>
<listitem><para>
Remove any file that was left over. This includes (but is not limited to)
<itemizedlist>
<listitem><para>/var/log/privoxy</para></listitem>
<listitem><para>/etc/privoxy</para></listitem>
<itemizedlist>
<listitem><para>/var/log/privoxy</para></listitem>
<listitem><para>/etc/privoxy</para></listitem>
<listitem><para>/etc/init.d/privoxy</para></listitem>
<listitem><para>/usr/doc/privoxy*</para></listitem>
</itemizedlist>
<listitem><para>/etc/init.d/privoxy</para></listitem>
<listitem><para>/usr/doc/privoxy*</para></listitem>
</itemizedlist>
<listitem><para>
Install the rpm. Any error messages?
</para></listitem>
<listitem><para>
Install the rpm. Any error messages?
</para></listitem>
<listitem><para>Start browsing. Does <application>Privoxy</application> work? Logfile written?</para></listitem>
<listitem><para>Remove the rpm. Any error messages? All files removed?</para></listitem>
</orderedlist>
<listitem><para>Start browsing. Does <application>Privoxy</application> work? Logfile written?</para></listitem>
<listitem><para>Remove the rpm. Any error messages? All files removed?</para></listitem>
</orderedlist>
</sect2>
<!-- XXX: Document how to write test reports and where to send them -->
</sect2>
<!-- XXX: Document how to write test reports and where to send them -->
First you need to determine which version number the release will have.
<application>Privoxy</application> version numbers consist of three numbers,
separated by dots, like in X.Y.Z (e.g. 3.0.0), where:
First you need to determine which version number the release will have.
<application>Privoxy</application> version numbers consist of three numbers,
separated by dots, like in X.Y.Z (e.g. 3.0.0), where:
<itemizedlist>
<listitem>
<para>
<itemizedlist>
<listitem>
<para>
</para>
</listitem>
</itemizedlist>
</para>
</listitem>
</itemizedlist>
<para>
In summary, the main CVS trunk is the development branch where new
features are being worked on for the next stable series. This should
<para>
In summary, the main CVS trunk is the development branch where new
features are being worked on for the next stable series. This should
The following <emphasis>must be done by one of the
developers</emphasis> prior to each new release.
</para>
The following <emphasis>must be done by one of the
developers</emphasis> prior to each new release.
</para>
<itemizedlist>
<listitem>
<para>
<itemizedlist>
<listitem>
<para>
If action file processing has changed and is not backward-compatible,
make sure the "for-privoxy-version=x.y.z" minimum version number in
default.action.master has been updated:
If action file processing has changed and is not backward-compatible,
make sure the "for-privoxy-version=x.y.z" minimum version number in
default.action.master has been updated:
<programlisting>
{{settings}}
#############################################################################
#MASTER# COMMENT: The minimum Privoxy version:
for-privoxy-version=3.0.11
</programlisting>
<programlisting>
{{settings}}
#############################################################################
#MASTER# COMMENT: The minimum Privoxy version:
for-privoxy-version=3.0.11
</programlisting>
</listitem>
<listitem>
<para>
</listitem>
<listitem>
<para>
</para>
</listitem>
</itemizedlist>
</para>
</listitem>
</itemizedlist>
</sect2>
<sect2 id="therelease">
</sect2>
<sect2 id="therelease">
asked for a password):
</para>
asked for a password):
</para>
<programlisting>
mkdir dist # delete or choose different name if it already exists
cd dist
cvs -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa login
cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa export -r v_X_Y_Z current
</programlisting>
<programlisting>
mkdir dist # delete or choose different name if it already exists
cd dist
cvs -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa login
cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa export -r v_X_Y_Z current
</programlisting>
<para>
<emphasis>Do NOT change</emphasis> a single bit, including, but not limited to
<para>
<emphasis>Do NOT change</emphasis> a single bit, including, but not limited to
Please keep these general guidelines in mind when putting together
your package. These apply to <emphasis>all</emphasis> platforms!
</para>
Please keep these general guidelines in mind when putting together
your package. These apply to <emphasis>all</emphasis> platforms!
</para>
<itemizedlist>
<listitem>
<para>
<itemizedlist>
<listitem>
<para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
version into an empty directory</emphasis>. (See "Building and releasing
packages" above). Then run:
</para>
version into an empty directory</emphasis>. (See "Building and releasing
packages" above). Then run:
</para>
<programlisting>
cd current
autoheader && autoconf && ./configure
</programlisting>
<programlisting>
cd current
autoheader && autoconf && ./configure
</programlisting>
<programlisting>
make tarball-dist
</programlisting>
<programlisting>
make tarball-dist
</programlisting>
<para>
To upload the package to Sourceforge, simply issue
</para>
<para>
To upload the package to Sourceforge, simply issue
</para>
<programlisting>
make tarball-upload
</programlisting>
<programlisting>
make tarball-upload
</programlisting>
<para>
Go to the displayed URL and release the file publicly on Sourceforge.
For the change log field, use the relevant section of the
<para>
Go to the displayed URL and release the file publicly on Sourceforge.
For the change log field, use the relevant section of the
<programlisting>
cd current
autoheader && autoconf && ./configure
</programlisting>
<programlisting>
cd current
autoheader && autoconf && ./configure
</programlisting>
<programlisting>
make <replaceable class="parameter">dist</replaceable>-dist
</programlisting>
<programlisting>
make <replaceable class="parameter">dist</replaceable>-dist
</programlisting>
<para>
To upload the package to Sourceforge, simply issue
</para>
<para>
To upload the package to Sourceforge, simply issue
</para>
<programlisting>
make <replaceable class="parameter">dist</replaceable>-upload <replaceable class="parameter">rpm_packagerev</replaceable>
</programlisting>
<programlisting>
make <replaceable class="parameter">dist</replaceable>-upload <replaceable class="parameter">rpm_packagerev</replaceable>
</programlisting>
<para>
where <replaceable class="parameter">rpm_packagerev</replaceable> is the
RPM release number as determined above.
<para>
where <replaceable class="parameter">rpm_packagerev</replaceable> is the
RPM release number as determined above.
version into an empty directory</emphasis>. (See "Building and releasing
packages" above). Then get the OS/2 Setup module:
</para>
version into an empty directory</emphasis>. (See "Building and releasing
packages" above). Then get the OS/2 Setup module:
</para>
<programlisting>
cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co os2setup
</programlisting>
<programlisting>
cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co os2setup
</programlisting>
<para>
You will need a mix of development tools.
The main compilation takes place with IBM Visual Age C++.
<para>
You will need a mix of development tools.
The main compilation takes place with IBM Visual Age C++.
Edit the os2build.cmd file to set the final executable filename.
For example,
</para>
Edit the os2build.cmd file to set the final executable filename.
For example,
</para>
<programlisting>
installExeName='privoxyos2_setup_X.Y.Z.exe'
</programlisting>
<programlisting>
installExeName='privoxyos2_setup_X.Y.Z.exe'
</programlisting>
<para>
Next, edit the <filename>IJB.wis</filename> file so the release number matches
in the <filename>PACKAGEID</filename> section:
</para>
<para>
Next, edit the <filename>IJB.wis</filename> file so the release number matches
in the <filename>PACKAGEID</filename> section:
</para>
<programlisting>
PACKAGEID="Privoxy Team\Privoxy\Privoxy Package\X\Y\Z"
</programlisting>
<programlisting>
PACKAGEID="Privoxy Team\Privoxy\Privoxy Package\X\Y\Z"
</programlisting>
<para>
You're now ready to build. Run:
</para>
<para>
You're now ready to build. Run:
</para>
<programlisting>
os2build
</programlisting>
<programlisting>
os2build
</programlisting>
<para>
You will find the WarpIN-installable executable in the
<filename>./files</filename> directory. Upload this anonymously to
<para>
You will find the WarpIN-installable executable in the
<filename>./files</filename> directory. Upload this anonymously to
<para>
Login to Sourceforge's compilefarm via ssh:
</para>
<para>
Login to Sourceforge's compilefarm via ssh:
</para>
<programlisting>
ssh cf.sourceforge.net
</programlisting>
<programlisting>
ssh cf.sourceforge.net
</programlisting>
<para>
Choose the right operating system (not the Debian one).
When logged in, <emphasis>make sure that you have freshly exported the right
version into an empty directory</emphasis>. (See "Building and releasing
packages" above). Then run:
</para>
<para>
Choose the right operating system (not the Debian one).
When logged in, <emphasis>make sure that you have freshly exported the right
version into an empty directory</emphasis>. (See "Building and releasing
packages" above). Then run:
</para>
<programlisting>
cd current
autoheader && autoconf && ./configure
</programlisting>
<programlisting>
cd current
autoheader && autoconf && ./configure
</programlisting>
<programlisting>
gmake solaris-dist
</programlisting>
<programlisting>
gmake solaris-dist
</programlisting>
<para>
which creates a gzip'ed tar archive. Sadly, you cannot use <command>make
solaris-upload</command> on the Sourceforge machine (no ncftpput). You now have
<para>
which creates a gzip'ed tar archive. Sadly, you cannot use <command>make
solaris-upload</command> on the Sourceforge machine (no ncftpput). You now have
version into an empty directory</emphasis>. (See "Building and releasing
packages" above). Then get the Windows setup module:
</para>
version into an empty directory</emphasis>. (See "Building and releasing
packages" above). Then get the Windows setup module:
</para>
<programlisting>
cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co winsetup
</programlisting>
<programlisting>
cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co winsetup
</programlisting>
<para>
Then you can build the package. This is fully automated, and is
controlled by <filename>winsetup/GNUmakefile</filename>.
All you need to do is:
</para>
<para>
Then you can build the package. This is fully automated, and is
controlled by <filename>winsetup/GNUmakefile</filename>.
All you need to do is:
</para>
<programlisting>
cd winsetup
make
</programlisting>
<programlisting>
cd winsetup
make
</programlisting>
<para>
Now you can manually rename <filename>privoxy_setup.exe</filename> to
<filename>privoxy_setup_X_Y_Z.exe</filename>, and upload it to
<para>
Now you can manually rename <filename>privoxy_setup.exe</filename> to
<filename>privoxy_setup_X_Y_Z.exe</filename>, and upload it to
entry to <filename>debian/changelog</filename>, if it is not
already there, for example by running:
</para>
entry to <filename>debian/changelog</filename>, if it is not
already there, for example by running:
</para>
<programlisting>
debchange -v &p-version;-&p-status;-1 "New upstream version"
</programlisting>
<programlisting>
debchange -v &p-version;-&p-status;-1 "New upstream version"
</programlisting>
<para>
Then, run:
</para>
<para>
Then, run:
</para>
<programlisting>
dpkg-buildpackage -rfakeroot -us -uc -b
</programlisting>
<programlisting>
dpkg-buildpackage -rfakeroot -us -uc -b
</programlisting>
<para>
This will create
<filename>../privoxy_&p-version;-&p-status;-1_i386.deb</filename>
which can be uploaded. To upload the package to Sourceforge, simply
issue
</para>
<para>
This will create
<filename>../privoxy_&p-version;-&p-status;-1_i386.deb</filename>
which can be uploaded. To upload the package to Sourceforge, simply
issue
</para>
<programlisting>
make debian-upload
</programlisting>
<programlisting>
make debian-upload
</programlisting>
</sect3>
<sect3 id="newrelease-macosx"><title>Mac OS X</title>
</sect3>
<sect3 id="newrelease-macosx"><title>Mac OS X</title>
The OSXPackageBuilder module generates OS X installer packages
supporting all Macs running OS X 10.4 and above. Obtain it from CVS as
follows into a folder parallel to the exported privoxy source:
The OSXPackageBuilder module generates OS X installer packages
supporting all Macs running OS X 10.4 and above. Obtain it from CVS as
follows into a folder parallel to the exported privoxy source:
<programlisting>
cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co OSXPackageBuilder
</programlisting>
<programlisting>
cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co OSXPackageBuilder
</programlisting>
<para>
The module contains complete instructions on its usage in the file
<filename>OS X Package Builder HOWTO.txt</filename>.
<para>
The module contains complete instructions on its usage in the file
<filename>OS X Package Builder HOWTO.txt</filename>.
<para>
Check out the module from CVS as follows into a folder parallel to the
exported privoxy source:
<para>
Check out the module from CVS as follows into a folder parallel to the
exported privoxy source:
<programlisting>
cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co osxsetup
</programlisting>
<programlisting>
cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co osxsetup
</programlisting>
<programlisting>
cd osxsetup
build
</programlisting>
<programlisting>
cd osxsetup
build
</programlisting>
<para>
This will run <filename>autoheader</filename>, <filename>autoconf</filename>
and <filename>configure</filename> as well as <filename>make</filename>.
<para>
This will run <filename>autoheader</filename>, <filename>autoconf</filename>
and <filename>configure</filename> as well as <filename>make</filename>.
package" button. If you specify ./Privoxy.pkg as the output package
name, you can then create the distributable zip file with the command:
</para>
package" button. If you specify ./Privoxy.pkg as the output package
name, you can then create the distributable zip file with the command:
</para>
<programlisting>
zip -r privoxyosx_setup_x.y.z.zip Privoxy.pkg
</programlisting>
<programlisting>
zip -r privoxyosx_setup_x.y.z.zip Privoxy.pkg
</programlisting>
<para>
You can then upload this file directly to the Files section of the
Sourceforge project in the Macintosh (OS X) folder. Each new version
<para>
You can then upload this file directly to the Files section of the
Sourceforge project in the Macintosh (OS X) folder. Each new version
<para>
Check out the module from CVS as follows into a folder parallel to the
exported privoxy source:
<para>
Check out the module from CVS as follows into a folder parallel to the
exported privoxy source:
<programlisting>
cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co macsetup
</programlisting>
<programlisting>
cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co macsetup
</programlisting>
<para>
The module contains complete instructions on its usage in its
<filename>README</filename> file. The end result will be the
<para>
The module contains complete instructions on its usage in its
<filename>README</filename> file. The end result will be the
to SourceForge, and go through the release steps. The upload
is done via FTP:
</para>
to SourceForge, and go through the release steps. The upload
is done via FTP:
</para>
<itemizedlist>
<listitem>
<para>
<itemizedlist>
<listitem>
<para>
</para>
</listitem>
</itemizedlist>
</para>
</listitem>
</itemizedlist>
<para>
Or use the <command>make</command> targets as described above.
</para>
<para>
Or use the <command>make</command> targets as described above.
</para>
If you have changed anything in the stable-branch documentation source
SGML files, do:
</para>
If you have changed anything in the stable-branch documentation source
SGML files, do:
</para>
<programlisting>
make dok
</programlisting>
<programlisting>
make dok
</programlisting>
<para>
That will generate <filename>doc/webserver/user-manual</filename>,
<filename>doc/webserver/developer-manual</filename>,
<para>
That will generate <filename>doc/webserver/user-manual</filename>,
<filename>doc/webserver/developer-manual</filename>,
Next, commit any changes from the above steps to CVS. All set?
If these are docs in the stable branch, then do:
</para>
Next, commit any changes from the above steps to CVS. All set?
If these are docs in the stable branch, then do:
</para>
<programlisting>
make webserver
</programlisting>
<programlisting>
make webserver
</programlisting>
<para>
This will do the upload to <ulink url="https://www.privoxy.org/">the
webserver</ulink> (www.privoxy.org) and ensure all files and directories
<para>
This will do the upload to <ulink url="https://www.privoxy.org/">the
webserver</ulink> (www.privoxy.org) and ensure all files and directories
for them in the <filename>user.action</filename> file. An example for yahoo might
look like:
</para>
for them in the <filename>user.action</filename> file. An example for yahoo might
look like:
</para>
<screen># Allow all cookies for Yahoo login:
#
{ -<ulink url="../user-manual/actions-file.html#CRUNCH-INCOMING-COOKIES">crunch-incoming-cookies</ulink> -<ulink url="../user-manual/actions-file.html#CRUNCH-OUTGOING-COOKIES">crunch-outgoing-cookies</ulink> -<ulink url="../user-manual/actions-file.html#SESSION-COOKIES-ONLY">session-cookies-only</ulink> }
.login.yahoo.com</screen>
<screen># Allow all cookies for Yahoo login:
#
{ -<ulink url="../user-manual/actions-file.html#CRUNCH-INCOMING-COOKIES">crunch-incoming-cookies</ulink> -<ulink url="../user-manual/actions-file.html#CRUNCH-OUTGOING-COOKIES">crunch-outgoing-cookies</ulink> -<ulink url="../user-manual/actions-file.html#SESSION-COOKIES-ONLY">session-cookies-only</ulink> }
.login.yahoo.com</screen>
<para>
These kinds of sites are often quite complex and heavy with
<ulink url="http://en.wikipedia.org/wiki/Javascript">Javascript</ulink> and
<para>
These kinds of sites are often quite complex and heavy with
<ulink url="http://en.wikipedia.org/wiki/Javascript">Javascript</ulink> and
url="../user-manual/actions-file.html#ALIASES">alias</ulink> just for such
sticky situations:
</para>
url="../user-manual/actions-file.html#ALIASES">alias</ulink> just for such
sticky situations:
</para>
<screen># Gmail is a _fragile_ site:
#
{ <literal>fragile</literal> }
# Gmail is ...
mail.google.com</screen>
<screen># Gmail is a _fragile_ site:
#
{ <literal>fragile</literal> }
# Gmail is ...
mail.google.com</screen>
<para>
Be sure to flush your browser's caches whenever making these kinds of
changes, just to make sure the changes <quote>take</quote>.
<para>
Be sure to flush your browser's caches whenever making these kinds of
changes, just to make sure the changes <quote>take</quote>.
should look like:
</para>
should look like:
</para>
<screen>
listen-address 192.168.1.1:8118</screen>
<screen>
listen-address 192.168.1.1:8118</screen>
<para>
Save the file, and restart <application>Privoxy</application>. Configure
<para>
Save the file, and restart <application>Privoxy</application>. Configure
all available interfaces:
</para>
all available interfaces:
</para>
<screen>
listen-address :8118</screen>
<screen>
listen-address :8118</screen>
<para>
And then use <application>Privoxy's</application>
<para>
And then use <application>Privoxy's</application>
To disable all cookie actions, so that cookies are allowed unrestricted,
both in and out, for <literal>example.com</literal>:
</para>
To disable all cookie actions, so that cookies are allowed unrestricted,
both in and out, for <literal>example.com</literal>:
</para>
<screen>
{ -crunch-incoming-cookies -crunch-outgoing-cookies -session-cookies-only -filter{content-cookies} }
.example.com</screen>
<screen>
{ -crunch-incoming-cookies -crunch-outgoing-cookies -session-cookies-only -filter{content-cookies} }
.example.com</screen>
<para>
Place the above in <filename>user.action</filename>. Note that some of these may
be off by default anyway, so this might be redundant, but there is no harm
<para>
Place the above in <filename>user.action</filename>. Note that some of these may
be off by default anyway, so this might be redundant, but there is no harm
can very easily over-ride <emphasis>all</emphasis> blocking with the
following very simple rule in your <filename>user.action</filename>:
</para>
can very easily over-ride <emphasis>all</emphasis> blocking with the
following very simple rule in your <filename>user.action</filename>:
</para>
<screen>
# Unblock everybody, everywhere
{ <ulink url="../user-manual/actions-file.html#BLOCK">-block</ulink> }
/ # UN-Block *all* URLs</screen>
<screen>
# Unblock everybody, everywhere
{ <ulink url="../user-manual/actions-file.html#BLOCK">-block</ulink> }
/ # UN-Block *all* URLs</screen>
<para>
Or even a more comprehensive reversing of various ad related actions:
</para>
<para>
Or even a more comprehensive reversing of various ad related actions:
</para>
<screen>
# Unblock everybody, everywhere, and turn off appropriate filtering, etc
{ <ulink url="../user-manual/actions-file.html#BLOCK">-block</ulink> \
<screen>
# Unblock everybody, everywhere, and turn off appropriate filtering, etc
{ <ulink url="../user-manual/actions-file.html#BLOCK">-block</ulink> \
<literal>allow-popups</literal> \
}
/ # UN-Block *all* URLs and allow ads</screen>
<literal>allow-popups</literal> \
}
/ # UN-Block *all* URLs and allow ads</screen>
<para>
This last <quote>action</quote> in this compound statement,
<literal>allow-popups</literal>, is an <ulink
<para>
This last <quote>action</quote> in this compound statement,
<literal>allow-popups</literal>, is an <ulink
available as compile-time options. You should
<command>configure</command> the sources as follows:
</para>
available as compile-time options. You should
<command>configure</command> the sources as follows:
</para>
<screen>
./configure --disable-toggle --disable-editor --disable-force</screen>
<screen>
./configure --disable-toggle --disable-editor --disable-force</screen>
<para>
This will create an executable with hard-coded security features so that
&my-app; does not allow easy bypassing of blocked sites, or changing the
<para>
This will create an executable with hard-coded security features so that
&my-app; does not allow easy bypassing of blocked sites, or changing the
<ulink url="../user-manual/config.html#FORWARDING">forwarding section</ulink>
and uncomment the line:
</para>
<ulink url="../user-manual/config.html#FORWARDING">forwarding section</ulink>
and uncomment the line:
</para>
<screen>
# forward-socks5t / 127.0.0.1:9050 .
</screen>
<screen>
# forward-socks5t / 127.0.0.1:9050 .
</screen>
<para>
Note that if you got Tor through one of the bundles, you may
have to change the port from 9050 to 9150 (or even another one).
<para>
Note that if you got Tor through one of the bundles, you may
have to change the port from 9050 to 9150 (or even another one).
uncomment the following forward rules, to make sure your local network is still
reachable through Privoxy:
</para>
uncomment the following forward rules, to make sure your local network is still
reachable through Privoxy:
</para>
<screen>
# forward 192.168.*.*/ .
# forward 10.*.*.*/ .
# forward 127.*.*.*/ .
</screen>
<screen>
# forward 192.168.*.*/ .
# forward 10.*.*.*/ .
# forward 127.*.*.*/ .
</screen>
<para>
Unencrypted connections to systems in these address ranges will
be as (un)secure as the local network is, but the alternative is
<para>
Unencrypted connections to systems in these address ranges will
be as (un)secure as the local network is, but the alternative is
network by using their names, you will need additional exceptions
that look like this:
</para>
network by using their names, you will need additional exceptions
that look like this:
</para>
<screen>
# forward localhost/ .
</screen>
<screen>
# forward localhost/ .
</screen>
<para>
Save the modified configuration file and open
<ulink url="http://config.privoxy.org/show-status">http://config.privoxy.org/show-status</ulink>
<para>
Save the modified configuration file and open
<ulink url="http://config.privoxy.org/show-status">http://config.privoxy.org/show-status</ulink>
your hosts list is neglected by <application>Privoxy's </application>
configuration, consider adding your list to your <filename>user.action</filename> file:
</para>
your hosts list is neglected by <application>Privoxy's </application>
configuration, consider adding your list to your <filename>user.action</filename> file:
</para>
<screen>
{ +block }
www.ad.example1.com
ad.example2.com
ads.galore.example.com
etc.example.com</screen>
<screen>
{ +block }
www.ad.example1.com
ad.example2.com
ads.galore.example.com
etc.example.com</screen>
</sect2>
<sect2 renderas="sect3" id="seealso">
</sect2>
<sect2 renderas="sect3" id="seealso">
<para>
There are several possibilities:
</para>
<para>
There are several possibilities:
</para>
<itemizedlist>
<listitem><para>
<application>Privoxy</application> is not running. Solution: verify
<itemizedlist>
<listitem><para>
<application>Privoxy</application> is not running. Solution: verify
try disabling or removing the firewall as a simple test.
</para></listitem>
</itemizedlist>
try disabling or removing the firewall as a simple test.
</para></listitem>
</itemizedlist>
our job a little easier. &my-app; has <quote>crunched</quote> (meaning caught
and BLOCKED) quite a few items in this example, but perhaps missed a few as well.
</para>
our job a little easier. &my-app; has <quote>crunched</quote> (meaning caught
and BLOCKED) quite a few items in this example, but perhaps missed a few as well.
</para>
<screen>
<![CDATA[
Request: www.example.com/
<screen>
<![CDATA[
Request: www.example.com/
Request: 66.70.21.80/scripts/click.php?hid=a71b9f6504b0c5681fa5&si=Ua
]]>
</screen>
Request: 66.70.21.80/scripts/click.php?hid=a71b9f6504b0c5681fa5&si=Ua
]]>
</screen>
<para>
Despite 12 out of 32 requests being blocked, the page looked, and seemed to
behave perfectly <quote>normal</quote> (minus some ads, of course).
<para>
Despite 12 out of 32 requests being blocked, the page looked, and seemed to
behave perfectly <quote>normal</quote> (minus some ads, of course).
To do that, enable logging to figure out which requests get blocked by
&my-app; and add the hosts (no path patterns) to a section like this:
</para>
To do that, enable logging to figure out which requests get blocked by
&my-app; and add the hosts (no path patterns) to a section like this:
</para>
<screen>
<![CDATA[
{+redirect{http://127.0.0.1:0/} -block -limit-connect}
.ivwbox.de:443/
]]>
</screen>
<screen>
<![CDATA[
{+redirect{http://127.0.0.1:0/} -block -limit-connect}
.ivwbox.de:443/
]]>
</screen>
<para>
Additionally you have to configure your browser to contact
<quote>127.0.0.1:0</quote> directly (instead of through &my-app;).
<para>
Additionally you have to configure your browser to contact
<quote>127.0.0.1:0</quote> directly (instead of through &my-app;).
Your userid probably isn't allowed to edit the file.
<!-- show how to check permissions? -->
On Windows you can use the windows equivalent of sudo:
Your userid probably isn't allowed to edit the file.
<!-- show how to check permissions? -->
On Windows you can use the windows equivalent of sudo:
- <screen>runas /user:administrator "notepad \privoxy\config.txt"</screen>
+ <screen>runas /user:administrator "notepad \privoxy\config.txt"</screen>
<para>
or fix the file permissions:
<para>
or fix the file permissions:
<screen>C:\Privoxy>icacls config.txt
config.txt BUILTIN\Administrators:(I)(F)
NT AUTHORITY\SYSTEM:(I)(F)
<screen>C:\Privoxy>icacls config.txt
config.txt BUILTIN\Administrators:(I)(F)
NT AUTHORITY\SYSTEM:(I)(F)
Successfully processed 1 files; Failed processing 0 files
C:\Privoxy></screen>
Successfully processed 1 files; Failed processing 0 files
C:\Privoxy></screen>
<para>
or try to point-n-click your way through adjusting the file
<para>
or try to point-n-click your way through adjusting the file
<listitem>
<para>
Supports "Connection: keep-alive". Outgoing connections can
<listitem>
<para>
Supports "Connection: keep-alive". Outgoing connections can
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
<para>
Unix, in local filesystem (may not work with all browsers):
</para>
<para>
Unix, in local filesystem (may not work with all browsers):
</para>
<screen> user-manual file:///usr/share/doc/privoxy-&p-version;/user-manual/</screen>
<screen> user-manual file:///usr/share/doc/privoxy-&p-version;/user-manual/</screen>
<para>
Windows, in local filesystem, <emphasis>must</emphasis> use forward slash notation:
</para>
<para>
Windows, in local filesystem, <emphasis>must</emphasis> use forward slash notation:
</para>
<screen> user-manual file:/c:/some-dir/privoxy-&p-version;/user-manual/</screen>
<screen> user-manual file:/c:/some-dir/privoxy-&p-version;/user-manual/</screen>
<para>
Windows, UNC notation (with forward slashes):
</para>
<para>
Windows, UNC notation (with forward slashes):
</para>
<screen> user-manual file://///some-server/some-path/privoxy-&p-version;/user-manual/</screen>
<screen> user-manual file://///some-server/some-path/privoxy-&p-version;/user-manual/</screen>
-->
<para>
The best all purpose solution is simply to put the full local
<literal>PATH</literal> to where the <citetitle>User Manual</citetitle> is
located:
</para>
-->
<para>
The best all purpose solution is simply to put the full local
<literal>PATH</literal> to where the <citetitle>User Manual</citetitle> is
located:
</para>
<screen> user-manual /usr/share/doc/privoxy/user-manual</screen>
<screen> user-manual /usr/share/doc/privoxy/user-manual</screen>
<para>
The User Manual is then available to anyone with access to
<application>Privoxy</application>, by following the built-in URL:
<para>
The User Manual is then available to anyone with access to
<application>Privoxy</application>, by following the built-in URL:
If the documentation is not on the local system, it can be accessed
from a remote server, as:
</para>
If the documentation is not on the local system, it can be accessed
from a remote server, as:
</para>
<screen> user-manual http://example.com/privoxy/user-manual/</screen>
<screen> user-manual http://example.com/privoxy/user-manual/</screen>
<![%user-man;[
<!-- this gets hammered in conversion to config. Text repeated below. -->
<warning>
<![%user-man;[
<!-- this gets hammered in conversion to config. Text repeated below. -->
<warning>
<para>
The available debug levels are:
</para>
<para>
The available debug levels are:
</para>
<programlisting>
debug 1 # Log the destination for each request &my-app; let through. See also debug 1024.
debug 2 # show each connection status
<programlisting>
debug 1 # Log the destination for each request &my-app; let through. See also debug 1024.
debug 2 # show each connection status
debug 32768 # log all data read from the network
debug 65536 # Log the applying actions
</programlisting>
debug 32768 # log all data read from the network
debug 65536 # Log the applying actions
</programlisting>
<para>
To select multiple debug levels, you can either add them or use
multiple <literal>debug</literal> lines.
<para>
To select multiple debug levels, you can either add them or use
multiple <literal>debug</literal> lines.
(192.168.0.0) and has another outside connection with a different address.
You want it to serve requests from inside only:
</para>
(192.168.0.0) and has another outside connection with a different address.
You want it to serve requests from inside only:
</para>
<programlisting>
listen-address 192.168.0.1:8118
</programlisting>
<programlisting>
listen-address 192.168.0.1:8118
</programlisting>
<para>
Suppose you are running <application>Privoxy</application> on an
IPv6-capable machine and you want it to listen on the IPv6 address
of the loopback device:
</para>
<para>
Suppose you are running <application>Privoxy</application> on an
IPv6-capable machine and you want it to listen on the IPv6 address
of the loopback device:
</para>
<programlisting>
listen-address [::1]:8118
</programlisting>
<programlisting>
listen-address [::1]:8118
</programlisting>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
</variablelist>
is OK. The absence of a <replaceable class="parameter">dst_addr</replaceable> implies that
<emphasis>all</emphasis> destination addresses are OK:
</para>
is OK. The absence of a <replaceable class="parameter">dst_addr</replaceable> implies that
<emphasis>all</emphasis> destination addresses are OK:
</para>
<screen>
permit-access localhost
</screen>
<screen>
permit-access localhost
</screen>
<para>
Allow any host on the same class C subnet as www.privoxy.org access to
nothing but www.example.com (or other domains hosted on the same system):
</para>
<para>
Allow any host on the same class C subnet as www.privoxy.org access to
nothing but www.example.com (or other domains hosted on the same system):
</para>
<screen>
permit-access www.privoxy.org/24 www.example.com/32
</screen>
<screen>
permit-access www.privoxy.org/24 www.example.com/32
</screen>
<para>
Allow access from any host on the 26-bit subnet 192.168.45.64 to anywhere,
with the exception that 192.168.45.73 may not access the IP address behind
www.dirty-stuff.example.com:
</para>
<para>
Allow access from any host on the 26-bit subnet 192.168.45.64 to anywhere,
with the exception that 192.168.45.73 may not access the IP address behind
www.dirty-stuff.example.com:
</para>
<screen>
permit-access 192.168.45.64/26
deny-access 192.168.45.73 www.dirty-stuff.example.com
</screen>
<screen>
permit-access 192.168.45.64/26
deny-access 192.168.45.73 www.dirty-stuff.example.com
</screen>
<para>
Allow access from the IPv4 network 192.0.2.0/24 even if listening on
an IPv6 wild card address (not supported on all platforms):
</para>
<para>
Allow access from the IPv4 network 192.0.2.0/24 even if listening on
an IPv6 wild card address (not supported on all platforms):
</para>
<programlisting>
permit-access 192.0.2.0/24
</programlisting>
<programlisting>
permit-access 192.0.2.0/24
</programlisting>
<para>
This is equivalent to the following line even if listening on an
IPv4 address (not supported on all platforms):
</para>
<para>
This is equivalent to the following line even if listening on an
IPv4 address (not supported on all platforms):
</para>
<programlisting>
permit-access [::ffff:192.0.2.0]/120
</programlisting>
<programlisting>
permit-access [::ffff:192.0.2.0]/120
</programlisting>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
</variablelist>
<para>
Everything goes to an example parent proxy, except SSL on port 443 (which it doesn't handle):
</para>
<para>
Everything goes to an example parent proxy, except SSL on port 443 (which it doesn't handle):
</para>
<screen>
forward / parent-proxy.example.org:8080
forward :443 .
</screen>
<screen>
forward / parent-proxy.example.org:8080
forward :443 .
</screen>
<para>
Everything goes to our example ISP's caching proxy, except for requests
to that ISP's sites:
</para>
<para>
Everything goes to our example ISP's caching proxy, except for requests
to that ISP's sites:
</para>
<screen>
forward / caching-proxy.isp.example.net:8000
forward .isp.example.net .
</screen>
<screen>
forward / caching-proxy.isp.example.net:8000
forward .isp.example.net .
</screen>
<para>
Parent proxy specified by an IPv6 address:
</para>
<para>
Parent proxy specified by an IPv6 address:
</para>
<programlisting>
forward / [2001:DB8::1]:8000
</programlisting>
<programlisting>
forward / [2001:DB8::1]:8000
</programlisting>
<para>
Suppose your parent proxy doesn't support IPv6:
</para>
<para>
Suppose your parent proxy doesn't support IPv6:
</para>
<programlisting>
forward / parent-proxy.example.org:8000
forward ipv6-server.example.org .
forward <[2-3][0-9a-f][0-9a-f][0-9a-f]:*> .
</programlisting>
<programlisting>
forward / parent-proxy.example.org:8000
forward ipv6-server.example.org .
forward <[2-3][0-9a-f][0-9a-f][0-9a-f]:*> .
</programlisting>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
</variablelist>
their ISP's proxy by way of example.com's corporate SOCKS 4A gateway to
the Internet.
</para>
their ISP's proxy by way of example.com's corporate SOCKS 4A gateway to
the Internet.
</para>
<screen>
forward-socks4a / socks-gw.example.com:1080 www-cache.isp.example.net:8080
forward .example.com .
</screen>
<screen>
forward-socks4a / socks-gw.example.com:1080 www-cache.isp.example.net:8080
forward .example.com .
</screen>
<para>
A rule that uses a SOCKS 4 gateway for all destinations but no HTTP parent looks like this:
</para>
<para>
A rule that uses a SOCKS 4 gateway for all destinations but no HTTP parent looks like this:
</para>
<screen>
forward-socks4 / socks-gw.example.com:1080 .
</screen>
<screen>
forward-socks4 / socks-gw.example.com:1080 .
</screen>
<para>
To chain Privoxy and Tor, both running on the same system, you would use
something like:
</para>
<para>
To chain Privoxy and Tor, both running on the same system, you would use
something like:
</para>
<screen>
forward-socks5t / 127.0.0.1:9050 .
</screen>
<screen>
forward-socks5t / 127.0.0.1:9050 .
</screen>
<para>
Note that if you got Tor through one of the bundles, you may
have to change the port from 9050 to 9150 (or even another one).
<para>
Note that if you got Tor through one of the bundles, you may
have to change the port from 9050 to 9150 (or even another one).
reach your local network, if you need to access local servers you
therefore might want to make some exceptions:
</para>
reach your local network, if you need to access local servers you
therefore might want to make some exceptions:
</para>
<screen>
forward 192.168.*.*/ .
forward 10.*.*.*/ .
forward 127.*.*.*/ .
</screen>
<screen>
forward 192.168.*.*/ .
forward 10.*.*.*/ .
forward 127.*.*.*/ .
</screen>
<para>
Unencrypted connections to systems in these address ranges will
be as (un)secure as the local network is, but the alternative is that you
<para>
Unencrypted connections to systems in these address ranges will
be as (un)secure as the local network is, but the alternative is that you
using their names, you will need additional exceptions that look like
this:
</para>
using their names, you will need additional exceptions that look like
this:
</para>
<screen>
forward localhost/ .
</screen>
<screen>
forward localhost/ .
</screen>
</listitem>
</varlistentry>
</listitem>
</varlistentry>
<screen>
forward / .
forward .isp-b.example.net host-b:8118
</screen>
<screen>
forward / .
forward .isp-b.example.net host-b:8118
</screen>
<screen>
forward / .
forward .isp-a.example.org host-a:8118
</screen>
<screen>
forward / .
forward .isp-a.example.org host-a:8118
</screen>
<para>
Now, your users can set their browser's proxy to use either
<para>
Now, your users can set their browser's proxy to use either
run on the same box, your <application>squid</application> configuration could then look like this:
</para>
run on the same box, your <application>squid</application> configuration could then look like this:
</para>
<screen>
# Define Privoxy as parent proxy (without ICP)
cache_peer 127.0.0.1 parent 8118 7 no-query
<screen>
# Define Privoxy as parent proxy (without ICP)
cache_peer 127.0.0.1 parent 8118 7 no-query
# Forward all the rest to Privoxy
never_direct allow all</screen>
# Forward all the rest to Privoxy
never_direct allow all</screen>
<para>
You would then need to change your browser's proxy settings to <application>squid</application>'s address and port.
<para>
You would then need to change your browser's proxy settings to <application>squid</application>'s address and port.
say, on <literal>antivir.example.com</literal>, port 8010:
</para>
say, on <literal>antivir.example.com</literal>, port 8010:
</para>
<screen>
forward / .
forward /.*\.(exe|com|dll|zip)$ antivir.example.com:8010</screen>
<screen>
forward / .
forward /.*\.(exe|com|dll|zip)$ antivir.example.com:8010</screen>
<varlistentry>
<term>Examples:</term>
<listitem>
<varlistentry>
<term>Examples:</term>
<listitem>
<screen>
# Best speed (compared to the other levels)
compression-level 1
<screen>
# Best speed (compared to the other levels)
compression-level 1
# is likely to be flawed.
compression-level 0
</screen>
# is likely to be flawed.
compression-level 0
</screen>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
</variablelist>
<varlistentry>
<term>Examples:</term>
<listitem>
<varlistentry>
<term>Examples:</term>
<listitem>
<screen>
# Define a couple of tags, the described effect requires action sections
# that are enabled based on CLIENT-TAG patterns.
client-specific-tag circumvent-blocks Overrule blocks but do not affect other actions
disable-content-filters Disable content-filters but do not affect other actions
</screen>
<screen>
# Define a couple of tags, the described effect requires action sections
# that are enabled based on CLIENT-TAG patterns.
client-specific-tag circumvent-blocks Overrule blocks but do not affect other actions
disable-content-filters Disable content-filters but do not affect other actions
</screen>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
</variablelist>
<varlistentry>
<term>Examples:</term>
<listitem>
<varlistentry>
<term>Examples:</term>
<listitem>
<screen>
# Increase the time to life for temporarily enabled tags to 3 minutes
client-tag-lifetime 180
</screen>
<screen>
# Increase the time to life for temporarily enabled tags to 3 minutes
client-tag-lifetime 180
</screen>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
</variablelist>
<varlistentry>
<term>Examples:</term>
<listitem>
<varlistentry>
<term>Examples:</term>
<listitem>
<screen>
# Allow systems that can reach Privoxy to provide the client
# IP address with a X-Forwarded-For header.
trust-x-forwarded-for 1
</screen>
<screen>
# Allow systems that can reach Privoxy to provide the client
# IP address with a X-Forwarded-For header.
trust-x-forwarded-for 1
</screen>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
</variablelist>
<varlistentry>
<term>Examples:</term>
<listitem>
<varlistentry>
<term>Examples:</term>
<listitem>
<screen>
# Increase the receive buffer size
receive-buffer-size 32768
</screen>
<screen>
# Increase the receive buffer size
receive-buffer-size 32768
</screen>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
</variablelist>
<simplelist>
<member>
<ulink
<simplelist>
<member>
<ulink
</member>
</simplelist>
]]>
</member>
</simplelist>
]]>
versions of <application>Privoxy</application>:
</para>
versions of <application>Privoxy</application>:
</para>
<itemizedlist>
<listitem>
<itemizedlist>
<listitem>
that filtering does not work on compressed pages, so if you use, or want to
use, filtering, you will need to force compression off. Example:
</para>
that filtering does not work on compressed pages, so if you use, or want to
use, filtering, you will need to force compression off. Example:
</para>
<screen>
{ +<link linkend="filter">filter</link>{google} +<link linkend="prevent-compression">prevent-compression</link> }
.google.</screen>
<screen>
{ +<link linkend="filter">filter</link>{google} +<link linkend="prevent-compression">prevent-compression</link> }
.google.</screen>
<para>
Or if you use a number of filters, or filter many sites, you may just want
to turn off compression for all sites in
<para>
Or if you use a number of filters, or filter many sites, you may just want
to turn off compression for all sites in
</sect2>
</sect1>
<!-- ~~~~~ New section ~~~~~ -->
<sect1 id="quickstart"><title>Quickstart to Using Privoxy</title>
</sect2>
</sect1>
<!-- ~~~~~ New section ~~~~~ -->
<sect1 id="quickstart"><title>Quickstart to Using Privoxy</title>
<itemizedlist>
<listitem>
<itemizedlist>
<listitem>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
<!-- ~~~~~ New section ~~~~~ -->
<!-- ~~~~~ New section ~~~~~ -->
<literal><link linkend="set-image-blocker">set-image-blocker</link></literal>:
</para>
<literal><link linkend="set-image-blocker">set-image-blocker</link></literal>:
</para>
<itemizedlist>
<listitem>
<itemizedlist>
<listitem>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
<para>
Advanced users will eventually want to explore &my-app;
<para>
Advanced users will eventually want to explore &my-app;
A quick and simple step by step example:
</para>
A quick and simple step by step example:
</para>
<itemizedlist>
<listitem>
<itemizedlist>
<listitem>
</para>
<!-- image of editor and actions files selections -->
</para>
<!-- image of editor and actions files selections -->
<figure pgwide="0" float="0"><title>Actions Files in Use</title>
<mediaobject>
<imageobject>
<figure pgwide="0" float="0"><title>Actions Files in Use</title>
<mediaobject>
<imageobject>
</textobject>
</mediaobject>
</figure>
</textobject>
</mediaobject>
</figure>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
<para>
This is a very crude and simple example. There might be good reasons to use a
<para>
This is a very crude and simple example. There might be good reasons to use a
</para>
<!-- image of Mozilla Proxy configuration -->
</para>
<!-- image of Mozilla Proxy configuration -->
<figure pgwide="0" float="0"><title>Proxy Configuration Showing
Mozilla/Netscape HTTP and HTTPS (SSL) Settings</title>
<mediaobject>
<figure pgwide="0" float="0"><title>Proxy Configuration Showing
Mozilla/Netscape HTTP and HTTPS (SSL) Settings</title>
<mediaobject>
</textobject>
</mediaobject>
</figure>
</textobject>
</mediaobject>
</figure>
</para>
<!-- image of IE Proxy configuration -->
</para>
<!-- image of IE Proxy configuration -->
<figure pgwide="0" float="0"><title>Proxy Configuration Showing
Internet Explorer HTTP and HTTPS (Secure) Settings</title>
<mediaobject>
<figure pgwide="0" float="0"><title>Proxy Configuration Showing
Internet Explorer HTTP and HTTPS (Secure) Settings</title>
<mediaobject>
</textobject>
</mediaobject>
</figure>
</textobject>
</mediaobject>
</figure>
<filename>/etc/privoxy/config</filename> as its main configuration
file.
</para>
<filename>/etc/privoxy/config</filename> as its main configuration
file.
</para>
<screen>
# /etc/init.d/privoxy start
</screen>
<screen>
# /etc/init.d/privoxy start
</screen>
</sect2>
<sect2 id="start-freebsd">
</sect2>
<sect2 id="start-freebsd">
<para>
To start <application>Privoxy</application> manually, run:
</para>
<para>
To start <application>Privoxy</application> manually, run:
</para>
<screen>
# service privoxy onestart
</screen>
<screen>
# service privoxy onestart
</screen>
</sect2>
<sect2 id="start-windows">
</sect2>
<sect2 id="start-windows">
<para>
Example Unix startup command:
</para>
<para>
Example Unix startup command:
</para>
<screen>
# /usr/sbin/privoxy --user privoxy /etc/privoxy/config
</screen>
<screen>
# /usr/sbin/privoxy --user privoxy /etc/privoxy/config
</screen>
<para>
Note that if you installed <application>Privoxy</application> through
a package manager, the package will probably contain a platform-specific
<para>
Note that if you installed <application>Privoxy</application> through
a package manager, the package will probably contain a platform-specific
command-line options:
</para>
command-line options:
</para>
<itemizedlist>
<listitem>
<itemizedlist>
<listitem>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
<para>
On <application>MS Windows</application> only there are two additional
<para>
On <application>MS Windows</application> only there are two additional
principle configuration files are:
</para>
principle configuration files are:
</para>
<itemizedlist>
<listitem>
<itemizedlist>
<listitem>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
<para>
The syntax of the configuration and filter files may change between different
<para>
The syntax of the configuration and filter files may change between different
are three action files included with <application>Privoxy</application> with
differing purposes:
</para>
are three action files included with <application>Privoxy</application> with
differing purposes:
</para>
<itemizedlist>
<listitem>
<para>
<itemizedlist>
<listitem>
<para>
The default profiles, and their associated actions, as pre-defined in
<filename>default.action</filename> are:
</para>
The default profiles, and their associated actions, as pre-defined in
<filename>default.action</filename> are:
</para>
<table frame=all><title>Default Configurations</title>
<tgroup cols=4 align=left colsep=1 rowsep=1>
<colspec colname=c1>
<table frame=all><title>Default Configurations</title>
<tgroup cols=4 align=left colsep=1 rowsep=1>
<colspec colname=c1>
</tbody>
</tgroup>
</table>
</tbody>
</tgroup>
</table>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
<para>
The list of actions files to be used are defined in the main configuration
<para>
The list of actions files to be used are defined in the main configuration
<screen>
{ +<literal>handle-as-image</literal> +<literal>block{Banner ads.}</literal> }
# Block these as if they were images. Send no block page.
banners.example.com
media.example.com/.*banners
.example.com/images/ads/</screen>
<screen>
{ +<literal>handle-as-image</literal> +<literal>block{Banner ads.}</literal> }
# Block these as if they were images. Send no block page.
banners.example.com
media.example.com/.*banners
.example.com/images/ads/</screen>
<para>
You can trace this process for URL patterns and any given URL by visiting <ulink
<para>
You can trace this process for URL patterns and any given URL by visiting <ulink
<screen>
# If the admin defined the client-specific-tag circumvent-blocks,
# and the request comes from a client that previously requested
<screen>
# If the admin defined the client-specific-tag circumvent-blocks,
# and the request comes from a client that previously requested
# the previous one.
{+block{Nobody is supposed to request this.}}
example.org/blocked-example-page</screen>
# the previous one.
{+block{Nobody is supposed to request this.}}
example.org/blocked-example-page</screen>
Actions fall into three categories:
</para>
Actions fall into three categories:
</para>
<itemizedlist>
<listitem>
<para>
Boolean, i.e the action can only be <quote>enabled</quote> or
<quote>disabled</quote>. Syntax:
</para>
<itemizedlist>
<listitem>
<para>
Boolean, i.e the action can only be <quote>enabled</quote> or
<quote>disabled</quote>. Syntax:
</para>
<screen>
+<replaceable class="function">name</replaceable> # enable action <replaceable class="parameter">name</replaceable>
-<replaceable class="function">name</replaceable> # disable action <replaceable class="parameter">name</replaceable></screen>
<screen>
+<replaceable class="function">name</replaceable> # enable action <replaceable class="parameter">name</replaceable>
-<replaceable class="function">name</replaceable> # disable action <replaceable class="parameter">name</replaceable></screen>
<para>
Example: <literal>+handle-as-image</literal>
</para>
<para>
Example: <literal>+handle-as-image</literal>
</para>
Parameterized, where some value is required in order to enable this type of action.
Syntax:
</para>
Parameterized, where some value is required in order to enable this type of action.
Syntax:
</para>
<screen>
+<replaceable class="function">name</replaceable>{<replaceable class="parameter">param</replaceable>} # enable action and set parameter to <replaceable class="parameter">param</replaceable>,
# overwriting parameter from previous match if necessary
-<replaceable class="function">name</replaceable> # disable action. The parameter can be omitted</screen>
<screen>
+<replaceable class="function">name</replaceable>{<replaceable class="parameter">param</replaceable>} # enable action and set parameter to <replaceable class="parameter">param</replaceable>,
# overwriting parameter from previous match if necessary
-<replaceable class="function">name</replaceable> # disable action. The parameter can be omitted</screen>
<para>
Note that if the URL matches multiple positive forms of a parameterized action,
the last match wins, i.e. the params from earlier matches are simply ignored.
<para>
Note that if the URL matches multiple positive forms of a parameterized action,
the last match wins, i.e. the params from earlier matches are simply ignored.
that can be executed for the same request repeatedly, like adding multiple
headers, or filtering through multiple filters. Syntax:
</para>
that can be executed for the same request repeatedly, like adding multiple
headers, or filtering through multiple filters. Syntax:
</para>
<screen>
+<replaceable class="function">name</replaceable>{<replaceable class="parameter">param</replaceable>} # enable action and add <replaceable class="parameter">param</replaceable> to the list of parameters
-<replaceable class="function">name</replaceable>{<replaceable class="parameter">param</replaceable>} # remove the parameter <replaceable class="parameter">param</replaceable> from the list of parameters
# If it was the last one left, disable the action.
<replaceable class="parameter">-name</replaceable> # disable this action completely and remove all parameters from the list</screen>
<screen>
+<replaceable class="function">name</replaceable>{<replaceable class="parameter">param</replaceable>} # enable action and add <replaceable class="parameter">param</replaceable> to the list of parameters
-<replaceable class="function">name</replaceable>{<replaceable class="parameter">param</replaceable>} # remove the parameter <replaceable class="parameter">param</replaceable> from the list of parameters
# If it was the last one left, disable the action.
<replaceable class="parameter">-name</replaceable> # disable this action completely and remove all parameters from the list</screen>
<para>
Examples: <literal>+add-header{X-Fun-Header: Some text}</literal> and
<literal>+filter{html-annoyances}</literal>
<para>
Examples: <literal>+add-header{X-Fun-Header: Some text}</literal> and
<literal>+filter{html-annoyances}</literal>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
<para>
If nothing is specified in any actions file, no <quote>actions</quote> are
<para>
If nothing is specified in any actions file, no <quote>actions</quote> are
<varlistentry>
<term>Example usage:</term>
<listitem>
<varlistentry>
<term>Example usage:</term>
<listitem>
<screen># Add a DNT ("Do not track") header to all requests,
# event to those that already have one.
#
<screen># Add a DNT ("Do not track") header to all requests,
# event to those that already have one.
#
# header may make user-tracking easier.
{+add-header{DNT: 1}}
/</screen>
# header may make user-tracking easier.
{+add-header{DNT: 1}}
/</screen>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
</variablelist>
<varlistentry>
<term>Example usage (section):</term>
<listitem>
<varlistentry>
<term>Example usage (section):</term>
<listitem>
<screen>{+block{No nasty stuff for you.}}
# Block and replace with "blocked" page
.nasty-stuff.example.com
<screen>{+block{No nasty stuff for you.}}
# Block and replace with "blocked" page
.nasty-stuff.example.com
{+block{Layered ads.} +handle-as-empty-document}
# Block and then ignore
adserver.example.net/.*\.js$</screen>
{+block{Layered ads.} +handle-as-empty-document}
# Block and then ignore
adserver.example.net/.*\.js$</screen>
</listitem>
</varlistentry>
</listitem>
</varlistentry>
<varlistentry>
<term>Example usage:</term>
<listitem>
<varlistentry>
<term>Example usage:</term>
<listitem>
<screen>+change-x-forwarded-for{block}</screen>
<screen>+change-x-forwarded-for{block}</screen>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
</variablelist>
<varlistentry>
<term>Example usage (section):</term>
<listitem>
<varlistentry>
<term>Example usage (section):</term>
<listitem>
<screen>
# Hide Tor exit notation in Host and Referer Headers
{+client-header-filter{hide-tor-exit-notation}}
/
<screen>
# Hide Tor exit notation in Host and Referer Headers
{+client-header-filter{hide-tor-exit-notation}}
/
</listitem>
</varlistentry>
</listitem>
</varlistentry>
<varlistentry>
<term>Example usage (section):</term>
<listitem>
<varlistentry>
<term>Example usage (section):</term>
<listitem>
<screen>
# Tag every request with the User-Agent header
{+client-header-tagger{user-agent}}
<screen>
# Tag every request with the User-Agent header
{+client-header-tagger{user-agent}}
TAG:^User-Agent: Ubuntu APT-HTTP/
TAG:^User-Agent: MPlayer/
</screen>
TAG:^User-Agent: Ubuntu APT-HTTP/
TAG:^User-Agent: MPlayer/
</screen>
<screen>
# Tag all requests with the Range header set
{+client-header-tagger{range-requests}}
<screen>
# Tag all requests with the Range header set
{+client-header-tagger{range-requests}}
{-filter -deanimate-gifs}
TAG:^RANGE-REQUEST$
</screen>
{-filter -deanimate-gifs}
TAG:^RANGE-REQUEST$
</screen>
<screen>
# Tag all requests with the client IP address
#
<screen>
# Tag all requests with the client IP address
#
{+forward-override{forward-socks5 127.0.1.2:2222 .}}
TAG:^IP-ADDRESS: 10\.0\.0\.1$
</screen>
{+forward-override{forward-socks5 127.0.1.2:2222 .}}
TAG:^IP-ADDRESS: 10\.0\.0\.1$
</screen>
</listitem>
</varlistentry>
</listitem>
</varlistentry>
<varlistentry>
<term>Example usage (sections):</term>
<listitem>
<varlistentry>
<term>Example usage (sections):</term>
<listitem>
<screen># Check if www.example.net/ really uses valid XHTML
{ +content-type-overwrite{application/xml} }
www.example.net/
<screen># Check if www.example.net/ really uses valid XHTML
{ +content-type-overwrite{application/xml} }
www.example.net/
www.example.net/.*\.css$
www.example.net/.*style
</screen>
www.example.net/.*\.css$
www.example.net/.*style
</screen>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
</variablelist>
<varlistentry>
<term>Example usage (section):</term>
<listitem>
<varlistentry>
<term>Example usage (section):</term>
<listitem>
<screen># Block the non-existent "Privacy-Violation:" client header
{ +crunch-client-header{Privacy-Violation:} }
/
</screen>
<screen># Block the non-existent "Privacy-Violation:" client header
{ +crunch-client-header{Privacy-Violation:} }
/
</screen>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
</variablelist>
<varlistentry>
<term>Example usage (section):</term>
<listitem>
<varlistentry>
<term>Example usage (section):</term>
<listitem>
<screen># Let the browser revalidate cached documents but don't
# allow the server to use the revalidation headers for user tracking.
{+hide-if-modified-since{-60} \
+overwrite-last-modified{randomize} \
+crunch-if-none-match}
/ </screen>
<screen># Let the browser revalidate cached documents but don't
# allow the server to use the revalidation headers for user tracking.
{+hide-if-modified-since{-60} \
+overwrite-last-modified{randomize} \
+crunch-if-none-match}
/ </screen>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
</variablelist>
<varlistentry>
<term>Example usage:</term>
<listitem>
<varlistentry>
<term>Example usage:</term>
<listitem>
<screen>+crunch-incoming-cookies</screen>
<screen>+crunch-incoming-cookies</screen>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
</variablelist>
<varlistentry>
<term>Example usage (section):</term>
<listitem>
<varlistentry>
<term>Example usage (section):</term>
<listitem>
<screen># Crunch server headers that try to prevent caching
{ +crunch-server-header{no-cache} }
/ </screen>
<screen># Crunch server headers that try to prevent caching
{ +crunch-server-header{no-cache} }
/ </screen>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
</variablelist>
<varlistentry>
<term>Example usage:</term>
<listitem>
<varlistentry>
<term>Example usage:</term>
<listitem>
<screen>+crunch-outgoing-cookies</screen>
<screen>+crunch-outgoing-cookies</screen>
</listitem>
</varlistentry>
</listitem>
</varlistentry>
<varlistentry>
<term>Example usage:</term>
<listitem>
<varlistentry>
<term>Example usage:</term>
<listitem>
<screen>+deanimate-gifs{last}</screen>
<screen>+deanimate-gifs{last}</screen>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
</variablelist>
<varlistentry>
<term>Example usage (section):</term>
<listitem>
<varlistentry>
<term>Example usage (section):</term>
<listitem>
<screen>{+downgrade-http-version}
problem-host.example.com</screen>
<screen>{+downgrade-http-version}
problem-host.example.com</screen>
</listitem>
</varlistentry>
</listitem>
</varlistentry>
<varlistentry>
<term>Example usage:</term>
<listitem>
<varlistentry>
<term>Example usage:</term>
<listitem>
<screen>+external-filter{fancy-filter}</screen>
<screen>+external-filter{fancy-filter}</screen>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
</variablelist>
<varlistentry>
<term>Example usage:</term>
<listitem>
<varlistentry>
<term>Example usage:</term>
<listitem>
<screen>
{ +fast-redirects{simple-check} }
one.example.com
{ +fast-redirects{check-decoded-url} }
another.example.com/testing</screen>
<screen>
{ +fast-redirects{simple-check} }
one.example.com
{ +fast-redirects{check-decoded-url} }
another.example.com/testing</screen>
</listitem>
</varlistentry>
</listitem>
</varlistentry>
<listitem>
<para>
<anchor id="filter-js-annoyances">
<listitem>
<para>
<anchor id="filter-js-annoyances">
- <screen>+filter{js-annoyances} # Get rid of particularly annoying JavaScript abuse.</screen>
+ <screen>+filter{js-annoyances} # Get rid of particularly annoying JavaScript abuse.</screen>
<para>
<anchor id="filter-js-events">
<para>
<anchor id="filter-js-events">
- <screen>+filter{js-events} # Kill JavaScript event bindings and timers (Radically destructive! Only for extra nasty sites).</screen>
+ <screen>+filter{js-events} # Kill JavaScript event bindings and timers (Radically destructive! Only for extra nasty sites).</screen>
<para>
<anchor id="filter-html-annoyances">
<para>
<anchor id="filter-html-annoyances">
- <screen>+filter{html-annoyances} # Get rid of particularly annoying HTML abuse.</screen>
+ <screen>+filter{html-annoyances} # Get rid of particularly annoying HTML abuse.</screen>
<para>
<anchor id="filter-content-cookies">
<para>
<anchor id="filter-content-cookies">
- <screen>+filter{content-cookies} # Kill cookies that come in the HTML or JS content.</screen>
+ <screen>+filter{content-cookies} # Kill cookies that come in the HTML or JS content.</screen>
<para>
<anchor id="filter-refresh-tags">
<para>
<anchor id="filter-refresh-tags">
- <screen>+filter{refresh-tags} # Kill automatic refresh tags if refresh time is larger than 9 seconds.</screen>
+ <screen>+filter{refresh-tags} # Kill automatic refresh tags if refresh time is larger than 9 seconds.</screen>
<para>
<anchor id="filter-unsolicited-popups">
<para>
<anchor id="filter-unsolicited-popups">
- <screen>+filter{unsolicited-popups} # Disable only unsolicited pop-up windows.</screen>
+ <screen>+filter{unsolicited-popups} # Disable only unsolicited pop-up windows.</screen>
<para>
<anchor id="filter-all-popups">
<para>
<anchor id="filter-all-popups">
- <screen>+filter{all-popups} # Kill all popups in JavaScript and HTML.</screen>
+ <screen>+filter{all-popups} # Kill all popups in JavaScript and HTML.</screen>
<para>
<anchor id="filter-img-reorder">
<para>
<anchor id="filter-img-reorder">
- <screen>+filter{img-reorder} # Reorder attributes in <img> tags to make the banners-by-* filters more effective.</screen>
+ <screen>+filter{img-reorder} # Reorder attributes in <img> tags to make the banners-by-* filters more effective.</screen>
<para>
<anchor id="filter-banners-by-size">
<para>
<anchor id="filter-banners-by-size">
- <screen>+filter{banners-by-size} # Kill banners by size.</screen>
+ <screen>+filter{banners-by-size} # Kill banners by size.</screen>
<para>
<anchor id="filter-banners-by-link">
<para>
<anchor id="filter-banners-by-link">
- <screen>+filter{banners-by-link} # Kill banners by their links to known clicktrackers.</screen>
+ <screen>+filter{banners-by-link} # Kill banners by their links to known clicktrackers.</screen>
<para>
<anchor id="filter-webbugs">
<para>
<anchor id="filter-webbugs">
- <screen>+filter{webbugs} # Squish WebBugs (1x1 invisible GIFs used for user tracking).</screen>
+ <screen>+filter{webbugs} # Squish WebBugs (1x1 invisible GIFs used for user tracking).</screen>
<para>
<anchor id="filter-tiny-textforms">
<para>
<anchor id="filter-tiny-textforms">
- <screen>+filter{tiny-textforms} # Extend those tiny textareas up to 40x80 and kill the hard wrap.</screen>
+ <screen>+filter{tiny-textforms} # Extend those tiny textareas up to 40x80 and kill the hard wrap.</screen>
<para>
<anchor id="filter-jumping-windows">
<para>
<anchor id="filter-jumping-windows">
- <screen>+filter{jumping-windows} # Prevent windows from resizing and moving themselves.</screen>
+ <screen>+filter{jumping-windows} # Prevent windows from resizing and moving themselves.</screen>
<para>
<anchor id="filter-frameset-borders">
<para>
<anchor id="filter-frameset-borders">
- <screen>+filter{frameset-borders} # Give frames a border and make them resizable.</screen>
+ <screen>+filter{frameset-borders} # Give frames a border and make them resizable.</screen>
<para>
<anchor id="filter-iframes">
<para>
<anchor id="filter-iframes">
- <screen>+filter{iframes} # Removes all detected iframes. Should only be enabled for individual sites.</screen>
+ <screen>+filter{iframes} # Removes all detected iframes. Should only be enabled for individual sites.</screen>
<para>
<anchor id="filter-demoronizer">
<para>
<anchor id="filter-demoronizer">
- <screen>+filter{demoronizer} # Fix MS's non-standard use of standard charsets.</screen>
+ <screen>+filter{demoronizer} # Fix MS's non-standard use of standard charsets.</screen>
<para>
<anchor id="filter-shockwave-flash">
<para>
<anchor id="filter-shockwave-flash">
- <screen>+filter{shockwave-flash} # Kill embedded Shockwave Flash objects.</screen>
+ <screen>+filter{shockwave-flash} # Kill embedded Shockwave Flash objects.</screen>
<para>
<anchor id="filter-quicktime-kioskmode">
<para>
<anchor id="filter-quicktime-kioskmode">
- <screen>+filter{quicktime-kioskmode} # Make Quicktime movies saveable.</screen>
+ <screen>+filter{quicktime-kioskmode} # Make Quicktime movies saveable.</screen>
<para>
<anchor id="filter-fun">
<para>
<anchor id="filter-fun">
- <screen>+filter{fun} # Text replacements for subversive browsing fun!</screen>
+ <screen>+filter{fun} # Text replacements for subversive browsing fun!</screen>
<para>
<anchor id="filter-crude-parental">
<para>
<anchor id="filter-crude-parental">
- <screen>+filter{crude-parental} # Crude parental filtering. Note that this filter doesn't work reliably.</screen>
+ <screen>+filter{crude-parental} # Crude parental filtering. Note that this filter doesn't work reliably.</screen>
<para>
<anchor id="filter-ie-exploits">
<para>
<anchor id="filter-ie-exploits">
- <screen>+filter{ie-exploits} # Disable some known Internet Explorer bug exploits.</screen>
+ <screen>+filter{ie-exploits} # Disable some known Internet Explorer bug exploits.</screen>
<para>
<anchor id="filter-site-specifics">
<para>
<anchor id="filter-site-specifics">
- <screen>+filter{site-specifics} # Cure for site-specific problems. Don't apply generally!</screen>
+ <screen>+filter{site-specifics} # Cure for site-specific problems. Don't apply generally!</screen>
<para>
<anchor id="filter-no-ping">
<para>
<anchor id="filter-no-ping">
- <screen>+filter{no-ping} # Removes non-standard ping attributes in <a> and <area> tags.</screen>
+ <screen>+filter{no-ping} # Removes non-standard ping attributes in <a> and <area> tags.</screen>
<para>
<anchor id="filter-google">
<para>
<anchor id="filter-google">
- <screen>+filter{google} # CSS-based block for Google text ads. Also removes a width limitation and the toolbar advertisement.</screen>
+ <screen>+filter{google} # CSS-based block for Google text ads. Also removes a width limitation and the toolbar advertisement.</screen>
<para>
<anchor id="filter-yahoo">
<para>
<anchor id="filter-yahoo">
- <screen>+filter{yahoo} # CSS-based block for Yahoo text ads. Also removes a width limitation.</screen>
+ <screen>+filter{yahoo} # CSS-based block for Yahoo text ads. Also removes a width limitation.</screen>
<para>
<anchor id="filter-msn">
<para>
<anchor id="filter-msn">
- <screen>+filter{msn} # CSS-based block for MSN text ads. Also removes tracking URLs and a width limitation.</screen>
+ <screen>+filter{msn} # CSS-based block for MSN text ads. Also removes tracking URLs and a width limitation.</screen>
<para>
<anchor id="filter-blogspot">
<para>
<anchor id="filter-blogspot">
- <screen>+filter{blogspot} # Cleans up some Blogspot blogs. Read the fine print before using this.</screen>
+ <screen>+filter{blogspot} # Cleans up some Blogspot blogs. Read the fine print before using this.</screen>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
</variablelist>
<varlistentry>
<term>Example usage:</term>
<listitem>
<varlistentry>
<term>Example usage:</term>
<listitem>
<screen>
+force-text-mode
</screen>
<screen>
+force-text-mode
</screen>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
</variablelist>
<varlistentry>
<term>Example usage:</term>
<listitem>
<varlistentry>
<term>Example usage:</term>
<listitem>
<screen>
# Use an ssh tunnel for requests previously tagged as
# <quote>User-Agent: fetch libfetch/2.0</quote> and make sure
<screen>
# Use an ssh tunnel for requests previously tagged as
# <quote>User-Agent: fetch libfetch/2.0</quote> and make sure
}
TAG:^User-Agent: fetch libfetch/2\.0$
</screen>
}
TAG:^User-Agent: fetch libfetch/2\.0$
</screen>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
</variablelist>
<varlistentry>
<term>Example usage:</term>
<listitem>
<varlistentry>
<term>Example usage:</term>
<listitem>
<screen># Block all documents on example.org that end with ".js",
# but send an empty document instead of the usual HTML message.
{+block{Blocked JavaScript} +handle-as-empty-document}
example.org/.*\.js$
</screen>
<screen># Block all documents on example.org that end with ".js",
# but send an empty document instead of the usual HTML message.
{+block{Blocked JavaScript} +handle-as-empty-document}
example.org/.*\.js$
</screen>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
</variablelist>
<varlistentry>
<term>Example usage (sections):</term>
<listitem>
<varlistentry>
<term>Example usage (sections):</term>
<listitem>
<screen># Generic image extensions:
#
{+handle-as-image}
<screen># Generic image extensions:
#
{+handle-as-image}
{+block{Nasty banners.} +handle-as-image}
nasty-banner-server.example.com/junk.cgi\?output=trash
</screen>
{+block{Nasty banners.} +handle-as-image}
nasty-banner-server.example.com/junk.cgi\?output=trash
</screen>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
</variablelist>
<varlistentry>
<term>Example usage (section):</term>
<listitem>
<varlistentry>
<term>Example usage (section):</term>
<listitem>
<screen># Pretend to use Canadian language settings.
{+hide-accept-language{en-ca} \
+hide-user-agent{Mozilla/5.0 (X11; U; OpenBSD i386; en-CA; rv:1.8.0.4) Gecko/20060628 Firefox/1.5.0.4} \
}
/ </screen>
<screen># Pretend to use Canadian language settings.
{+hide-accept-language{en-ca} \
+hide-user-agent{Mozilla/5.0 (X11; U; OpenBSD i386; en-CA; rv:1.8.0.4) Gecko/20060628 Firefox/1.5.0.4} \
}
/ </screen>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
</variablelist>
<varlistentry>
<term>Example usage:</term>
<listitem>
<varlistentry>
<term>Example usage:</term>
<listitem>
<screen># Disarm the download link in Sourceforge's patch tracker
{ -filter \
+content-type-overwrite{text/plain}\
+hide-content-disposition{block} }
.sourceforge.net/tracker/download\.php</screen>
<screen># Disarm the download link in Sourceforge's patch tracker
{ -filter \
+content-type-overwrite{text/plain}\
+hide-content-disposition{block} }
.sourceforge.net/tracker/download\.php</screen>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
</variablelist>
<varlistentry>
<term>Example usage (section):</term>
<listitem>
<varlistentry>
<term>Example usage (section):</term>
<listitem>
<screen># Let the browser revalidate but make tracking based on the time less likely.
{+hide-if-modified-since{-60} \
+overwrite-last-modified{randomize} \
+crunch-if-none-match}
/</screen>
<screen># Let the browser revalidate but make tracking based on the time less likely.
{+hide-if-modified-since{-60} \
+overwrite-last-modified{randomize} \
+crunch-if-none-match}
/</screen>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
</variablelist>
<varlistentry>
<term>Example usage:</term>
<listitem>
<varlistentry>
<term>Example usage:</term>
<listitem>
- <para>
- <screen>+hide-from-header{block}</screen> or
+ <screen>+hide-from-header{block}</screen>
+ <para>or</para>
<screen>+hide-from-header{spam-me-senseless@sittingduck.example.com}</screen>
<screen>+hide-from-header{spam-me-senseless@sittingduck.example.com}</screen>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
</variablelist>
<varlistentry>
<term>Example usage:</term>
<listitem>
<varlistentry>
<term>Example usage:</term>
<listitem>
- <para>
- <screen>+hide-referrer{forge}</screen> or
+ <screen>+hide-referrer{forge}</screen>
+ <para>or</para>
<screen>+hide-referrer{http://www.yahoo.com/}</screen>
<screen>+hide-referrer{http://www.yahoo.com/}</screen>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
</variablelist>
<varlistentry>
<term>Example usage:</term>
<listitem>
<varlistentry>
<term>Example usage:</term>
<listitem>
<screen>+hide-user-agent{Netscape 6.1 (X11; I; Linux 2.4.18 i686)}</screen>
<screen>+hide-user-agent{Netscape 6.1 (X11; I; Linux 2.4.18 i686)}</screen>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
</variablelist>
<!-- I had trouble getting the spacing to look right in my browser -->
<!-- I probably have the wrong font setup, bollocks. -->
<!-- Apparently the emphasis tag uses a proportional font no matter what -->
<!-- I had trouble getting the spacing to look right in my browser -->
<!-- I probably have the wrong font setup, bollocks. -->
<!-- Apparently the emphasis tag uses a proportional font no matter what -->
<screen>+limit-connect{443} # Port 443 is OK.
+limit-connect{80,443} # Ports 80 and 443 are OK.
+limit-connect{-3, 7, 20-100, 500-} # Ports less than 3, 7, 20 to 100 and above 500 are OK.
+limit-connect{-} # All ports are OK
+limit-connect{,} # No HTTPS/SSL traffic is allowed</screen>
<screen>+limit-connect{443} # Port 443 is OK.
+limit-connect{80,443} # Ports 80 and 443 are OK.
+limit-connect{-3, 7, 20-100, 500-} # Ports less than 3, 7, 20 to 100 and above 500 are OK.
+limit-connect{-} # All ports are OK
+limit-connect{,} # No HTTPS/SSL traffic is allowed</screen>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
</variablelist>
<varlistentry>
<term>Example usages:</term>
<listitem>
<varlistentry>
<term>Example usages:</term>
<listitem>
- <para>
- <screen>+limit-cookie-lifetime{60}
- </screen>
- </para>
+ <screen>+limit-cookie-lifetime{60}</screen>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
</variablelist>
<varlistentry>
<term>Example usage (sections):</term>
<listitem>
<varlistentry>
<term>Example usage (sections):</term>
<listitem>
<screen>
# Selectively turn off compression, and enable a filter
#
<screen>
# Selectively turn off compression, and enable a filter
#
#
{ -prevent-compression }
.compusa.com/</screen>
#
{ -prevent-compression }
.compusa.com/</screen>
</listitem>
</varlistentry>
</listitem>
</varlistentry>
<varlistentry>
<term>Example usage:</term>
<listitem>
<varlistentry>
<term>Example usage:</term>
<listitem>
<screen># Let the browser revalidate without being tracked across sessions
{ +hide-if-modified-since{-60} \
+overwrite-last-modified{randomize} \
+crunch-if-none-match}
/</screen>
<screen># Let the browser revalidate without being tracked across sessions
{ +hide-if-modified-since{-60} \
+overwrite-last-modified{randomize} \
+crunch-if-none-match}
/</screen>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
</variablelist>
<varlistentry>
<term>Example usages:</term>
<listitem>
<varlistentry>
<term>Example usages:</term>
<listitem>
<screen># Replace example.com's style sheet with another one
{ +redirect{http://localhost/css-replacements/example.com.css} }
example.com/stylesheet\.css
<screen># Replace example.com's style sheet with another one
{ +redirect{http://localhost/css-replacements/example.com.css} }
example.com/stylesheet\.css
# to the local version delivered by Privoxy
{+redirect{s@^http://www@http://config@}}
www.privoxy.org/user-manual/</screen>
# to the local version delivered by Privoxy
{+redirect{s@^http://www@http://config@}}
www.privoxy.org/user-manual/</screen>
</listitem>
</varlistentry>
</listitem>
</varlistentry>
<varlistentry>
<term>Example usage (section):</term>
<listitem>
<varlistentry>
<term>Example usage (section):</term>
<listitem>
<screen>
{+server-header-filter{html-to-xml}}
example.org/xml-instance-that-is-delivered-as-html
<screen>
{+server-header-filter{html-to-xml}}
example.org/xml-instance-that-is-delivered-as-html
{+server-header-filter{xml-to-html}}
example.org/instance-that-is-delivered-as-xml-but-is-not
</screen>
{+server-header-filter{xml-to-html}}
example.org/instance-that-is-delivered-as-xml-but-is-not
</screen>
</listitem>
</varlistentry>
</listitem>
</varlistentry>
<varlistentry>
<term>Example usage (section):</term>
<listitem>
<varlistentry>
<term>Example usage (section):</term>
<listitem>
<screen>
# Tag every request with the content type declared by the server
{+server-header-tagger{content-type}}
<screen>
# Tag every request with the content type declared by the server
{+server-header-tagger{content-type}}
# <literal><link linkend="external-filter-syntax">silly example</link></literal>.
{+external-filter{rotate-image} +force-text-mode}
TAG:^image/
# <literal><link linkend="external-filter-syntax">silly example</link></literal>.
{+external-filter{rotate-image} +force-text-mode}
TAG:^image/
</listitem>
</varlistentry>
</listitem>
</varlistentry>
<varlistentry>
<term>Example usage:</term>
<listitem>
<varlistentry>
<term>Example usage:</term>
<listitem>
<screen>+session-cookies-only</screen>
<screen>+session-cookies-only</screen>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
</variablelist>
<para>
Built-in pattern:
</para>
<para>
Built-in pattern:
</para>
<screen>+set-image-blocker{pattern}</screen>
<screen>+set-image-blocker{pattern}</screen>
<para>
Redirect to the BSD daemon:
</para>
<para>
Redirect to the BSD daemon:
</para>
<screen>+set-image-blocker{http://www.freebsd.org/gifs/dae_up3.gif}</screen>
<screen>+set-image-blocker{http://www.freebsd.org/gifs/dae_up3.gif}</screen>
<para>
Redirect to the built-in pattern for better caching:
</para>
<para>
Redirect to the built-in pattern for better caching:
</para>
<screen>+set-image-blocker{http://config.privoxy.org/send-banner?type=pattern}</screen>
<screen>+set-image-blocker{http://config.privoxy.org/send-banner?type=pattern}</screen>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
</variablelist>
Now let's define some aliases...
</para>
Now let's define some aliases...
</para>
<screen>
# Useful custom aliases we can use later.
#
<screen>
# Useful custom aliases we can use later.
#
#
c0 = +crunch-all-cookies
c1 = -crunch-all-cookies</screen>
#
c0 = +crunch-all-cookies
c1 = -crunch-all-cookies</screen>
<para>
...and put them to use. These sections would appear in the lower part of an
<para>
...and put them to use. These sections would appear in the lower part of an
up for the <quote>/</quote> pattern):
</para>
up for the <quote>/</quote> pattern):
</para>
<screen>
# These sites are either very complex or very keen on
# user data and require minimal interference to work:
<screen>
# These sites are either very complex or very keen on
# user data and require minimal interference to work:
{-filter{all-popups} -filter{unsolicited-popups}}
.dabs.com
.overclockers.co.uk</screen>
{-filter{all-popups} -filter{unsolicited-popups}}
.dabs.com
.overclockers.co.uk</screen>
<para>
Aliases like <quote>shop</quote> and <quote>fragile</quote> are typically used for
<para>
Aliases like <quote>shop</quote> and <quote>fragile</quote> are typically used for
multiple lines with line continuation.
</para>
multiple lines with line continuation.
</para>
<screen>
{ \
+<link linkend="CHANGE-X-FORWARDED-FOR">change-x-forwarded-for{block}</link> \
<screen>
{ \
+<link linkend="CHANGE-X-FORWARDED-FOR">change-x-forwarded-for{block}</link> \
}
/ # Match all URLs
</screen>
}
/ # Match all URLs
</screen>
<para>
The default behavior is now set.
<para>
The default behavior is now set.
that prevents older &my-app; versions from reading the file:
</para>
that prevents older &my-app; versions from reading the file:
</para>
<screen>
##########################################################################
# Settings -- Don't change! For internal Privoxy use ONLY.
##########################################################################
{{settings}}
for-privoxy-version=3.0.11</screen>
<screen>
##########################################################################
# Settings -- Don't change! For internal Privoxy use ONLY.
##########################################################################
{{settings}}
for-privoxy-version=3.0.11</screen>
<para>
After that comes the (optional) alias section. We'll use the example
<para>
After that comes the (optional) alias section. We'll use the example
that also explains why and how aliases are used:
</para>
that also explains why and how aliases are used:
</para>
<screen>
##########################################################################
# Aliases
<screen>
##########################################################################
# Aliases
#
fragile = -<link linkend="BLOCK">block</link> -<link linkend="FILTER">filter</link> -crunch-all-cookies -<link linkend="FAST-REDIRECTS">fast-redirects</link> -<link linkend="HIDE-REFERER">hide-referrer</link>
shop = -crunch-all-cookies -<link linkend="FILTER-ALL-POPUPS">filter{all-popups}</link></screen>
#
fragile = -<link linkend="BLOCK">block</link> -<link linkend="FILTER">filter</link> -crunch-all-cookies -<link linkend="FAST-REDIRECTS">fast-redirects</link> -<link linkend="HIDE-REFERER">hide-referrer</link>
shop = -crunch-all-cookies -<link linkend="FILTER-ALL-POPUPS">filter{all-popups}</link></screen>
<para>
The first of our specialized sections is concerned with <quote>fragile</quote>
<para>
The first of our specialized sections is concerned with <quote>fragile</quote>
of actions explicitly:
</para>
of actions explicitly:
</para>
<screen>
##########################################################################
# Exceptions for sites that'll break under the default action set:
<screen>
##########################################################################
# Exceptions for sites that'll break under the default action set:
.office.microsoft.com # surprise, surprise!
.windowsupdate.microsoft.com
mail.google.com</screen>
.office.microsoft.com # surprise, surprise!
.windowsupdate.microsoft.com
mail.google.com</screen>
<para>
Shopping sites are not as fragile, but they typically
<para>
Shopping sites are not as fragile, but they typically
carts or item details. Again, we'll use a pre-defined alias:
</para>
carts or item details. Again, we'll use a pre-defined alias:
</para>
<screen>
# Shopping sites:
#
<screen>
# Shopping sites:
#
.worldpay.com # for quietpc.com
.jungle.com
.scan.co.uk</screen>
.worldpay.com # for quietpc.com
.jungle.com
.scan.co.uk</screen>
<para>
The <literal><link linkend="FAST-REDIRECTS">fast-redirects</link></literal>
<para>
The <literal><link linkend="FAST-REDIRECTS">fast-redirects</link></literal>
breaks some sites. So disable it for popular sites where we know it misbehaves:
</para>
breaks some sites. So disable it for popular sites where we know it misbehaves:
</para>
<screen>
{ -<link linkend="FAST-REDIRECTS">fast-redirects</link> }
login.yahoo.com
<screen>
{ -<link linkend="FAST-REDIRECTS">fast-redirects</link> }
login.yahoo.com
.altavista.com/.*(like|url|link):http
.altavista.com/trans.*urltext=http
.nytimes.com</screen>
.altavista.com/.*(like|url|link):http
.altavista.com/trans.*urltext=http
.nytimes.com</screen>
<para>
It is important that <application>Privoxy</application> knows which
<para>
It is important that <application>Privoxy</application> knows which
<screen>
##########################################################################
# Images:
<screen>
##########################################################################
# Images:
#
{ +<link linkend="HANDLE-AS-IMAGE">handle-as-image</link> }
/.*\.(gif|jpe?g|png|bmp|ico)$</screen>
#
{ +<link linkend="HANDLE-AS-IMAGE">handle-as-image</link> }
/.*\.(gif|jpe?g|png|bmp|ico)$</screen>
<para>
And then there are known banner sources. They often use scripts to
<para>
And then there are known banner sources. They often use scripts to
action before, it still applies and needn't be repeated:
</para>
action before, it still applies and needn't be repeated:
</para>
<screen>
# Known ad generators:
#
<screen>
# Known ad generators:
#
.a[0-9].yimg.com/(?:(?!/i/).)*$
bs*.gsanet.com
.qkimg.net</screen>
.a[0-9].yimg.com/(?:(?!/i/).)*$
bs*.gsanet.com
.qkimg.net</screen>
<para>
One of the most important jobs of <application>Privoxy</application>
<para>
One of the most important jobs of <application>Privoxy</application>
to keep the example short:
</para>
to keep the example short:
</para>
<screen>
##########################################################################
# Block these fine banners:
<screen>
##########################################################################
# Block these fine banners:
# Site-specific patterns (abbreviated):
#
.hitbox.com</screen>
# Site-specific patterns (abbreviated):
#
.hitbox.com</screen>
<para>
It's quite remarkable how many advertisers actually call their banner
<para>
It's quite remarkable how many advertisers actually call their banner
with no <literal><link linkend="BLOCK">block</link></literal> action applying.
</para>
with no <literal><link linkend="BLOCK">block</link></literal> action applying.
</para>
<screen>
##########################################################################
# Save some innocent victims of the above generic block patterns:
<screen>
##########################################################################
# Save some innocent victims of the above generic block patterns:
#
www.globalintersec.com/adv # (adv = advanced)
www.ugu.com/sui/ugu/adv</screen>
#
www.globalintersec.com/adv # (adv = advanced)
www.ugu.com/sui/ugu/adv</screen>
<para>
Filtering source code can have nasty side effects,
<para>
Filtering source code can have nasty side effects,
disables <emphasis>all</emphasis> filters in one fell swoop!
</para>
disables <emphasis>all</emphasis> filters in one fell swoop!
</para>
<screen>
# Don't filter code!
#
<screen>
# Don't filter code!
#
developer.
wiki.
.sourceforge.net</screen>
developer.
wiki.
.sourceforge.net</screen>
<para>
The actual <filename>default.action</filename> is of course much more
<para>
The actual <filename>default.action</filename> is of course much more
<!-- brief sample user.action here -->
<!-- brief sample user.action here -->
<screen>
# My user.action file. <fred@example.com></screen>
<screen>
# My user.action file. <fred@example.com></screen>
<para>
As <link linkend="aliases">aliases</link> are local to the actions
<para>
As <link linkend="aliases">aliases</link> are local to the actions
<filename>default.action</filename>, unless you repeat them here:
</para>
<filename>default.action</filename>, unless you repeat them here:
</para>
<screen>
# Aliases are local to the file they are defined in.
# (Re-)define aliases for this file:
<screen>
# Aliases are local to the file they are defined in.
# (Re-)define aliases for this file:
# Alias for specific file types that are text, but might have conflicting
# MIME types. We want the browser to force these to be text documents.
handle-as-text = -<link linkend="FILTER">filter</link> +-<link linkend="content-type-overwrite">content-type-overwrite{text/plain}</link> +-<link linkend="FORCE-TEXT-MODE">force-text-mode</link> -<link linkend="HIDE-CONTENT-DISPOSITION">hide-content-disposition</link></screen>
# Alias for specific file types that are text, but might have conflicting
# MIME types. We want the browser to force these to be text documents.
handle-as-text = -<link linkend="FILTER">filter</link> +-<link linkend="content-type-overwrite">content-type-overwrite{text/plain}</link> +-<link linkend="FORCE-TEXT-MODE">force-text-mode</link> -<link linkend="HIDE-CONTENT-DISPOSITION">hide-content-disposition</link></screen>
<para>
Say you have accounts on some sites that you visit regularly, and
<para>
Say you have accounts on some sites that you visit regularly, and
processing of cookies to make them only temporary.
</para>
processing of cookies to make them only temporary.
</para>
<screen>
{ allow-all-cookies }
sourceforge.net
.yahoo.com
.msdn.microsoft.com
.redhat.com</screen>
<screen>
{ allow-all-cookies }
sourceforge.net
.yahoo.com
.msdn.microsoft.com
.redhat.com</screen>
<para>
Your bank is allergic to some filter, but you don't know which, so you disable them all:
</para>
<para>
Your bank is allergic to some filter, but you don't know which, so you disable them all:
</para>
<screen>
{ -<link linkend="FILTER">filter</link> }
.your-home-banking-site.com</screen>
<screen>
{ -<link linkend="FILTER">filter</link> }
.your-home-banking-site.com</screen>
<para>
Some file types you may not want to filter for various reasons:
</para>
<para>
Some file types you may not want to filter for various reasons:
</para>
<screen>
# Technical documentation is likely to contain strings that might
# erroneously get altered by the JavaScript-oriented filters:
<screen>
# Technical documentation is likely to contain strings that might
# erroneously get altered by the JavaScript-oriented filters:
# so that Privoxy thinks it is getting HTML and starts filtering:
#
stupid-server.example.com/</screen>
# so that Privoxy thinks it is getting HTML and starts filtering:
#
stupid-server.example.com/</screen>
<para>
Example of a simple <link linkend="BLOCK">block</link> action. Say you've
<para>
Example of a simple <link linkend="BLOCK">block</link> action. Say you've
in default.action anyway:
</para>
in default.action anyway:
</para>
<screen>
{ +<link linkend="BLOCK">block</link>{Nasty ads.} }
www.example.com/nasty-ads/sponsor\.gif
another.example.net/more/junk/here/</screen>
<screen>
{ +<link linkend="BLOCK">block</link>{Nasty ads.} }
www.example.com/nasty-ads/sponsor\.gif
another.example.net/more/junk/here/</screen>
<para>
The URLs of dynamically generated banners, especially from large banner
<para>
The URLs of dynamically generated banners, especially from large banner
browser. Use cautiously.
</para>
browser. Use cautiously.
</para>
<screen>
{ +block-as-image }
.doubleclick.net
.fastclick.net
/Realmedia/ads/
ar.atwola.com/</screen>
<screen>
{ +block-as-image }
.doubleclick.net
.fastclick.net
/Realmedia/ads/
ar.atwola.com/</screen>
<para>
Now you noticed that the default configuration breaks Forbes Magazine,
<para>
Now you noticed that the default configuration breaks Forbes Magazine,
that misbehave, and add those to our personalized list of troublemakers:
</para>
that misbehave, and add those to our personalized list of troublemakers:
</para>
<screen>
{ fragile }
.forbes.com
webmail.example.com
.mybank.com</screen>
<screen>
{ fragile }
.forbes.com
webmail.example.com
.mybank.com</screen>
<para>
You like the <quote>fun</quote> text replacements in <filename>default.filter</filename>,
<para>
You like the <quote>fun</quote> text replacements in <filename>default.filter</filename>,
update-safe config, once and for all:
</para>
update-safe config, once and for all:
</para>
<screen>
{ +<link linkend="filter-fun">filter{fun}</link> }
/ # For ALL sites!</screen>
<screen>
{ +<link linkend="filter-fun">filter{fun}</link> }
/ # For ALL sites!</screen>
<para>
Note that the above is not really a good idea: There are exceptions
<para>
Note that the above is not really a good idea: There are exceptions
sites that you feel provide value to you:
</para>
sites that you feel provide value to you:
</para>
<screen>
{ allow-ads }
.sourceforge.net
.slashdot.org
.osdn.net</screen>
<screen>
{ allow-ads }
.sourceforge.net
.slashdot.org
.osdn.net</screen>
<para>
Note that <literal>allow-ads</literal> has been aliased to
<para>
Note that <literal>allow-ads</literal> has been aliased to
it should I choose to.
</para>
it should I choose to.
</para>
<screen>
{ handle-as-text }
/.*\.sh$</screen>
<screen>
{ handle-as-text }
/.*\.sh$</screen>
<para>
<filename>user.action</filename> is generally the best place to define
<para>
<filename>user.action</filename> is generally the best place to define
paths and patterns:
</para>
paths and patterns:
</para>
<screen>
{ +<link linkend="set-image-blocker">set-image-blocker{blank}</link> }
/ # ALL sites</screen>
<screen>
{ +<link linkend="set-image-blocker">set-image-blocker{blank}</link> }
/ # ALL sites</screen>
<screen>FILTER: foo Replace all "foo" with "bar"</screen>
<screen>FILTER: foo Replace all "foo" with "bar"</screen>
<para>
Below that line, and up to the next header line, come the jobs that
<para>
Below that line, and up to the next header line, come the jobs that
<screen>s/foo/bar/</screen>
<screen>s/foo/bar/</screen>
<para>
But wait! Didn't the comment say that <emphasis>all</emphasis> occurrences
<para>
But wait! Didn't the comment say that <emphasis>all</emphasis> occurrences
we'll need to add the <literal>g</literal> option:
</para>
we'll need to add the <literal>g</literal> option:
</para>
<screen>s/foo/bar/g</screen>
<screen>s/foo/bar/g</screen>
<para>
Our complete filter now looks like this:
</para>
<para>
Our complete filter now looks like this:
</para>
<screen>FILTER: foo Replace all "foo" with "bar"
s/foo/bar/g</screen>
<screen>FILTER: foo Replace all "foo" with "bar"
s/foo/bar/g</screen>
<para>
Let's look at some real filters for more interesting examples. Here you see
<para>
Let's look at some real filters for more interesting examples. Here you see
<screen>
FILTER: js-annoyances Get rid of particularly annoying JavaScript abuse
# Get rid of JavaScript referrer tracking. Test page: http://www.randomoddness.com/untitled.htm
#
s|(<script.*)document\.referrer(.*</script>)|$1"Not Your Business!"$2|Usg</screen>
<screen>
FILTER: js-annoyances Get rid of particularly annoying JavaScript abuse
# Get rid of JavaScript referrer tracking. Test page: http://www.randomoddness.com/untitled.htm
#
s|(<script.*)document\.referrer(.*</script>)|$1"Not Your Business!"$2|Usg</screen>
<para>
Following the header line and a comment, you see the job. Note that it uses
<para>
Following the header line and a comment, you see the job. Note that it uses
this time only point out the constructs of special interest:
</para>
this time only point out the constructs of special interest:
</para>
<screen>
# The status bar is for displaying link targets, not pointless blahblah
#
s/window\.status\s*=\s*(['"]).*?\1/dUmMy=1/ig</screen>
<screen>
# The status bar is for displaying link targets, not pointless blahblah
#
s/window\.status\s*=\s*(['"]).*?\1/dUmMy=1/ig</screen>
<para>
<literal>\s</literal> stands for whitespace characters (space, tab, newline,
<para>
<literal>\s</literal> stands for whitespace characters (space, tab, newline,
you move your mouse over links.
</para>
you move your mouse over links.
</para>
<screen>
# Kill OnUnload popups. Yummy. Test: http://www.zdnet.com/zdsubs/yahoo/tree/yfs.html
#
s/(<body [^>]*)onunload(.*>)/$1never$2/iU</screen>
<screen>
# Kill OnUnload popups. Yummy. Test: http://www.zdnet.com/zdsubs/yahoo/tree/yfs.html
#
s/(<body [^>]*)onunload(.*>)/$1never$2/iU</screen>
The last example is from the fun department:
</para>
The last example is from the fun department:
</para>
<screen>
FILTER: fun Fun text replacements
# Spice the daily news:
#
s/microsoft(?!\.com)/MicroSuck/ig</screen>
<screen>
FILTER: fun Fun text replacements
# Spice the daily news:
#
s/microsoft(?!\.com)/MicroSuck/ig</screen>
<para>
Note the <literal>(?!\.com)</literal> part (a so-called negative lookahead)
<para>
Note the <literal>(?!\.com)</literal> part (a so-called negative lookahead)
still replacing the word everywhere else.
</para>
still replacing the word everywhere else.
</para>
<screen>
# Buzzword Bingo (example for extended regex syntax)
#
<screen>
# Buzzword Bingo (example for extended regex syntax)
#
| unrivalled \
*<font color="red"><b>BINGO!</b></font> \
*igx</screen>
| unrivalled \
*<font color="red"><b>BINGO!</b></font> \
*igx</screen>
<para>
The <literal>x</literal> option in this job turns on extended syntax, and allows for
<para>
The <literal>x</literal> option in this job turns on extended syntax, and allows for
<para>
The purpose of this filter is to get rid of particularly annoying JavaScript abuse.
To that end, it
<para>
The purpose of this filter is to get rid of particularly annoying JavaScript abuse.
To that end, it
<itemizedlist>
<listitem>
<para>
<itemizedlist>
<listitem>
<para>
</para>
</listitem>
</itemizedlist>
</para>
</listitem>
</itemizedlist>
<para>
Use with caution. This is an aggressive filter, and can break sites that
rely heavily on JavaScript.
<para>
Use with caution. This is an aggressive filter, and can break sites that
rely heavily on JavaScript.
&my-app; will temporary store the content to filter in the
<literal><link linkend="temporary-directory">temporary-directory</link></literal>.
</para>
&my-app; will temporary store the content to filter in the
<literal><link linkend="temporary-directory">temporary-directory</link></literal>.
</para>
<screen>
EXTERNAL-FILTER: cat Pointless example filter that doesn't actually modify the content
/bin/cat
<screen>
EXTERNAL-FILTER: cat Pointless example filter that doesn't actually modify the content
/bin/cat
EXTERNAL-FILTER: citation-needed Adds a "[citation needed]" tag to an image. The coordinates may need adjustment.
/usr/local/bin/convert - -pointsize 16 -fill white -annotate +17+418 "[citation needed]" -
</screen>
EXTERNAL-FILTER: citation-needed Adds a "[citation needed]" tag to an image. The coordinates may need adjustment.
/usr/local/bin/convert - -pointsize 16 -fill white -annotate +17+418 "[citation needed]" -
</screen>
is in an alpha or beta development stage:
</para>
is in an alpha or beta development stage:
</para>
<screen>
<!-- @if-unstable-start -->
... beta warning HTML code goes here ...
<!-- if-unstable-end@ --></screen>
<screen>
<!-- @if-unstable-start -->
... beta warning HTML code goes here ...
<!-- if-unstable-end@ --></screen>
<para>
If the "unstable" symbol is set, everything in between and including
<para>
If the "unstable" symbol is set, everything in between and including
will disappear, leaving nothing but an empty comment:
</para>
will disappear, leaving nothing but an empty comment:
</para>
<screen><!-- --></screen>
<screen><!-- --></screen>
<para>
There's also an if-then-else construct and an <literal>#include</literal>
<para>
There's also an if-then-else construct and an <literal>#include</literal>
<!-- ~~~~~ New section ~~~~~ -->
<sect2 id="license"><title>License</title>
<!-- ~~~~~ New section ~~~~~ -->
<sect2 id="license"><title>License</title>
<screen><![ RCDATA [ &GPLv2; ]]></screen>
<screen><![ RCDATA [ &GPLv2; ]]></screen>
</sect2>
<!-- ~ End section ~ -->
</sect2>
<!-- ~ End section ~ -->
and then some examples:
</para>
and then some examples:
</para>
<member>
<emphasis>.</emphasis> - Matches any single character, e.g. <quote>a</quote>,
<quote>A</quote>, <quote>4</quote>, <quote>:</quote>, or <quote>@</quote>.
</member>
<member>
<emphasis>.</emphasis> - Matches any single character, e.g. <quote>a</quote>,
<quote>A</quote>, <quote>4</quote>, <quote>:</quote>, or <quote>@</quote>.
</member>
<member>
<emphasis>?</emphasis> - The preceding character or expression is matched ZERO or ONE
times. Either/or.
</member>
<member>
<emphasis>?</emphasis> - The preceding character or expression is matched ZERO or ONE
times. Either/or.
</member>
<member>
<emphasis>+</emphasis> - The preceding character or expression is matched ONE or MORE
times.
</member>
<member>
<emphasis>+</emphasis> - The preceding character or expression is matched ONE or MORE
times.
</member>
<member>
<emphasis>*</emphasis> - The preceding character or expression is matched ZERO or MORE
times.
</member>
<member>
<emphasis>*</emphasis> - The preceding character or expression is matched ZERO or MORE
times.
</member>
<member>
<emphasis>\</emphasis> - The <quote>escape</quote> character denotes that
the following character should be taken literally. This is used where one of the
<member>
<emphasis>\</emphasis> - The <quote>escape</quote> character denotes that
the following character should be taken literally. This is used where one of the
sure the period is recognized only as a period (and not expanded to its
meta-character meaning of any single character).
</member>
sure the period is recognized only as a period (and not expanded to its
meta-character meaning of any single character).
</member>
<member>
<emphasis>[ ]</emphasis> - Characters enclosed in brackets will be matched if
any of the enclosed characters are encountered. For instance, <quote>[0-9]</quote>
matches any numeric digit (zero through nine). As an example, we can combine
this with <quote>+</quote> to match any digit one of more times: <quote>[0-9]+</quote>.
</member>
<member>
<emphasis>[ ]</emphasis> - Characters enclosed in brackets will be matched if
any of the enclosed characters are encountered. For instance, <quote>[0-9]</quote>
matches any numeric digit (zero through nine). As an example, we can combine
this with <quote>+</quote> to match any digit one of more times: <quote>[0-9]+</quote>.
</member>
<member>
<emphasis>( )</emphasis> - parentheses are used to group a sub-expression,
or multiple sub-expressions.
</member>
<member>
<emphasis>( )</emphasis> - parentheses are used to group a sub-expression,
or multiple sub-expressions.
</member>
<member>
<emphasis>|</emphasis> - The <quote>bar</quote> character works like an
<quote>or</quote> conditional statement. A match is successful if the
<member>
<emphasis>|</emphasis> - The <quote>bar</quote> character works like an
<quote>or</quote> conditional statement. A match is successful if the
and would match either <quote>this example</quote> or <quote>that
example</quote>, and nothing else.
</member>
and would match either <quote>this example</quote> or <quote>that
example</quote>, and nothing else.
</member>
<para>
These are just some of the ones you are likely to use when matching URLs with
<para>
These are just some of the ones you are likely to use when matching URLs with
necessary either.
</para>
necessary either.
</para>
<itemizedlist>
<listitem>
<itemizedlist>
<listitem>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
page is requested by your browser:
</para>
page is requested by your browser:
</para>
<itemizedlist>
<listitem>
<para>
<itemizedlist>
<listitem>
<para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
<para>
NOTE: This is somewhat of a simplistic overview of what happens with each URL
request. For the sake of brevity and simplicity, we have focused on
<para>
NOTE: This is somewhat of a simplistic overview of what happens with each URL
request. For the sake of brevity and simplicity, we have focused on
configuration may vary):
</para>
configuration may vary):
</para>
<screen>
Matches for http://www.google.com:
<screen>
Matches for http://www.google.com:
In file: user.action <guibutton>[ View ]</guibutton> <guibutton>[ Edit ]</guibutton>
(no matches in this file)
</screen>
In file: user.action <guibutton>[ View ]</guibutton> <guibutton>[ Edit ]</guibutton>
(no matches in this file)
</screen>
<para>
This is telling us how we have defined our
<para>
This is telling us how we have defined our
to <quote>google.com</quote>:
</para>
to <quote>google.com</quote>:
</para>
-server-header-filter{html-to-xml}
-session-cookies-only
+set-image-blocker {pattern} </screen>
-server-header-filter{html-to-xml}
-session-cookies-only
+set-image-blocker {pattern} </screen>
<para>
Notice the only difference here to the previous listing, is to
<para>
Notice the only difference here to the previous listing, is to
Now another example, <quote>ad.doubleclick.net</quote>:
</para>
Now another example, <quote>ad.doubleclick.net</quote>:
</para>
<screen>
{ +block{Domains starts with "ad"} }
ad*.
<screen>
{ +block{Domains starts with "ad"} }
ad*.
{ +block{Doubleclick banner server} +handle-as-image }
.[a-vx-z]*.doubleclick.net
</screen>
{ +block{Doubleclick banner server} +handle-as-image }
.[a-vx-z]*.doubleclick.net
</screen>
<para>
We'll just show the interesting part here - the explicit matches. It is
<para>
We'll just show the interesting part here - the explicit matches. It is
This one is giving us problems. We are getting a blank page. Hmmm ...
</para>
This one is giving us problems. We are getting a blank page. Hmmm ...
</para>
<screen>
Matches for http://www.example.net/adsl/HOWTO/:
<screen>
Matches for http://www.example.net/adsl/HOWTO/:
{ +block{Path contains "ads".} +handle-as-image }
/ads
</screen>
{ +block{Path contains "ads".} +handle-as-image }
/ads
</screen>
<para>
Ooops, the <quote>/adsl/</quote> is matching <quote>/ads</quote> in our
<para>
Ooops, the <quote>/adsl/</quote> is matching <quote>/ads</quote> in our
wins). There are various ways to handle such exceptions. Example:
</para>
wins). There are various ways to handle such exceptions. Example:
</para>
<screen>
{ -block }
/adsl
</screen>
<screen>
{ -block }
/adsl
</screen>
<para>
Now the page displays ;-)
<para>
Now the page displays ;-)
<screen>
{ +block{Path starts with "ads".} +handle-as-image }
/ads
</screen>
<screen>
{ +block{Path starts with "ads".} +handle-as-image }
/ads
</screen>
<para>
That actually was very helpful and pointed us quickly to where the problem
<para>
That actually was very helpful and pointed us quickly to where the problem
<link linkend="FILTER"><quote>+filter</quote></link>:
</para>
<link linkend="FILTER"><quote>+filter</quote></link>:
</para>
<screen>
{ shop }
.quietpc.com
<screen>
{ shop }
.quietpc.com
.scan.co.uk
.forbes.com
</screen>
.scan.co.uk
.forbes.com
</screen>
<para>
<quote><literal>{ shop }</literal></quote> is an <quote>alias</quote> that expands to
<para>
<quote><literal>{ shop }</literal></quote> is an <quote>alias</quote> that expands to
Or you could do your own exception to negate filtering:
</para>
Or you could do your own exception to negate filtering:
</para>
<screen>
{ -filter }
# Disable ALL filter actions for sites in this section
<screen>
{ -filter }
# Disable ALL filter actions for sites in this section
developer.ibm.com
localhost
</screen>
developer.ibm.com
localhost
</screen>
<para>
This would turn off all filtering for these sites. This is best
<para>
This would turn off all filtering for these sites. This is best
actions that are the most likely to cause trouble. This can be used as a
last resort for problem sites.
</para>
actions that are the most likely to cause trouble. This can be used as a
last resort for problem sites.
</para>
<screen>
{ fragile }
# Handle with care: easy to break
mail.google.
mybank.example.com</screen>
<screen>
{ fragile }
# Handle with care: easy to break
mail.google.
mybank.example.com</screen>