1 .\" Revised man page 10/13/01, for development version.
2 .\" Hal Burgiss <hal@foobox.net>
3 .\" for Privoxy developers: ijbswa-developers@lists.sourceforge.net
5 .TH PRIVOXY 1 "v2.9.13 (beta) Date: 2002/03/24"
14 [--help] [--version] [--no-daemon] [--pidfile \fIpidfile\fP] [--user \fIuser\fP[.\fIgroup\fP]]
15 \fI\&[configfile]\fP (Unix)
17 \fBprivoxy.exe\fP \fI[configfile]\fP (Windows)
21 \fBPrivoxy\fP may be invoked with the following command-line options:
23 .BR --version " (unix only)"
24 Print version info and exit.
26 .BR --help " (unix only)"
27 Print a short usage info and exit.
29 .BR --no-daemon " (unix only)"
30 Don't become a daemon, i.e. don't fork and become process group
31 leader, don't detach from controlling tty, and do all logging
34 \fB --pidfile\fP \fIpidfile\fP (unix only)
35 On startup, write the process ID to \fIpidfile\fP. Delete the
36 \fIpidfile\fP on exit. Failiure to create or delete the
37 \fIpidfile\fP is non-fatal. If no \fB--pidfile\fP option
38 is given, no PID file will be used.
40 \fB --user\fP \fIuser\fP[.\fIgroup\fP] (unix only)
41 After (optionally) writing the PID file, assume the user ID
42 of \fIuser\fP and the GID of \fIgroup\fP, or, if the optional
43 \fIgroup\fP was not given, the default group of \fIuser\fP.
44 Exit if the privileges are not sufficient to do so.
47 If the \fIconfigfile\fP is not specified on the command line,
48 \fBPrivoxy\fP will look for a file named \fBconfig\fP in the
49 current directory (except on Win32 where it will try \fBconfig.txt\fP).
54 is an instrumentable HTTP proxy that filters the
57 web servers and browsers.
58 \fBPrivoxy\fP can be used to protect privacy, manage cookies, filter web
59 page content, manage access restrictions, and to discard such annoying Internet
60 junk as ads, banners, and pop-ups. Or whatever other annoyances strike your
63 \fBPrivoxy\fP is derived from \fBInternet Junkbuster (tm)\fP by
64 Junkbusters Corporation, which is no longer being developed. Many
65 new features and enhancements have been added.
67 .SH INSTALLATION AND USE
68 Browsers must be individually configured to use
69 \fBPrivoxy\fP as a HTTP proxy.
70 The default setting is for localhost,
71 on port 8118 (configurable in the main config file).
74 proxy in Netscape and Mozilla,
80 \fB\&Manual Proxy Configuration\fP;
83 For Internet Explorer,
86 \fB\&Internet Properties\fP;
91 Secure (SSL) Proxy \" ijbfaq.html#security
92 should also be set to the same values,
98 For other browsers, check the documentation.
101 \fBPrivoxy\fP can be configured with the various configuration
102 files. The default configuration files are: \fIconfig\fP,
103 \fIdefault.action\fP, and \fIdefault.filter\fP. These are well commented.
104 On Unix and Unix-like systems, these are located in \fI/etc/privoxy/\fP
105 by default. On Windows, OS/2 and AmigaOS, these files are in the same directory
106 as the \fBPrivoxy\fP executable.
108 The name and number of configuration files has changed from previous versions,
109 and is subject to change as development progresses. In fact, the configuration
110 itself is changed and much more sophisticated. See the user-manual for a brief
111 explanation of all configuration options.
113 The actions list (ad blocks, etc) can also be configured with your
114 web browser at \fIhttp://www.privoxy.org/config\fP.
115 \fBPrivoxy's\fP configuration parameters can also be viewed
116 at the same page. In addition, \fBPrivoxy\fP can be toggled on/off.
117 This is an internal page.
119 .SH "SAMPLE CONFIGURATION"
121 A brief example of what a \fIdefault.action\fP configuration might look like:
125 # Define a few useful custom aliases for later use
128 # Don't accept cookies
129 +no-cookies = +no-cookies-set +no-cookies-read
132 -no-cookies = -no-cookies-set -no-cookies-read
134 # Treat these blocked URLs as images.
135 +imageblock = +block +image
137 # Define page filters we want to use.
138 myfilters = +filter{html-annoyances} +filter{js-annoyances}\\
139 +filter{no-popups} +filter{webbugs}
141 ## Default Policies (actions) ############################
150 +hide-referer{forge} \\
153 +image-blocker{blank} \\
163 # Now set exceptions to the above defined policies #######
165 # Sites where we want persistant cookies
166 {-no-cookies -no-cookies-keep}
172 # This site requires cookies AND 'fast-redirects' on
173 {-no-cookies -no-cookies-keep -fast-redirects}
176 # Add custom headers, and turn off filtering of page source
177 {+add-header{X-Privacy: Yes please} #-add-header{*} \\
178 +add-header{X-User-Tracking: No thanks!} -filter}
181 # Block, and treat these URLs as 'images'.
184 .ad.preferences.com/image.*
186 .ad-adex3.flycast.com
189 .ad.de.doubleclick.net
190 /.*/count\\.cgi\\?.*df=
192 a196.g.akamai.net/7/196/2670/000[12]/images.gmx.net/i4/images/.*/
194 # Block any URLs that match these patterns
196 /.*/(.*[-_.])?ads?[0-9]?(/|[-_.].*|\\.(gif|jpe?g))
197 /.*/(plain|live|rotate)[-_.]?ads?/
198 /.*/(sponsor)s?[0-9]?/
199 /.*/ad(server|stream|juggler)\\.(cgi|pl|dll|exe)
201 /.*/adv((er)?ts?|ertis(ing|ements?))?/
204 /.*/advert[0-9]+\\.jpg
207 /images/.*/.*_anim\\.gif
209 /.*(ms)?backoff(ice)?.*\\.(gif|jpe?g)
210 195.63.104.*/(inbox|log|meld|folderlu|folderru|log(in|out)[lmr]u|)
212 .images.yahoo.com/adv/
218 See the comments in the configuration files themselves, or the user-manual
219 for explanations of the above syntax, and other \fBPrivoxy\fP configuration
223 \fI/usr/sbin/privoxy\fP
225 \fI/etc/privoxy/config\fP
227 \fI/etc/privoxy/default.action\fP
229 \fI/etc/privoxy/advanced.action\fP
231 \fI/etc/privoxy/basic.action\fP
233 \fI/etc/privoxy/intermediate.action\fP
235 \fI/etc/privoxy/default.filter\fP
237 \fI/etc/privoxy/trust\fP
239 \fI/etc/privoxy/templates/*\fP
241 \fI/var/log/privoxy/logfile\fP
244 Various other files should be included, but may vary depending on platform
245 and build configuration. More documentation should be included in the local
246 documentation directory, though is not complete at this time.
249 \fBPrivoxy\fP terminates on the \fBSIGINT\fP, \fBSIGTERM\fP and \fBSIGABRT\fP
250 signals. Log rotation scripts may cause a re-opening of the logfile by sending
251 a \fBSIGHUP\fP to \fBPrivoxy\fP. Note that unlike other daemons, \fBPrivoxy\fP
252 does not need to be made aware of config file changes by \fBSIGHUP\fP -- it will
253 detect them automatically.
256 This is a \fBBETA\fP version of \fBPrivoxy\fP. Not all features are
257 complete or well tested.
259 Please see the user-maual on how to contact the developers for
260 feature requests, reporting problems, and other questions.
263 Probably. Please see the user-manual for how and where to report bugs.
267 http://www.privoxy.org/config
269 http://www.privoxy.org/
271 http://sourceforge.net/projects/ijbswa
273 http://www.waldherr.org/junkbuster/\" waldherr.org#
275 http://www.junkbusters.com/ht/en/cookies.html\" cookies.html#
277 http://privacy.net/analyze/
279 http://www.squid-cache.org/
281 http://linuxalpha.ch/packages/
313 .SH COPYRIGHT AND LICENSE
314 \"Orginally written by, and copyrighted by, the Anonymous Coders and Junkbusters
317 This program is free software; you can redistribute it and/or modify
318 it under the terms of the GNU General Public License as published by
319 the Free Software Foundation; either version 2 of the License, or
320 (at your option) any later version.
322 This program is distributed in the hope that it will be useful,
323 but WITHOUT ANY WARRANTY; without even the implied warranty of
324 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
325 GNU General Public License for more details.
327 You should have received a copy of the GNU General Public License
328 along with this program; if not, write to the Free Software
329 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
334 trademark \" legal.html#marks
335 of Junkbusters Corporation.