This file belongs into
ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/
- $Id: user-manual.sgml,v 1.52 2002/03/24 11:01:06 swa Exp $
+ $Id: user-manual.sgml,v 1.59 2002/03/27 00:54:33 hal9 Exp $
Written by and Copyright (C) 2001 the SourceForge
- Privoxy team. http://ijbswa.sourceforge.net
+ Privoxy team. http://www.privoxy.org/
Based on the Internet Junkbuster originally written
by and Copyright (C) 1997 Anonymous Coders and
<artheader>
<title>Privoxy User Manual</title>
-<pubdate>$Id: user-manual.sgml,v 1.52 2002/03/24 11:01:06 swa Exp $</pubdate>
+<pubdate>$Id: user-manual.sgml,v 1.59 2002/03/27 00:54:33 hal9 Exp $</pubdate>
<authorgroup>
<author>
stand-alone systems and multi-user networks.
</para>
<para>
-You can find the latest version of the user manual at <ulink url="http://ijbswa.sourceforge.net/user-manual/">http://ijbswa.sourceforge.net/user-manual/</ulink>.
+You can find the latest version of the user manual at <ulink url="http://www.privoxy.org/user-manual/">http://www.privoxy.org/user-manual/</ulink>.
</para>
<!-- <para> -->
<sect1 id="introduction"><title>Introduction</title>
<para>
- <application>Privoxy</application> is a web proxy with advanced
- filtering capabilities for protecting privacy, filtering and modifying web
- page content, managing cookies, controlling access, and removing ads,
- banners, pop-ups and other obnoxious Internet Junk.
- <application>Privoxy</application> has a very flexible configuration and
- can be customized to suit individual needs and tastes. <application>Privoxy</application> has application for both stand-alone systems and
- multi-user networks.
+ <application>Privoxy</application> is a web proxy with advanced filtering
+ capabilities for protecting privacy, filtering web page content, managing
+ cookies, controlling access, and removing ads, banners, pop-ups and other
+ obnoxious Internet junk. <application>Privoxy</application> has a very
+ flexible configuration and can be customized to suit individual needs and
+ tastes. <application>Privoxy</application> has application for both
+ stand-alone systems and multi-user networks.
+</para>
+
+<para>
+ <application>Privoxy</application> is based on the code of the
+ <application>Internet Junkbuster</application>.
+ <application>Junkbuster</application> was originally written by JunkBusters
+ Corporation, and was released as free open-source software under the GNU GPL.
+ Stefan Waldherr made many improvements, and started the SourceForge project
+ to continue development.
+</para>
+
+<para>
+ <application>Privoxy</application> continues the
+ <application>Junkbuster</application> tradition, but adds many
+ refinements and enhancements.
</para>
<para>
<listitem>
<para>
Integrated browser based configuration and control utility (<ulink
- url="http://i.j.b">http://i.j.b</ulink>). Browser-based tracing of rule
+ url="http://p.p">http://p.p</ulink>). Browser-based tracing of rule
and filter effects.
</para>
</listitem>
<para>
<screen>
- tar xzvf ijb_source_* [.tgz or .tar.gz]
- cd ijb_source_2.9.11_beta
+ tar xzvf privoxy-2.9.13-beta-src* [.tgz or .tar.gz]
+ cd privoxy-2.9.13-beta
</screen>
</para>
<para>
<screen>
- autoheader [suggested for CVS source]
- autoconf [suggested for CVS source]
+ autoheader
+ autoconf
./configure
make redhat-dist
</screen>
<para>
<screen>
- autoheader [suggested for CVS source]
- autoconf [suggested for CVS source]
+ autoheader
+ autoconf
./configure
make suse-dist
</screen>
<title>Controlling <application>Privoxy</application> with Your Web Browser</title>
<para>
<application>Privoxy</application> can be reached by the special
- URL <ulink url="http://i.j.b/">http://i.j.b/</ulink> (or alternately
- <ulink url="http://ijbswa.sourceforge.net/config/">http://ijbswa.sourceforge.net/config/</ulink>),
+ URL <ulink url="http://p.p/">http://p.p/</ulink> (or alternately
+ <ulink url="http://www.privoxy.org/config/">http://www.privoxy.org/config/</ulink>),
which is an internal page. You will see the following section:
</para>
<quote>actions</quote> relating to images, banners, pop-ups, access
restrictions, banners and cookies. There is a CGI based editor for this
file that can be accessed via <ulink
- url="http://i.j.b">http://i.j.b</ulink>. (Other actions
+ url="http://p.p">http://p.p</ulink>. (Other actions
files are included as well with differing levels of filtering
and blocking, e.g. <filename>ijb-basic.action</filename>.)
</para>
</para>
<para>
- The <quote>default.action</quote> file contains patterns to specify the actions
- to apply to requests for each site. Default: Cookies to and from all
+ The <quote>default.action</quote> file contains patterns to specify the
+ actions to apply to requests for each site. Default: Cookies to and from all
destinations are kept only during the current browser session (i.e. they are
not saved to disk). Pop-ups are disabled for all sites. All sites are
filtered through selected sections of <quote>default.filter</quote>. No sites
- are blocked. The <application>Privoxy</application> logo is displayed for
- filtered ads and other images. The syntax of this file is explained in detail
- <link linkend="actionsfile">below</link>. Other <quote>actions</quote> files
- are included, and you are free to use any of them. They have varying degrees
- of aggressiveness.
+ are blocked. <application>Privoxy</application> displays a checkboard type
+ pattern for filtered ads and other images. The syntax of this file is
+ explained in detail <link linkend="actionsfile">below</link>. Other
+ <quote>actions</quote> files are included, and you are free to use any of
+ them. They have varying degrees of aggressiveness.
</para>
<para>
to temporarily disable <application>Privoxy</application>, e.g., to access
a site that requires cookies which you would otherwise have blocked. This can also
be toggled via a web browser at the <application>Privoxy</application>
- internal address of <ulink url="http://i.j.b">http://i.j.b</ulink> on
+ internal address of <ulink url="http://p.p">http://p.p</ulink> on
any platform.
</para>
that you must have compiled <application>Privoxy</application> with
support for this feature, otherwise this option has no effect. This
internal page can be reached at <ulink
- url="http://i.j.b">http://i.j.b</ulink>.
+ url="http://p.p">http://p.p</ulink>.
</para>
<para>
<para>
Security note: If this is enabled, anyone who can use the proxy can toggle
- it on or off (see <ulink url="http://i.j.b">http://i.j.b</ulink>), and
+ it on or off (see <ulink url="http://p.p">http://p.p</ulink>), and
their changes will affect all users. For shared proxies, you probably want to
disable this. Default: enabled.
</para>
<!-- ~~~~~ New section ~~~~~ -->
-<sect3>
+<sect3 id="forwarding">
<title>Forwarding</title>
<para>
<para>
The <quote>default.action</quote> file (formerly
- <filename>actionsfile</filename>) is used to define what actions
+ <filename>actionsfile</filename> or <filename>ijb.action</filename>) is used to define what actions
<application>Privoxy</application> takes, and thus determines how images,
cookies and various other aspects of HTTP content and transactions are
handled. Images can be anything you want, including ads, banners, or just
<para>
The easiest way to edit <quote>actions</quote> file is with a browser by
- loading <ulink url="http://i.j.b/">http://i.j.b/</ulink>, and then select
+ loading <ulink url="http://p.p/">http://p.p/</ulink>, and then select
<quote>Edit Actions List</quote>. A text editor can also be used.
</para>
compared to all patterns in this file. Every time it matches, the list of
applicable actions for the URL is incrementally updated. You can trace
this process by visiting <ulink
- url="http://i.j.b/show-url-info">http://i.j.b/show-url-info</ulink>.
+ url="http://p.p/show-url-info">http://p.p/show-url-info</ulink>.
</para>
+image}</quote>, e.g an advertizement. There are five options.
<quote>-image-blocker</quote> will send a HTML <quote>blocked</quote> page,
usually resulting in a <quote>broken image</quote> icon.
- <quote>+image-blocker{logo}</quote> will send a
- <application>Privoxy</application> logo
- image. <quote>+image-blocker{blank}</quote> will send a 1x1 transparent GIF
- image. And finally, <quote>+image-blocker{http://xyz.com}</quote> will send
- a HTTP temporary redirect to the specified image. This has the advantage of
- the icon being being cached by the browser, which will speed up the display.
- <quote>+image-blocker{pattern}</quote> will send a checkboard type pattern,
- which scales better than the logo (which can get blocky if the browser
- enlarges it too much).
+<!-- <quote>+image-blocker{logo}</quote> will send a -->
+<!-- <application>Privoxy</application> logo -->
+<!-- image. -->
+<quote>+image-blocker{blank}</quote> will send a 1x1 transparent GIF
+image. And finally, <quote>+image-blocker{http://xyz.com}</quote> will send a
+HTTP temporary redirect to the specified image. This has the advantage of the
+icon being being cached by the browser, which will speed up the display.
+<quote>+image-blocker{pattern}</quote> will send a checkboard type pattern
+<!-- , -->
+<!-- which scales better than the logo (which can get blocky if the browser -->
+<!-- enlarges it too much). -->
</para>
<para>
<literal>
<msgtext>
<literallayout>
- <emphasis>+image-blocker{logo}</emphasis>
+<!-- <emphasis>+image-blocker{logo}</emphasis> -->
<emphasis>+image-blocker{blank}</emphasis>
<emphasis>+image-blocker{pattern}</emphasis>
- <emphasis>+image-blocker{http://i.j.b/send-banner}</emphasis>
+ <emphasis>+image-blocker{http://p.p/send-banner}</emphasis>
</literallayout>
</msgtext>
</literal>
preferences and requirements. There are many, many aspects that can
be customized. <quote>Actions</quote> (as specified in <filename>default.action</filename>)
can be adjusted by pointing your browser to
- <ulink url="http://i.j.b/">http://i.j.b/</ulink>,
+ <ulink url="http://p.p/">http://p.p/</ulink>,
and then follow the link to <quote>edit the actions list</quote>.
(This is an internal page and does not require Internet access.)
</para>
<sect2>
<title>History</title>
+<para>
+ <application>Privoxy</application> is derived from
+ <application>the Internet Junkbuster</application>, with many
+ improvments and enhancements over the original.
+</para>
+
<para>
<application>Junkbuster</application> was originally written by Anonymous
Coders and <ulink
- url="http://www.junkbusters.com/ht/en/ijbfaq.html">Junkbuster's
+ url="http://www.junkbusters.com">Junkbuster's
Corporation</ulink>, and was released as free open-source software under the
GNU GPL. <ulink url="http://www.waldherr.org/junkbuster/">Stefan
Waldherr</ulink> made many improvements, and started the <ulink
url="http://sourceforge.net/projects/ijbswa/">SourceForge project
Privoxy</ulink> to rekindle development. There are now several active
- developers contributing. The last stable release was v2.0.2, which has now
+ developers contributing. The last stable release of
+ <application>Junkbuster</application> was v2.0.2, which has now
grown whiskers ;-).
</para>
</simplelist>
<simplelist>
<member>
- <ulink url="http://ijbswa.sourceforge.net/">http://ijbswa.sourceforge.net/</ulink>
+ <ulink url="http://www.privoxy.org/">http://www.privoxy.org/</ulink>
</member>
</simplelist>
<simplelist>
<member>
- <ulink url="http://i.j.b/">http://i.j.b/</ulink>
+ <ulink url="http://p.p/">http://p.p/</ulink>
</member>
</simplelist>
<simplelist>
</para>
<blockquote>
<para>
- <ulink url="http://ijbswa.sourceforge.net/config/">http://ijbswa.sourceforge.net/config/</ulink>
+ <ulink url="http://www.privoxy.org/config/">http://www.privoxy.org/config/</ulink>
</para>
</blockquote>
<para>
- Alternately, this may be reached at <ulink url="http://i.j.b/">http://i.j.b/</ulink>,
- but this variation may not work as reliably as the above in some
- configurations.
+ Alternately, this may be reached at <ulink
+ url="http://p.p/">http://p.p/</ulink>, but this
+ variation may not work as reliably as the above in some configurations.
</para>
</listitem>
</para>
<blockquote>
<para>
- <ulink url="http://ijbswa.sourceforge.net/config/show-status">http://ijbswa.sourceforge.net/config/show-status</ulink>
+ <ulink url="http://www.privoxy.org/config/show-status">http://www.privoxy.org/config/show-status</ulink>
</para>
</blockquote>
</listitem>
</para>
<blockquote>
<para>
- <ulink url="http://ijbswa.sourceforge.net/config/show-version">http://ijbswa.sourceforge.net/config/show-version</ulink>
+ <ulink url="http://www.privoxy.org/config/show-version">http://www.privoxy.org/config/show-version</ulink>
</para>
</blockquote>
</listitem>
</para>
<blockquote>
<para>
- <ulink url="http://ijbswa.sourceforge.net/config/show-request">http://ijbswa.sourceforge.net/config/show-request</ulink>
+ <ulink url="http://www.privoxy.org/config/show-request">http://www.privoxy.org/config/show-request</ulink>
</para>
</blockquote>
</listitem>
</para>
<blockquote>
<para>
- <ulink url="http://ijbswa.sourceforge.net/config/show-url-info">http://ijbswa.sourceforge.net/config/show-url-info</ulink>
+ <ulink url="http://www.privoxy.org/config/show-url-info">http://www.privoxy.org/config/show-url-info</ulink>
</para>
</blockquote>
</listitem>
</para>
<blockquote>
<para>
- <ulink url="http://ijbswa.sourceforge.net/config/toggle">http://ijbswa.sourceforge.net/config/toggle</ulink>
+ <ulink url="http://www.privoxy.org/config/toggle">http://www.privoxy.org/config/toggle</ulink>
</para>
</blockquote>
<para>
</para>
<blockquote>
<para>
- <ulink url="http://ijbswa.sourceforge.net/config/toggle?set=disable">http://ijbswa.sourceforge.net/config/toggle?set=disable</ulink>
+ <ulink url="http://www.privoxy.org/config/toggle?set=disable">http://www.privoxy.org/config/toggle?set=disable</ulink>
</para>
</blockquote>
<blockquote>
<para>
- <ulink url="http://ijbswa.sourceforge.net/config/toggle?set=enable">http://ijbswa.sourceforge.net/config/toggle?set=enable</ulink>
+ <ulink url="http://www.privoxy.org/config/toggle?set=enable">http://www.privoxy.org/config/toggle?set=enable</ulink>
</para>
</blockquote>
</listitem>
</para>
<blockquote>
<para>
- <ulink url="http://ijbswa.sourceforge.net/config/edit-actions">http://ijbswa.sourceforge.net/config/edit-actions</ulink>
+ <ulink url="http://www.privoxy.org/config/edit-actions">http://www.privoxy.org/config/edit-actions</ulink>
</para>
</blockquote>
</listitem>
the actions files themselves, since they tend to be filled with
<quote>regular expressions</quote> whose consequences are not always
so obvious. <application>Privoxy</application> provides the
- <ulink url="http://ijbswa.sourceforge.net/config/show-url-info">http://ijbswa.sourceforge.net/config/show-url-info</ulink>
+ <ulink url="http://www.privoxy.org/config/show-url-info">http://www.privoxy.org/config/show-url-info</ulink>
page that can show us very specifically how <application>actions</application>
are being applied to any given URL. This is a big help for troubleshooting.
</para>
<para>
First, enter one URL (or partial URL) at the prompt, and then
<application>Privoxy</application> will tell us
- how current configuration will handle it. This will not
- help with filtering effects from the <filename>default.filter</filename>! It
+ how the current configuration will handle it. This will not
+ help with filtering effects from the <filename>default.filter</filename> file! It
also will not tell you about any other URLs that may be embedded within the
URL you are testing. For instance, images such as ads are expressed as URLs
within the raw page source of HTML pages. So you will only get info for the
</para>
+<para>
+ But now what about a situation where we get no explicit matches like
+ we did with:
+
+</para>
+
+<para>
+ <screen>
+
+ { -block }
+ /adsl
+
+ </screen>
+</para>
+
+<para>
+ That actually was very telling and pointed us quickly to where the problem
+ was. If you don't get this kind of match, then it means one of the default
+ rules in the first section is causing the problem. This would require some
+ guesswork, and maybe a little trial and error to isolate the offending rule.
+ One likely cause would be one of the <quote>{+filter}</quote> actions. Try
+ adding the URL for the site to one of aliases that turn off <quote>+filter</quote>:
+</para>
+
+<para>
+ <screen>
+
+ {shop}
+ .quietpc.com
+ .worldpay.com # for quietpc.com
+ .jungle.com
+ .scan.co.uk
+ .forbes.com
+
+ </screen>
+</para>
+
+<para>
+ <quote>{shop}</quote> is an <quote>alias</quote> that expands to
+ <quote>{ -filter -no-cookies -no-cookies-keep }</quote>. Or you could do
+ your own exception to negate filtering:
+
+</para>
+
+<para>
+ <screen>
+
+ {-filter}
+ .forbes.com
+
+ </screen>
+</para>
+
</sect2>
</sect1>
Temple Place - Suite 330, Boston, MA 02111-1307, USA.
$Log: user-manual.sgml,v $
+ Revision 1.59 2002/03/27 00:54:33 hal9
+ Touch up intro for new name.
+
+ Revision 1.58 2002/03/26 22:29:55 swa
+ we have a new homepage!
+
+ Revision 1.57 2002/03/24 20:33:30 hal9
+ A few minor catch ups with name change.
+
+ Revision 1.56 2002/03/24 16:17:06 swa
+ configure needs to be generated.
+
+ Revision 1.55 2002/03/24 16:08:08 swa
+ we are too lazy to make a block-built
+ privoxy logo. hence removed the option.
+
+ Revision 1.54 2002/03/24 15:46:20 swa
+ name change related issue.
+
+ Revision 1.53 2002/03/24 11:51:00 swa
+ name change. changed filenames.
+
Revision 1.52 2002/03/24 11:01:06 swa
name change
projects / privoxy.git / blobdiff