2 File : $Source: /cvsroot/ijbswa/current/doc/source/privoxy-man-page.sgml,v $
6 ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/
8 $Id: privoxy-man-page.sgml,v 1.5 2002/04/11 10:02:27 oes Exp $
10 Written by and Copyright (C) 2001 the SourceForge
11 Privoxy team. http://www.privoxy.org/
13 Based on the Internet Junkbuster originally written
14 by and Copyright (C) 1997 Anonymous Coders and
15 Junkbusters Corporation. http://www.junkbusters.com
17 ========================================================================
18 NOTE: Please read developer-manual/documentation.html before touching
19 anything in this, or other Privoxy documentation. You have been warned!
20 Failure to abide by this rule will result in the revocation of your license
21 to live a peaceful existence!
22 ========================================================================
24 Doc NOTES: This is some tricky stuff! There are some quirks
25 to how this markup is handled. It is not always so co-operative.
26 Please don't change the markup, unless you are willing to
29 literallayout tags are particularly sensitive to where they are placed.
30 The 'replaceable' and 'command' tags are used here somewhat unconventionally,
31 since it seems to generate the proper formatting (at least for me :).
33 Create man page: 'docbook2man privoxy-man-page.sgml'
35 For man page references, see:
36 http://www.linuxdoc.org/HOWTO/mini/DocBook-Install/using.html
37 http://docbook.org/tdg/en/html/ch02.html#making-refentry
40 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN"[
41 <!entity % dummy "INCLUDE">
42 <!entity p-intro SYSTEM "privoxy.sgml">
43 <!entity seealso SYSTEM "seealso.sgml">
44 <!entity copyright SYSTEM "copyright.sgml">
45 <!entity authors SYSTEM "p-authors.sgml">
46 <!entity p-version "2.9.14">
47 <!entity p-status "beta">
48 <!entity % p-not-stable "INCLUDE">
49 <!entity % p-stable "IGNORE">
50 <!entity % p-text "IGNORE"> <!-- define we are not a text only doc -->
51 <!entity % p-authors-formal "IGNORE"> <!-- exclude additional formating -->
54 <refentry id="privoxy">
56 <date>2002-04-11</date>
60 <refentrytitle>privoxy</refentrytitle>
61 <manvolnum>1</manvolnum>
62 <refmiscinfo>Privoxy &p-version;<![%p-not-stable;[ &p-status;]]></refmiscinfo>
66 <refname><application>privoxy</application></refname>
67 <refpurpose>Privacy Enhancing Proxy</refpurpose>
72 <command>privoxy</command>
73 <arg><option>--help</option></arg>
74 <arg><option>--version</option></arg>
75 <arg><option>--no-daemon</option></arg>
76 <arg><option>--pidfile </option><replaceable class="parameter">pidfile</replaceable></arg>
77 <arg><option>--user </option><replaceable class="parameter">user[.group]</replaceable></arg>
78 <arg><replaceable class="parameter">configfile</replaceable></arg>
79 <command>(UNIX)</command>
83 <command>privoxy.exe</command>
84 <arg><replaceable class="parameter">configfile</replaceable></arg>
85 <command>(Windows)</command>
90 <!-- ~~~~~ New section ~~~~~ -->
91 <refsect1><title>Options</title>
93 <command>Privoxy</command> may be invoked with the following command line
102 Print brief usage info and exit.
108 <term>--version</term>
111 Print version info and exit.
117 <term>--no-daemon</term>
120 Don't become a daemon, i.e. don't fork and become process group
121 leader, don't detach from controlling tty, and do all logging there.
127 <term>--pidfile <replaceable class="parameter">pidfile</replaceable></term>
130 On startup, write the process ID to <replaceable class="parameter">pidfile</replaceable>.
131 Delete the <replaceable class="parameter">pidfile</replaceable> on exit.
132 Failiure to create or delete the <replaceable class="parameter">pidfile</replaceable>
133 is non-fatal. If no <command>--pidfile</command> option is given, no PID file will be used.
139 <term>--user <replaceable class="parameter">user[.group]</replaceable></term>
142 <!-- Note: replaceable is maybe the wrong tag, but generates -->
143 <!-- correct looking man output. -->
144 After (optionally) writing the PID file, assume the user ID of
145 <replaceable class="parameter">user</replaceable> and the GID of
146 <replaceable class="parameter">group</replaceable>, or, if the optional
147 <replaceable class="parameter">group</replaceable> was not given, the default group of
148 <replaceable class="parameter">user</replaceable>. Exit if the privileges are not
156 If the <filename>configfile</filename> is not specified on the command line,
157 <command>Privoxy</command> will look for a file named
158 <filename>config</filename> in the current directory (except on Win32 where
159 it will try <filename>config.txt</filename>). If no
160 <filename>configfile</filename> is found, <command>Privoxy</command> will
167 <!-- ~~~~~ New section ~~~~~ -->
168 <refsect1><title>Description</title>
169 <!-- Include privoxy.sgml boilerplate: -->
171 <!-- end boilerplate -->
175 <!-- ~~~~~ New section ~~~~~ -->
176 <refsect1><title>Installation and Usage</title>
178 Browsers must be individually configured to use <command>Privoxy</command> as
179 a HTTP proxy. The default setting is for localhost, on port 8118
180 (configurable in the main config file). To set the HTTP proxy in Netscape
181 and Mozilla, go through: <command>Edit</command>;
182 <command>Preferences</command>; <command>Advanced</command>;
183 <command>Proxies</command>; <command>Manual Proxy Configuration</command>;
184 <command>View</command>.
187 For Internet Explorer, go through: <command>Tools</command>;
188 <command>Internet Properties</command>; <command>Connections</command>;
189 <command>LAN Settings</command>.
192 The Secure (SSL) Proxy should also be set to the same values, otherwise
193 https: URLs will not be proxied.
196 For other browsers, check the documentation.
201 <!-- ~~~~~ New section ~~~~~ -->
202 <refsect1><title>Configuration</title>
204 <command>Privoxy</command> can be configured with the various configuration
205 files. The default configuration files are: <filename>config</filename>,
206 <filename>default.action</filename>, and
207 <filename>default.filter</filename>. These are well commented. On Unix and
208 Unix-like systems, these are located in <filename>/etc/privoxy/</filename> by
209 default. On Windows, OS/2 and AmigaOS, these files are in the same directory
210 as the <command>Privoxy</command> executable.
213 The name and number of configuration files has changed from previous
214 versions, and is subject to change as development progresses. In fact, the
215 configuration itself is changed and much more sophisticated. See the
216 <ulink url="http://www.privoxy.org/user-manual/">user-manual</ulink> for a
217 brief explanation of all configuration options.
220 The actions list (ad blocks, etc) can also be configured with your
221 web browser at <ulink url="http://ijbswa.sourceforge.net/config">http://ijbswa.sourceforge.net/config</ulink>.
222 <command>Privoxy's</command> configuration parameters can also be viewed at
223 the same page. In addition, <command>Privoxy</command> can be toggled on/off.
224 This is an internal page.
229 <!-- ~~~~~ New section ~~~~~ -->
230 <refsect1><title>Sample Configuration</title>
232 A brief example of what a <filename>default.action</filename> configuration
238 # Define a few useful custom aliases for later use
241 # Don't accept cookies
242 +no-cookies = +no-cookies-set +no-cookies-read
245 -no-cookies = -no-cookies-set -no-cookies-read
247 # Treat these blocked URLs as images.
248 +imageblock = +block +image
250 # Define page filters we want to use.
251 myfilters = +filter{html-annoyances} +filter{js-annoyances}\
252 +filter{no-popups} +filter{webbugs}
254 ## Default Policies (actions) ############################
263 +hide-referer{forge} \
266 +image-blocker{blank} \
276 # Now set exceptions to the above defined policies #######
278 # Sites where we want persistant cookies
279 {-no-cookies -no-cookies-keep}
285 # This site requires cookies AND 'fast-redirects' on
286 {-no-cookies -no-cookies-keep -fast-redirects}
289 # Add custom headers, and turn off filtering of page source
290 {+add-header{X-Privacy: Yes please} #-add-header{*} \
291 +add-header{X-User-Tracking: No thanks!} -filter}
294 # Block, and treat these URLs as 'images'.
297 .ad.preferences.com/image.*
299 .ad-adex3.flycast.com
302 .ad.de.doubleclick.net
303 /.*/count\.cgi\?.*df=
305 a196.g.akamai.net/7/196/2670/000[12]/images.gmx.net/i4/images/.*/
307 # Block any URLs that match these patterns
309 /.*/(.*[-_.])?ads?[0-9]?(/|[-_.].*|\.(gif|jpe?g))
310 /.*/(plain|live|rotate)[-_.]?ads?/
311 /.*/(sponsor)s?[0-9]?/
312 /.*/ad(server|stream|juggler)\.(cgi|pl|dll|exe)
314 /.*/adv((er)?ts?|ertis(ing|ements?))?/
317 /.*/advert[0-9]+\.jpg
320 /images/.*/.*_anim\.gif
322 /.*(ms)?backoff(ice)?.*\.(gif|jpe?g)
323 195.63.104.*/(inbox|log|meld|folderlu|folderru|log(in|out)[lmr]u|)
325 .images.yahoo.com/adv/
331 See the comments in the configuration files themselves, or the
332 <citetitle>user-manual</citetitle>
333 for explanations of the above syntax, and other <command>Privoxy</command>
334 configuration options.
340 <!-- ~~~~~ New section ~~~~~ -->
341 <refsect1><title>Files</title>
342 <!-- this is a cheesy way to do this, but WTF. -->
344 <filename>/usr/sbin/privoxy</filename>
345 <filename>/etc/privoxy/config</filename>
346 <filename>/etc/privoxy/default.action</filename>
347 <filename>/etc/privoxy/advanced.action</filename>
348 <filename>/etc/privoxy/basic.action</filename>
349 <filename>/etc/privoxy/intermediate.action</filename>
350 <filename>/etc/privoxy/default.filter</filename>
351 <filename>/etc/privoxy/trust</filename>
352 <filename>/etc/privoxy/templates/*</filename>
353 <filename>/var/log/privoxy/logfile</filename>
357 Various other files should be included, but may vary depending on platform
358 and build configuration. More documentation should be included in the local
359 documentation directory, though is not complete at this time.
365 <!-- ~~~~~ New section ~~~~~ -->
366 <refsect1><title>Signals</title>
368 <!-- command tag is used here to get proper looking format -->
369 <command>Privoxy</command> terminates on the <command>SIGINT</command>,
370 <command>SIGTERM</command> and <command>SIGABRT</command> signals. Log
371 rotation scripts may cause a re-opening of the logfile by sending a
372 <command>SIGHUP</command> to <command>Privoxy</command>. Note that unlike
373 other daemons, <command>Privoxy</command> does not need to be made aware of
374 config file changes by <command>SIGHUP</command> -- it will detect them
380 <!-- ~~~~~ New section ~~~~~ -->
381 <refsect1><title>Notes</title>
384 This is a &p-status; version of <command>Privoxy</command>. Not
385 all features are well tested.
388 Please see the <citetitle>user-manual</citetitle> on how to contact the
389 developers for feature requests, reporting problems, and other questions.
394 <!-- ~~~~~ New section ~~~~~ -->
395 <refsect1><title>See Also</title>
396 <!-- Include seealso.sgml boilerplate: -->
398 <!-- end boilerplate -->
401 <!-- ~~~~~ New section ~~~~~ -->
402 <refsect1><title>Development Team</title>
403 <!-- Include p-authors.sgml boilerplate: -->
405 <!-- end boilerplate -->
408 <!-- ~~~~~ New section ~~~~~ -->
409 <refsect1><title>Copyright and License</title>
410 <!-- Include seealso.sgml boilerplate: -->
412 <!-- end boilerplate -->