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

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
   2 <html>
   3   <head>
   4     <title>
   5       Privoxy Man page
   6     </title>
   7     <link rel="stylesheet" type="text/css" href="../p_web.css">
   8   </head>
   9   <body>
  10     <h2>
  11       NAME
  12     </h2>
  13 <pre>
  14 <!-- Manpage converted by man2html 3.0.1 -->
  15
  16 </pre>
  17     <h2>
  18       SYNOPSIS
  19     </h2>
  20 <pre>
  21        <b>privoxy</b> [<b>--chroot</b> ] [<b>--config-test</b> ] [<b>--help</b> ] [<b>--no-daemon</b> ]
  22        [<b>--pidfile</b> <i>pidfile</i> ] [<b>--pre-chroot-nslookup</b> <i>hostname</i> ] [<b>--user</b>
  23        <i>user[.group]</i> ] [<b>--version</b> ] [<i>configfile</i> ]
  24
  25
  26
  27 </pre>
  28     <h2>
  29       OPTIONS
  30     </h2>
  31 <pre>
  32        <b>Privoxy</b> may be invoked with the following command line options:
  33
  34        <b>--chroot</b>
  35               Before changing to the user ID given in the --user option,
  36               chroot to that user's home directory, i.e. make the kernel
  37               pretend to the <b>Privoxy</b> process that the directory tree starts
  38               there. If set up carefully, this can limit the impact of
  39               possible vulnerabilities in <b>Privoxy</b> to the files contained in
  40               that hierarchy.
  41
  42        <b>--config-test</b>
  43               Exit after loading the configuration files before binding to the
  44               listen address. The exit code signals whether or not the
  45               configuration files have been successfully loaded.
  46
  47               If the exit code is 1, at least one of the configuration files
  48               is invalid, if it is 0, all the configuration files have been
  49               successfully loaded (but may still contain errors that can
  50               currently only be detected at run time).
  51
  52               This option doesn't affect the log setting, combination with
  53               "--no-daemon" is recommended if a configured log file shouldn't
  54               be used.
  55
  56        <b>--help</b> Print brief usage info and exit.
  57
  58        <b>--no-daemon</b>
  59               Don't  become  a daemon, i.e. don't fork and become process
  60               group leader, don't detach from controlling tty, and do all
  61               logging there.
  62
  63        <b>--pidfile</b> <i>pidfile</i>
  64               On startup, write the process ID to <i>pidfile</i>.  Delete the <i>pidfile</i>
  65               on exit.  Failure to create or delete the <i>pidfile</i> is non-fatal.
  66               If no <b>--pidfile</b> option is given, no PID file will be used.
  67
  68        <b>--pre-chroot-nslookup</b> <i>hostname</i>
  69               Initialize the resolver library using <i>hostname</i> before
  70               chroot'ing. On some systems this reduces the number of files
  71               that must be copied into the chroot tree.
  72
  73        <b>--user</b> <i>user[.group]</i>
  74               After (optionally) writing the PID file, assume the user ID of
  75               <i>user</i> and the GID of <i>group</i>, or, if the optional <i>group</i> was not
  76               given, the default group of <i>user</i>. Exit if the privileges are not
  77
  78        individual needs and tastes.  It has application for both stand-alone
  79        systems and multi-user networks.
  80
  81        Privoxy is Free Software and licensed under the GNU GPLv2.
  82
  83        Privoxy is an associated project of Software in the Public Interest
  84        (SPI).
  85
  86        Helping hands and donations are welcome:
  87
  88        &acirc;&euro;&cent; https://www.privoxy.org/faq/general.html#PARTICIPATE
  89
  90        &acirc;&euro;&cent; https://www.privoxy.org/faq/general.html#DONATE
  91
  92
  93 </pre>
  94     <h2>
  95       INSTALLATION AND USAGE
  96     </h2>
  97 <pre>
  98        Browsers can either be individually configured to use <b>Privoxy</b> as a HTTP
  99        proxy (recommended), or <b>Privoxy</b> can be combined with a packet filter to
 100        build an intercepting proxy (see <i>config</i>).  The default setting is  for
 101        localhost,  on port  8118 (configurable in the main config file).  To
 102        set the HTTP proxy in Firefox, go through: <b>Tools</b>; <b>Options</b>; <b>General</b>;
 103        <b>Connection</b> <b>Settings</b>; <b>Manual</b> <b>Proxy</b> <b>Configuration</b>.
 104
 105        For Internet Explorer, go through: <b>Tools</b>; <b>Internet</b> <b>Properties</b>;
 106        <b>Connections</b>; <b>LAN</b> <b>Settings</b>.
 107
 108        The Secure (SSL) Proxy should also be set to the same values, otherwise
 109        https: URLs will not be proxied. Note: <b>Privoxy</b> can only proxy HTTP and
 110        HTTPS traffic. Do not try it with FTP or other protocols.  HTTPS
 111        presents some limitations, and not all features will work with HTTPS
 112        connections.
 113
 114        For other browsers, check the documentation.
 115
 116
 117 </pre>
 118     <h2>
 119       CONFIGURATION
 120     </h2>
 121 <pre>
 122        <b>Privoxy</b> can be configured with the various configuration files. The
 123        default configuration files are: <i>config</i>, <i>default.filter</i>, <i>default.action</i>
 124        and <i>default.action</i>. <i>user.action</i> should be used for locally defined
 125        exceptions to the default rules in <i>match-all.action</i> and <i>default.action</i>,
 126        and <i>user.filter</i> for locally defined filters. These are well commented.
 127        On Unix and Unix-like systems, these are located in <i>/etc/privoxy/</i> by
 128        default.
 129
 130        <b>Privoxy</b> uses the concept of <b>actions</b> in order to manipulate the data
 131        stream between the browser and remote sites.  There are various actions
 132        available with specific functions for such things as blocking web
 133        sites, managing cookies, etc. These actions can be invoked individually
 134        or combined, and used against individual URLs, or groups of URLs that
 135        can be defined using wildcards and regular expressions. The result is
 136        that the user has greatly enhanced control and freedom.
 137
 138        The actions list (ad blocks, etc) can also be configured with your web
 139        browser at http://config.privoxy.org/ (assuming the configuration
 140         <i>/etc/privoxy/user.filter</i>
 141         <i>/etc/privoxy/trust</i>
 142         <i>/etc/privoxy/templates/*</i>
 143         <i>/var/log/privoxy/logfile</i>
 144
 145        Various other files should be included, but may vary depending on
 146        platform and build configuration. Additional documentation should be
 147        included in the local documentation directory.
 148
 149
 150 </pre>
 151     <h2>
 152       SIGNALS
 153     </h2>
 154 <pre>
 155        <b>Privoxy</b> terminates on the <b>SIGINT</b> and <b>SIGTERM</b> signals. Log rotation
 156        scripts may cause a re-opening of the logfile by sending a <b>SIGHUP</b> to
 157        <b>Privoxy</b>. Note that unlike other daemons,  <b>Privoxy</b> does not need to be
 158        made aware of config file changes by <b>SIGHUP</b> -- it will detect them
 159        automatically. Signals other than the ones listed above aren't
 160        explicitly handled and result in the default action defined by the
 161        operating system.
 162
 163
 164 </pre>
 165     <h2>
 166       NOTES
 167     </h2>
 168 <pre>
 169        This is a beta version of <b>Privoxy</b>. Not all features are well tested.
 170
 171        Please see the <i>User</i> <i>Manual</i> on how to contact the developers, for
 172        feature requests, reporting problems, and other questions.
 173
 174
 175 </pre>
 176     <h2>
 177       SEE ALSO
 178     </h2>
 179 <pre>
 180        Other references and sites of interest to <b>Privoxy</b> users:
 181
 182        https://www.privoxy.org/, the <b>Privoxy</b> Home page.
 183
 184        https://www.privoxy.org/faq/, the <b>Privoxy</b> FAQ.
 185
 186        https://www.privoxy.org/developer-manual/, the <b>Privoxy</b> developer
 187        manual.
 188
 189        https://sourceforge.net/projects/ijbswa/, the Project Page for <b>Privoxy</b>
 190        on SourceForge.
 191
 192        http://config.privoxy.org/, the web-based user interface. <b>Privoxy</b> must
 193        be running for this to work. Shortcut: http://p.p/
 194
 195        https://sourceforge.net/tracker/?group_id=11118&amp;atid=460288, to submit
 196        ``misses'' and other configuration related suggestions to the
 197        developers.
 198
 199
 200 </pre>
 201     <h2>
 202       DEVELOPMENT TEAM
 203     </h2>
 204 <pre>
 205         Fabian Keil, lead developer
 206         David Schmidt
 207         Hal Burgiss
 208         Lee Rian
 209         Roland Rosenfeld
 210         Ian Silvester
 211
 212        <b>Privoxy</b> is distributed in the hope that it will be useful, but WITHOUT
 213        ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 214        FITNESS FOR A PARTICULAR PURPOSE.  See the  <i>license</i> for details.
 215
 216
 217
 218 Privoxy 3.0.25 beta              26 July 2016                       <b>PRIVOXY(1)</b>
 219 </pre>
 220   </body>
 221 </html>
 222