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" "05 May 2002" "Privoxy 2.9.15 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.filter\fR, and
86 \fIdefault.action\fR. \fIuser.action\fR should
87 be used for locally defined exceptions to the default rules of
88 \fIdefault.action\fR These are all well commented. On Unix
89 and Unix-like systems, these are located in
90 \fI/etc/privoxy/\fR by default. On Windows, OS/2 and AmigaOS,
91 these files are in the same directory as the \fBPrivoxy\fR
94 The name and number of configuration files has changed from previous
95 versions, and is subject to change as development progresses. In fact, the
96 configuration itself is changed and much more sophisticated. See the
98 brief explanation of all configuration options.
100 The actions list (ad blocks, etc) can also be configured with your
101 web browser at http://ijbswa.sourceforge.net/config.
102 \fBPrivoxy's\fR configuration parameters can also be viewed at
103 the same page. In addition, \fBPrivoxy\fR can be toggled on/off.
104 This is an internal page.
105 .SH "SAMPLE CONFIGURATION"
107 A brief example of what a simple \fIdefault.action\fR
108 configuration might look like:
111 # Define a few useful custom aliases for later use
115 +prevent-cookies = +prevent-setting-cookies +prevent-reading-cookies
116 -prevent-cookies = -prevent-setting-cookies -prevent-reading-cookies
117 +imageblock = +block +handle-as-image
119 # Fragile sites should have the minimum changes
120 fragile = -block -deanimate-gifs -fast-redirects -filter \\
121 -hide-referer -prevent-cookies -kill-popups
123 ## Turn some actions on ################################
127 +deanimate-gifs{last} \\
128 -downgrade-http-version \\
130 +filter{html-annoyances} \\
131 +filter{js-annoyances} \\
132 +filter{content-cookies} \\
134 +filter{banners-by-size} \\
135 +hide-forwarded-for-headers \\
136 +hide-from-header{block} \\
137 +hide-referrer{forge} \\
140 +set-image-blocker{pattern} \\
142 +prevent-compression \\
143 +session-cookies-only \\
144 +prevent-reading-cookies \\
145 +prevent-setting-cookies \\
150 # Block, and treat these URL patterns as if they were 'images'.
153 .a[0-9].yimg.com/(?:(?!/i/).)*$
156 # Block any URLs that match these patterns
161 /.*count(er)?\\.(pl|cgi|exe|dll|asp|php[34]?)
162 /(?:.*/)?(publicite|werbung|rekla(ma|me|am)|maino(kset|nta|s)?)/
165 # Make exceptions for these harmless ones that would be
166 # caught by +block above.
173 Then for a \fIuser.action\fR, we would put local,
174 narrowly defined exceptions:
177 # Set personal exceptions to the policies in default.action #######
179 # Sites where we want persistant cookies
180 {-prevent-reading-cookies -prevent-setting-cookies -session-cookies-only}
185 {-block -fast-redirects}
189 See the comments in the configuration files themselves, or the
191 for explanations of the above syntax, and other \fBPrivoxy\fR
192 configuration options.
197 \fI/usr/sbin/privoxy\fR
198 \fI/etc/privoxy/config\fR
199 \fI/etc/privoxy/default.action\fR
200 \fI/etc/privoxy/standard.action\fR
201 \fI/etc/privoxy/user.action\fR
202 \fI/etc/privoxy/default.filter\fR
203 \fI/etc/privoxy/trust\fR
204 \fI/etc/privoxy/templates/*\fR
205 \fI/var/log/privoxy/logfile\fR
208 Various other files should be included, but may vary depending on platform
209 and build configuration. More documentation should be included in the local
210 documentation directory, though is not complete at this time.
213 \fBPrivoxy\fR terminates on the \fBSIGINT\fR,
214 \fBSIGTERM\fR and \fBSIGABRT\fR signals. Log
215 rotation scripts may cause a re-opening of the logfile by sending a
216 \fBSIGHUP\fR to \fBPrivoxy\fR. Note that unlike
217 other daemons, \fBPrivoxy\fR does not need to be made aware of
218 config file changes by \fBSIGHUP\fR -- it will detect them
222 This is a beta version of \fBPrivoxy\fR. Not
223 all features are well tested.
225 Please see the \fIuser-manual\fR on how to contact the
226 developers for feature requests, reporting problems, and other questions.
229 Other references and sites of interest to \fBPrivoxy\fR
233 http://www.privoxy.org/,
234 The \fBPrivoxy\fR Home page.
236 http://sourceforge.net/projects/ijbswa,
237 the Project Page for \fBPrivoxy\fR on
241 \fBPrivoxy\fR from your browser. Alternately,
242 http://config.privoxy.org
243 may work in some situations where the first does not.
245 http://p.p/ to submit ``misses'' to the developers.
247 http://www.junkbusters.com/ht/en/cookies.html
249 http://www.waldherr.org/junkbuster/
251 http://privacy.net/analyze/
253 http://www.squid-cache.org/
254 .SH "DEVELOPMENT TEAM"
262 Rodrigo Barbosa (RPM specfiles)
268 David Schmidt (OS/2, Mac OSX ports)
272 .SH "COPYRIGHT AND LICENSE"
275 Permission is granted to copy, distribute and/or modify this document under
276 the terms of the \fIGNU Free
277 Documentation License\fR, Version 1.1 or any later version
278 published by the Free Software Foundation with no Invariant Sections, no
279 Front-Cover Texts, and no Back-Cover Texts. A copy of the license can be
280 found http://www.gnu.org/licenses/fdl.html.
283 \fBPrivoxy\fR is free software; you can
284 redistribute it and/or modify it under the terms of the GNU General Public
285 License as published by the Free Software Foundation; either version 2 of the
286 License, or (at your option) any later version.
288 This program is distributed in the hope that it will be useful, but WITHOUT
289 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
290 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
291 more details, which is available from the Free Software Foundation, Inc, 59
292 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
294 You should have received a copy of the GNU General Public License
295 along with this program; if not, write to the Free Software Foundation, Inc.,
296 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.