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" "11 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] (UNIX)
14 \fBprivoxy.exe\fR [\fB\fIconfigfile\fB\fR] (Windows)
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 the code of the
62 \fBInternet Junkbuster\fR (tm).
63 \fBJunkbuster\fR was originally written by Junkbusters
64 Corporation, and was released as free open-source software under the GNU GPL.
65 Stefan Waldherr made many improvements, and started the SourceForge project
66 to continue development.
68 \fBPrivoxy\fR continues the
69 \fBJunkbuster\fR tradition, but adds many
70 refinements, enhancements and new features.
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.
88 For other browsers, check the documentation.
91 \fBPrivoxy\fR can be configured with the various configuration
92 files. The default configuration files are: \fIconfig\fR,
93 \fIdefault.action\fR, and
94 \fIdefault.filter\fR. These are well commented. On Unix and
95 Unix-like systems, these are located in \fI/etc/privoxy/\fR by
96 default. On Windows, OS/2 and AmigaOS, these files are in the same directory
97 as the \fBPrivoxy\fR executable.
99 The name and number of configuration files has changed from previous
100 versions, and is subject to change as development progresses. In fact, the
101 configuration itself is changed and much more sophisticated. See the
103 brief explanation of all configuration options.
105 The actions list (ad blocks, etc) can also be configured with your
106 web browser at http://ijbswa.sourceforge.net/config.
107 \fBPrivoxy's\fR configuration parameters can also be viewed at
108 the same page. In addition, \fBPrivoxy\fR can be toggled on/off.
109 This is an internal page.
110 .SH "SAMPLE CONFIGURATION"
112 A brief example of what a \fIdefault.action\fR configuration
117 # Define a few useful custom aliases for later use
120 # Don't accept cookies
121 +no-cookies = +no-cookies-set +no-cookies-read
124 -no-cookies = -no-cookies-set -no-cookies-read
126 # Treat these blocked URLs as images.
127 +imageblock = +block +image
129 # Define page filters we want to use.
130 myfilters = +filter{html-annoyances} +filter{js-annoyances}\\
131 +filter{no-popups} +filter{webbugs}
133 ## Default Policies (actions) ############################
142 +hide-referer{forge} \\
145 +image-blocker{blank} \\
155 # Now set exceptions to the above defined policies #######
157 # Sites where we want persistant cookies
158 {-no-cookies -no-cookies-keep}
164 # This site requires cookies AND 'fast-redirects' on
165 {-no-cookies -no-cookies-keep -fast-redirects}
168 # Add custom headers, and turn off filtering of page source
169 {+add-header{X-Privacy: Yes please} #-add-header{*} \\
170 +add-header{X-User-Tracking: No thanks!} -filter}
173 # Block, and treat these URLs as 'images'.
176 .ad.preferences.com/image.*
178 .ad-adex3.flycast.com
181 .ad.de.doubleclick.net
182 /.*/count\\.cgi\\?.*df=
184 a196.g.akamai.net/7/196/2670/000[12]/images.gmx.net/i4/images/.*/
186 # Block any URLs that match these patterns
188 /.*/(.*[-_.])?ads?[0-9]?(/|[-_.].*|\\.(gif|jpe?g))
189 /.*/(plain|live|rotate)[-_.]?ads?/
190 /.*/(sponsor)s?[0-9]?/
191 /.*/ad(server|stream|juggler)\\.(cgi|pl|dll|exe)
193 /.*/adv((er)?ts?|ertis(ing|ements?))?/
196 /.*/advert[0-9]+\\.jpg
199 /images/.*/.*_anim\\.gif
201 /.*(ms)?backoff(ice)?.*\\.(gif|jpe?g)
202 195.63.104.*/(inbox|log|meld|folderlu|folderru|log(in|out)[lmr]u|)
204 .images.yahoo.com/adv/
208 See the comments in the configuration files themselves, or the
210 for explanations of the above syntax, and other \fBPrivoxy\fR
211 configuration options.
216 \fI/usr/sbin/privoxy\fR
217 \fI/etc/privoxy/config\fR
218 \fI/etc/privoxy/default.action\fR
219 \fI/etc/privoxy/advanced.action\fR
220 \fI/etc/privoxy/basic.action\fR
221 \fI/etc/privoxy/intermediate.action\fR
222 \fI/etc/privoxy/default.filter\fR
223 \fI/etc/privoxy/trust\fR
224 \fI/etc/privoxy/templates/*\fR
225 \fI/var/log/privoxy/logfile\fR
228 Various other files should be included, but may vary depending on platform
229 and build configuration. More documentation should be included in the local
230 documentation directory, though is not complete at this time.
233 \fBPrivoxy\fR terminates on the \fBSIGINT\fR,
234 \fBSIGTERM\fR and \fBSIGABRT\fR signals. Log
235 rotation scripts may cause a re-opening of the logfile by sending a
236 \fBSIGHUP\fR to \fBPrivoxy\fR. Note that unlike
237 other daemons, \fBPrivoxy\fR does not need to be made aware of
238 config file changes by \fBSIGHUP\fR -- it will detect them
242 This is a beta version of \fBPrivoxy\fR. Not
243 all features are well tested.
245 Please see the \fIuser-manual\fR on how to contact the
246 developers for feature requests, reporting problems, and other questions.
249 Other references and sites of interest to \fBPrivoxy\fR
253 http://www.privoxy.org/,
254 The \fBPrivoxy\fR Home page.
256 http://sourceforge.net/projects/ijbswa,
257 the Project Page for \fBPrivoxy\fR on
261 \fBPrivoxy\fR from your browser. Alternately,
262 http://config.privoxy.org
263 may work in some situations where the first does not.
266 to submit ``misses'' to the developers.
268 http://www.junkbusters.com/ht/en/cookies.html
270 http://www.waldherr.org/junkbuster/
272 http://privacy.net/analyze/
274 http://www.squid-cache.org/
275 .SH "DEVELOPMENT TEAM"
283 David Schmidt (OS/2, Mac OSX ports)
290 Rodrigo Barbosa (RPM specfiles)
296 .SH "COPYRIGHT AND LICENSE"
298 \fBPrivoxy\fR is free software; you can
299 redistribute it and/or modify it under the terms of the GNU General Public
300 License as published by the Free Software Foundation; either version 2 of the
301 License, or (at your option) any later version.
303 This program is distributed in the hope that it will be useful, but WITHOUT
304 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
305 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
306 more details, which is available from the Free Software Foundation, Inc, 59
307 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
309 You should have received a copy of the GNU General Public License
310 along with this program; if not, write to the Free Software Foundation, Inc.,
311 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.