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" "25 August 2006" "Privoxy 3.0.4 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--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, and \fIuser.filter\fR for
98 locally defined filters. These are well commented. On Unix
99 and Unix-like systems, these are located in
100 \fI/etc/privoxy/\fR by default. On Windows, OS/2 and AmigaOS,
101 these files are in the same directory as the \fBPrivoxy\fR
104 See the user-manual for a complete
105 explanation of general usage, configuration options, new features and notes for
108 The actions list (ad blocks, etc) can also be configured with your
109 web browser at http://config.privoxy.org/.
110 \fBPrivoxy's\fR configuration parameters can also be viewed at
111 the same page. In addition, \fBPrivoxy\fR can be toggled on/off.
112 This is an internal page, and does not require Internet access.
113 .SH "SAMPLE CONFIGURATION"
115 A brief example of what a simple \fIdefault.action\fR
116 configuration might look like:
119 # Define a few useful custom aliases for later use
123 +crunch-cookies = +crunch-incoming-cookies +crunch-outgoing-cookies
124 -crunch-cookies = -crunch-incoming-cookies -crunch-outgoing-cookies
125 +imageblock = +block +handle-as-image
127 # Fragile sites should have the minimum changes
128 fragile = -block -deanimate-gifs -fast-redirects -filter \\
129 -hide-referer -prevent-cookies -kill-popups
131 ## Turn some actions on ################################
135 -content-type-overwrite \\
136 -crunch-if-none-match \\
137 +crunch-incoming-cookies \\
138 +crunch-outgoing-cookies \\
139 +crunch-server-header {no-cache} \\
140 +deanimate-gifs{last} \\
141 -downgrade-http-version \\
144 -filter{html-annoyances} \\
145 -filter{js-annoyances} \\
146 +filter{content-cookies} \\
148 -filter{banners-by-size} \\
149 -handle-as-empty-document \\
150 +hide-accept-language{en-ca} \\
151 +hide-content-disposition {block} \\
152 +hide-forwarded-for-headers \\
153 +hide-from-header{block} \\
154 +hide-if-modified-since {-1} \\
155 +hide-referrer{forge} \\
160 +set-image-blocker{pattern} \\
162 +overwrite-last-modified {randomize} \\
163 +prevent-compression \\
164 +session-cookies-only \\
165 +treat-forbidden-connects-like-blocks \\
168 / # '/' Matches *all* URL patterns
170 # Block, and treat these URL patterns as if they were 'images'.
171 # We would expect these to be ads.
174 .a[0-9].yimg.com/(?:(?!/i/).)*$
177 # Block any URLs that match these patterns
182 /.*count(er)?\\.(pl|cgi|exe|dll|asp|php[34]?)
185 # Make exceptions for these harmless ones that would be
186 # caught by our +block patterns just above.
193 Then for a \fIuser.action\fR, we would put local,
194 narrowly defined exceptions:
197 # Re-define aliases as needed here
201 -crunch-cookies = -crunch-incoming-cookies -crunch-outgoing-cookies
203 # Set personal exceptions to the policies in default.action #######
205 # Sites where we want persistant cookies, so allow *all* cookies
206 {-crunch-cookies -session-cookies-only}
211 # This site breaks easily.
212 {-block -fast-redirects}
216 See the comments in the configuration files themselves, or the
218 for explanations of the above syntax, and other \fBPrivoxy\fR
219 configuration options.
224 \fI/usr/sbin/privoxy\fR
225 \fI/etc/privoxy/config\fR
226 \fI/etc/privoxy/default.action\fR
227 \fI/etc/privoxy/standard.action\fR
228 \fI/etc/privoxy/user.action\fR
229 \fI/etc/privoxy/default.filter\fR
230 \fI/etc/privoxy/user.filter\fR
231 \fI/etc/privoxy/trust\fR
232 \fI/etc/privoxy/templates/*\fR
233 \fI/var/log/privoxy/logfile\fR
236 Various other files should be included, but may vary depending on platform
237 and build configuration. More documentation should be included in the local
238 documentation directory.
241 \fBPrivoxy\fR terminates on the \fBSIGINT\fR,
242 \fBSIGTERM\fR and \fBSIGABRT\fR signals. Log
243 rotation scripts may cause a re-opening of the logfile by sending a
244 \fBSIGHUP\fR to \fBPrivoxy\fR. Note that unlike
245 other daemons, \fBPrivoxy\fR does not need to be made aware of
246 config file changes by \fBSIGHUP\fR -- it will detect them
250 This is a BETA version of \fBPrivoxy\fR. Not
251 all features are well tested.
253 Please see the \fIUser Manual\fR on how to contact the
254 developers, for feature requests, reporting problems, and other questions.
257 Other references and sites of interest to \fBPrivoxy\fR
261 http://www.privoxy.org/,
262 the \fBPrivoxy\fR Home page.
264 http://www.privoxy.org/faq/,
265 the \fBPrivoxy\fR FAQ.
267 http://sourceforge.net/projects/ijbswa/,
268 the Project Page for \fBPrivoxy\fR on
271 http://config.privoxy.org/,
272 the web-based user interface. \fBPrivoxy\fR must be
273 running for this to work. Shortcut: http://p.p/
275 http://www.privoxy.org/actions/, to submit ``misses'' to the developers.
277 http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/ijbswa/contrib/, cool
278 and fun ideas from \fBPrivoxy\fR users.
280 http://www.junkbusters.com/ht/en/cookies.html,
281 an explanation how cookies are used to track web users.
283 http://www.junkbusters.com/ijb.html,
284 the original Internet Junkbuster.
286 http://www.waldherr.org/junkbuster/,
287 Stefan Waldherr's version of Junkbuster, from which \fBPrivoxy\fR was
290 http://privacy.net/analyze/, a useful site
291 to check what information about you is leaked while you browse the web.
293 http://www.squid-cache.org/, a very popular
294 caching proxy, which is often used together with \fBPrivoxy\fR.
296 http://www.privoxy.org/developer-manual/,
297 the \fBPrivoxy\fR developer manual.
298 .SH "DEVELOPMENT TEAM"
306 Rodrigo Barbosa (RPM specfiles)
309 Karsten Hopp (Red Hat)
316 Georg Sauthoff (Gentoo)
318 Joerg Strohmayer (Amiga)
324 .SH "COPYRIGHT AND LICENSE"
327 Copyright (C) 2001 - 2006 by Privoxy Developers <ijbswa-developers@lists.sourceforge.net>
329 Some source code is based on code Copyright (C) 1997 by Anonymous Coders
330 and Junkbusters, Inc. and licensed under the \fIGNU General Public
334 \fBPrivoxy\fR is free software; you can
335 redistribute it and/or modify it under the terms of the
336 \fIGNU General Public
337 License\fR, version 2, as published by the Free Software Foundation.
339 This program is distributed in the hope that it will be useful, but WITHOUT
340 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
341 FITNESS FOR A PARTICULAR PURPOSE. See the
342 \fIGNU General Public License\fR for
343 more details, which is available from the Free Software Foundation, Inc, 59
344 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
346 You should have received a copy of the \fIGNU General Public License\fR
347 along with this program; if not, write to the Free Software
348 Foundation, Inc. 59 Temple Place - Suite 330
349 Boston, MA 02111-1307