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 2.3 2002/09/05 05:45:30 hal9 Exp $
10 Copyright (C) 2001, 2002 Privoxy Developers <developers@privoxy.org>
13 ========================================================================
14 NOTE: Please read developer-manual/documentation.html before touching
15 anything in this, or other Privoxy documentation.
16 ========================================================================
18 Doc NOTES: This is some tricky markup! There are some quirks
19 to how this markup is handled. It is not always so co-operative.
20 Please don't change the markup unless you can verify the changes
21 will improve finished output!
23 literallayout tags are particularly sensitive to where they are placed.
24 The 'replaceable' and 'command' tags are used here somewhat unconventionally,
25 since it seems to generate the proper formatting (at least for me :).
27 For man page references, see:
28 http://www.linuxdoc.org/HOWTO/mini/DocBook-Install/using.html
29 http://docbook.org/tdg/en/html/ch02.html#making-refentry
32 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN"[
33 <!entity % dummy "IGNORE">
34 <!entity p-intro SYSTEM "privoxy.sgml">
35 <!entity seealso SYSTEM "seealso.sgml">
36 <!entity copyright SYSTEM "copyright.sgml">
37 <!entity license SYSTEM "license.sgml">
38 <!entity authors SYSTEM "p-authors.sgml">
39 <!entity p-version SYSTEM "doc_version.tmp">
40 <!entity p-status SYSTEM "doc_status.tmp">
41 <!entity % p-not-stable "IGNORE">
42 <!entity % p-stable "IGNORE">
43 <!entity % p-alpha "IGNORE">
44 <!entity % p-beta "IGNORE">
45 <!entity % p-text "IGNORE"> <!-- define we are not a text only doc -->
46 <!entity % p-authors-formal "IGNORE"> <!-- exclude additional formating -->
47 <!entity my-copy "(C)"> <!-- db2man barfs on copyright symbol -->
50 <refentry id="privoxy">
52 <date>2002-05-14</date>
55 <refentrytitle>privoxy</refentrytitle>
56 <manvolnum>1</manvolnum>
58 Privoxy &p-version;<![%p-not-stable;[ &p-status;]]>
63 <refname><application>privoxy</application></refname>
64 <refpurpose>Privacy Enhancing Proxy</refpurpose>
69 <command>privoxy</command>
70 <arg><option>--help</option></arg>
71 <arg><option>--version</option></arg>
72 <arg><option>--no-daemon</option></arg>
73 <arg><option>--pidfile </option><replaceable class="parameter">pidfile</replaceable></arg>
74 <arg><option>--user </option><replaceable class="parameter">user[.group]</replaceable></arg>
75 <arg><replaceable class="parameter">configfile</replaceable></arg>
76 <command> (UNIX)</command>
80 <command>privoxy.exe</command>
81 <arg><replaceable class="parameter">configfile</replaceable></arg>
82 <command> (Windows)</command>
87 <!-- ~~~~~ New section ~~~~~ -->
88 <refsect1><title>Options</title>
90 <command>Privoxy</command> may be invoked with the following command line
99 Print brief usage info and exit.
105 <term>--version</term>
108 Print version info and exit.
114 <term>--no-daemon</term>
117 Don't become a daemon, i.e. don't fork and become process group
118 leader, don't detach from controlling tty, and do all logging there.
124 <term>--pidfile <replaceable class="parameter">pidfile</replaceable></term>
127 On startup, write the process ID to <replaceable class="parameter">pidfile</replaceable>.
128 Delete the <replaceable class="parameter">pidfile</replaceable> on exit.
129 Failure to create or delete the <replaceable class="parameter">pidfile</replaceable>
130 is non-fatal. If no <command>--pidfile</command> option is given, no PID file will be used.
136 <term>--user <replaceable class="parameter">user[.group]</replaceable></term>
139 <!-- Note: replaceable is maybe the wrong tag, but generates -->
140 <!-- correct looking man output. -->
141 After (optionally) writing the PID file, assume the user ID of
142 <replaceable class="parameter">user</replaceable> and the GID of
143 <replaceable class="parameter">group</replaceable>, or, if the optional
144 <replaceable class="parameter">group</replaceable> was not given, the default group of
145 <replaceable class="parameter">user</replaceable>. Exit if the privileges are not
153 If the <filename>configfile</filename> is not specified on the command line,
154 <command>Privoxy</command> will look for a file named
155 <filename>config</filename> in the current directory (except on Win32 where
156 it will try <filename>config.txt</filename>). If no
157 <filename>configfile</filename> is found, <command>Privoxy</command> will
164 <!-- ~~~~~ New section ~~~~~ -->
165 <refsect1><title>Description</title>
166 <!-- Include privoxy.sgml boilerplate: -->
168 <!-- end boilerplate -->
172 <!-- ~~~~~ New section ~~~~~ -->
173 <refsect1><title>Installation and Usage</title>
175 Browsers must be individually configured to use <command>Privoxy</command> as
176 a HTTP proxy. The default setting is for localhost, on port 8118
177 (configurable in the main config file). To set the HTTP proxy in Netscape
178 and Mozilla, go through: <command>Edit</command>;
179 <command>Preferences</command>; <command>Advanced</command>;
180 <command>Proxies</command>; <command>Manual Proxy Configuration</command>;
181 <command>View</command>.
184 For Internet Explorer, go through: <command>Tools</command>;
185 <command>Internet Properties</command>; <command>Connections</command>;
186 <command>LAN Settings</command>.
189 The Secure (SSL) Proxy should also be set to the same values, otherwise
190 https: URLs will not be proxied. Note: <command>Privoxy</command> can only
191 proxy HTTP and HTTPS traffic. Do not try it with FTP or other protocols.
195 For other browsers, check the documentation.
200 <!-- ~~~~~ New section ~~~~~ -->
201 <refsect1><title>Configuration</title>
203 <command>Privoxy</command> can be configured with the various configuration
204 files. The default configuration files are: <filename>config</filename>,
205 <filename>default.filter</filename>, and
206 <filename>default.action</filename>. <filename>user.action</filename> should
207 be used for locally defined exceptions to the default rules of
208 <filename>default.action</filename> These are all well commented. On Unix
209 and Unix-like systems, these are located in
210 <filename>/etc/privoxy/</filename> by default. On Windows, OS/2 and AmigaOS,
211 these files are in the same directory as the <command>Privoxy</command>
215 The name and number of configuration files has changed from previous
216 versions<![%p-not-stable;[, and is subject to change as development
217 progresses]]>. In fact, the configuration itself is changed and much more
218 sophisticated. See the <ulink
219 url="http://www.privoxy.org/user-manual/">user-manual</ulink> for a complete
220 explanation of all configuration options and general usage, and notes for
221 upgrading from <command>Junkbuster</command> and earlier <command>Privoxy</command>
225 The actions list (ad blocks, etc) can also be configured with your
226 web browser at <ulink url="http://config.privoxy.org/">http://config.privoxy.org/</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, and does not require Internet access.
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 +crunch-cookies = +crunch-incoming-cookies +crunch-outgoing-cookies
247 -crunch-cookies = -crunch-incoming-cookies -crunch-outgoing-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 \
278 / # '/' Matches *all* URL patterns
280 # Block, and treat these URL patterns as if they were 'images'.
281 # We would expect these to be ads.
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]?)
295 # Make exceptions for these harmless ones that would be
296 # caught by our +block patterns just above.
305 Then for a <filename>user.action</filename>, we would put local,
306 narrowly defined exceptions:
310 # Re-define aliases as needed here
314 -crunch-cookies = -crunch-incoming-cookies -crunch-outgoing-cookies
316 # Set personal exceptions to the policies in default.action #######
318 # Sites where we want persistant cookies, so allow *all* cookies
319 {-crunch-cookies -session-cookies-only}
324 # This site breaks easily.
325 {-block -fast-redirects}
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/standard.action</filename>
348 <filename>/etc/privoxy/user.action</filename>
349 <filename>/etc/privoxy/default.filter</filename>
350 <filename>/etc/privoxy/trust</filename>
351 <filename>/etc/privoxy/templates/*</filename>
352 <filename>/var/log/privoxy/logfile</filename>
356 Various other files should be included, but may vary depending on platform
357 and build configuration. More documentation should be included in the local
358 documentation directory.
364 <!-- ~~~~~ New section ~~~~~ -->
365 <refsect1><title>Signals</title>
367 <!-- command tag is used here to get proper looking format -->
368 <command>Privoxy</command> terminates on the <command>SIGINT</command>,
369 <command>SIGTERM</command> and <command>SIGABRT</command> signals. Log
370 rotation scripts may cause a re-opening of the logfile by sending a
371 <command>SIGHUP</command> to <command>Privoxy</command>. Note that unlike
372 other daemons, <command>Privoxy</command> does not need to be made aware of
373 config file changes by <command>SIGHUP</command> -- it will detect them
379 <!-- ~~~~~ New section ~~~~~ -->
380 <refsect1><title>Notes</title>
383 This is a &p-status; version of <command>Privoxy</command>. Not
384 all features are well tested.
387 Please see the <citetitle>User Manual</citetitle> on how to contact the
388 developers for feature requests, reporting problems, and other questions.
393 <!-- ~~~~~ New section ~~~~~ -->
394 <refsect1><title>See Also</title>
395 <!-- Include seealso.sgml boilerplate: -->
397 <!-- end boilerplate -->
400 <!-- ~~~~~ New section ~~~~~ -->
401 <refsect1><title>Development Team</title>
402 <!-- Include p-authors.sgml boilerplate: -->
404 <!-- end boilerplate -->
407 <!-- ~~~~~ New section ~~~~~ -->
408 <refsect1><title>Copyright and License</title>
410 <refsect2><title>Copyright</title>
411 <!-- Include copyright.sgml boilerplate: -->
413 <!-- end boilerplate -->
416 <refsect2><title>License</title>
417 <!-- Include license.sgml boilerplate: -->
419 <!-- end boilerplate -->