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 configured to use
70 (the default is localhost,
74 proxy in Netscape and Mozilla,
80 \fB\&Manual Proxy Configuration\fP;
83 For Internet Explorer,
86 \fB\&Internet Properties\fP;
90 Set the HTTP proxy location for localhost, port 8118.
92 Secure (SSL) Proxy\" ijbfaq.html#security
93 should also be set to the same values,
99 For other browsers, check the documentation.
102 \fBPrivoxy\fP can be configured with the various configuration
103 files. The default configuration files are: \fIconfig\fP,
104 \fIdefault.action\fP, and \fIdefault.filter\fP. These are well commented.
105 On Unix and Unix-like systems, these are located in \fI/etc/privoxy/\fP
106 by default. On Windows, OS/2 and AmigaOS, these files are in the same directory
107 as the \fBPrivoxy\fP executable.
109 The name and number of configuration files has changed from previous versions,
110 and is subject to change as development progresses. In fact, the configuration
111 itself is changed and much more sophisticated. See the user-manual for a brief
112 explanation of all configuration options.
114 The actions list (ad blocks, etc) can also be configured with your
115 web browser at \fIhttp://ijbswa.sourceforge.net/config\fP.
116 \fBPrivoxy's\fP configuration parameters can also be viewed
117 at the same page. In addition, \fBPrivoxy\fP can be toggled on/off.
118 This is an internal page.
120 .SH "SAMPLE CONFIGURATION"
122 A brief example of what an \fIdefault.action\fP configuration might look like:
126 # Define a few useful custom aliases for later use
129 # Don't accept cookies
130 +no-cookies = +no-cookies-set +no-cookies-read
133 -no-cookies = -no-cookies-set -no-cookies-read
135 # Treat these blocked URLs as images.
136 +imageblock = +block +image
138 # Define page filters we want to use.
139 myfilters = +filter{html-annoyances} +filter{js-annoyances}\\
140 +filter{no-popups} +filter{webbugs}
142 ## Default Policies (actions) ############################
151 +hide-referer{forge} \\
154 +image-blocker{blank} \\
164 # Now set exceptions to the above defined policies #######
166 # Sites where we want persistant cookies
167 {-no-cookies -no-cookies-keep}
173 # This site requires cookies AND 'fast-redirects' on
174 {-no-cookies -no-cookies-keep -fast-redirects}
177 # Add custom headers, and turn off filtering of page source
178 {+add-header{X-Privacy: Yes please} #-add-header{*} \\
179 +add-header{X-User-Tracking: No thanks!} -filter}
182 # Block, and treat these URLs as 'images'.
185 .ad.preferences.com/image.*
187 .ad-adex3.flycast.com
190 .ad.de.doubleclick.net
191 /.*/count\\.cgi\\?.*df=
193 a196.g.akamai.net/7/196/2670/000[12]/images.gmx.net/i4/images/.*/
195 # Block any URLs that match these patterns
197 /.*/(.*[-_.])?ads?[0-9]?(/|[-_.].*|\\.(gif|jpe?g))
198 /.*/(plain|live|rotate)[-_.]?ads?/
199 /.*/(sponsor)s?[0-9]?/
200 /.*/ad(server|stream|juggler)\\.(cgi|pl|dll|exe)
202 /.*/adv((er)?ts?|ertis(ing|ements?))?/
205 /.*/advert[0-9]+\\.jpg
208 /images/.*/.*_anim\\.gif
210 /.*(ms)?backoff(ice)?.*\\.(gif|jpe?g)
211 195.63.104.*/(inbox|log|meld|folderlu|folderru|log(in|out)[lmr]u|)
213 .images.yahoo.com/adv/
219 See the comments in the configuration files themselves, or the user-manual
220 for explanations of the above syntax, and other \fBPrivoxy\fP configuration
224 \fI/usr/sbin/privoxy\fP
226 \fI/etc/privoxy/config\fP
228 \fI/etc/privoxy/default.action\fP
230 \fI/etc/privoxy/advanced.action\fP
232 \fI/etc/privoxy/basic.action\fP
234 \fI/etc/privoxy/intermediate.action\fP
236 \fI/etc/privoxy/default.filter\fP
238 \fI/etc/privoxy/trust\fP
240 \fI/etc/privoxy/templates/*\fP
242 \fI/var/log/privoxy/logfile\fP
245 Various other files should be included, but may vary depending on platform
246 and build configuration. More documentation should be included in the local
247 documentation directory, though is not complete at this time.
250 \fBPrivoxy\fP terminates on the \fBSIGINT\fP, \fBSIGTERM\fP and \fBSIGABRT\fP
251 signals. Log rotation scripts may cause a re-opening of the logfile by sending
252 a \fBSIGHUP\fP to \fBPrivoxy\fP. Note that unlike other daemons, \fBPrivoxy\fP
253 does not need to be made aware of config file changes by \fBSIGHUP\fP -- it will
254 detect them automatically.
257 This is a \fBBETA\fP version of \fBPrivoxy\fP. Not all features are
260 Please see the user-maual on how to contact the developers for
261 feature requests, reporting problems, and other questions.
264 Probably. Please see the user-manual for how and where to report bugs.
268 http://ijbswa.sourceforge.net/config
270 http://ijbswa.sourceforge.net/
272 http://sourceforge.net/projects/ijbswa
274 http://www.waldherr.org/junkbuster/\" waldherr.org#
276 http://www.junkbusters.com/ht/en/cookies.html\" cookies.html#
278 http://privacy.net/analyze/
280 http://www.squid-cache.org/
282 http://linuxalpha.ch/packages/
314 .SH COPYRIGHT AND LICENSE
315 Orginally written by, and copyrighted by, the Anonymous Coders and Junkbusters
318 This program is free software; you can redistribute it and/or modify
319 it under the terms of the GNU General Public License as published by
320 the Free Software Foundation; either version 2 of the License, or
321 (at your option) any later version.
323 This program is distributed in the hope that it will be useful,
324 but WITHOUT ANY WARRANTY; without even the implied warranty of
325 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
326 GNU General Public License for more details.
328 You should have received a copy of the GNU General Public License
329 along with this program; if not, write to the Free Software
330 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
335 trademark\" legal.html#marks
336 of Junkbusters Corporation.