X-Git-Url: http://www.privoxy.org/gitweb/?p=privoxy.git;a=blobdiff_plain;f=privoxy.1;h=0e7e306f04ab7077627b0b938c8587d9b0f5feb8;hp=4e07f716dbaa6aa744f19f52842ddeec8fc7f15f;hb=65252bdb46f1295b2691e13ed574d98f9d6dd2ed;hpb=3ace467d150a37f61fd3c5ff446d2dc21de4c5b7 diff --git a/privoxy.1 b/privoxy.1 index 4e07f716..0e7e306f 100644 --- a/privoxy.1 +++ b/privoxy.1 @@ -3,35 +3,35 @@ .\" .\" Please send any bug reports, improvements, comments, patches, .\" etc. to Steve Cheng . -.TH "PRIVOXY" "1" "07 December 2007" "Privoxy 3.0.7" "" +.TH "PRIVOXY" "1" "26 August 2011" "Privoxy 3.0.18 UNRELEASED" "" .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--chroot\fR ] [\fB--pre-chroot-nslookup \fIhostname\fB\fR ] [\fB\fIconfigfile\fB\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 @@ -39,37 +39,43 @@ After (optionally) writing the PID file, assume the user ID 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 +\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 +\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 . If no +\fIconfig\fR in the current directory. If no \fIconfigfile\fR is found, \fBPrivoxy\fR will fail to start. .SH "DESCRIPTION" .PP -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. +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 -Privoxy is based on Internet Junkbuster (tm). +Privoxy is Free Software and licensed under the GNU GPLv2. +.PP +Privoxy is an associated project of Software in the Public Interest (SPI). +.PP +Helping hands and donations are welcome: +.TP 0.2i +\(bu +http://www.privoxy.org/faq/general.html#PARTICIPATE +.TP 0.2i +\(bu +http://www.privoxy.org/faq/general.html#DONATE .SH "INSTALLATION AND USAGE" .PP Browsers can either be individually configured to use @@ -78,12 +84,7 @@ 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; +HTTP proxy in Firefox, go through: \fBTools\fR; \fBOptions\fR; \fBGeneral\fR; \fBConnection Settings\fR; \fBManual Proxy Configuration\fR. @@ -103,12 +104,12 @@ For other browsers, check the documentation. .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, and \fIuser.filter\fR for -locally defined filters. These are well commented. On Unix -and Unix-like systems, these are located in +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 @@ -129,113 +130,14 @@ This is an internal page, and does not require Internet access. 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 -configuration might look like: - -.nf - # Define a few useful custom aliases for later use - {{alias}} - - # Useful aliases that combine more than one action - +crunch-cookies = +crunch-incoming-cookies +crunch-outgoing-cookies - -crunch-cookies = -crunch-incoming-cookies -crunch-outgoing-cookies - +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 ################################ - ## 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. - { +block-as-image } - .ad.doubleclick.net - .a[0-9].yimg.com/(?:(?!/i/).)*$ - ad.*.doubleclick.net - - # Make exceptions for these harmless ones that would be - # caught by our +block patterns just above. - { -block } - adsl. - adobe. - advice. - .*downloads. - # uploads or downloads - /.*loads -.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 persistent cookies, so allow *all* cookies - { -crunch-cookies -session-cookies-only } - .redhat.com - .sun.com - .msdn.microsoft.com - - # 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 full explanations of the above syntax, and other \fBPrivoxy\fR -configuration options. .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 @@ -258,6 +160,9 @@ config file changes by \fBSIGHUP\fR -- it will detect them automatically. .SH "NOTES" .PP +This is a UNRELEASED 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" @@ -272,7 +177,10 @@ the \fBPrivoxy\fR Home page. http://www.privoxy.org/faq/, the \fBPrivoxy\fR FAQ. -http://sourceforge.net/projects/ijbswa/, +http://www.privoxy.org/developer-manual/, +the \fBPrivoxy\fR developer manual. + +https://sourceforge.net/projects/ijbswa/, the Project Page for \fBPrivoxy\fR on SourceForge. @@ -280,46 +188,24 @@ http://config.privoxy.org/, the web-based user interface. \fBPrivoxy\fR must be running for this to work. Shortcut: http://p.p/ -http://sourceforge.net/tracker/?group_id=11118&atid=460288, to submit ``misses'' and other +https://sourceforge.net/tracker/?group_id=11118&atid=460288, to submit ``misses'' and other configuration related suggestions 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/ijb.html, -the original Internet Junkbuster. - -http://privacy.net/, a useful site -to check what information about you is leaked while you browse the web. - -http://www.squid-cache.org/, a popular -caching proxy, which is often used together with \fBPrivoxy\fR. - -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 Fabian Keil, lead developer David Schmidt, developer - + Hal Burgiss + Mark Miller + Gerry Murphy + Lee Rian Roland Rosenfeld - Jörg Strohmayer .fi .SH "COPYRIGHT AND LICENSE" .SS "COPYRIGHT" .PP -Copyright (C) 2001-2007 by Privoxy Developers +Copyright (C) 2001-2011 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 @@ -328,17 +214,14 @@ 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, -51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, 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. 51 Franklin Street, Fifth Floor Boston, MA 02110-1301