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.50 2016/01/17 14:32:19 fabiankeil Exp $
10 Copyright (C) 2001-2012 Privoxy Developers http://www.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 Create man page: 'make man'
29 Requires docbook2man (short perl script), see CVS
30 http://sources.redhat.com/docbook-tools/. Also requires openjade and SGMLSpm
33 For man page references, see:
34 http://www.linuxdoc.org/HOWTO/mini/DocBook-Install/using.html
35 http://docbook.org/tdg/en/html/ch02.html#making-refentry
38 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN"[
39 <!entity % dummy "IGNORE">
40 <!entity p-intro SYSTEM "privoxy.sgml">
41 <!entity seealso SYSTEM "seealso.sgml">
42 <!entity copyright SYSTEM "copyright.sgml">
43 <!entity license SYSTEM "license.sgml">
44 <!entity authors SYSTEM "p-authors.sgml">
45 <!entity p-version "3.0.24">
46 <!entity p-status "stable">
47 <!entity % p-not-stable "IGNORE">
48 <!entity % p-stable "INCLUDE">
49 <!entity % p-text "IGNORE"> <!-- define we are not a text only doc -->
50 <!entity % p-authors-formal "IGNORE"> <!-- exclude additional formating -->
51 <!entity my-copy "(C)"> <!-- db2man barfs on copyright symbol -->
52 <!entity % seealso-extra "IGNORE"> <!-- for excluding sections of seealso -->
55 <refentry id="privoxy">
57 <date>2012-11-08</date>
60 <refentrytitle>privoxy</refentrytitle>
61 <manvolnum>1</manvolnum>
63 Privoxy &p-version;<![%p-not-stable;[ &p-status;]]>
68 <refname><application>privoxy</application></refname>
69 <refpurpose>Privacy Enhancing Proxy</refpurpose>
74 <command>privoxy</command>
75 <arg><option>--chroot</option></arg>
76 <arg><option>--config-test</option></arg>
77 <arg><option>--help</option></arg>
78 <arg><option>--no-daemon</option></arg>
79 <arg><option>--pidfile </option><replaceable class="parameter">pidfile</replaceable></arg>
80 <arg><option>--pre-chroot-nslookup </option><replaceable class="parameter">hostname</replaceable></arg>
81 <arg><option>--user </option><replaceable class="parameter">user[.group]</replaceable></arg>
82 <arg><option>--version</option></arg>
83 <arg><replaceable class="parameter">configfile</replaceable></arg>
89 <!-- ~~~~~ New section ~~~~~ -->
90 <refsect1><title>Options</title>
92 <command>Privoxy</command> may be invoked with the following command line
102 Before changing to the user ID given in the --user option, chroot to
103 that user's home directory, i.e. make the kernel pretend to the
104 <command>Privoxy</command> process that the directory tree starts
105 there. If set up carefully, this can limit the impact of possible
106 vulnerabilities in <command>Privoxy</command> to the files contained in
113 <term>--config-test</term>
116 Exit after loading the configuration files before binding to
117 the listen address. The exit code signals whether or not the
118 configuration files have been successfully loaded.
121 If the exit code is 1, at least one of the configuration files
122 is invalid, if it is 0, all the configuration files have been
123 successfully loaded (but may still contain errors that can
124 currently only be detected at run time).
127 This option doesn't affect the log setting, combination with
128 "--no-daemon" is recommended if a configured log file shouldn't
138 Print brief usage info and exit.
144 <term>--no-daemon</term>
147 Don't become a daemon, i.e. don't fork and become process group
148 leader, don't detach from controlling tty, and do all logging there.
154 <term>--pidfile <replaceable class="parameter">pidfile</replaceable></term>
157 On startup, write the process ID to <replaceable class="parameter">pidfile</replaceable>.
158 Delete the <replaceable class="parameter">pidfile</replaceable> on exit.
159 Failure to create or delete the <replaceable class="parameter">pidfile</replaceable>
160 is non-fatal. If no <command>--pidfile</command> option is given, no PID file will be used.
166 <term>--pre-chroot-nslookup <replaceable class="parameter">hostname</replaceable></term>
169 Initialize the resolver library using <replaceable class="parameter">hostname</replaceable>
170 before chroot'ing. On some systems this reduces the number of files
171 that must be copied into the chroot tree.
177 <term>--user <replaceable class="parameter">user[.group]</replaceable></term>
180 <!-- Note: replaceable is maybe the wrong tag, but generates -->
181 <!-- correct looking man output. -->
182 After (optionally) writing the PID file, assume the user ID of
183 <replaceable class="parameter">user</replaceable> and the GID of
184 <replaceable class="parameter">group</replaceable>, or, if the optional
185 <replaceable class="parameter">group</replaceable> was not given, the default group of
186 <replaceable class="parameter">user</replaceable>. Exit if the privileges are not
193 <term>--version</term>
196 Print version info and exit.
204 If the <filename>configfile</filename> is not specified on the command line,
205 <command>Privoxy</command> will look for a file named
206 <filename>config</filename> in the current directory. If no
207 <filename>configfile</filename> is found, <command>Privoxy</command> will
214 <!-- ~~~~~ New section ~~~~~ -->
215 <refsect1><title>Description</title>
216 <!-- Include privoxy.sgml boilerplate: -->
218 <!-- end boilerplate -->
222 <!-- ~~~~~ New section ~~~~~ -->
223 <refsect1><title>Installation and Usage</title>
225 Browsers can either be individually configured to use
226 <command>Privoxy</command> as a HTTP proxy (recommended),
227 or <command>Privoxy</command> can be combined with a packet
228 filter to build an intercepting proxy
229 (see <filename>config</filename>). The default setting is for
230 localhost, on port 8118 (configurable in the main config file). To set the
231 HTTP proxy in Firefox, go through: <command>Tools</command>;
232 <command>Options</command>; <command>General</command>;
233 <command>Connection Settings</command>;
234 <command>Manual Proxy Configuration</command>.
237 For Internet Explorer, go through: <command>Tools</command>;
238 <command>Internet Properties</command>; <command>Connections</command>;
239 <command>LAN Settings</command>.
242 The Secure (SSL) Proxy should also be set to the same values, otherwise
243 https: URLs will not be proxied. Note: <command>Privoxy</command> can only
244 proxy HTTP and HTTPS traffic. Do not try it with FTP or other protocols.
245 HTTPS presents some limitations, and not all features will work with HTTPS
250 For other browsers, check the documentation.
255 <!-- ~~~~~ New section ~~~~~ -->
256 <refsect1><title>Configuration</title>
258 <command>Privoxy</command> can be configured with the various configuration
259 files. The default configuration files are: <filename>config</filename>,
260 <filename>default.filter</filename>, <filename>default.action</filename> and
261 <filename>default.action</filename>. <filename>user.action</filename> should
262 be used for locally defined exceptions to the default rules in
263 <filename>match-all.action</filename> and <filename>default.action</filename>,
264 and <filename>user.filter</filename> for locally defined filters. These are
265 well commented. On Unix and Unix-like systems, these are located in
266 <filename>/etc/privoxy/</filename> by default.
269 <command>Privoxy</command> uses the concept of <command>actions</command>
270 in order to manipulate the data stream between the browser and remote sites.
271 There are various actions available with specific functions for such things
272 as blocking web sites, managing cookies, etc. These actions can be invoked
273 individually or combined, and used against individual URLs, or groups of URLs
274 that can be defined using wildcards and regular expressions. The result is
275 that the user has greatly enhanced control and freedom.
278 The actions list (ad blocks, etc) can also be configured with your
279 web browser at <ulink url="http://config.privoxy.org/">http://config.privoxy.org/</ulink>
280 (assuming the configuration allows it).
281 <command>Privoxy's</command> configuration parameters can also be viewed at
282 the same page. In addition, <command>Privoxy</command> can be toggled on/off.
283 This is an internal page, and does not require Internet access.
287 url="http://www.privoxy.org/user-manual/"><citetitle>User Manual</citetitle></ulink> for a detailed
288 explanation of installation, general usage, all configuration options, new
289 features and notes on upgrading.
295 <!-- ~~~~~ New section ~~~~~ -->
296 <refsect1><title>Files</title>
297 <!-- this is a cheesy way to do this, but WTF. -->
299 <filename>/usr/sbin/privoxy</filename>
300 <filename>/etc/privoxy/config</filename>
301 <filename>/etc/privoxy/match-all.action</filename>
302 <filename>/etc/privoxy/default.action</filename>
303 <filename>/etc/privoxy/user.action</filename>
304 <filename>/etc/privoxy/default.filter</filename>
305 <filename>/etc/privoxy/user.filter</filename>
306 <filename>/etc/privoxy/trust</filename>
307 <filename>/etc/privoxy/templates/*</filename>
308 <filename>/var/log/privoxy/logfile</filename>
312 Various other files should be included, but may vary depending on platform
313 and build configuration. Additional documentation should be included in the local
314 documentation directory.
320 <!-- ~~~~~ New section ~~~~~ -->
321 <refsect1><title>Signals</title>
323 <!-- command tag is used here to get proper looking format -->
324 <command>Privoxy</command> terminates on the <command>SIGINT</command>
325 and <command>SIGTERM</command> signals. Log
326 rotation scripts may cause a re-opening of the logfile by sending a
327 <command>SIGHUP</command> to <command>Privoxy</command>. Note that unlike
328 other daemons, <command>Privoxy</command> does not need to be made aware of
329 config file changes by <command>SIGHUP</command> -- it will detect them
330 automatically. Signals other than the ones listed above aren't explicitly
331 handled and result in the default action defined by the operating system.
336 <!-- ~~~~~ New section ~~~~~ -->
337 <refsect1><title>Notes</title>
340 This is a &p-status; version of <command>Privoxy</command>. Not
341 all features are well tested.
344 Please see the <citetitle>User Manual</citetitle> on how to contact the
345 developers, for feature requests, reporting problems, and other questions.
350 <!-- ~~~~~ New section ~~~~~ -->
351 <refsect1><title>See Also</title>
352 <!-- Include seealso.sgml boilerplate: -->
354 <!-- end boilerplate -->
357 <!-- ~~~~~ New section ~~~~~ -->
358 <refsect1><title>Development Team</title>
359 <!-- Include p-authors.sgml boilerplate: -->
361 <!-- end boilerplate -->
364 <!-- ~~~~~ New section ~~~~~ -->
365 <refsect1><title>Copyright and License</title>
367 <refsect2><title>Copyright</title>
368 <!-- Include copyright.sgml boilerplate: -->
370 <!-- end boilerplate -->
373 <refsect2><title>License</title>
374 <!-- Include license.sgml boilerplate: -->
376 <!-- end boilerplate -->