-.\" Revised man page 10/13/01, for development version.
-.\" Hal Burgiss <hal@foobox.net>
-.\" for Privoxy developers: ijbswa-developers@lists.sourceforge.net
-.\"
-.TH PRIVOXY 1 "v2.9.13 (beta) Date: 2002/03/24"
-
+.\" This manpage has been automatically generated by docbook2man
+.\" from a DocBook document. This tool can be found at:
+.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/>
+.\" Please send any bug reports, improvements, comments, patches,
+.\" etc. to Steve Cheng <steve@ggi-project.org>.
+.TH "PRIVOXY" "1" "05 May 2002" "Privoxy 2.9.15 beta" ""
.SH NAME
-\fBprivoxy\fP
-- Privacy enhancing
-Proxy
-.\"\s-2(TM)\s+2
+privoxy \- Privacy Enhancing Proxy
.SH SYNOPSIS
-\fBprivoxy\fP
-[--help] [--version] [--no-daemon] [--pidfile \fIpidfile\fP] [--user \fIuser\fP[.\fIgroup\fP]]
-\fI\&[configfile]\fP (Unix)
-.TP
-\fBprivoxy.exe\fP \fI[configfile]\fP (Windows)
-.br
-.SH OPTIONS
-\fBPrivoxy\fP may be invoked with the following command-line options:
+\fBprivoxy\fR [\fB--help\fR] [\fB--version\fR] [\fB--no-daemon\fR] [\fB--pidfile \fIpidfile\fB\fR] [\fB--user \fIuser[.group]\fB\fR] [\fB\fIconfigfile\fB\fR] \fB(UNIX)\fR
+
+
+\fBprivoxy.exe\fR [\fB\fIconfigfile\fB\fR] \fB(Windows)\fR
+
+.SH "OPTIONS"
+.PP
+\fBPrivoxy\fR may be invoked with the following command line
+options:
.TP
-.BR --version " (unix only)"
-Print version info and exit.
+\fB--help\fR
+Print brief usage info and exit.
.TP
-.BR --help " (unix only)"
-Print a short usage info and exit.
+\fB--version\fR
+Print version info and exit.
.TP
-.BR --no-daemon " (unix only)"
-Don't become a daemon, i.e. don't fork and become process group
-leader, don't detach from controlling tty, and do all logging
-there.
+\fB--no-daemon\fR
+Don't become a daemon, i.e. don't fork and become process group
+leader, don't detach from controlling tty, and do all logging there.
.TP
-\fB --pidfile\fP \fIpidfile\fP (unix only)
-On startup, write the process ID to \fIpidfile\fP. Delete the
-\fIpidfile\fP on exit. Failiure to create or delete the
-\fIpidfile\fP is non-fatal. If no \fB--pidfile\fP option
-is given, no PID file will be used.
+\fB--pidfile \fIpidfile\fB\fR
+On startup, write the process ID to \fIpidfile\fR.
+Delete the \fIpidfile\fR on exit.
+Failiure to create or delete the \fIpidfile\fR
+is non-fatal. If no \fB--pidfile\fR option is given, no PID file will be used.
.TP
-\fB --user\fP \fIuser\fP[.\fIgroup\fP] (unix only)
-After (optionally) writing the PID file, assume the user ID
-of \fIuser\fP and the GID of \fIgroup\fP, or, if the optional
-\fIgroup\fP was not given, the default group of \fIuser\fP.
-Exit if the privileges are not sufficient to do so.
-
+\fB--user \fIuser[.group]\fB\fR
+After (optionally) writing the PID file, assume the user ID of
+\fIuser\fR and the GID of
+\fIgroup\fR, or, if the optional
+\fIgroup\fR was not given, the default group of
+\fIuser\fR. Exit if the privileges are not
+sufficient to do so.
.PP
-If the \fIconfigfile\fP is not specified on the command line,
-\fBPrivoxy\fP will look for a file named \fBconfig\fP in the
-current directory (except on Win32 where it will try \fBconfig.txt\fP).
-
-
-.SH DESCRIPTION
-\fBPrivoxy\fP 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. \fBPrivoxy\fP has a very flexible configuration and
-can be customized to suit individual needs and tastes. \fBPrivoxy\fP has
-application for both stand-alone systems and multi-user networks.
+If the \fIconfigfile\fR is not specified on the command line,
+\fBPrivoxy\fR will look for a file named
+\fIconfig\fR in the current directory (except on Win32 where
+it will try \fIconfig.txt\fR). If no
+\fIconfigfile\fR is found, \fBPrivoxy\fR will
+fail to start.
+.SH "DESCRIPTION"
.PP
-\fBPrivoxy\fP is based on code of the \fBInternet Junkbuster (tm)\fP.
-\fBJunkbuster\fP 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.
-
-.SH INSTALLATION AND USE
-Browsers must be individually configured to use
-\fBPrivoxy\fP as a \s-2HTTP\s0 proxy.
-The default setting is for localhost,
-on port 8118 (configurable in the main config file).
-To set the
-\s-2HTTP\s0
-proxy in Netscape and Mozilla,
-go through:
-\fB\&Edit\fP;
-\fB\&Preferences\fP;
-\fB\&Advanced\fP;
-\fB\&Proxies\fP;
-\fB\&Manual Proxy Configuration\fP;
-\fB\&View\fP.
+\fBPrivoxy\fR 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. \fBPrivoxy\fR has a very
+flexible configuration and can be customized to suit individual needs and
+tastes. \fBPrivoxy\fR has application for both
+stand-alone systems and multi-user networks.
+.PP
+\fBPrivoxy\fR is based on \fBInternet
+Junkbuster\fR (tm).
+.SH "INSTALLATION AND USAGE"
.PP
-For Internet Explorer,
-go through:
-\fB\&Tools\fP;
-\fB\&Internet Properties\fP;
-\fB\&Connections\fP;
-\fB\&LAN Settings\fP.
+Browsers must be individually configured to use \fBPrivoxy\fR as
+a HTTP proxy. The default setting is for localhost, on port 8118
+(configurable in the main config file). To set the HTTP proxy in Netscape
+and Mozilla, go through: \fBEdit\fR;
+\fBPreferences\fR; \fBAdvanced\fR;
+\fBProxies\fR; \fBManual Proxy Configuration\fR;
+\fBView\fR.
.PP
-The
-Secure (SSL) Proxy \" ijbfaq.html#security
-should also be set to the same values,
-otherwise
-\fB\&https:\fP
-\s-2URL\s0s
-will not be proxied.
+For Internet Explorer, go through: \fBTools\fR;
+\fBInternet Properties\fR; \fBConnections\fR;
+\fBLAN Settings\fR.
+.PP
+The Secure (SSL) Proxy should also be set to the same values, otherwise
+https: URLs will not be proxied.
.PP
For other browsers, check the documentation.
-
-.SH CONFIGURATION
-\fBPrivoxy\fP can be configured with the various configuration
-files. The default configuration files are: \fIconfig\fP,
-\fIdefault.action\fP, and \fIdefault.filter\fP. These are well commented.
-On Unix and Unix-like systems, these are located in \fI/etc/privoxy/\fP
-by default. On Windows, OS/2 and AmigaOS, these files are in the same directory
-as the \fBPrivoxy\fP executable.
+.SH "CONFIGURATION"
.PP
-The name and number of configuration files has changed from previous versions,
-and is subject to change as development progresses. In fact, the configuration
-itself is changed and much more sophisticated. See the user-manual for a brief
-explanation of all configuration options.
+\fBPrivoxy\fR can be configured with the various configuration
+files. The default configuration files are: \fIconfig\fR,
+\fIdefault.filter\fR, and
+\fIdefault.action\fR. \fIuser.action\fR should
+be used for locally defined exceptions to the default rules of
+\fIdefault.action\fR These are all well commented. On Unix
+and Unix-like systems, these are located in
+\fI/etc/privoxy/\fR by default. On Windows, OS/2 and AmigaOS,
+these files are in the same directory as the \fBPrivoxy\fR
+executable.
.PP
-The actions list (ad blocks, etc) can also be configured with your
-web browser at \fIhttp://www.privoxy.org/config\fP.
-\fBPrivoxy's\fP configuration parameters can also be viewed
-at the same page. In addition, \fBPrivoxy\fP can be toggled on/off.
-This is an internal page.
-
-.SH "SAMPLE CONFIGURATION"
+The name and number of configuration files has changed from previous
+versions, and is subject to change as development progresses. In fact, the
+configuration itself is changed and much more sophisticated. See the
+user-manual for a
+brief explanation of all configuration options.
.PP
-A brief example of what a \fIdefault.action\fP configuration might look like:
+The actions list (ad blocks, etc) can also be configured with your
+web browser at http://ijbswa.sourceforge.net/config.
+\fBPrivoxy's\fR configuration parameters can also be viewed at
+the same page. In addition, \fBPrivoxy\fR can be toggled on/off.
+This is an internal page.
+.SH "SAMPLE CONFIGURATION"
.PP
-.nf
-
-# Define a few useful custom aliases for later use
-{{alias}}
+A brief example of what a simple \fIdefault.action\fR
+configuration might look like:
-# Don't accept cookies
-+no-cookies = +no-cookies-set +no-cookies-read
-
-# Do accept cookies
--no-cookies = -no-cookies-set -no-cookies-read
+.nf
+ # Define a few useful custom aliases for later use
+ {{alias}}
-# Treat these blocked URLs as images.
-+imageblock = +block +image
+ # Useful aliases
+ +prevent-cookies = +prevent-setting-cookies +prevent-reading-cookies
+ -prevent-cookies = -prevent-setting-cookies -prevent-reading-cookies
+ +imageblock = +block +handle-as-image
-# Define page filters we want to use.
-myfilters = +filter{html-annoyances} +filter{js-annoyances}\\
- +filter{no-popups} +filter{webbugs}
+ # Fragile sites should have the minimum changes
+ fragile = -block -deanimate-gifs -fast-redirects -filter \\
+ -hide-referer -prevent-cookies -kill-popups
-## Default Policies (actions) ############################
-{ \\
+ ## Turn some actions on ################################
+ { \\
+ -add-header \\
-block \\
- -downgrade \\
- +fast-redirects \\
- myfilters \\
- +no-compression \\
- +hide-forwarded \\
- +hide-from{block} \\
- +hide-referer{forge} \\
+ +deanimate-gifs{last} \\
+ -downgrade-http-version \\
+ -fast-redirects \\
+ +filter{html-annoyances} \\
+ +filter{js-annoyances} \\
+ +filter{content-cookies} \\
+ +filter{webbugs} \\
+ +filter{banners-by-size} \\
+ +hide-forwarded-for-headers \\
+ +hide-from-header{block} \\
+ +hide-referrer{forge} \\
-hide-user-agent \\
- -image \\
- +image-blocker{blank} \\
- +no-cookies-keep \\
- -no-cookies-read \\
- -no-cookies-set \\
- +no-popups \\
- -vanilla-wafer \\
- -wafer \\
-}
-/
-
-# Now set exceptions to the above defined policies #######
-
-# Sites where we want persistant cookies
-{-no-cookies -no-cookies-keep}
- .redhat.com
- .sun.com
- .yahoo.com
- .msdn.microsoft.com
-
-# This site requires cookies AND 'fast-redirects' on
-{-no-cookies -no-cookies-keep -fast-redirects}
- .nytimes.com
+ -handle-as-image \\
+ +set-image-blocker{pattern} \\
+ -limit-connect \\
+ +prevent-compression \\
+ +session-cookies-only \\
+ +prevent-reading-cookies \\
+ +prevent-setting-cookies \\
+ -kill-popups \\
+ }
+ / # Match all URLs
+
+ # Block, and treat these URL patterns as if they were 'images'.
+ {+imageblock}
+ .ad.doubleclick.net
+ .a[0-9].yimg.com/(?:(?!/i/).)*$
+ ad.*.doubleclick.net
-# Add custom headers, and turn off filtering of page source
-{+add-header{X-Privacy: Yes please} #-add-header{*} \\
- +add-header{X-User-Tracking: No thanks!} -filter}
- privacy.net
+ # Block any URLs that match these patterns
+ {+block}
+ ad*.
+ .*ads.
+ banner?.
+ /.*count(er)?\\.(pl|cgi|exe|dll|asp|php[34]?)
+ /(?:.*/)?(publicite|werbung|rekla(ma|me|am)|maino(kset|nta|s)?)/
+ .hitbox.com
-# Block, and treat these URLs as 'images'.
-{+imageblock}
- .adforce.imgis.com
- .ad.preferences.com/image.*
- .ads.web.aol.com
- .ad-adex3.flycast.com
- .ad.doubleclick.net
- .ln.doubleclick.net
- .ad.de.doubleclick.net
- /.*/count\\.cgi\\?.*df=
- 194.221.183.22[1-7]
- a196.g.akamai.net/7/196/2670/000[12]/images.gmx.net/i4/images/.*/
+ # Make exceptions for these harmless ones that would be
+ # caught by +block above.
+ {-block}
+ adsl.
+ advice.
+ .*downloads.
+.fi
+.PP
+Then for a \fIuser.action\fR, we would put local,
+narrowly defined exceptions:
-# Block any URLs that match these patterns
-{+block}
- /.*/(.*[-_.])?ads?[0-9]?(/|[-_.].*|\\.(gif|jpe?g))
- /.*/(plain|live|rotate)[-_.]?ads?/
- /.*/(sponsor)s?[0-9]?/
- /.*/ad(server|stream|juggler)\\.(cgi|pl|dll|exe)
- /.*/adbanners/
- /.*/adv((er)?ts?|ertis(ing|ements?))?/
- /.*/banners?/
- /.*/popupads/
- /.*/advert[0-9]+\\.jpg
- /ad_images/
- /.*/ads/
- /images/.*/.*_anim\\.gif
- /rotations/
- /.*(ms)?backoff(ice)?.*\\.(gif|jpe?g)
- 195.63.104.*/(inbox|log|meld|folderlu|folderru|log(in|out)[lmr]u|)
- .images.nytimes.com
- .images.yahoo.com/adv/
- /.*cnnstore\\.gif
+.nf
+ # Set personal exceptions to the policies in default.action #######
+ # Sites where we want persistant cookies
+ {-prevent-reading-cookies -prevent-setting-cookies -session-cookies-only}
+ .redhat.com
+ .sun.com
+ .msdn.microsoft.com
+
+ {-block -fast-redirects}
+ .forbes.com
.fi
-.sp
.PP
-See the comments in the configuration files themselves, or the user-manual
-for explanations of the above syntax, and other \fBPrivoxy\fP configuration
-options.
-
+See the comments in the configuration files themselves, or the
+\fIuser-manual\fR
+for explanations of the above syntax, and other \fBPrivoxy\fR
+configuration options.
.SH "FILES"
-\fI/usr/sbin/privoxy\fP
-.br
-\fI/etc/privoxy/config\fP
-.br
-\fI/etc/privoxy/default.action\fP
-.br
-\fI/etc/privoxy/advanced.action\fP
-.br
-\fI/etc/privoxy/basic.action\fP
-.br
-\fI/etc/privoxy/intermediate.action\fP
-.br
-\fI/etc/privoxy/default.filter\fP
-.br
-\fI/etc/privoxy/trust\fP
-.br
-\fI/etc/privoxy/templates/*\fP
-.br
-\fI/var/log/privoxy/logfile\fP
+.nf
+
+ \fI/usr/sbin/privoxy\fR
+ \fI/etc/privoxy/config\fR
+ \fI/etc/privoxy/default.action\fR
+ \fI/etc/privoxy/standard.action\fR
+ \fI/etc/privoxy/user.action\fR
+ \fI/etc/privoxy/default.filter\fR
+ \fI/etc/privoxy/trust\fR
+ \fI/etc/privoxy/templates/*\fR
+ \fI/var/log/privoxy/logfile\fR
+.fi
.PP
-Various other files should be included, but may vary depending on platform
+Various other files should be included, but may vary depending on platform
and build configuration. More documentation should be included in the local
documentation directory, though is not complete at this time.
-
-.SH SIGNALS
-\fBPrivoxy\fP terminates on the \fBSIGINT\fP, \fBSIGTERM\fP and \fBSIGABRT\fP
-signals. Log rotation scripts may cause a re-opening of the logfile by sending
-a \fBSIGHUP\fP to \fBPrivoxy\fP. Note that unlike other daemons, \fBPrivoxy\fP
-does not need to be made aware of config file changes by \fBSIGHUP\fP -- it will
-detect them automatically.
-
-.SH NOTES
-This is a \fBBETA\fP version of \fBPrivoxy\fP. Not all features are
-well tested.
+.SH "SIGNALS"
+.PP
+\fBPrivoxy\fR terminates on the \fBSIGINT\fR,
+\fBSIGTERM\fR and \fBSIGABRT\fR signals. Log
+rotation scripts may cause a re-opening of the logfile by sending a
+\fBSIGHUP\fR to \fBPrivoxy\fR. Note that unlike
+other daemons, \fBPrivoxy\fR does not need to be made aware of
+config file changes by \fBSIGHUP\fR -- it will detect them
+automatically.
+.SH "NOTES"
+.PP
+This is a beta version of \fBPrivoxy\fR. Not
+all features are well tested.
+.PP
+Please see the \fIuser-manual\fR on how to contact the
+developers for feature requests, reporting problems, and other questions.
+.SH "SEE ALSO"
.PP
-Please see the user-maual on how to contact the developers for
-feature requests, reporting problems, and other questions.
+Other references and sites of interest to \fBPrivoxy\fR
+users:
+.PP
+
+http://www.privoxy.org/,
+The \fBPrivoxy\fR Home page.
+
+http://sourceforge.net/projects/ijbswa,
+the Project Page for \fBPrivoxy\fR on
+Sourceforge.
+
+http://p.p/, access
+\fBPrivoxy\fR from your browser. Alternately,
+http://config.privoxy.org
+may work in some situations where the first does not.
-.SH BUGS
-Probably. Please see the user-manual for how and where to report bugs.
+http://p.p/ to submit ``misses'' to the developers.
+
+http://www.junkbusters.com/ht/en/cookies.html
+
+http://www.waldherr.org/junkbuster/
-.SH SEE ALSO
-.br
-http://www.privoxy.org/faq/
-.br
-http://www.privoxy.org/user-manual/
-.br
-http://www.privoxy.org/developer-manual/
-.br
-http://www.privoxy.org/config
-.br
-http://www.privoxy.org/
-.br
-http://sourceforge.net/projects/ijbswa (Privoxy Project Page)
-.br
-http://www.waldherr.org/junkbuster/\" waldherr.org#
-.br
-http://www.junkbusters.com/ht/en/cookies.html\" cookies.html#
-.br
http://privacy.net/analyze/
-.br
+
http://www.squid-cache.org/
-.br
-http://linuxalpha.ch/steudten/software/
+.SH "DEVELOPMENT TEAM"
-.SH DEVELOPMENT TEAM
-.br
- Stefan Waldherr
-.br
- Andreas Oesterhelt
-.br
- Jon Foster
-.br
- Markus Breitenbach
-.br
+.nf
+ Jon Foster
+ Andreas Oesterhelt
+ Stefan Waldherr
Thomas Steudten
-.br
- David Schmidt
-.br
+ Rodney Stromlund
+ Rodrigo Barbosa (RPM specfiles)
+ Hal Burgiss (docs)
+ Alexander Lazic
+ Gábor Lipták
+ Guy
Haroon Rafique
-.br
+ David Schmidt (OS/2, Mac OSX ports)
Joerg Strohmayer
-.br
- Shamim Mohamed
-.br
Sarantis Paskalis
-.br
- Gabriel L. Somlo
-.br
- John Venvertloh
-.br
- Hal Burgiss
-.br
- Rodrigo Barbosa
-
-.SH COPYRIGHT AND LICENSE
-\"Orginally written by, and copyrighted by, the Anonymous Coders and Junkbusters
-\"Corporation.
-\".PP
-This program is free software; you can redistribute it and/or modify
-it under the terms of the GNU General Public License as published by
-the Free Software Foundation; either version 2 of the License, or
-(at your option) any later version.
+.fi
+.SH "COPYRIGHT AND LICENSE"
+.SS "COPYRIGHT"
.PP
-This program is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-GNU General Public License for more details.
+Permission is granted to copy, distribute and/or modify this document under
+the terms of the \fIGNU Free
+Documentation License\fR, Version 1.1 or any later version
+published by the Free Software Foundation with no Invariant Sections, no
+Front-Cover Texts, and no Back-Cover Texts. A copy of the license can be
+found http://www.gnu.org/licenses/fdl.html.
+.SS "LICENSE"
.PP
-You should have received a copy of the GNU General Public License
-along with this program; if not, write to the Free Software
-Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+\fBPrivoxy\fR is free software; you can
+redistribute it and/or modify it under the terms of the GNU General Public
+License as published by the Free Software Foundation; either version 2 of the
+License, or (at your option) any later version.
+.PP
+This program is distributed in the hope that it will be useful, but WITHOUT
+ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
+more details, which is available from the Free Software Foundation, Inc, 59
+Temple Place - Suite 330, Boston, MA 02111-1307, USA.
.PP
-Internet Junkbuster
-Proxy
-is a
-trademark \" legal.html#marks
-of Junkbusters Corporation.
+You should have received a copy of the GNU General Public License
+along with this program; if not, write to the Free Software Foundation, Inc.,
+59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
projects / privoxy.git / blobdiff