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
112 # Don't accept cookies
113 +no-cookies = +no-cookies-set +no-cookies-read
116 -no-cookies = -no-cookies-set -no-cookies-read
118 # Treat these blocked URLs as images.
119 +imageblock = +block +image
121 # Define page filters we want to use.
122 myfilters = +filter{html-annoyances} +filter{js-annoyances}\\
123 +filter{no-popups} +filter{webbugs}
125 ## Default Policies (actions) ############################
134 +hide-referer{forge} \\
137 +image-blocker{blank} \\
147 # Now set exceptions to the above defined policies #######
149 # Sites where we want persistant cookies
150 {-no-cookies -no-cookies-keep}
156 # This site requires cookies AND 'fast-redirects' on
157 {-no-cookies -no-cookies-keep -fast-redirects}
160 # Add custom headers, and turn off filtering of page source
161 {+add-header{X-Privacy: Yes please} #-add-header{*} \\
162 +add-header{X-User-Tracking: No thanks!} -filter}
165 # Block, and treat these URLs as 'images'.
167 .ad.preferences.com/image.*
169 .ad-adex3.flycast.com
172 .ad.de.doubleclick.net
173 /.*/count\\.cgi\\?.*df=
175 a196.g.akamai.net/7/196/2670/000[12]/images.gmx.net/i4/images/.*/
177 # Block any URLs that match these patterns
179 /.*/(.*[-_.])?ads?[0-9]?(/|[-_.].*|\\.(gif|jpe?g))
180 /.*/(plain|live|rotate)[-_.]?ads?/
181 /.*/(sponsor)s?[0-9]?/
182 /.*/ad(server|stream|juggler)\\.(cgi|pl|dll|exe)
184 /.*/adv((er)?ts?|ertis(ing|ements?))?/
187 /.*/advert[0-9]+\\.jpg
190 /images/.*/.*_anim\\.gif
192 /.*(ms)?backoff(ice)?.*\\.(gif|jpe?g)
193 195.63.104.*/(inbox|log|meld|folderlu|folderru|log(in|out)[lmr]u|)
195 .images.yahoo.com/adv/
199 See the comments in the configuration files themselves, or the
201 for explanations of the above syntax, and other \fBPrivoxy\fR
202 configuration options.
207 \fI/usr/sbin/privoxy\fR
208 \fI/etc/privoxy/config\fR
209 \fI/etc/privoxy/default.action\fR
210 \fI/etc/privoxy/standard.action\fR
211 \fI/etc/privoxy/user.action\fR
212 \fI/etc/privoxy/default.filter\fR
213 \fI/etc/privoxy/trust\fR
214 \fI/etc/privoxy/templates/*\fR
215 \fI/var/log/privoxy/logfile\fR
218 Various other files should be included, but may vary depending on platform
219 and build configuration. More documentation should be included in the local
220 documentation directory, though is not complete at this time.
223 \fBPrivoxy\fR terminates on the \fBSIGINT\fR,
224 \fBSIGTERM\fR and \fBSIGABRT\fR signals. Log
225 rotation scripts may cause a re-opening of the logfile by sending a
226 \fBSIGHUP\fR to \fBPrivoxy\fR. Note that unlike
227 other daemons, \fBPrivoxy\fR does not need to be made aware of
228 config file changes by \fBSIGHUP\fR -- it will detect them
232 This is a beta version of \fBPrivoxy\fR. Not
233 all features are well tested.
235 Please see the \fIuser-manual\fR on how to contact the
236 developers for feature requests, reporting problems, and other questions.
239 Other references and sites of interest to \fBPrivoxy\fR
243 http://www.privoxy.org/,
244 The \fBPrivoxy\fR Home page.
246 http://sourceforge.net/projects/ijbswa,
247 the Project Page for \fBPrivoxy\fR on
251 \fBPrivoxy\fR from your browser. Alternately,
252 http://config.privoxy.org
253 may work in some situations where the first does not.
256 to submit ``misses'' to the developers.
258 http://www.junkbusters.com/ht/en/cookies.html
260 http://www.waldherr.org/junkbuster/
262 http://privacy.net/analyze/
264 http://www.squid-cache.org/
265 .SH "DEVELOPMENT TEAM"
273 Rodrigo Barbosa (RPM specfiles)
279 David Schmidt (OS/2, Mac OSX ports)
283 .SH "COPYRIGHT AND LICENSE"
285 \fBPrivoxy\fR is free software; you can
286 redistribute it and/or modify it under the terms of the GNU General Public
287 License as published by the Free Software Foundation; either version 2 of the
288 License, or (at your option) any later version.
290 This program is distributed in the hope that it will be useful, but WITHOUT
291 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
292 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
293 more details, which is available from the Free Software Foundation, Inc, 59
294 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
296 You should have received a copy of the GNU General Public License
297 along with this program; if not, write to the Free Software Foundation, Inc.,
298 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.