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.8 2002/04/24 04:53:37 hal9 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.
20 ========================================================================
22 Doc NOTES: This is some tricky markup! There are some quirks
23 to how this markup is handled. It is not always so co-operative.
24 Please don't change the markup unless you can verify the changes
25 will improve finished output!
27 literallayout tags are particularly sensitive to where they are placed.
28 The 'replaceable' and 'command' tags are used here somewhat unconventionally,
29 since it seems to generate the proper formatting (at least for me :).
31 Create man page: 'make man'
33 Requires docbook2man (short perl script), see CVS
34 http://sources.redhat.com/docbook-tools/. Also requires openjade and SGMLSpm
37 For man page references, see:
38 http://www.linuxdoc.org/HOWTO/mini/DocBook-Install/using.html
39 http://docbook.org/tdg/en/html/ch02.html#making-refentry
42 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN"[
43 <!entity % dummy "IGNORE">
44 <!entity p-intro SYSTEM "privoxy.sgml">
45 <!entity seealso SYSTEM "seealso.sgml">
46 <!entity copyright SYSTEM "copyright.sgml">
47 <!entity authors SYSTEM "p-authors.sgml">
48 <!entity p-version "2.9.14">
49 <!entity p-status "beta">
50 <!entity % p-not-stable "INCLUDE">
51 <!entity % p-stable "IGNORE">
52 <!entity % p-text "IGNORE"> <!-- define we are not a text only doc -->
53 <!entity % p-authors-formal "IGNORE"> <!-- exclude additional formating -->
56 <refentry id="privoxy">
58 <date>2002-04-11</date>
62 <refentrytitle>privoxy</refentrytitle>
63 <manvolnum>1</manvolnum>
64 <refmiscinfo>Privoxy &p-version;<![%p-not-stable;[ &p-status;]]></refmiscinfo>
68 <refname><application>privoxy</application></refname>
69 <refpurpose>Privacy Enhancing Proxy</refpurpose>
74 <command>privoxy</command>
75 <arg><option>--help</option></arg>
76 <arg><option>--version</option></arg>
77 <arg><option>--no-daemon</option></arg>
78 <arg><option>--pidfile </option><replaceable class="parameter">pidfile</replaceable></arg>
79 <arg><option>--user </option><replaceable class="parameter">user[.group]</replaceable></arg>
80 <arg><replaceable class="parameter">configfile</replaceable></arg>
81 <command>(UNIX)</command>
85 <command>privoxy.exe</command>
86 <arg><replaceable class="parameter">configfile</replaceable></arg>
87 <command>(Windows)</command>
92 <!-- ~~~~~ New section ~~~~~ -->
93 <refsect1><title>Options</title>
95 <command>Privoxy</command> may be invoked with the following command line
104 Print brief usage info and exit.
110 <term>--version</term>
113 Print version info and exit.
119 <term>--no-daemon</term>
122 Don't become a daemon, i.e. don't fork and become process group
123 leader, don't detach from controlling tty, and do all logging there.
129 <term>--pidfile <replaceable class="parameter">pidfile</replaceable></term>
132 On startup, write the process ID to <replaceable class="parameter">pidfile</replaceable>.
133 Delete the <replaceable class="parameter">pidfile</replaceable> on exit.
134 Failiure to create or delete the <replaceable class="parameter">pidfile</replaceable>
135 is non-fatal. If no <command>--pidfile</command> option is given, no PID file will be used.
141 <term>--user <replaceable class="parameter">user[.group]</replaceable></term>
144 <!-- Note: replaceable is maybe the wrong tag, but generates -->
145 <!-- correct looking man output. -->
146 After (optionally) writing the PID file, assume the user ID of
147 <replaceable class="parameter">user</replaceable> and the GID of
148 <replaceable class="parameter">group</replaceable>, or, if the optional
149 <replaceable class="parameter">group</replaceable> was not given, the default group of
150 <replaceable class="parameter">user</replaceable>. Exit if the privileges are not
158 If the <filename>configfile</filename> is not specified on the command line,
159 <command>Privoxy</command> will look for a file named
160 <filename>config</filename> in the current directory (except on Win32 where
161 it will try <filename>config.txt</filename>). If no
162 <filename>configfile</filename> is found, <command>Privoxy</command> will
169 <!-- ~~~~~ New section ~~~~~ -->
170 <refsect1><title>Description</title>
171 <!-- Include privoxy.sgml boilerplate: -->
173 <!-- end boilerplate -->
177 <!-- ~~~~~ New section ~~~~~ -->
178 <refsect1><title>Installation and Usage</title>
180 Browsers must be individually configured to use <command>Privoxy</command> as
181 a HTTP proxy. The default setting is for localhost, on port 8118
182 (configurable in the main config file). To set the HTTP proxy in Netscape
183 and Mozilla, go through: <command>Edit</command>;
184 <command>Preferences</command>; <command>Advanced</command>;
185 <command>Proxies</command>; <command>Manual Proxy Configuration</command>;
186 <command>View</command>.
189 For Internet Explorer, go through: <command>Tools</command>;
190 <command>Internet Properties</command>; <command>Connections</command>;
191 <command>LAN Settings</command>.
194 The Secure (SSL) Proxy should also be set to the same values, otherwise
195 https: URLs will not be proxied.
198 For other browsers, check the documentation.
203 <!-- ~~~~~ New section ~~~~~ -->
204 <refsect1><title>Configuration</title>
206 <command>Privoxy</command> can be configured with the various configuration
207 files. The default configuration files are: <filename>config</filename>,
208 <filename>default.filter</filename>, and
209 <filename>default.action</filename>. <filename>user.action</filename> should
210 be used for locally defined exceptions to the default rules of
211 <filename>default.action</filename> These are all well commented. On Unix
212 and Unix-like systems, these are located in
213 <filename>/etc/privoxy/</filename> by default. On Windows, OS/2 and AmigaOS,
214 these files are in the same directory as the <command>Privoxy</command>
218 The name and number of configuration files has changed from previous
219 versions, and is subject to change as development progresses. In fact, the
220 configuration itself is changed and much more sophisticated. See the
221 <ulink url="http://www.privoxy.org/user-manual/">user-manual</ulink> for a
222 brief explanation of all configuration options.
225 The actions list (ad blocks, etc) can also be configured with your
226 web browser at <ulink url="http://ijbswa.sourceforge.net/config">http://ijbswa.sourceforge.net/config</ulink>.
227 <command>Privoxy's</command> configuration parameters can also be viewed at
228 the same page. In addition, <command>Privoxy</command> can be toggled on/off.
229 This is an internal page.
234 <!-- ~~~~~ New section ~~~~~ -->
235 <refsect1><title>Sample Configuration</title>
237 A brief example of what a simple <filename>default.action</filename>
238 configuration might look like:
242 # Define a few useful custom aliases for later use
246 +prevent-cookies = +prevent-setting-cookies +prevent-reading-cookies
247 -prevent-cookies = -prevent-setting-cookies -prevent-reading-cookies
248 +imageblock = +block +handle-as-image
250 # Fragile sites should have the minimum changes
251 fragile = -block -deanimate-gifs -fast-redirects -filter \
252 -hide-referer -prevent-cookies -kill-popups
254 ## Turn some actions on ################################
258 +deanimate-gifs{last} \
259 -downgrade-http-version \
261 +filter{html-annoyances} \
262 +filter{js-annoyances} \
263 +filter{content-cookies} \
265 +filter{banners-by-size} \
266 +hide-forwarded-for-headers \
267 +hide-from-header{block} \
268 +hide-referrer{forge} \
271 +set-image-blocker{pattern} \
273 +prevent-compression \
274 +session-cookies-only \
275 +prevent-reading-cookies \
276 +prevent-setting-cookies \
281 # Block, and treat these URL patterns as if they were 'images'.
284 .a[0-9].yimg.com/(?:(?!/i/).)*$
287 # Block any URLs that match these patterns
292 /.*count(er)?\.(pl|cgi|exe|dll|asp|php[34]?)
293 /(?:.*/)?(publicite|werbung|rekla(ma|me|am)|maino(kset|nta|s)?)/
296 # Make exceptions for these harmless ones that would be
297 # caught by +block above.
306 Then for a <filename>user.action</filename>, we would put local,
307 narrowly defined exceptions:
311 # Set personal exceptions to the policies in default.action #######
313 # Sites where we want persistant cookies
314 {-prevent-reading-cookies -prevent-setting-cookies -session-cookies-only}
319 {-block -fast-redirects}
325 See the comments in the configuration files themselves, or the
326 <citetitle>user-manual</citetitle>
327 for explanations of the above syntax, and other <command>Privoxy</command>
328 configuration options.
334 <!-- ~~~~~ New section ~~~~~ -->
335 <refsect1><title>Files</title>
336 <!-- this is a cheesy way to do this, but WTF. -->
338 <filename>/usr/sbin/privoxy</filename>
339 <filename>/etc/privoxy/config</filename>
340 <filename>/etc/privoxy/default.action</filename>
341 <filename>/etc/privoxy/standard.action</filename>
342 <filename>/etc/privoxy/user.action</filename>
343 <filename>/etc/privoxy/default.filter</filename>
344 <filename>/etc/privoxy/trust</filename>
345 <filename>/etc/privoxy/templates/*</filename>
346 <filename>/var/log/privoxy/logfile</filename>
350 Various other files should be included, but may vary depending on platform
351 and build configuration. More documentation should be included in the local
352 documentation directory, though is not complete at this time.
358 <!-- ~~~~~ New section ~~~~~ -->
359 <refsect1><title>Signals</title>
361 <!-- command tag is used here to get proper looking format -->
362 <command>Privoxy</command> terminates on the <command>SIGINT</command>,
363 <command>SIGTERM</command> and <command>SIGABRT</command> signals. Log
364 rotation scripts may cause a re-opening of the logfile by sending a
365 <command>SIGHUP</command> to <command>Privoxy</command>. Note that unlike
366 other daemons, <command>Privoxy</command> does not need to be made aware of
367 config file changes by <command>SIGHUP</command> -- it will detect them
373 <!-- ~~~~~ New section ~~~~~ -->
374 <refsect1><title>Notes</title>
377 This is a &p-status; version of <command>Privoxy</command>. Not
378 all features are well tested.
381 Please see the <citetitle>user-manual</citetitle> on how to contact the
382 developers for feature requests, reporting problems, and other questions.
387 <!-- ~~~~~ New section ~~~~~ -->
388 <refsect1><title>See Also</title>
389 <!-- Include seealso.sgml boilerplate: -->
391 <!-- end boilerplate -->
394 <!-- ~~~~~ New section ~~~~~ -->
395 <refsect1><title>Development Team</title>
396 <!-- Include p-authors.sgml boilerplate: -->
398 <!-- end boilerplate -->
401 <!-- ~~~~~ New section ~~~~~ -->
402 <refsect1><title>Copyright and License</title>
403 <!-- Include copyright.sgml boilerplate: -->
405 <!-- end boilerplate -->