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.10 2002/05/04 08:44:44 swa 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 license SYSTEM "license.sgml">
48 <!entity authors SYSTEM "p-authors.sgml">
49 <!entity p-version "2.9.15">
50 <!entity p-status "beta">
51 <!entity % p-not-stable "INCLUDE">
52 <!entity % p-stable "IGNORE">
53 <!entity % p-text "IGNORE"> <!-- define we are not a text only doc -->
54 <!entity % p-authors-formal "IGNORE"> <!-- exclude additional formating -->
57 <refentry id="privoxy">
59 <date>2002-04-11</date>
63 <refentrytitle>privoxy</refentrytitle>
64 <manvolnum>1</manvolnum>
65 <refmiscinfo>Privoxy &p-version;<![%p-not-stable;[ &p-status;]]></refmiscinfo>
69 <refname><application>privoxy</application></refname>
70 <refpurpose>Privacy Enhancing Proxy</refpurpose>
75 <command>privoxy</command>
76 <arg><option>--help</option></arg>
77 <arg><option>--version</option></arg>
78 <arg><option>--no-daemon</option></arg>
79 <arg><option>--pidfile </option><replaceable class="parameter">pidfile</replaceable></arg>
80 <arg><option>--user </option><replaceable class="parameter">user[.group]</replaceable></arg>
81 <arg><replaceable class="parameter">configfile</replaceable></arg>
82 <command>(UNIX)</command>
86 <command>privoxy.exe</command>
87 <arg><replaceable class="parameter">configfile</replaceable></arg>
88 <command>(Windows)</command>
93 <!-- ~~~~~ New section ~~~~~ -->
94 <refsect1><title>Options</title>
96 <command>Privoxy</command> may be invoked with the following command line
105 Print brief usage info and exit.
111 <term>--version</term>
114 Print version info and exit.
120 <term>--no-daemon</term>
123 Don't become a daemon, i.e. don't fork and become process group
124 leader, don't detach from controlling tty, and do all logging there.
130 <term>--pidfile <replaceable class="parameter">pidfile</replaceable></term>
133 On startup, write the process ID to <replaceable class="parameter">pidfile</replaceable>.
134 Delete the <replaceable class="parameter">pidfile</replaceable> on exit.
135 Failiure to create or delete the <replaceable class="parameter">pidfile</replaceable>
136 is non-fatal. If no <command>--pidfile</command> option is given, no PID file will be used.
142 <term>--user <replaceable class="parameter">user[.group]</replaceable></term>
145 <!-- Note: replaceable is maybe the wrong tag, but generates -->
146 <!-- correct looking man output. -->
147 After (optionally) writing the PID file, assume the user ID of
148 <replaceable class="parameter">user</replaceable> and the GID of
149 <replaceable class="parameter">group</replaceable>, or, if the optional
150 <replaceable class="parameter">group</replaceable> was not given, the default group of
151 <replaceable class="parameter">user</replaceable>. Exit if the privileges are not
159 If the <filename>configfile</filename> is not specified on the command line,
160 <command>Privoxy</command> will look for a file named
161 <filename>config</filename> in the current directory (except on Win32 where
162 it will try <filename>config.txt</filename>). If no
163 <filename>configfile</filename> is found, <command>Privoxy</command> will
170 <!-- ~~~~~ New section ~~~~~ -->
171 <refsect1><title>Description</title>
172 <!-- Include privoxy.sgml boilerplate: -->
174 <!-- end boilerplate -->
178 <!-- ~~~~~ New section ~~~~~ -->
179 <refsect1><title>Installation and Usage</title>
181 Browsers must be individually configured to use <command>Privoxy</command> as
182 a HTTP proxy. The default setting is for localhost, on port 8118
183 (configurable in the main config file). To set the HTTP proxy in Netscape
184 and Mozilla, go through: <command>Edit</command>;
185 <command>Preferences</command>; <command>Advanced</command>;
186 <command>Proxies</command>; <command>Manual Proxy Configuration</command>;
187 <command>View</command>.
190 For Internet Explorer, go through: <command>Tools</command>;
191 <command>Internet Properties</command>; <command>Connections</command>;
192 <command>LAN Settings</command>.
195 The Secure (SSL) Proxy should also be set to the same values, otherwise
196 https: URLs will not be proxied.
199 For other browsers, check the documentation.
204 <!-- ~~~~~ New section ~~~~~ -->
205 <refsect1><title>Configuration</title>
207 <command>Privoxy</command> can be configured with the various configuration
208 files. The default configuration files are: <filename>config</filename>,
209 <filename>default.filter</filename>, and
210 <filename>default.action</filename>. <filename>user.action</filename> should
211 be used for locally defined exceptions to the default rules of
212 <filename>default.action</filename> These are all well commented. On Unix
213 and Unix-like systems, these are located in
214 <filename>/etc/privoxy/</filename> by default. On Windows, OS/2 and AmigaOS,
215 these files are in the same directory as the <command>Privoxy</command>
219 The name and number of configuration files has changed from previous
220 versions, and is subject to change as development progresses. In fact, the
221 configuration itself is changed and much more sophisticated. See the
222 <ulink url="http://www.privoxy.org/user-manual/">user-manual</ulink> for a
223 brief explanation of all configuration options.
226 The actions list (ad blocks, etc) can also be configured with your
227 web browser at <ulink url="http://ijbswa.sourceforge.net/config">http://ijbswa.sourceforge.net/config</ulink>.
228 <command>Privoxy's</command> configuration parameters can also be viewed at
229 the same page. In addition, <command>Privoxy</command> can be toggled on/off.
230 This is an internal page.
235 <!-- ~~~~~ New section ~~~~~ -->
236 <refsect1><title>Sample Configuration</title>
238 A brief example of what a simple <filename>default.action</filename>
239 configuration might look like:
243 # Define a few useful custom aliases for later use
247 +prevent-cookies = +prevent-setting-cookies +prevent-reading-cookies
248 -prevent-cookies = -prevent-setting-cookies -prevent-reading-cookies
249 +imageblock = +block +handle-as-image
251 # Fragile sites should have the minimum changes
252 fragile = -block -deanimate-gifs -fast-redirects -filter \
253 -hide-referer -prevent-cookies -kill-popups
255 ## Turn some actions on ################################
259 +deanimate-gifs{last} \
260 -downgrade-http-version \
262 +filter{html-annoyances} \
263 +filter{js-annoyances} \
264 +filter{content-cookies} \
266 +filter{banners-by-size} \
267 +hide-forwarded-for-headers \
268 +hide-from-header{block} \
269 +hide-referrer{forge} \
272 +set-image-blocker{pattern} \
274 +prevent-compression \
275 +session-cookies-only \
276 +prevent-reading-cookies \
277 +prevent-setting-cookies \
282 # Block, and treat these URL patterns as if they were 'images'.
285 .a[0-9].yimg.com/(?:(?!/i/).)*$
288 # Block any URLs that match these patterns
293 /.*count(er)?\.(pl|cgi|exe|dll|asp|php[34]?)
294 /(?:.*/)?(publicite|werbung|rekla(ma|me|am)|maino(kset|nta|s)?)/
297 # Make exceptions for these harmless ones that would be
298 # caught by +block above.
307 Then for a <filename>user.action</filename>, we would put local,
308 narrowly defined exceptions:
312 # Set personal exceptions to the policies in default.action #######
314 # Sites where we want persistant cookies
315 {-prevent-reading-cookies -prevent-setting-cookies -session-cookies-only}
320 {-block -fast-redirects}
326 See the comments in the configuration files themselves, or the
327 <citetitle>user-manual</citetitle>
328 for explanations of the above syntax, and other <command>Privoxy</command>
329 configuration options.
335 <!-- ~~~~~ New section ~~~~~ -->
336 <refsect1><title>Files</title>
337 <!-- this is a cheesy way to do this, but WTF. -->
339 <filename>/usr/sbin/privoxy</filename>
340 <filename>/etc/privoxy/config</filename>
341 <filename>/etc/privoxy/default.action</filename>
342 <filename>/etc/privoxy/standard.action</filename>
343 <filename>/etc/privoxy/user.action</filename>
344 <filename>/etc/privoxy/default.filter</filename>
345 <filename>/etc/privoxy/trust</filename>
346 <filename>/etc/privoxy/templates/*</filename>
347 <filename>/var/log/privoxy/logfile</filename>
351 Various other files should be included, but may vary depending on platform
352 and build configuration. More documentation should be included in the local
353 documentation directory, though is not complete at this time.
359 <!-- ~~~~~ New section ~~~~~ -->
360 <refsect1><title>Signals</title>
362 <!-- command tag is used here to get proper looking format -->
363 <command>Privoxy</command> terminates on the <command>SIGINT</command>,
364 <command>SIGTERM</command> and <command>SIGABRT</command> signals. Log
365 rotation scripts may cause a re-opening of the logfile by sending a
366 <command>SIGHUP</command> to <command>Privoxy</command>. Note that unlike
367 other daemons, <command>Privoxy</command> does not need to be made aware of
368 config file changes by <command>SIGHUP</command> -- it will detect them
374 <!-- ~~~~~ New section ~~~~~ -->
375 <refsect1><title>Notes</title>
378 This is a &p-status; version of <command>Privoxy</command>. Not
379 all features are well tested.
382 Please see the <citetitle>user-manual</citetitle> on how to contact the
383 developers for feature requests, reporting problems, and other questions.
388 <!-- ~~~~~ New section ~~~~~ -->
389 <refsect1><title>See Also</title>
390 <!-- Include seealso.sgml boilerplate: -->
392 <!-- end boilerplate -->
395 <!-- ~~~~~ New section ~~~~~ -->
396 <refsect1><title>Development Team</title>
397 <!-- Include p-authors.sgml boilerplate: -->
399 <!-- end boilerplate -->
402 <!-- ~~~~~ New section ~~~~~ -->
403 <refsect1><title>Copyright and License</title>
405 <refsect2><title>Copyright</title>
406 <!-- Include copyright.sgml boilerplate: -->
408 <!-- end boilerplate -->
411 <refsect2><title>License</title>
412 <!-- Include license.sgml boilerplate: -->
414 <!-- end boilerplate -->