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 .\" Modified for privoxy-developers, 04/08/02.
7 .TH "PRIVOXY" "1" "08 April 2002" "Privoxy 2.9.13 beta" ""
9 privoxy \- Privacy Enhancing Proxy
12 \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)
15 \fBprivoxy.exe\fR [\fB\fIconfigfile\fB\fR] (Windows)
19 \fBPrivoxy\fR may be invoked with the following command line
23 Print brief usage info and exit.
26 Print version info and exit.
29 Don't become a daemon, i.e. don't fork and become process group
30 leader, don't detach from controlling tty, and do all logging there.
32 \fB--pidfile \fIpidfile\fB\fR
33 After (optionally) writing the PID file, assume the user ID of user
34 and the GID of group, or, if the optional group was not given, the
35 default group of user. Exit if the privileges are not sufficient to
38 \fB--user \fIuser[.group]\fB\fR
39 After (optionally) writing the PID file, assume the user ID of
40 \fIuser\fR and the GID of
41 \fIgroup\fR, or, if the optional
42 \fIgroup\fR was not given, the default group of
43 \fIuser\fR. Exit if the privileges are not
46 If the \fIconfigfile\fR is not specified on the command line,
47 \fBPrivoxy\fR will look for a file named
48 \fIconfig\fR in the current directory (except on Win32 where
49 it will try \fIconfig.txt\fR). If no
50 \fIconfigfile\fR is found, \fBPrivoxy\fR will
54 \fBPrivoxy\fR is a web proxy with advanced filtering
55 capabilities for protecting privacy, filtering web page content, managing
56 cookies, controlling access, and removing ads, banners, pop-ups and other
57 obnoxious Internet junk. \fBPrivoxy\fR has a very
58 flexible configuration and can be customized to suit individual needs and
59 tastes. \fBPrivoxy\fR has application for both
60 stand-alone systems and multi-user networks.
62 \fBPrivoxy\fR is based on the code of the
63 \fBInternet Junkbuster\fR (tm).
64 \fBJunkbuster\fR was originally written by JunkBusters
65 Corporation, and was released as free open-source software under the GNU GPL.
66 Stefan Waldherr made many improvements, and started the SourceForge project
67 to continue development.
69 \fBPrivoxy\fR continues the
70 \fBJunkbuster\fR tradition, but adds many
71 refinements, enhancements and new features.
72 .SH "INSTALLATION AND USAGE"
74 Browsers must be individually configured to use \fBPrivoxy\fR as
75 a HTTP proxy. The default setting is for localhost, on port 8118
76 (configurable in the main config file). To set the HTTP proxy in Netscape
77 and Mozilla, go through: \fBEdit\fR;
78 \fBPreferences\fR; \fBAdvanced\fR;
79 \fBProxies\fR; \fBManual Proxy Configuration\fR;
82 For Internet Explorer, go through: \fBTools\fR;
83 \fBInternet Properties\fR; \fBConnections\fR;
86 The Secure (SSL) Proxy should also be set to the same values, otherwise
87 https: URLs will not be proxied.
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.action\fR, and
95 \fIdefault.filter\fR. These are well commented. On Unix and
96 Unix-like systems, these are located in \fI/etc/privoxy/\fR by
97 default. On Windows, OS/2 and AmigaOS, these files are in the same directory
98 as the \fBPrivoxy\fR executable.
100 The name and number of configuration files has changed from previous
101 versions, and is subject to change as development progresses. In fact, the
102 configuration itself is changed and much more sophisticated. See the
104 brief explanation of all configuration options.
106 The actions list (ad blocks, etc) can also be configured with your
107 web browser at http://ijbswa.sourceforge.net/config.
108 \fBPrivoxy's\fR configuration parameters can also be viewed at
109 the same page. In addition, \fBPrivoxy\fR can be toggled on/off.
110 This is an internal page.
111 .SH "SAMPLE CONFIGURATION"
113 A brief example of what a \fIdefault.action\fR configuration
118 # Define a few useful custom aliases for later use
121 # Don't accept cookies
122 +no-cookies = +no-cookies-set +no-cookies-read
125 -no-cookies = -no-cookies-set -no-cookies-read
127 # Treat these blocked URLs as images.
128 +imageblock = +block +image
130 # Define page filters we want to use.
131 myfilters = +filter{html-annoyances} +filter{js-annoyances}\\
132 +filter{no-popups} +filter{webbugs}
134 ## Default Policies (actions) ############################
143 +hide-referer{forge} \\
146 +image-blocker{blank} \\
156 # Now set exceptions to the above defined policies #######
158 # Sites where we want persistant cookies
159 {-no-cookies -no-cookies-keep}
165 # This site requires cookies AND 'fast-redirects' on
166 {-no-cookies -no-cookies-keep -fast-redirects}
169 # Add custom headers, and turn off filtering of page source
170 {+add-header{X-Privacy: Yes please} #-add-header{*} \\
171 +add-header{X-User-Tracking: No thanks!} -filter}
174 # Block, and treat these URLs as 'images'.
177 .ad.preferences.com/image.*
179 .ad-adex3.flycast.com
182 .ad.de.doubleclick.net
183 /.*/count\\.cgi\\?.*df=
185 a196.g.akamai.net/7/196/2670/000[12]/images.gmx.net/i4/images/.*/
187 # Block any URLs that match these patterns
189 /.*/(.*[-_.])?ads?[0-9]?(/|[-_.].*|\\.(gif|jpe?g))
190 /.*/(plain|live|rotate)[-_.]?ads?/
191 /.*/(sponsor)s?[0-9]?/
192 /.*/ad(server|stream|juggler)\\.(cgi|pl|dll|exe)
194 /.*/adv((er)?ts?|ertis(ing|ements?))?/
197 /.*/advert[0-9]+\\.jpg
200 /images/.*/.*_anim\\.gif
202 /.*(ms)?backoff(ice)?.*\\.(gif|jpe?g)
203 195.63.104.*/(inbox|log|meld|folderlu|folderru|log(in|out)[lmr]u|)
205 .images.yahoo.com/adv/
209 See the comments in the configuration files themselves, or the
211 for explanations of the above syntax, and other \fBPrivoxy\fR
212 configuration options.
217 \fI/usr/sbin/privoxy\fR
218 \fI/etc/privoxy/config\fR
219 \fI/etc/privoxy/default.action\fR
220 \fI/etc/privoxy/advanced.action\fR
221 \fI/etc/privoxy/basic.action\fR
222 \fI/etc/privoxy/intermediate.action\fR
223 \fI/etc/privoxy/default.filter\fR
224 \fI/etc/privoxy/trust\fR
225 \fI/etc/privoxy/templates/*\fR
226 \fI/var/log/privoxy/logfile\fR
229 Various other files should be included, but may vary depending on platform
230 and build configuration. More documentation should be included in the local
231 documentation directory, though is not complete at this time.
234 \fBPrivoxy\fR terminates on the \fBSIGINT\fR,
235 \fBSIGTERM\fR and \fBSIGABRT\fR signals. Log
236 rotation scripts may cause a re-opening of the logfile by sending a
237 \fBSIGHUP\fR to \fBPrivoxy\fR. Note that unlike
238 other daemons, \fBPrivoxy\fR does not need to be made aware of
239 config file changes by \fBSIGHUP\fR -- it will detect them
243 This is a beta version of \fBPrivoxy\fR. Not
244 all features are well tested.
246 Please see the \fIuser-manual\fR on how to contact the
247 developers for feature requests, reporting problems, and other questions.
250 Other references and sites of interest to \fBPrivoxy\fR
254 http://www.privoxy.org/,
255 The \fBPrivoxy\fR Home page.
257 http://sourceforge.net/projects/ijbswa,
258 the Project Page for \fBPrivoxy\fR on
262 \fBPrivoxy\fR from your browser. Alternately,
263 http://config.privoxy.org
264 may work in some situations where the first does not.
266 http://www.junkbusters.com/ht/en/cookies.html
268 http://www.waldherr.org/junkbuster/
270 http://privacy.net/analyze/
272 http://www.squid-cache.org/
273 .SH "DEVELOPMENT TEAM"
281 David Schmidt (OS/2, Mac OSX ports)
288 Rodrigo Barbosa (RPM specfiles)
294 .SH "COPYRIGHT AND LICENSE"
296 \fBPrivoxy\fR is free software; you can
297 redistribute it and/or modify it under the terms of the GNU General Public
298 License as published by the Free Software Foundation; either version 2 of the
299 License, or (at your option) any later version.
301 This program is distributed in the hope that it will be useful, but WITHOUT
302 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
303 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
304 more details, which is available from the Free Software Foundation, Inc, 59
305 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
307 You should have received a copy of the GNU General Public License
308 along with this program; if not, write to the Free Software Foundation, Inc.,
309 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.