X-Git-Url: http://www.privoxy.org/gitweb/?p=privoxy.git;a=blobdiff_plain;f=privoxy.1;h=6081581cba994deffde87d35b7a4c45db1da7b53;hp=19cc5e26ac371e0198a53726c2b99c352492c03a;hb=e56d26413b7b73cae45e39d934d655d67865ee4e;hpb=8459f40f646d1503eac7600aa352c42227903655 diff --git a/privoxy.1 b/privoxy.1 index 19cc5e26..6081581c 100644 --- a/privoxy.1 +++ b/privoxy.1 @@ -3,15 +3,12 @@ .\" .\" 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" "19 January 2008" "Privoxy 3.0.8" "" .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 @@ -31,7 +28,7 @@ leader, don't detach from controlling tty, and do all logging there. \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 +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. .TP \fB--user \fIuser[.group]\fB\fR @@ -41,41 +38,65 @@ After (optionally) writing the PID file, assume the user ID of \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, managing HTTP +cookies, +controlling access, and removing ads, banners, pop-ups and other obnoxious +Internet junk. Privoxy has a flexible configuration and can be +customized to suit individual needs and tastes. Privoxy has application for +both stand-alone systems and multi-user networks. .PP -\fBPrivoxy\fR is based on \fBInternet -Junkbuster\fR (tm). +Privoxy is based on Internet Junkbuster (tm). .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; +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 Netscape and Mozilla, go through: \fBEdit\fR; \fBPreferences\fR; \fBAdvanced\fR; \fBProxies\fR; \fBManual Proxy Configuration\fR; \fBView\fR. .PP +For 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" @@ -85,23 +106,29 @@ 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 +\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. On Windows, OS/2 and AmigaOS, -these files are in the same directory as the \fBPrivoxy\fR -executable. +\fI/etc/privoxy/\fR by default. .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. +\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. +This is an internal page, and does not require Internet access. +.PP +See the \fIUser Manual\fR for a detailed +explanation of installation, general usage, all configuration options, new +features and notes on upgrading. .SH "SAMPLE CONFIGURATION" .PP A brief example of what a simple \fIdefault.action\fR @@ -111,62 +138,62 @@ configuration might look like: # Define a few useful custom aliases for later use {{alias}} - # Useful aliases + # Useful aliases that combine more than one action +crunch-cookies = +crunch-incoming-cookies +crunch-outgoing-cookies -crunch-cookies = -crunch-incoming-cookies -crunch-outgoing-cookies - +imageblock = +block +handle-as-image + +block-as-image = +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 + ## NOTE: Actions are off by default, unless explictily turned on + ## otherwise with the '+' operator. + +{ \\ ++deanimate-gifs{last} \\ ++filter{refresh-tags} \\ ++filter{img-reorder} \\ ++filter{banners-by-size} \\ ++filter{webbugs} \\ ++filter{jumping-windows} \\ ++filter{ie-exploits} \\ ++hide-forwarded-for-headers \\ ++hide-from-header{block} \\ ++hide-referrer{conditional-block} \\ ++session-cookies-only \\ ++set-image-blocker{pattern} \\ +} +/ # '/' Match *all* URL patterns + + # Block all URLs that match these patterns + { +block } + ad. + ad[sv]. + .*ads. + banner?. + /.*count(er)?\\.(pl|cgi|exe|dll|asp|php[34]?) + .hitbox.com + media./.*(ads|banner) + # Block, and treat these URL patterns as if they were 'images'. # We would expect these to be ads. - {+imageblock} + { +block-as-image } .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} + { -block } adsl. + adobe. advice. .*downloads. + # uploads or downloads + /.*loads .fi .PP Then for a \fIuser.action\fR, we would put local, @@ -181,20 +208,25 @@ narrowly defined exceptions: # Set personal exceptions to the policies in default.action ####### - # Sites where we want persistant cookies, so allow *all* cookies - {-crunch-cookies -session-cookies-only} + # Sites where we want persistent cookies, so allow *all* cookies + { -crunch-cookies -session-cookies-only } .redhat.com .sun.com .msdn.microsoft.com - # This site breaks easily. - {-block -fast-redirects} + # These sites break easily. Use our "fragile" alias here. + { fragile } .forbes.com + mybank.example.com + + # Replace example.com's style sheet with one of my choosing + { +redirect{http://localhost/css-replacements/example.com.css} } + .example.com/stylesheet.css .fi .PP See the comments in the configuration files themselves, or the -\fIuser-manual\fR -for explanations of the above syntax, and other \fBPrivoxy\fR +\fIUser Manual\fR +for full explanations of the above syntax, and other \fBPrivoxy\fR configuration options. .SH "FILES" @@ -206,13 +238,14 @@ configuration options. \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 +258,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 +267,60 @@ users: .PP http://www.privoxy.org/, -The \fBPrivoxy\fR Home page. +the \fBPrivoxy\fR Home page. + +http://www.privoxy.org/faq/, +the \fBPrivoxy\fR FAQ. -http://sourceforge.net/projects/ijbswa, +http://sourceforge.net/projects/ijbswa/, the Project Page for \fBPrivoxy\fR on -Sourceforge. +SourceForge. + +http://config.privoxy.org/, +the web-based user interface. \fBPrivoxy\fR must be +running for this to work. Shortcut: http://p.p/ -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://sourceforge.net/tracker/?group_id=11118&atid=460288, to submit ``misses'' and other +configuration related suggestions to the developers. -http://p.p/ to submit ``misses'' to the developers. +http://www.junkbusters.com/ht/en/cookies.html, +an explanation how cookies are used to track web users. -http://www.junkbusters.com/ht/en/cookies.html +http://www.junkbusters.com/ijb.html, +the original Internet Junkbuster. -http://www.waldherr.org/junkbuster/ +http://privacy.net/, a useful site +to check what information about you is leaked while you browse the web. -http://privacy.net/analyze/ +http://www.squid-cache.org/, a popular +caching proxy, which is often used together with \fBPrivoxy\fR. -http://www.squid-cache.org/ +http://www.pps.jussieu.fr/~jch/software/polipo/, +\fBPolipo\fR is a caching proxy with advanced features +like pipelining, multiplexing and caching of partial instances. In many setups +it can be used as \fBSquid\fR replacement. + +http://tor.eff.org/, +\fBTor\fR can help anonymize web browsing, +web publishing, instant messaging, IRC, SSH, and other applications. + +http://www.privoxy.org/developer-manual/, +the \fBPrivoxy\fR developer manual. .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 + Gerry Murphy + Roland Rosenfeld + Jörg Strohmayer .fi .SH "COPYRIGHT AND LICENSE" .SS "COPYRIGHT" .PP -Copyright (C) 2001, 2002 by Privoxy Developers +Copyright (C) 2001-2008 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 @@ -294,11 +336,11 @@ 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. +more details, which is available from the Free Software Foundation, Inc, +51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA .PP You should have received a copy of the \fIGNU General Public License\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