doc/webserver/man-page/privoxy-man-page.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2
   3 <html>
   4 <head>
   5   <title>Man page of PRIVOXY</title>
   6   <link rel="STYLESHEET" type="text/css" href="../p_doc.css">
   7 </head>
   8
   9 <body>
  10   <h1>PRIVOXY</h1>Section: (1)<br>
  11   Updated: 26 May 2016<br>
  12   <a href="#index">Index</a>
  13   <hr>
  14   <a name="lbAB" id="lbAB">&nbsp;</a>
  15
  16   <h2>NAME</h2>privoxy - Privacy Enhancing Proxy <a name="lbAC" id=
  17   "lbAC">&nbsp;</a>
  18
  19   <h2>SYNOPSIS</h2>
  20
  21   <p><b>privoxy</b> [<b>--chroot</b> ] [<b>--config-test</b> ] [<b>--help</b>
  22   ] [<b>--no-daemon</b> ] [<b>--pidfile</b> <i>pidfile</i> ]
  23   [<b>--pre-chroot-nslookup</b> <i>hostname</i> ] [<b>--user</b>
  24   <i>user[.group]</i> ] [<b>--version</b> ] [<i>configfile</i> ]</p>
  25
  26   <p><a name="lbAD" id="lbAD">&nbsp;</a></p>
  27
  28   <h2>OPTIONS</h2>
  29
  30   <p><b>Privoxy</b> may be invoked with the following command line
  31   options:</p>
  32
  33   <dl compact>
  34     <dt><b>--chroot</b></dt>
  35
  36     <dd>Before changing to the user ID given in the --user option, chroot to
  37     that user's home directory, i.e. make the kernel pretend to the
  38     <b>Privoxy</b> process that the directory tree starts there. If set up
  39     carefully, this can limit the impact of possible vulnerabilities in
  40     <b>Privoxy</b> to the files contained in that hierarchy.</dd>
  41
  42     <dt><b>--config-test</b></dt>
  43
  44     <dd>
  45       Exit after loading the configuration files before binding to the listen
  46       address. The exit code signals whether or not the configuration files
  47       have been successfully loaded.
  48
  49       <p>If the exit code is 1, at least one of the configuration files is
  50       invalid, if it is 0, all the configuration files have been successfully
  51       loaded (but may still contain errors that can currently only be
  52       detected at run time).</p>
  53
  54       <p>This option doesn't affect the log setting, combination with
  55       "--no-daemon" is recommended if a configured log file shouldn't be
  56       used.</p>
  57     </dd>
  58
  59     <dt><b>--help</b></dt>
  60
  61     <dd>Print brief usage info and exit.</dd>
  62
  63     <dt><b>--no-daemon</b></dt>
  64
  65     <dd>Don't become a daemon, i.e. don't fork and become process group
  66     leader, don't detach from controlling tty, and do all logging there.</dd>
  67
  68     <dt><b>--pidfile</b> <i>pidfile</i></dt>
  69
  70     <dd>On startup, write the process ID to <i>pidfile</i>. Delete the
  71     <i>pidfile</i> on exit. Failure to create or delete the <i>pidfile</i> is
  72     non-fatal. If no <b>--pidfile</b> option is given, no PID file will be
  73     used.</dd>
  74
  75     <dt><b>--pre-chroot-nslookup</b> <i>hostname</i></dt>
  76
  77     <dd>Initialize the resolver library using <i>hostname</i> before
  78     chroot'ing. On some systems this reduces the number of files that must be
  79     copied into the chroot tree.</dd>
  80
  81     <dt><b>--user</b> <i>user[.group]</i></dt>
  82
  83     <dd>After (optionally) writing the PID file, assume the user ID of
  84     <i>user</i> and the GID of <i>group</i>, or, if the optional <i>group</i>
  85     was not given, the default group of <i>user</i>. Exit if the privileges
  86     are not sufficient to do so.</dd>
  87
  88     <dt><b>--version</b></dt>
  89
  90     <dd>Print version info and exit.</dd>
  91   </dl>
  92
  93   <p>If the <i>configfile</i> is not specified on the command line,
  94   <b>Privoxy</b> will look for a file named <i>config</i> in the current
  95   directory. If no <i>configfile</i> is found, <b>Privoxy</b> will fail to
  96   start. <a name="lbAE" id="lbAE">&nbsp;</a></p>
  97
  98   <h2>DESCRIPTION</h2>
  99
 100   <p>Privoxy is a non-caching web proxy with advanced filtering capabilities
 101   for enhancing privacy, modifying web page data and HTTP headers,
 102   controlling access, and removing ads and other obnoxious Internet junk.
 103   Privoxy has a flexible configuration and can be customized to suit
 104   individual needs and tastes. It has application for both stand-alone
 105   systems and multi-user networks.</p>
 106
 107   <p>Privoxy is Free Software and licensed under the GNU GPLv2.</p>
 108
 109   <p>Privoxy is an associated project of Software in the Public Interest
 110   (SPI).</p>
 111
 112   <p>Helping hands and donations are welcome:</p>
 113
 114   <dl compact>
 115     <dt>&bull;</dt>
 116
 117     <dd><a href=
 118     "https://www.privoxy.org/faq/general.html#PARTICIPATE">https://www.privoxy.org/faq/general.html#PARTICIPATE</a></dd>
 119
 120     <dt>&bull;</dt>
 121
 122     <dd><a href=
 123     "https://www.privoxy.org/faq/general.html#DONATE">https://www.privoxy.org/faq/general.html#DONATE</a></dd>
 124   </dl><a name="lbAF" id="lbAF">&nbsp;</a>
 125
 126   <h2>INSTALLATION AND USAGE</h2>
 127
 128   <p>Browsers can either be individually configured to use <b>Privoxy</b> as
 129   a HTTP proxy (recommended), or <b>Privoxy</b> can be combined with a packet
 130   filter to build an intercepting proxy (see <i>config</i>). The default
 131   setting is for localhost, on port 8118 (configurable in the main config
 132   file). To set the HTTP proxy in Firefox, go through: <b>Tools</b>;
 133   <b>Options</b>; <b>General</b>; <b>Connection Settings</b>; <b>Manual Proxy
 134   Configuration</b>.</p>
 135
 136   <p>For Internet Explorer, go through: <b>Tools</b>; <b>Internet
 137   Properties</b>; <b>Connections</b>; <b>LAN Settings</b>.</p>
 138
 139   <p>The Secure (SSL) Proxy should also be set to the same values, otherwise
 140   https: URLs will not be proxied. Note: <b>Privoxy</b> can only proxy HTTP
 141   and HTTPS traffic. Do not try it with FTP or other protocols. HTTPS
 142   presents some limitations, and not all features will work with HTTPS
 143   connections.</p>
 144
 145   <p>For other browsers, check the documentation. <a name="lbAG" id=
 146   "lbAG">&nbsp;</a></p>
 147
 148   <h2>CONFIGURATION</h2>
 149
 150   <p><b>Privoxy</b> can be configured with the various configuration files.
 151   The default configuration files are: <i>config</i>, <i>default.filter</i>,
 152   <i>default.action</i> and <i>default.action</i>. <i>user.action</i> should
 153   be used for locally defined exceptions to the default rules in
 154   <i>match-all.action</i> and <i>default.action</i>, and <i>user.filter</i>
 155   for locally defined filters. These are well commented. On Unix and
 156   Unix-like systems, these are located in <i>/etc/privoxy/</i> by
 157   default.</p>
 158
 159   <p><b>Privoxy</b> uses the concept of <b>actions</b> in order to manipulate
 160   the data stream between the browser and remote sites. There are various
 161   actions available with specific functions for such things as blocking web
 162   sites, managing cookies, etc. These actions can be invoked individually or
 163   combined, and used against individual URLs, or groups of URLs that can be
 164   defined using wildcards and regular expressions. The result is that the
 165   user has greatly enhanced control and freedom.</p>
 166
 167   <p>The actions list (ad blocks, etc) can also be configured with your web
 168   browser at <a href=
 169   "http://config.privoxy.org/">http://config.privoxy.org/</a> (assuming the
 170   configuration allows it). <b>Privoxy's</b> configuration parameters can
 171   also be viewed at the same page. In addition, <b>Privoxy</b> can be toggled
 172   on/off. This is an internal page, and does not require Internet access.</p>
 173
 174   <p>See the <i>User Manual</i> for a detailed explanation of installation,
 175   general usage, all configuration options, new features and notes on
 176   upgrading. <a name="lbAH" id="lbAH">&nbsp;</a></p>
 177
 178   <h2>FILES</h2>
 179   <pre>
 180  <i>/usr/sbin/privoxy</i>
 181  <i>/etc/privoxy/config</i>
 182  <i>/etc/privoxy/match-all.action</i>
 183  <i>/etc/privoxy/default.action</i>
 184  <i>/etc/privoxy/user.action</i>
 185  <i>/etc/privoxy/default.filter</i>
 186  <i>/etc/privoxy/user.filter</i>
 187  <i>/etc/privoxy/trust</i>
 188  <i>/etc/privoxy/templates/*</i>
 189  <i>/var/log/privoxy/logfile</i>
 190 </pre>
 191
 192   <p>Various other files should be included, but may vary depending on
 193   platform and build configuration. Additional documentation should be
 194   included in the local documentation directory. <a name="lbAI" id=
 195   "lbAI">&nbsp;</a></p>
 196
 197   <h2>SIGNALS</h2>
 198
 199   <p><b>Privoxy</b> terminates on the <b>SIGINT</b> and <b>SIGTERM</b>
 200   signals. Log rotation scripts may cause a re-opening of the logfile by
 201   sending a <b>SIGHUP</b> to <b>Privoxy</b>. Note that unlike other daemons,
 202   <b>Privoxy</b> does not need to be made aware of config file changes by
 203   <b>SIGHUP</b> -- it will detect them automatically. Signals other than the
 204   ones listed above aren't explicitly handled and result in the default
 205   action defined by the operating system. <a name="lbAJ" id=
 206   "lbAJ">&nbsp;</a></p>
 207
 208   <h2>NOTES</h2>
 209
 210   <p>This is a beta version of <b>Privoxy</b>. Not all features are well
 211   tested.</p>
 212
 213   <p>Please see the <i>User Manual</i> on how to contact the developers, for
 214   feature requests, reporting problems, and other questions. <a name="lbAK"
 215   id="lbAK">&nbsp;</a></p>
 216
 217   <h2>SEE ALSO</h2>
 218
 219   <p>Other references and sites of interest to <b>Privoxy</b> users:</p>
 220
 221   <p><a href="https://www.privoxy.org/">https://www.privoxy.org/,</a> the
 222   <b>Privoxy</b> Home page.</p>
 223
 224   <p><a href="https://www.privoxy.org/faq/">https://www.privoxy.org/faq/,</a>
 225   the <b>Privoxy</b> FAQ.</p>
 226
 227   <p><a href=
 228   "https://www.privoxy.org/developer-manual/">https://www.privoxy.org/developer-manual/,</a>
 229   the <b>Privoxy</b> developer manual.</p>
 230
 231   <p><a href=
 232   "https://sourceforge.net/projects/ijbswa/">https://sourceforge.net/projects/ijbswa/,</a>
 233   the Project Page for <b>Privoxy</b> on SourceForge.</p>
 234
 235   <p><a href="http://config.privoxy.org/">http://config.privoxy.org/,</a> the
 236   web-based user interface. <b>Privoxy</b> must be running for this to work.
 237   Shortcut: <a href="http://p.p/">http://p.p/</a></p>
 238
 239   <p><a href=
 240   "https://sourceforge.net/tracker/?group_id=11118">https://sourceforge.net/tracker/?group_id=11118</a>&amp;atid=460288,
 241   to submit ``misses'' and other configuration related suggestions to the
 242   developers. <a name="lbAL" id="lbAL">&nbsp;</a></p>
 243
 244   <h2>DEVELOPMENT TEAM</h2>
 245   <pre>
 246  Fabian Keil, lead developer
 247  David Schmidt
 248  Hal Burgiss
 249  Lee Rian
 250  Roland Rosenfeld
 251  Ian Silvester
 252 </pre><a name="lbAM" id="lbAM">&nbsp;</a>
 253
 254   <h2>COPYRIGHT AND LICENSE</h2><a name="lbAN" id="lbAN">&nbsp;</a>
 255
 256   <h3>COPYRIGHT</h3>
 257
 258   <p>Copyright (C) 2001-2016 by Privoxy Developers &lt;<a href=
 259   "mailto:privoxy-devel@lists.privoxy.org">privoxy-devel@lists.privoxy.org</a>&gt;</p>
 260
 261   <p>Some source code is based on code Copyright (C) 1997 by Anonymous Coders
 262   and Junkbusters, Inc. and licensed under the <i>GNU General Public
 263   License</i>. <a name="lbAO" id="lbAO">&nbsp;</a></p>
 264
 265   <h3>LICENSE</h3>
 266
 267   <p><b>Privoxy</b> is free software; you can redistribute it and/or modify
 268   it under the terms of the <i>GNU General Public License</i>, version 2, as
 269   published by the Free Software Foundation.</p>
 270
 271   <p><b>Privoxy</b> is distributed in the hope that it will be useful, but
 272   WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
 273   or FITNESS FOR A PARTICULAR PURPOSE. See the <i>license</i> for
 274   details.</p>
 275   <hr>
 276   <a name="index" id="index">&nbsp;</a>
 277
 278   <h2>Index</h2>
 279
 280   <dl>
 281     <dt><a href="#lbAB">NAME</a></dt>
 282
 283     <dt><a href="#lbAC">SYNOPSIS</a></dt>
 284
 285     <dt><a href="#lbAD">OPTIONS</a></dt>
 286
 287     <dt><a href="#lbAE">DESCRIPTION</a></dt>
 288
 289     <dt><a href="#lbAF">INSTALLATION AND USAGE</a></dt>
 290
 291     <dt><a href="#lbAG">CONFIGURATION</a></dt>
 292
 293     <dt><a href="#lbAH">FILES</a></dt>
 294
 295     <dt><a href="#lbAI">SIGNALS</a></dt>
 296
 297     <dt><a href="#lbAJ">NOTES</a></dt>
 298
 299     <dt><a href="#lbAK">SEE ALSO</a></dt>
 300
 301     <dt><a href="#lbAL">DEVELOPMENT TEAM</a></dt>
 302
 303     <dt><a href="#lbAM">COPYRIGHT AND LICENSE</a></dt>
 304
 305     <dd>
 306       <dl>
 307         <dt><a href="#lbAN">COPYRIGHT</a></dt>
 308
 309         <dt><a href="#lbAO">LICENSE</a></dt>
 310       </dl>
 311     </dd>
 312   </dl>
 313   <hr>
 314   This document was created by man2html, using the manual pages.<br>
 315   Time: 16:00:31 GMT, May 26, 2016
 316 </body>
 317 </html>