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" "31 Januar 2004" "Privoxy 3.0.3" ""
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--chroot\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 Failure 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
46 Before changing to the user ID given in the --user option, chroot to
47 that user's home directory, i.e. make the kernel pretend to the
48 \fBPrivoxy\fR process that the directory tree starts
49 there. If set up carefully, this can limit the impact of possible
50 vulnerabilities in \fBPrivoxy\fR to the files contained in
53 If the \fIconfigfile\fR is not specified on the command line,
54 \fBPrivoxy\fR will look for a file named
55 \fIconfig\fR in the current directory (except on Win32 where
56 it will try \fIconfig.txt\fR). If no
57 \fIconfigfile\fR is found, \fBPrivoxy\fR will
61 \fBPrivoxy\fR is a web proxy with advanced filtering
62 capabilities for protecting privacy, modifying web page content, managing
63 cookies, controlling access, and removing ads, banners, pop-ups and other
64 obnoxious Internet junk. \fBPrivoxy\fR has a very
65 flexible configuration and can be customized to suit individual needs and
66 tastes. \fBPrivoxy\fR has application for both
67 stand-alone systems and multi-user networks.
69 \fBPrivoxy\fR is based on \fBInternet
71 .SH "INSTALLATION AND USAGE"
73 Browsers must be individually configured to use \fBPrivoxy\fR as
74 a HTTP proxy. The default setting is for localhost, on port 8118
75 (configurable in the main config file). To set the HTTP proxy in Netscape
76 and Mozilla, go through: \fBEdit\fR;
77 \fBPreferences\fR; \fBAdvanced\fR;
78 \fBProxies\fR; \fBManual Proxy Configuration\fR;
81 For Internet Explorer, go through: \fBTools\fR;
82 \fBInternet Properties\fR; \fBConnections\fR;
85 The Secure (SSL) Proxy should also be set to the same values, otherwise
86 https: URLs will not be proxied. Note: \fBPrivoxy\fR can only
87 proxy HTTP and HTTPS traffic. Do not try it with FTP or other protocols.
89 For other browsers, check the documentation.
92 \fBPrivoxy\fR can be configured with the various configuration
93 files. The default configuration files are: \fIconfig\fR,
94 \fIdefault.filter\fR, and
95 \fIdefault.action\fR. \fIuser.action\fR should
96 be used for locally defined exceptions to the default rules of
97 \fIdefault.action\fR These are all well commented. On Unix
98 and Unix-like systems, these are located in
99 \fI/etc/privoxy/\fR by default. On Windows, OS/2 and AmigaOS,
100 these files are in the same directory as the \fBPrivoxy\fR
103 The name and number of configuration files has changed from previous
104 versions. In fact, the configuration itself is changed and much more
105 sophisticated. See the user-manual for a complete
106 explanation of all configuration options and general usage, and notes for
107 upgrading from \fBJunkbuster\fR and earlier \fBPrivoxy\fR
110 The actions list (ad blocks, etc) can also be configured with your
111 web browser at http://config.privoxy.org/.
112 \fBPrivoxy's\fR configuration parameters can also be viewed at
113 the same page. In addition, \fBPrivoxy\fR can be toggled on/off.
114 This is an internal page, and does not require Internet access.
115 .SH "SAMPLE CONFIGURATION"
117 A brief example of what a simple \fIdefault.action\fR
118 configuration might look like:
121 # Define a few useful custom aliases for later use
125 +crunch-cookies = +crunch-incoming-cookies +crunch-outgoing-cookies
126 -crunch-cookies = -crunch-incoming-cookies -crunch-outgoing-cookies
127 +imageblock = +block +handle-as-image
129 # Fragile sites should have the minimum changes
130 fragile = -block -deanimate-gifs -fast-redirects -filter \\
131 -hide-referer -prevent-cookies -kill-popups
133 ## Turn some actions on ################################
137 +deanimate-gifs{last} \\
138 -downgrade-http-version \\
140 +filter{html-annoyances} \\
141 +filter{js-annoyances} \\
142 +filter{content-cookies} \\
144 +filter{banners-by-size} \\
145 +hide-forwarded-for-headers \\
146 +hide-from-header{block} \\
147 +hide-referrer{forge} \\
150 +set-image-blocker{pattern} \\
152 +prevent-compression \\
153 +session-cookies-only \\
157 / # '/' Matches *all* URL patterns
159 # Block, and treat these URL patterns as if they were 'images'.
160 # We would expect these to be ads.
163 .a[0-9].yimg.com/(?:(?!/i/).)*$
166 # Block any URLs that match these patterns
171 /.*count(er)?\\.(pl|cgi|exe|dll|asp|php[34]?)
174 # Make exceptions for these harmless ones that would be
175 # caught by our +block patterns just above.
182 Then for a \fIuser.action\fR, we would put local,
183 narrowly defined exceptions:
186 # Re-define aliases as needed here
190 -crunch-cookies = -crunch-incoming-cookies -crunch-outgoing-cookies
192 # Set personal exceptions to the policies in default.action #######
194 # Sites where we want persistant cookies, so allow *all* cookies
195 {-crunch-cookies -session-cookies-only}
200 # This site breaks easily.
201 {-block -fast-redirects}
205 See the comments in the configuration files themselves, or the
207 for explanations of the above syntax, and other \fBPrivoxy\fR
208 configuration options.
213 \fI/usr/sbin/privoxy\fR
214 \fI/etc/privoxy/config\fR
215 \fI/etc/privoxy/default.action\fR
216 \fI/etc/privoxy/standard.action\fR
217 \fI/etc/privoxy/user.action\fR
218 \fI/etc/privoxy/default.filter\fR
219 \fI/etc/privoxy/trust\fR
220 \fI/etc/privoxy/templates/*\fR
221 \fI/var/log/privoxy/logfile\fR
224 Various other files should be included, but may vary depending on platform
225 and build configuration. More documentation should be included in the local
226 documentation directory.
229 \fBPrivoxy\fR terminates on the \fBSIGINT\fR,
230 \fBSIGTERM\fR and \fBSIGABRT\fR signals. Log
231 rotation scripts may cause a re-opening of the logfile by sending a
232 \fBSIGHUP\fR to \fBPrivoxy\fR. Note that unlike
233 other daemons, \fBPrivoxy\fR does not need to be made aware of
234 config file changes by \fBSIGHUP\fR -- it will detect them
238 Please see the \fIUser Manual\fR on how to contact the
239 developers for feature requests, reporting problems, and other questions.
242 Other references and sites of interest to \fBPrivoxy\fR
246 http://www.privoxy.org/,
247 the \fBPrivoxy\fR Home page.
249 http://www.privoxy.org/faq/,
250 the \fBPrivoxy\fR FAQ.
252 http://sourceforge.net/projects/ijbswa/,
253 the Project Page for \fBPrivoxy\fR on
256 http://config.privoxy.org/,
257 the web-based user interface. \fBPrivoxy\fR must be
258 running for this to work. Shortcut: http://p.p/
260 http://www.privoxy.org/actions/, to submit ``misses'' to the developers.
262 http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/ijbswa/contrib/, cool
263 and fun ideas from \fBPrivoxy\fR users.
265 http://www.junkbusters.com/ht/en/cookies.html,
266 an explanation how cookies are used to track web users.
268 http://www.junkbusters.com/ijb.html,
269 the original Internet Junkbuster.
271 http://www.waldherr.org/junkbuster/,
272 Stefan Waldherr's version of Junkbuster, from which \fBPrivoxy\fR was
275 http://privacy.net/analyze/, a useful site
276 to check what information about you is leaked while you browse the web.
278 http://www.squid-cache.org/, a very popular
279 caching proxy, which is often used together with \fBPrivoxy\fR.
281 http://www.privoxy.org/developer-manual/,
282 the \fBPrivoxy\fR developer manual.
283 .SH "DEVELOPMENT TEAM"
288 David Schmidt (OS/2, Mac OSX ports)
291 Rodrigo Barbosa (RPM specfiles)
296 Karsten Hopp (Red Hat)
303 Roland Rosenfeld (Debian)
304 Georg Sauthoff (Gentoo)
306 Joerg Strohmayer (Amiga)
312 .SH "COPYRIGHT AND LICENSE"
315 Copyright (C) 2001 - 2004 by Privoxy Developers <developers@privoxy.org>
317 Some source code is based on code Copyright (C) 1997 by Anonymous Coders
318 and Junkbusters, Inc. and licensed under the \fIGNU General Public
322 \fBPrivoxy\fR is free software; you can
323 redistribute it and/or modify it under the terms of the
324 \fIGNU General Public
325 License\fR, version 2, as published by the Free Software Foundation.
327 This program is distributed in the hope that it will be useful, but WITHOUT
328 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
329 FITNESS FOR A PARTICULAR PURPOSE. See the
330 \fIGNU General Public License\fR for
331 more details, which is available from the Free Software Foundation, Inc, 59
332 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
334 You should have received a copy of the \fIGNU General Public License\fR
335 along with this program; if not, write to the Free Software
336 Foundation, Inc. 59 Temple Place - Suite 330
337 Boston, MA 02111-1307