1 .\" This manpage has been automatically generated by docbook2man
2 .\" from a DocBook document. This tool can be found at:
3 .\" <http://shell.ipoline.com/~elmert/comp/docbook2X/>
4 .\" Please send any bug reports, improvements, comments, patches,
5 .\" etc. to Steve Cheng <steve@ggi-project.org>.
6 .TH "PRIVOXY" "1" "24 April 2002" "Privoxy 2.9.14 beta" ""
8 privoxy \- Privacy Enhancing Proxy
11 \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
14 \fBprivoxy.exe\fR [\fB\fIconfigfile\fB\fR] \fB(Windows)\fR
18 \fBPrivoxy\fR may be invoked with the following command line
22 Print brief usage info and exit.
25 Print version info and exit.
28 Don't become a daemon, i.e. don't fork and become process group
29 leader, don't detach from controlling tty, and do all logging there.
31 \fB--pidfile \fIpidfile\fB\fR
32 On startup, write the process ID to \fIpidfile\fR.
33 Delete the \fIpidfile\fR on exit.
34 Failiure to create or delete the \fIpidfile\fR
35 is non-fatal. If no \fB--pidfile\fR option is given, no PID file will be used.
37 \fB--user \fIuser[.group]\fB\fR
38 After (optionally) writing the PID file, assume the user ID of
39 \fIuser\fR and the GID of
40 \fIgroup\fR, or, if the optional
41 \fIgroup\fR was not given, the default group of
42 \fIuser\fR. Exit if the privileges are not
45 If the \fIconfigfile\fR is not specified on the command line,
46 \fBPrivoxy\fR will look for a file named
47 \fIconfig\fR in the current directory (except on Win32 where
48 it will try \fIconfig.txt\fR). If no
49 \fIconfigfile\fR is found, \fBPrivoxy\fR will
53 \fBPrivoxy\fR is a web proxy with advanced filtering
54 capabilities for protecting privacy, filtering web page content, managing
55 cookies, controlling access, and removing ads, banners, pop-ups and other
56 obnoxious Internet junk. \fBPrivoxy\fR has a very
57 flexible configuration and can be customized to suit individual needs and
58 tastes. \fBPrivoxy\fR has application for both
59 stand-alone systems and multi-user networks.
61 \fBPrivoxy\fR is based on \fBInternet
63 .SH "INSTALLATION AND USAGE"
65 Browsers must be individually configured to use \fBPrivoxy\fR as
66 a HTTP proxy. The default setting is for localhost, on port 8118
67 (configurable in the main config file). To set the HTTP proxy in Netscape
68 and Mozilla, go through: \fBEdit\fR;
69 \fBPreferences\fR; \fBAdvanced\fR;
70 \fBProxies\fR; \fBManual Proxy Configuration\fR;
73 For Internet Explorer, go through: \fBTools\fR;
74 \fBInternet Properties\fR; \fBConnections\fR;
77 The Secure (SSL) Proxy should also be set to the same values, otherwise
78 https: URLs will not be proxied.
80 For other browsers, check the documentation.
83 \fBPrivoxy\fR can be configured with the various configuration
84 files. The default configuration files are: \fIconfig\fR,
85 \fIdefault.action\fR, and
86 \fIdefault.filter\fR. These are well commented. On Unix and
87 Unix-like systems, these are located in \fI/etc/privoxy/\fR by
88 default. On Windows, OS/2 and AmigaOS, these files are in the same directory
89 as the \fBPrivoxy\fR executable.
91 The name and number of configuration files has changed from previous
92 versions, and is subject to change as development progresses. In fact, the
93 configuration itself is changed and much more sophisticated. See the
95 brief explanation of all configuration options.
97 The actions list (ad blocks, etc) can also be configured with your
98 web browser at http://ijbswa.sourceforge.net/config.
99 \fBPrivoxy's\fR configuration parameters can also be viewed at
100 the same page. In addition, \fBPrivoxy\fR can be toggled on/off.
101 This is an internal page.
102 .SH "SAMPLE CONFIGURATION"
104 A brief example of what a \fIdefault.action\fR configuration
109 # Define a few useful custom aliases for later use
113 +prevent-cookies = +prevent-setting-cookies +prevent-reading-cookies
114 -prevent-cookies = -prevent-setting-cookies -prevent-reading-cookies
115 +imageblock = +block +handle-as-image
117 # Fragile sites should have the minimum changes
118 fragile = -block -deanimate-gifs -fast-redirects -filter \\
119 -hide-referer -prevent-cookies -kill-popups
121 # Shops should be allowed to set persistent cookies
122 shop = -filter -prevent-cookies -prevent-keeping-cookies
124 # Your favourite blend of filters:
126 myfilters = +filter{html-annoyances} +filter{js-annoyances} \\
127 +filter{popups} +filter{webbugs} +filter{banners-by-size}
129 ## Default Policies (actions) ############################
133 +deanimate-gifs{last} \\
134 -downgrade-http-version \\
136 +filter{html-annoyances} \\
137 +filter{js-annoyances} \\
138 +filter{content-cookies} \\
141 +filter{refresh-tags} \\
144 +filter{banners-by-size} \\
145 -filter{shockwave-flash} \\
146 -filter{crude-prental} \\
147 +hide-forwarded-for-headers \\
148 +hide-from-header{block} \\
149 +hide-referrer{forge} \\
152 +set-image-blocker{pattern} \\
154 +prevent-compression \\
155 +session-cookies-only \\
156 +prevent-reading-cookies \\
157 +prevent-setting-cookies \\
159 -send-vanilla-wafer \\
163 # Now set exceptions to the above defined policies #######
165 # Sites where we want persistant cookies
166 {-prevent-reading-cookies -prevent-setting-cookies}
172 # This site requires cookies AND 'fast-redirects' on
173 {-prevent-reading-cookies -prevent-setting-cookies -fast-redirects}
176 # Add custom headers, and turn off filtering of page source
177 {+add-header{X-Privacy: Yes please} #-add-header{*} \\
178 +add-header{X-User-Tracking: No thanks!} -filter}
181 # Block, and treat these URLs as 'images'.
185 .a.yimg.com/(?:(?!/i/).)*$
186 .a[0-9].yimg.com/(?:(?!/i/).)*$
192 # Block any URLs that match these patterns
198 /(?:.*/)?(ads(erver?|tream)?|.*?ads|adv(ert(s|enties|is(ing|e?ments)?)?)?|(ad)?[-_]?banner(s|ads?|farm)?)/
199 /.*count(er)?\\.(pl|cgi|exe|dll|asp|php[34]?)
200 /(?:.*/)?(publicite|werbung|rekla(ma|me|am)|annonse|maino(kset|nta|s)?)/
203 # Make exceptions for these harmless ones that would be
215 See the comments in the configuration files themselves, or the
217 for explanations of the above syntax, and other \fBPrivoxy\fR
218 configuration options.
223 \fI/usr/sbin/privoxy\fR
224 \fI/etc/privoxy/config\fR
225 \fI/etc/privoxy/default.action\fR
226 \fI/etc/privoxy/standard.action\fR
227 \fI/etc/privoxy/user.action\fR
228 \fI/etc/privoxy/default.filter\fR
229 \fI/etc/privoxy/trust\fR
230 \fI/etc/privoxy/templates/*\fR
231 \fI/var/log/privoxy/logfile\fR
234 Various other files should be included, but may vary depending on platform
235 and build configuration. More documentation should be included in the local
236 documentation directory, though is not complete at this time.
239 \fBPrivoxy\fR terminates on the \fBSIGINT\fR,
240 \fBSIGTERM\fR and \fBSIGABRT\fR signals. Log
241 rotation scripts may cause a re-opening of the logfile by sending a
242 \fBSIGHUP\fR to \fBPrivoxy\fR. Note that unlike
243 other daemons, \fBPrivoxy\fR does not need to be made aware of
244 config file changes by \fBSIGHUP\fR -- it will detect them
248 This is a beta version of \fBPrivoxy\fR. Not
249 all features are well tested.
251 Please see the \fIuser-manual\fR on how to contact the
252 developers for feature requests, reporting problems, and other questions.
255 Other references and sites of interest to \fBPrivoxy\fR
259 http://www.privoxy.org/,
260 The \fBPrivoxy\fR Home page.
262 http://sourceforge.net/projects/ijbswa,
263 the Project Page for \fBPrivoxy\fR on
267 \fBPrivoxy\fR from your browser. Alternately,
268 http://config.privoxy.org
269 may work in some situations where the first does not.
272 to submit ``misses'' to the developers.
274 http://www.junkbusters.com/ht/en/cookies.html
276 http://www.waldherr.org/junkbuster/
278 http://privacy.net/analyze/
280 http://www.squid-cache.org/
281 .SH "DEVELOPMENT TEAM"
289 Rodrigo Barbosa (RPM specfiles)
295 David Schmidt (OS/2, Mac OSX ports)
299 .SH "COPYRIGHT AND LICENSE"
301 \fBPrivoxy\fR is free software; you can
302 redistribute it and/or modify it under the terms of the GNU General Public
303 License as published by the Free Software Foundation; either version 2 of the
304 License, or (at your option) any later version.
306 This program is distributed in the hope that it will be useful, but WITHOUT
307 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
308 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
309 more details, which is available from the Free Software Foundation, Inc, 59
310 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
312 You should have received a copy of the GNU General Public License
313 along with this program; if not, write to the Free Software Foundation, Inc.,
314 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.