X-Git-Url: http://www.privoxy.org/gitweb/?p=privoxy.git;a=blobdiff_plain;f=privoxy.1;h=dca772a57abf31579c24932f785e20bcafb0291e;hp=d324c066aab23628d41e648d54d17c2467e262ce;hb=e8db07c2f0720685bb504013a6a1e576b0cf718f;hpb=012f9dbd22ecc66d631a469406100ed90ee80f53
diff --git a/privoxy.1 b/privoxy.1
index d324c066..dca772a5 100644
--- a/privoxy.1
+++ b/privoxy.1
@@ -3,216 +3,141 @@
.\"
.\" Please send any bug reports, improvements, comments, patches,
.\" etc. to Steve Cheng .
-.TH "PRIVOXY" "1" "14 May 2002" "Privoxy 2.9.15 beta" ""
+.TH "PRIVOXY" "1" "21 March 2009" "Privoxy 3.0.12" ""
.SH NAME
privoxy \- Privacy Enhancing Proxy
.SH SYNOPSIS
-\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
+\fBprivoxy\fR [\fB\-\-help\fR ] [\fB\-\-version\fR ] [\fB\-\-no-daemon\fR ] [\fB\-\-pidfile \fIpidfile\fB\fR ] [\fB\-\-user \fIuser[.group]\fB\fR ] [\fB\-\-chroot\fR ] [\fB\-\-pre-chroot-nslookup \fIhostname\fB\fR ] [\fB\fIconfigfile\fB\fR ]
.SH "OPTIONS"
.PP
\fBPrivoxy\fR may be invoked with the following command line
options:
.TP
-\fB--help\fR
+\fB\-\-help\fR
Print brief usage info and exit.
.TP
-\fB--version\fR
+\fB\-\-version\fR
Print version info and exit.
.TP
-\fB--no-daemon\fR
+\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 \fIpidfile\fB\fR
+\fB\-\-pidfile \fIpidfile\fB\fR
On startup, write the process ID to \fIpidfile\fR.
Delete the \fIpidfile\fR on exit.
Failure to create or delete the \fIpidfile\fR
-is non-fatal. If no \fB--pidfile\fR option is given, no PID file will be used.
+is non-fatal. If no \fB\-\-pidfile\fR option is given, no PID file will be used.
.TP
-\fB--user \fIuser[.group]\fB\fR
+\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.
+.TP
+\fB\-\-chroot\fR
+Before changing to the user ID given in the \-\-user option, chroot to
+that user's home directory, i.e. make the kernel pretend to the
+\fBPrivoxy\fR process that the directory tree starts
+there. If set up carefully, this can limit the impact of possible
+vulnerabilities in \fBPrivoxy\fR to the files contained in
+that hierarchy.
+.TP
+\fB\-\-pre-chroot-nslookup \fIhostname\fB\fR
+Initialize the resolver library using \fIhostname\fR
+before chroot'ing. On some systems this reduces the number of files
+that must be copied into the chroot tree.
.PP
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
+\fIconfig\fR in the current directory. If no
\fIconfigfile\fR is found, \fBPrivoxy\fR will
fail to start.
.SH "DESCRIPTION"
.PP
-\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.
+Privoxy is a non-caching web proxy with advanced filtering capabilities
+for enhancing privacy, modifying web page data and HTTP headers, controlling
+access, and removing ads and other obnoxious Internet junk. Privoxy has a
+flexible configuration and can be customized to suit individual needs and tastes.
+It has application for both stand-alone systems and multi-user networks.
.PP
-\fBPrivoxy\fR is based on \fBInternet
-Junkbuster\fR (tm).
+Privoxy is Free Software and licensed under the GPL2.
.SH "INSTALLATION AND USAGE"
.PP
-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.
+Browsers can either be individually configured to use
+\fBPrivoxy\fR as a HTTP proxy (recommended),
+or \fBPrivoxy\fR can be combined with a packet
+filter to build an intercepting proxy
+(see \fIconfig\fR). The default setting is for
+localhost, on port 8118 (configurable in the main config file). To set the
+HTTP proxy in Firefox, go through: \fBTools\fR;
+\fBOptions\fR; \fBGeneral\fR;
+\fBConnection Settings\fR;
+\fBManual Proxy Configuration\fR.
.PP
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.
+https: URLs will not be proxied. Note: \fBPrivoxy\fR can only
+proxy HTTP and HTTPS traffic. Do not try it with FTP or other protocols.
+HTTPS presents some limitations, and not all features will work with HTTPS
+connections.
.PP
For other browsers, check the documentation.
.SH "CONFIGURATION"
.PP
\fBPrivoxy\fR can be configured with the various configuration
files. The default configuration files are: \fIconfig\fR,
-\fIdefault.filter\fR, and
+\fIdefault.filter\fR, \fIdefault.action\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 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
-complete explanation of all configuration options and general usage.
+be used for locally defined exceptions to the default rules in
+\fImatch-all.action\fR and \fIdefault.action\fR,
+and \fIuser.filter\fR for locally defined filters. These are
+well commented. On Unix and Unix-like systems, these are located in
+\fI/etc/privoxy/\fR by default.
+.PP
+\fBPrivoxy\fR uses the concept of \fBactions\fR
+in order to manipulate the data stream between the browser and remote sites.
+There are various actions available with specific functions for such things
+as blocking web sites, managing cookies, etc. These actions can be invoked
+individually or combined, and used against individual URLs, or groups of URLs
+that can be defined using wildcards and regular expressions. The result is
+that the user has greatly enhanced control and freedom.
.PP
The actions list (ad blocks, etc) can also be configured with your
-web browser at http://config.privoxy.org/.
+web browser at http://config.privoxy.org/
+(assuming the configuration allows it).
\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
-A brief example of what a simple \fIdefault.action\fR
-configuration might look like:
-
-.nf
- # Define a few useful custom aliases for later use
- {{alias}}
-
- # Useful aliases
- +crunch-cookies = +crunch-incoming-cookies +crunch-outgoing-cookies
- -crunch-cookies = -crunch-incoming-cookies -crunch-outgoing-cookies
- +imageblock = +block +handle-as-image
-
- # Fragile sites should have the minimum changes
- fragile = -block -deanimate-gifs -fast-redirects -filter \\
- -hide-referer -prevent-cookies -kill-popups
-
- ## Turn some actions on ################################
- { \\
- -add-header \\
- -block \\
- +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 \\
- -handle-as-image \\
- +set-image-blocker{pattern} \\
- -limit-connect \\
- +prevent-compression \\
- +session-cookies-only \\
- -crunch-cookies \\
- -kill-popups \\
- }
- / # '/' Matches *all* URL patterns
-
- # Block, and treat these URL patterns as if they were 'images'.
- # We would expect these to be ads.
- {+imageblock}
- .ad.doubleclick.net
- .a[0-9].yimg.com/(?:(?!/i/).)*$
- ad.*.doubleclick.net
-
- # Block any URLs that match these patterns
- {+block}
- ad*.
- .*ads.
- banner?.
- /.*count(er)?\\.(pl|cgi|exe|dll|asp|php[34]?)
- .hitbox.com
-
- # Make exceptions for these harmless ones that would be
- # caught by our +block patterns just above.
- {-block}
- adsl.
- advice.
- .*downloads.
-.fi
-.PP
-Then for a \fIuser.action\fR, we would put local,
-narrowly defined exceptions:
-
-.nf
- # Re-define aliases as needed here
- {{alias}}
-
- # Useful aliases
- -crunch-cookies = -crunch-incoming-cookies -crunch-outgoing-cookies
-
- # Set personal exceptions to the policies in default.action #######
-
- # Sites where we want persistant cookies, so allow *all* cookies
- {-crunch-cookies -session-cookies-only}
- .redhat.com
- .sun.com
- .msdn.microsoft.com
-
- # This site breaks easily.
- {-block -fast-redirects}
- .forbes.com
-.fi
+This is an internal page, and does not require Internet access.
.PP
-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.
+See the \fIUser Manual\fR for a detailed
+explanation of installation, general usage, all configuration options, new
+features and notes on upgrading.
.SH "FILES"
.nf
\fI/usr/sbin/privoxy\fR
\fI/etc/privoxy/config\fR
+ \fI/etc/privoxy/match-all.action\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/user.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
-and build configuration. More documentation should be included in the local
+and build configuration. Additional documentation should be included in the local
documentation directory.
.SH "SIGNALS"
.PP
@@ -225,11 +150,8 @@ 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.
+Please see the \fIUser Manual\fR on how to contact the
+developers, for feature requests, reporting problems, and other questions.
.SH "SEE ALSO"
.PP
Other references and sites of interest to \fBPrivoxy\fR
@@ -237,48 +159,41 @@ users:
.PP
http://www.privoxy.org/,
-The \fBPrivoxy\fR Home page.
+the \fBPrivoxy\fR Home page.
-http://sourceforge.net/projects/ijbswa,
-the Project Page for \fBPrivoxy\fR on
-Sourceforge.
+http://www.privoxy.org/faq/,
+the \fBPrivoxy\fR FAQ.
-http://p.p/, access
-\fBPrivoxy\fR from your browser. Alternately,
-http://config.privoxy.org
-may work in some situations where the first does not.
+http://www.privoxy.org/developer-manual/,
+the \fBPrivoxy\fR developer manual.
-http://p.p/ to submit ``misses'' to the developers.
-
-http://www.junkbusters.com/ht/en/cookies.html
-
-http://www.waldherr.org/junkbuster/
+https://sourceforge.net/projects/ijbswa/,
+the Project Page for \fBPrivoxy\fR on
+SourceForge.
-http://privacy.net/analyze/
+http://config.privoxy.org/,
+the web-based user interface. \fBPrivoxy\fR must be
+running for this to work. Shortcut: http://p.p/
-http://www.squid-cache.org/
+https://sourceforge.net/tracker/?group_id=11118&atid=460288, to submit ``misses'' and other
+configuration related suggestions to the developers.
.SH "DEVELOPMENT TEAM"
.nf
- Jon Foster
- Andreas Oesterhelt
- Stefan Waldherr
- Thomas Steudten
- Rodney Stromlund
- Rodrigo Barbosa (RPM specfiles)
- Hal Burgiss (docs)
- Alexander Lazic
- Gábor Lipták
- Guy
- Haroon Rafique
- David Schmidt (OS/2, Mac OSX ports)
- Joerg Strohmayer
- Sarantis Paskalis
+ Fabian Keil, lead developer
+ David Schmidt, developer
+
+ Hal Burgiss
+ Mark Miller
+ Gerry Murphy
+ Lee Rian
+ Roland Rosenfeld
+ J\[:o]rg Strohmayer
.fi
.SH "COPYRIGHT AND LICENSE"
.SS "COPYRIGHT"
.PP
-Copyright (C) 2001, 2002 by Privoxy Developers
+Copyright (C) 2001-2009 by Privoxy Developers
.PP
Some source code is based on code Copyright (C) 1997 by Anonymous Coders
and Junkbusters, Inc. and licensed under the \fIGNU General Public
@@ -287,18 +202,15 @@ License\fR.
.PP
\fBPrivoxy\fR is free software; you can
redistribute it and/or modify it under the terms of the
-\fIGNU General Public
-License\fR, version 2, as published by the Free Software Foundation.
+\fIGNU General Public License\fR, version 2,
+as published by the Free Software Foundation.
.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
-\fIGNU General Public License\fR for
-more details, which is available from the Free Software Foundation, Inc, 59
-Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+FITNESS FOR A PARTICULAR PURPOSE. See the \fIGNU General Public License\fR for details.
.PP
-You should have received a copy of the \fIGNU General Public License\fR
+You should have received a copy of the \fIGNU GPL\fR
along with this program; if not, write to the Free Software
-Foundation, Inc. 59 Temple Place - Suite 330
-Boston, MA 02111-1307
+Foundation, Inc. 51 Franklin Street, Fifth Floor
+Boston, MA 02110-1301
USA