This file belongs into
ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/
- $Id: user-manual.sgml,v 1.51 2002/03/23 15:13:11 swa Exp $
+ $Id: user-manual.sgml,v 1.56 2002/03/24 16:17:06 swa Exp $
Written by and Copyright (C) 2001 the SourceForge
Privoxy team. http://ijbswa.sourceforge.net
<artheader>
<title>Privoxy User Manual</title>
-<pubdate>$Id: user-manual.sgml,v 1.51 2002/03/23 15:13:11 swa Exp $</pubdate>
+<pubdate>$Id: user-manual.sgml,v 1.56 2002/03/24 16:17:06 swa Exp $</pubdate>
<authorgroup>
<author>
multi-user networks.
</para>
+<para>
+ <application>Privoxy</application> is derived from
+ <application>Internet Junkbuster</application> by Junkbusters Corporation,
+ which is no longer under development. Many enhancements and
+ new features have been added.
+
+</para>
+
<para>
This documentation is included with the current BETA version of
<application>Privoxy</application> and is mostly complete at this
<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
+ URL <ulink url="http://p.p/">http://p.p/</ulink> (or alternately
<ulink url="http://ijbswa.sourceforge.net/config/">http://ijbswa.sourceforge.net/config/</ulink>),
which is an internal page. You will see the following section:
<listitem>
<para>
- The <filename>ijb.action</filename> file is used to define various
+ The <filename>default.action</filename> file is used to define various
<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>
<listitem>
<para>
- The <filename>re_filterfile</filename> file can be used to re-write the raw
+ The <filename>default.filter</filename> file can be used to re-write the raw
page content, including viewable text as well as embedded HTML and JavaScript,
and whatever else lurks on any given web page.
</para>
</para>
<para>
- <filename>ijb.action</filename> and <filename>re_filterfile</filename>
+ <filename>default.action</filename> and <filename>default.filter</filename>
can use Perl style regular expressions for maximum flexibility. All files use
the <quote><literal>#</literal></quote> character to denote a comment. Such
lines are not processed by <application>Privoxy</application>. After
</para>
<para>
- The <quote>ijb.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>re_filterfile</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.
+ filtered through selected sections of <quote>default.filter</quote>. No sites
+ 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>
<literal>
<msgtext>
<literallayout>
- <emphasis>actionsfile ijb.action</emphasis>
+ <emphasis>actionsfile default.action</emphasis>
</literallayout>
</msgtext>
</literal>
</para>
<para>
- The <quote>re_filterfile</quote> file contains content modification rules
+ The <quote>default.filter</quote> file contains content modification rules
that use <quote>regular expressions</quote>. These rules permit powerful
changes on the content of Web pages, e.g., you could disable your favorite
JavaScript annoyances, re-write the actual displayed text, or just have some
<literal>
<msgtext>
<literallayout>
- <emphasis>re_filterfile re_filterfile</emphasis>
+ <emphasis>filterfile default.filter</emphasis>
</literallayout>
</msgtext>
</literal>
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>
</para>
<para>
- To enable the web-based <filename>ijb.action</filename> file editor set
+ To enable the web-based <filename>default.action</filename> file editor set
<application>enable-edit-actions</application> to 1, or 0 to disable. Note
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>
<title>The Actions File</title>
<para>
- The <quote>ijb.action</quote> file (formerly
- <filename>actionsfile</filename>) is used to define what actions
+ The <quote>default.action</quote> file (formerly
+ <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
some obnoxious URL that you would rather not see. Cookies can be accepted
or rejected, or accepted only during the current browser session (i.e.
- not written to disk). Changes to <filename>ijb.action</filename> should
+ not written to disk). Changes to <filename>default.action</filename> should
be immediately visible to <application>Privoxy</application> without
the need to restart.
</para>
<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>
So in this case <application>Privoxy</application> would just be a
normal, non-blocking, non-anonymizing proxy. You must specifically
enable the privacy and blocking features you need (although the
- provided default <filename>ijb.action</filename> file will
+ provided default <filename>default.action</filename> file will
give a good starting point).
</para>
<listitem>
<para>
Apply the filters in the <literal>section_header</literal>
- section of the <filename>re_filterfile</filename> file to the site(s).
- <filename>Re_filterfile</filename> sections are grouped according to like
+ section of the <filename>default.filter</filename> file to the site(s).
+ <filename>default.filter</filename> sections are grouped according to like
functionality.
</para>
<para>
Filter sections that are pre-defined in the supplied
- <filename>re_filterfile</filename> include:
+ <filename>default.filter</filename> include:
</para>
<blockquote>
+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>
<quote>z</quote>, <quote>0</quote>-<quote>9</quote>, <quote>+</quote>, and
<quote>-</quote>. Alias names are not case sensitive, and
<emphasis>must be defined before anything</emphasis> else in the
- <filename>ijb.action</filename>file ! And there can only be one set of
+ <filename>default.action</filename>file ! And there can only be one set of
<quote>aliases</quote> defined.
</para>
Any web page can be dynamically modified with the filter file. This
modification can be removal, or re-writing, of any web page content,
including tags and non-visible content. The default filter file is
- <filename>re_filterfile</filename>, located in the config directory.
+ <filename>default.filter</filename>, located in the config directory.
</para>
<para>
<para>
This file uses regular expressions to alter or remove any string in the
target page. The expressions can only operate on one line at a time. Some
- examples from the included default <filename>re_filterfile</filename>:
+ examples from the included default <filename>default.filter</filename>:
</para>
<para>
The included default configuration files should give a reasonable starting
point, though may be somewhat aggressive in blocking junk. You will probably
want to keep an eye out for sites that require persistent cookies, and add these to
- <filename>ijb.action</filename> as needed. By default, most of these will
+ <filename>default.action</filename> as needed. By default, most of these will
be accepted only during the current browser session, until you add them to
the configuration. If you want the browser to handle this instead, you will
- need to edit <filename>ijb.action</filename> and disable this feature. If you
+ need to edit <filename>default.action</filename> and disable this feature. If you
use more than one browser, it would make more sense to let
<application>Privoxy</application> handle this. In which case, the
browser(s) should be set to accept all cookies.
<para>
If a particular site shows problems loading properly, try adding it
to the <literal>{fragile}</literal> section of
- <filename>ijb.action</filename>. This will turn off most actions for
+ <filename>default.action</filename>. This will turn off most actions for
this site.
</para>
problems, you might try to force HTTP/1.0 compatibility. For Mozilla, look
under <literal>Edit -> Preferences -> Debug -> Networking</literal>.
Or set the <quote>+downgrade</quote> config option in
- <filename>ijb.action</filename>.
+ <filename>default.action</filename>.
</para>
<para>
After running <application>Privoxy</application> for a while, you can
start to fine tune the configuration to suit your personal, or site,
preferences and requirements. There are many, many aspects that can
- be customized. <quote>Actions</quote> (as specified in <filename>ijb.action</filename>)
+ 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>
configuration can be viewed from this page, including
current configuration parameters, source code version numbers,
the browser's request headers, and <quote>actions</quote> that apply
- to a given URL. In addition to the <filename>ijb.action</filename> file
+ to a given URL. In addition to the <filename>default.action</filename> file
editor mentioned above, <application>Privoxy</application> can also
be turned <quote>on</quote> and <quote>off</quote> from this page.
</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
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://i.j.b/">http://i.j.b/</ulink>
+ <ulink url="http://p.p/">http://p.p/</ulink>
</member>
</simplelist>
<simplelist>
</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>
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>re_filterfile</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
Temple Place - Suite 330, Boston, MA 02111-1307, USA.
$Log: user-manual.sgml,v $
+ 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
+
Revision 1.51 2002/03/23 15:13:11 swa
renamed every reference to the old name with foobar.
fixed "application foobar application" tag, fixed
projects / privoxy.git / blobdiff