By: Privoxy Developers
-$Id: user-manual.sgml,v 1.68 2002/04/04 18:46:47 swa Exp $
+$Id: user-manual.sgml,v 1.75 2002/04/12 02:08:48 david__schmidt Exp $
The user manual gives users information on how to install, configure and use
Privoxy.
networks.
Privoxy is based on the code of the Internet Junkbuster (tm). Junkbuster was
-originally written by JunkBusters Corporation, and was released as free
+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.
5.6. Templates
6. Contacting the Developers, Bug Reporting and Feature Requests
+
+ 6.1. Submitting Ads and "Action" Problems
+
7. Copyright and History
7.1. Copyright
1. Introduction
-This documentation is included with the current BETA version of Privoxy,
-v.2.9.13, and is mostly complete at this point. The most up to date reference
+This documentation is included with the current beta version of Privoxy,
+v.2.9.14, and is mostly complete at this point. The most up to date reference
for the time being is still the comments in the source files and in the
individual configuration files. Development of version 3.0 is currently nearing
completion, and includes many significant changes and enhancements over earlier
versions. The target release date for stable v3.0 is "soon" ;-).
-Since this is a BETA version, not all new features are well tested. This
+Since this is a beta version, not all new features are well tested. This
documentation may be slightly out of sync as a result (especially with CVS
sources). And there may be bugs, though hopefully not many!
To build Privoxy from source, autoconf and GNU make (gmake) are required.
Source is available as gzipped tar archives. For this, first unpack the source:
- tar xzvf privoxy-2.9.13-beta-src* [.tgz or .tar.gz]
- cd privoxy-2.9.13-beta
+ tar xzvf privoxy-2.9.14-beta-src* [.tgz or .tar.gz]
+ cd privoxy-2.9.14-beta
For retrieving the current CVS sources, you'll need the CVS package installed
This will create both binary and src RPMs in the usual places. Example:
- /usr/src/redhat/RPMS/i686/privoxy-2.9.13-1.i686.rpm
+ /usr/src/redhat/RPMS/i686/privoxy-2.9.14-1.i686.rpm
- /usr/src/redhat/SRPMS/privoxy-2.9.13-1.src.rpm
+ /usr/src/redhat/SRPMS/privoxy-2.9.14-1.src.rpm
To install, of course:
- rpm -Uvv /usr/src/redhat/RPMS/i686/privoxy-2.9.13-1.i686.rpm
+ rpm -Uvv /usr/src/redhat/RPMS/i686/privoxy-2.9.14-1.i686.rpm
This will place the Privoxy configuration files in /etc/privoxy/, and log files
-in /var/log/privoxy/. Run ckconfig privoxy on to have Privoxy start
+in /var/log/privoxy/. Run "chkconfig privoxy on" to have Privoxy start
automatically during init.
-------------------------------------------------------------------------------
This will create both binary and src RPMs in the usual places. Example:
- /usr/src/packages/RPMS/i686/privoxy-2.9.13-1.i686.rpm
+ /usr/src/packages/RPMS/i686/privoxy-2.9.14-1.i686.rpm
- /usr/src/packages/SRPMS/privoxy-2.9.13-1.src.rpm
+ /usr/src/packages/SRPMS/privoxy-2.9.14-1.src.rpm
To install, of course:
- rpm -Uvv /usr/src/packages/RPMS/i686/privoxy-2.9.13-1.i686.rpm
+ rpm -Uvv /usr/src/packages/RPMS/i686/privoxy-2.9.14-1.i686.rpm
This will place the Privoxy configuration files in /etc/privoxy/, and log files
Privoxy is packaged in a WarpIN self- installing archive. The self-installing
program will be named depending on the release version, something like:
-privoxyos2_setup_2.9.13.exe. In order to install it, simply run this executable
+privoxyos2_setup_2.9.14.exe. In order to install it, simply run this executable
or double-click on its icon and follow the WarpIN installation panels. A shadow
of the Privoxy executable will be placed in your startup folder so it will
start automatically whenever OS/2 starts.
The directory you choose to install Privoxy into will contain all of the
configuration files.
-If you would like to build binary images on OS/2 yourself, you will need a few
-Unix-like tools: autoconf, autoheader and sh. These tools will be used to
-create the required config.h file, which is not part of the source distribution
-because it differs based on platform. You will also need a compiler. The
-distribution has been created using IBM VisualAge compilers, but you can use
-any compiler you like. GCC/EMX has the disadvantage of needing to be
-single-threaded due to a limitation of EMX's implementation of the select()
-socket call.
-
-In addition to needing the source code distribution as outlined earlier, you
-will want to extract the os2seutp directory from CVS:
-
- cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
- cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co os2setup
-
-
-This will create a directory named os2setup/, which will contain the
-Makefile.vac makefile and os2build.cmd which is used to completely create the
-binary distribution. The sequence of events for building the executable for
-yourself goes something like this:
-
- cd current
- autoheader
- autoconf
- sh configure
- cd ..\os2setup
- nmake -f Makefile.vac
-
-
-You will see this sequence laid out in os2build.cmd.
-
-------------------------------------------------------------------------------
3.1.4. Windows
config.privoxy.org/), which is an internal page. You will see the following
section:
-Please choose from the following options:
+ Please choose from the following options:
* Show information about the current configuration
* Show the source code version numbers
When Privoxy displays one of its internal pages, such as a 404 Not Found error
page, it uses the appropriate template. On Linux, BSD, and Unix, these are
located in /etc/privoxy/templates by default. These may be customized, if
-desired.
+desired. cgi-style.css is used to control the HTML attributes (fonts, etc).
The default "Blocked" banner page with the bright red top banner, is called
just "blocked". This may be customized or replaced with something else if
We value your feedback. However, to provide you with the best support, please
note:
- * Use the Sourceforge Support Forum to get help:
+ * Use the Sourceforge Support Forum to get help:
- http://sourceforge.net/tracker/?group_id=11118&atid=211118
+ http://sourceforge.net/tracker/?group_id=11118&atid=211118
- * Submit bugs only through our Sourceforge Bug Forum:
+ * Submit bugs only through our Sourceforge Bug Forum:
- http://sourceforge.net/tracker/?group_id=11118&atid=111118.
+ http://sourceforge.net/tracker/?group_id=11118&atid=111118.
Make sure that the bug has not already been submitted. Please try to verify
platform, browser, any pertinent log data, any other relevant details
(please be specific) and, if possible, some way to reproduce the bug.
- * Submit feature requests only through our Sourceforge feature request
- forum:
+ * Submit feature requests only through our Sourceforge feature request forum:
- http://sourceforge.net/tracker/?atid=361118&group_id=11118&func=browse.
+ http://sourceforge.net/tracker/?atid=361118&group_id=11118&func=browse.
- * For any other issues, feel free to use the mailing lists:
+ * You can also send feedback on websites that Privoxy has problems with. Please bookmark
+ the following link: "Privoxy - Submit Filter Feedback"
+ . Once you surf to a page with problems, use the
+ bookmark to send us feedback. We will look into the issue as soon as possible.
+
+
+ * For any other issues, feel free to use the mailing lists:
- http://sourceforge.net/mail/?group_id=11118.
+ http://sourceforge.net/mail/?group_id=11118.
Anyone interested in actively participating in development and related
discussions can also join the appropriate mailing list. Archives are
- available too.
+ available, too.
-------------------------------------------------------------------------------
+6.1. Submitting Ads and "Action" Problems
+
+Ads and banners that are not stopped by Privoxy can be submitted to the
+developers by accessing a special page and filling out the brief, required
+form. Conversely, you can also report pages, images, etc. that Privoxy is
+blocking, but should not. The form itself does require Internet access.
+
+To do this, point your browser to Privoxy at http://p.p/, and then select
+Actions file feedback system, near the bottom of the page. Paste in the URL
+that is the cause of the unwanted behavior, and follow the prompts. The
+developers will try to incorporate your submission into future versions.
+
+New default.actions files will occasionally be made available based on your
+feedback. These will be announced on the ijbswa-announce list.
+
+-------------------------------------------------------------------------------
+
7. Copyright and History
7.1. Copyright
Privoxy is evolved, and derived from, the Internet Junkbuster, with many
improvments and enhancements over the original.
-Junkbuster was originally written by Anonymous Coders and Junkbuster's
+Junkbuster was originally written by Anonymous Coders and Junkbusters
Corporation, and was released as free open-source software under the GNU GPL.
Stefan Waldherr made many improvements, and started the SourceForge project
Privoxy to rekindle development. There are now several active developers
http://p.p/, access Privoxy from your browser. Alternately, http://
config.privoxy.org may work in some situations where the first does not.
+http://p.p/, and select "actions file feedback system" to submit "misses" to
+the developers.
+
http://www.junkbusters.com/ht/en/cookies.html
http://www.waldherr.org/junkbuster/
9.2.1. Bookmarklets
-Here are some bookmarklets to allow you to easily access a "mini" version of
-this page. They are designed for MS Internet Explorer, but should work equally
-well in Netscape, Mozilla, and other browsers which support JavaScript. They
-are designed to run directly from your bookmarks - not by clicking the links
-below (although that will work for testing).
+Below are some "bookmarklets" to allow you to easily access a "mini" version of
+some of Privoxy's special pages. They are designed for MS Internet Explorer,
+but should work equally well in Netscape, Mozilla, and other browsers which
+support JavaScript. They are designed to run directly from your bookmarks - not
+by clicking the links below (although that should work for testing).
To save them, right-click the link and choose "Add to Favorites" (IE) or "Add
Bookmark" (Netscape). You will get a warning that the bookmark "may not be
* View Privoxy Status
+ * Actions file feedback system
+
Credit: The site which gave me the general idea for these bookmarklets is
www.bookmarklets.com. They have more information about bookmarklets.
it does nothing. Every action is disabled. This is not particularly informative
for our purposes here. OK, next section:
- Matches for http://google.com:
+ Matches for http://google.com:
{ -add-header -block +deanimate-gifs -downgrade +fast-redirects
+filter{html-annoyances} +filter{js-annoyances} +filter{no-popups}
And now we pull it altogether in the bottom section and summarize how Privoxy
is appying all its "actions" to "google.com":
- Final results:
+ Final results:
-add-header -block -deanimate-gifs -downgrade -fast-redirects
+filter{html-annoyances} +filter{js-annoyances} +filter{no-popups}
Now another example, "ad.doubleclick.net":
- { +block +image }
+ { +block +image }
.ad.doubleclick.net
{ +block +image }
One last example. Let's try "http://www.rhapsodyk.net/adsl/HOWTO/". This one is
giving us problems. We are getting a blank page. Hmmm...
- Matches for http://www.rhapsodyk.net/adsl/HOWTO/:
+ Matches for http://www.rhapsodyk.net/adsl/HOWTO/:
{ -add-header -block +deanimate-gifs -downgrade +fast-redirects
+filter{html-annoyances} +filter{js-annoyances} +filter{no-popups}
explictly does not block (-block) pages with "adsl". There are various ways to
handle such exceptions. Example:
- { -block }
+ { -block }
/adsl
But now what about a situation where we get no explicit matches like we did
with:
- { -block }
+ { -block }
/adsl
cause would be one of the "{+filter}" actions. Try adding the URL for the site
to one of aliases that turn off "+filter":
- {shop}
+ {shop}
.quietpc.com
.worldpay.com # for quietpc.com
.jungle.com
"{shop}" is an "alias" that expands to "{ -filter -no-cookies -no-cookies-keep
}". Or you could do your own exception to negate filtering:
- {-filter}
+ {-filter}
.forbes.com
projects / privoxy.git / blobdiff