[privoxy.git] / doc / webserver / man-page / privoxy-man-page.html
1 <!-- Creator     : groff version 1.19.2 -->
2 <!-- CreationDate: Wed Jan 20 16:20:52 2021 -->
3 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
4 "">
5 <html>
6 <head>
7   <meta name="generator" content="groff -Thtml, see">
8   <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
9   <meta name="Content-Style" content="text/css">
10   <style type="text/css">
11        p     { margin-top: 0; margin-bottom: 0; }
12        pre   { margin-top: 0; margin-bottom: 0; }
13        table { margin-top: 0; margin-bottom: 0; }
14   </style>
15   <title>PRIVOXY</title>
16   <link rel="STYLESHEET" type="text/css" href="../p_doc.css">
17 </head>
18 <body>
19   <h1 align="center">PRIVOXY</h1><a href="#NAME">NAME</a><br>
20   <a href="#SYNOPSIS">SYNOPSIS</a><br>
21   <a href="#OPTIONS">OPTIONS</a><br>
22   <a href="#DESCRIPTION">DESCRIPTION</a><br>
25   <a href="#FILES">FILES</a><br>
26   <a href="#SIGNALS">SIGNALS</a><br>
27   <a href="#NOTES">NOTES</a><br>
28   <a href="#SEE%20ALSO">SEE ALSO</a><br>
31   <hr>
32   <a name="NAME"></a>
33   <h2>NAME</h2>
34   <p style="margin-left:11%; margin-top: 1em">privoxy &minus; Privacy Enhancing Proxy</p><a name="SYNOPSIS"></a>
35   <h2>SYNOPSIS</h2>
36   <p style="margin-left:11%; margin-top: 1em"><b>privoxy</b> [<b>&minus;&minus;chroot</b> ]
37   [<b>&minus;&minus;config-test</b> ] [<b>&minus;&minus;help</b> ] [<b>&minus;&minus;no-daemon</b> ]
38   [<b>&minus;&minus;pidfile</b> <i>pidfile</i> ] [<b>&minus;&minus;pre-chroot-nslookup</b> <i>hostname</i> ]
39   [<b>&minus;&minus;user</b> <i>user[.group]</i> ] [<b>&minus;&minus;version</b> ] [<i>configfile</i> ]</p><a name=
40   "OPTIONS"></a>
41   <h2>OPTIONS</h2>
42   <p style="margin-left:11%; margin-top: 1em"><b>Privoxy</b> may be invoked with the following command line options:
43   <b><br>
44   &minus;&minus;chroot</b></p>
45   <p style="margin-left:22%;">Before changing to the user ID given in the &minus;&minus;user option, chroot to that
46   user&rsquo;s home directory, i.e. make the kernel pretend to the <b>Privoxy</b> process that the directory tree
47   starts there. If set up carefully, this can limit the impact of possible vulnerabilities in <b>Privoxy</b> to the
48   files contained in that hierarchy.</p>
49   <p style="margin-left:11%;"><b>&minus;&minus;config-test</b></p>
50   <p style="margin-left:22%;">Exit after loading the configuration files before binding to the listen address. The exit
51   code signals whether or not the configuration files have been successfully loaded.</p>
52   <p style="margin-left:22%; margin-top: 1em">If the exit code is 1, at least one of the configuration files is
53   invalid, if it is 0, all the configuration files have been successfully loaded (but may still contain errors that can
54   currently only be detected at run time).</p>
55   <p style="margin-left:22%; margin-top: 1em">This option doesn&rsquo;t affect the log setting, combination with
56   &quot;--no-daemon&quot; is recommended if a configured log file shouldn&rsquo;t be used.</p>
57   <table width="100%" border="0" rules="none" frame="void" cellspacing="0" cellpadding="0">
58     <tr valign="top" align="left">
59       <td width="11%"></td>
60       <td width="9%">
61         <p style="margin-top: 1em" valign="top"><b>&minus;&minus;help</b></p>
62       </td>
63       <td width="2%"></td>
64       <td width="49%">
65         <p style="margin-top: 1em" valign="top">Print brief usage info and exit.</p>
66       </td>
67       <td width="29%"></td>
68     </tr>
69   </table>
70   <p style="margin-left:11%;"><b>&minus;&minus;no-daemon</b></p>
71   <p style="margin-left:22%;">Don&rsquo;t become a daemon, i.e. don&rsquo;t fork and become process group leader,
72   don&rsquo;t detach from controlling tty, and do all logging there.</p>
73   <p style="margin-left:11%;"><b>&minus;&minus;pidfile</b> <i>pidfile</i></p>
74   <p style="margin-left:22%;">On startup, write the process ID to <i>pidfile</i>. Delete the <i>pidfile</i> on exit.
75   Failure to create or delete the <i>pidfile</i> is non-fatal. If no <b>&minus;&minus;pidfile</b> option is given, no
76   PID file will be used.</p>
77   <p style="margin-left:11%;"><b>&minus;&minus;pre-chroot-nslookup</b> <i>hostname</i></p>
78   <p style="margin-left:22%;">Initialize the resolver library using <i>hostname</i> before chroot&rsquo;ing. On some
79   systems this reduces the number of files that must be copied into the chroot tree.</p>
80   <p style="margin-left:11%;"><b>&minus;&minus;user</b> <i>user[.group]</i></p>
81   <p style="margin-left:22%;">After (optionally) writing the PID file, assume the user ID of <i>user</i> and the GID of
82   <i>group</i>, or, if the optional <i>group</i> was not given, the default group of <i>user</i>. Exit if the
83   privileges are not sufficient to do so.</p>
84   <p style="margin-left:11%;"><b>&minus;&minus;version</b></p>
85   <p style="margin-left:22%;">Print version info and exit.</p>
86   <p style="margin-left:11%; margin-top: 1em">If the <i>configfile</i> is not specified on the command line,
87   <b>Privoxy</b> will look for a file named <i>config</i> in the current directory. If no <i>configfile</i> is found,
88   <b>Privoxy</b> will fail to start.</p><a name="DESCRIPTION"></a>
89   <h2>DESCRIPTION</h2>
90   <p style="margin-left:11%; margin-top: 1em">Privoxy is a non-caching web proxy with advanced filtering capabilities
91   for enhancing privacy, modifying web page data and HTTP headers, controlling access, and removing ads and other
92   obnoxious Internet junk. Privoxy has a flexible configuration and can be customized to suit individual needs and
93   tastes. It has application for both stand-alone systems and multi-user networks.</p>
94   <p style="margin-left:11%; margin-top: 1em">Privoxy is Free Software and licensed under the GNU GPLv2 or later.</p>
95   <p style="margin-left:11%; margin-top: 1em">Privoxy is an associated project of Software in the Public Interest
96   (SPI).</p>
97   <p style="margin-left:11%; margin-top: 1em">Helping hands and donations are welcome:</p>
98   <table width="100%" border="0" rules="none" frame="void" cellspacing="0" cellpadding="0">
99     <tr valign="top" align="left">
100       <td width="11%"></td>
101       <td width="1%">
102         <p style="margin-top: 1em" valign="top">&bull;</p>
103       </td>
104       <td width="2%"></td>
105       <td width="54%">
106         <p style="margin-top: 1em" valign="top"></p>
107       </td>
108       <td width="32%"></td>
109     </tr>
110     <tr valign="top" align="left">
111       <td width="11%"></td>
112       <td width="1%">
113         <p style="margin-top: 1em" valign="top">&bull;</p>
114       </td>
115       <td width="2%"></td>
116       <td width="54%">
117         <p style="margin-top: 1em" valign="top"></p>
118       </td>
119       <td width="32%"></td>
120     </tr>
121   </table><a name="INSTALLATION AND USAGE"></a>
123   <p style="margin-left:11%; margin-top: 1em">Browsers can either be individually configured to use <b>Privoxy</b> as a
124   HTTP proxy (recommended), or <b>Privoxy</b> can be combined with a packet filter to build an intercepting proxy (see
125   <i>config</i>). The default setting is for localhost, on port 8118 (configurable in the main config file). To set the
126   HTTP proxy in Firefox, go through: <b>Tools</b>; <b>Options</b>; <b>General</b>; <b>Connection Settings</b>;
127   <b>Manual Proxy Configuration</b>.</p>
128   <p style="margin-left:11%; margin-top: 1em">For Internet Explorer, go through: <b>Tools</b>; <b>Internet
129   Properties</b>; <b>Connections</b>; <b>LAN Settings</b>.</p>
130   <p style="margin-left:11%; margin-top: 1em">The Secure (SSL) Proxy should also be set to the same values, otherwise
131   https: URLs will not be proxied. Note: <b>Privoxy</b> can only proxy HTTP and HTTPS traffic. Do not try it with FTP
132   or other protocols. HTTPS presents some limitations, and not all features will work with HTTPS connections.</p>
133   <p style="margin-left:11%; margin-top: 1em">For other browsers, check the documentation.</p><a name=
134   "CONFIGURATION"></a>
135   <h2>CONFIGURATION</h2>
136   <p style="margin-left:11%; margin-top: 1em"><b>Privoxy</b> can be configured with the various configuration files.
137   The default configuration files are: <i>config</i>, <i>default.filter</i>, <i>default.action</i> and
138   <i>default.action</i>. <i>user.action</i> should be used for locally defined exceptions to the default rules in
139   <i>match-all.action</i> and <i>default.action</i>, and <i>user.filter</i> for locally defined filters. These are well
140   commented. On Unix and Unix-like systems, these are located in <i>/etc/privoxy/</i> by default.</p>
141   <p style="margin-left:11%; margin-top: 1em"><b>Privoxy</b> uses the concept of <b>actions</b> in order to manipulate
142   the data stream between the browser and remote sites. There are various actions available with specific functions for
143   such things as blocking web sites, managing cookies, etc. These actions can be invoked individually or combined, and
144   used against individual URLs, or groups of URLs that can be defined using wildcards and regular expressions. The
145   result is that the user has greatly enhanced control and freedom.</p>
146   <p style="margin-left:11%; margin-top: 1em">The actions list (ad blocks, etc) can also be configured with your web
147   browser at (assuming the configuration allows it). <b>Privoxy&rsquo;s</b> configuration
148   parameters can also be viewed at the same page. In addition, <b>Privoxy</b> can be toggled on/off. This is an
149   internal page, and does not require Internet access.</p>
150   <p style="margin-left:11%; margin-top: 1em">See the <i>User Manual</i> for a detailed explanation of installation,
151   general usage, all configuration options, new features and notes on upgrading.</p><a name="FILES"></a>
152   <h2>FILES</h2>
153   <p style="margin-left:11%; margin-top: 1em"><i>/usr/sbin/privoxy<br>
154   /etc/privoxy/config<br>
155   /etc/privoxy/match-all.action<br>
156   /etc/privoxy/default.action<br>
157   /etc/privoxy/user.action<br>
158   /etc/privoxy/default.filter<br>
159   /etc/privoxy/user.filter<br>
160   /etc/privoxy/trust<br>
161   /etc/privoxy/templates/*<br>
162   /var/log/privoxy/logfile</i></p>
163   <p style="margin-left:11%; margin-top: 1em">Various other files should be included, but may vary depending on
164   platform and build configuration. Additional documentation should be included in the local documentation
165   directory.</p><a name="SIGNALS"></a>
166   <h2>SIGNALS</h2>
167   <p style="margin-left:11%; margin-top: 1em"><b>Privoxy</b> terminates on the <b>SIGINT</b> and <b>SIGTERM</b>
168   signals. Log rotation scripts may cause a re-opening of the logfile by sending a <b>SIGHUP</b> to <b>Privoxy</b>.
169   Note that unlike other daemons, <b>Privoxy</b> does not need to be made aware of config file changes by <b>SIGHUP</b>
170   -- it will detect them automatically. Signals other than the ones listed above aren&rsquo;t explicitly handled and
171   result in the default action defined by the operating system.</p><a name="NOTES"></a>
172   <h2>NOTES</h2>
173   <p style="margin-left:11%; margin-top: 1em">Please see the <i>User Manual</i> on how to contact the developers, for
174   feature requests, reporting problems, and other questions.</p><a name="SEE ALSO"></a>
175   <h2>SEE ALSO</h2>
176   <p style="margin-left:11%; margin-top: 1em">Other references and sites of interest to <b>Privoxy</b> users:</p>
177   <p style="margin-left:11%; margin-top: 1em">, the <b>Privoxy</b> Home page.</p>
178   <p style="margin-left:11%; margin-top: 1em">, the <b>Privoxy</b> FAQ.</p>
179   <p style="margin-left:11%; margin-top: 1em">, the <b>Privoxy</b> developer
180   manual.</p>
181   <p style="margin-left:11%; margin-top: 1em">, the Project Page for
182   <b>Privoxy</b> on SourceForge.</p>
183   <p style="margin-left:11%; margin-top: 1em">, the web-based user interface. <b>Privoxy</b>
184   must be running for this to work. Shortcut: http://p.p/</p>
185   <p style="margin-left:11%; margin-top: 1em">, to submit
186   &lsquo;&lsquo;misses&rsquo;&rsquo; and other configuration related suggestions to the developers.</p><a name=
188   <h2>DEVELOPMENT TEAM</h2>
189   <p style="margin-left:11%; margin-top: 1em">Fabian Keil, lead developer<br>
190   David Schmidt<br>
191   Lee Rian<br>
192   Roland Rosenfeld<br>
193   Ian Silvester</p><a name="COPYRIGHT AND LICENSE"></a>
195   <p style="margin-left:11%; margin-top: 1em"><b>COPYRIGHT</b><br>
196   Copyright (C) 2001-2020 by Privoxy Developers &lt;;</p>
197   <p style="margin-left:11%; margin-top: 1em">Some source code is based on code Copyright (C) 1997 by Anonymous Coders
198   and Junkbusters, Inc.</p>
199   <p style="margin-left:11%; margin-top: 1em"><b>LICENSE<br>
200   Privoxy</b> is free software; you can redistribute and/or modify its source code under the terms of the <i>GNU
201   General Public License</i> as published by the Free Software Foundation, either version 2 of the license, or (at your
202   option) any later version.</p>
203   <p style="margin-left:11%; margin-top: 1em">The same is true for <b>Privoxy</b> binaries unless they are linked with
204   a mbed TLS version that is licensed under the Apache 2.0 license in which case you can redistribute and/or modify the
205   <b>Privoxy</b> binaries under the terms of the <i>GNU General Public License</i> as published by the Free Software
206   Foundation, either version 3 of the license, or (at your option) any later version.</p>
207   <p style="margin-left:11%; margin-top: 1em"><b>Privoxy</b> is distributed in the hope that it will be useful, but
209   the <i>license</i> for details.</p>
210   <hr>
211 </body>
212 </html>