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

   1 <!DOCTYPE html PUBLIC "-//IETF//DTD HTML 2.0//EN">
   2 <html>
   3   <head>
   4     <meta name="generator" content="HTML Tidy, see www.w3.org">
   5     <title>
   6       Privoxy Man page
   7     </title>
   8     <link rel="stylesheet" type="text/css" href="../p_web.css">
   9   </head>
  10   <body>
  11     <h2>
  12       NAME
  13     </h2>
  14 <pre>
  15 <!-- Manpage converted by man2html 3.0.1 -->
  16
  17 </pre>
  18     <h2>
  19       SYNOPSIS
  20     </h2>
  21 <pre>
  22        <b>privoxy</b>   [<b>--help</b>   ]  [<b>--version</b>   ]  [<b>--no-daemon</b>  ] [<b>--pidfile</b> <i>pidfile</i> ]
  23        [<b>--user</b> <i>user[.group]</i> ] [<b>--chroot</b>    ]  [<b>--pre-chroot-nslookup</b>  <i>hostname</i>  ]
  24        [<i>configfile</i> ]
  25
  26
  27
  28 </pre>
  29     <h2>
  30       OPTIONS
  31     </h2>
  32 <pre>
  33        <b>Privoxy</b> may be invoked with the following command line options:
  34
  35        <b>--help</b> Print brief usage  info and exit.
  36
  37        <b>--version</b>
  38           Print version info and exit.
  39
  40        <b>--no-daemon</b>
  41           Don't   become   a  daemon,  i.e.  don't fork and become process
  42           group leader, don't detach from controlling tty, and do all log-
  43           ging there.
  44
  45        <b>--pidfile</b> <i>pidfile</i>
  46           On startup, write the process ID to <i>pidfile</i>.  Delete the <i>pidfile</i>
  47           on exit.  Failure to create or delete the <i>pidfile</i>  is  non-fatal.
  48           If no <b>--pidfile</b> option is  given, no PID file will be used.
  49
  50        <b>--user</b> <i>user[.group]</i>
  51           After  (optionally)  writing the PID file, assume the user ID of
  52           <i>user</i> and the GID of <i>group</i>, or, if   the  optional  <i>group</i>  was  not
  53           given, the default group of <i>user</i>.  Exit if the privileges are not
  54           sufficient to do so.
  55
  56        <b>--chroot</b>
  57           Before changing to the user  ID  given  in  the  --user  option,
  58           chroot  to that user's home directory, i.e. make the kernel pre-
  59           tend to the <b>Privoxy</b>  process  that  the  directory  tree   starts
  60           there.  If set up carefully, this can limit the impact of possi-
  61           ble vulnerabilities in <b>Privoxy</b> to  the files  contained  in  that
  62           hierarchy.
  63
  64        <b>--pre-chroot-nslookup</b> <i>hostname</i>
  65           Initialize   the   resolver   library   using   <i>hostname</i>   before
  66           chroot'ing. On some systems this reduces  the  number  of  files
  67           that must be copied into the chroot tree.
  68
  69        If  the  <i>configfile</i>  is   not  specified on  the  command  line, <b>Privoxy</b>
  70        will  look for a file named <i>config</i> in the current directory. If no <i>con-</i>
  71        <i>figfile</i> is found, <b>Privoxy</b> will fail to start.
  72
  73
  74 </pre>
  75     <h2>
  76       DESCRIPTION
  77     </h2>
  78 <pre>
  79        Privoxy is a non-caching web proxy with advanced filtering capabilities
  80        for enhancing privacy, modifying web page data and HTTP  headers,  con-
  81        trolling  access,  and  removing ads and other obnoxious Internet junk.
  82        Privoxy has a flexible configuration and  can  be  customized  to  suit
  83
  84
  85 </pre>
  86     <h2>
  87       INSTALLATION AND USAGE
  88     </h2>
  89 <pre>
  90        Browsers can either be individually configured to use <b>Privoxy</b> as  a HTTP
  91        proxy (recommended), or <b>Privoxy</b> can be combined with a packet filter to
  92        build  an intercepting proxy (see <i>config</i>).  The default setting is  for
  93        localhost,  on port  8118 (configurable in the main config  file).   To
  94        set  the  HTTP  proxy  in Firefox, go through: <b>Tools</b>; <b>Options</b>; <b>General</b>;
  95        <b>Connection</b> <b>Settings</b>; <b>Manual</b> <b>Proxy</b> <b>Configuration</b>.
  96
  97        For Internet Explorer, go through: <b>Tools</b>; <b>Internet</b> <b>Properties</b>;  <b>Connec-</b>
  98        <b>tions</b>; <b>LAN</b> <b>Settings</b>.
  99
 100        The Secure (SSL) Proxy should also be set to the same values, otherwise
 101        https: URLs will not be proxied. Note: <b>Privoxy</b> can only proxy HTTP  and
 102        HTTPS  traffic.  Do  not  try  it  with  FTP or other protocols.  HTTPS
 103        presents some limitations, and not all features will  work  with  HTTPS
 104        connections.
 105
 106        For other browsers, check the documentation.
 107
 108
 109 </pre>
 110     <h2>
 111       CONFIGURATION
 112     </h2>
 113 <pre>
 114        <b>Privoxy</b>   can  be  configured  with the various configuration files. The
 115        default configuration files are: <i>config</i>,  <i>default.filter</i>,  <i>default.action</i>
 116        and  <i>default.action</i>.  <i>user.action</i>  should  be  used for locally defined
 117        exceptions to the default rules in <i>match-all.action</i> and <i>default.action</i>,
 118        and  <i>user.filter</i>  for locally defined filters. These are well commented.
 119        On Unix and Unix-like systems, these are located  in  <i>/etc/privoxy/</i>  by
 120        default.
 121
 122        <b>Privoxy</b>   uses  the  concept  of <b>actions</b> in order  to manipulate the data
 123        stream between the browser and remote sites.  There are various actions
 124        available  with  specific  functions  for  such  things as blocking web
 125        sites, managing cookies, etc. These actions can be invoked individually
 126        or  combined,  and used against individual URLs, or groups of URLs that
 127        can be defined using wildcards and regular expressions. The  result  is
 128        that the user has greatly enhanced control and freedom.
 129
 130        The  actions list (ad blocks, etc) can also be configured with your web
 131        browser  at  http://config.privoxy.org/  (assuming  the   configuration
 132        allows it).  <b>Privoxy's</b> configuration parameters   can also  be viewed at
 133        the same page. In addition, <b>Privoxy</b> can be toggled on/off.  This  is  an
 134        internal page, and does not require Internet access.
 135
 136        See the <i>User</i> <i>Manual</i> for a detailed explanation of installation, general
 137        usage, all configuration options, new features and notes on  upgrading.
 138
 139
 140 </pre>
 141     <h2>
 142       FILES
 143     </h2>
 144 <pre>
 145     <i>/usr/sbin/privoxy</i>
 146     <i>/etc/privoxy/config</i>
 147     <i>/etc/privoxy/match-all.action</i>
 148     <i>/etc/privoxy/default.action</i>
 149     <i>/etc/privoxy/user.action</i>
 150     <i>/etc/privoxy/default.filter</i>
 151        detect them automatically.
 152
 153
 154 </pre>
 155     <h2>
 156       NOTES
 157     </h2>
 158 <pre>
 159        This  is  a  UNRELEASED  version  of <b>Privoxy</b>. Not all features are well
 160        tested.
 161
 162        Please see the <i>User</i> <i>Manual</i> on how to contact the   developers,  for  fea-
 163        ture requests, reporting problems, and other questions.
 164
 165
 166 </pre>
 167     <h2>
 168       SEE ALSO
 169     </h2>
 170 <pre>
 171        Other references and sites of interest to <b>Privoxy</b> users:
 172
 173
 174        http://www.privoxy.org/, the <b>Privoxy</b> Home page.
 175
 176        http://www.privoxy.org/faq/, the <b>Privoxy</b>  FAQ.
 177
 178        http://www.privoxy.org/developer-manual/, the <b>Privoxy</b> developer manual.
 179
 180        https://sourceforge.net/projects/ijbswa/, the Project Page for  <b>Privoxy</b>
 181        on SourceForge.
 182
 183        http://config.privoxy.org/,  the web-based user interface. <b>Privoxy</b> must
 184        be running for this to work. Shortcut: http://p.p/
 185
 186        https://sourceforge.net/tracker/?group_id=11118&amp;atid=460288, to  submit
 187        ``misses''  and other configuration related suggestions to the develop-
 188        ers.
 189
 190
 191 </pre>
 192     <h2>
 193       DEVELOPMENT TEAM
 194     </h2>
 195 <pre>
 196     Fabian Keil, lead developer
 197     David Schmidt, developer
 198
 199     Hal Burgiss
 200     Mark Miller
 201     Gerry Murphy
 202     Lee Rian
 203     Roland Rosenfeld
 204
 205
 206 </pre>
 207     <h2>
 208       COPYRIGHT AND LICENSE
 209     </h2>
 210 <pre>
 211    <b>COPYRIGHT</b>
 212        Copyright  (C)  2001-2011  by   Privoxy   Developers   &lt;ijbswa-develop-
 213        ers@lists.sourceforge.net&gt;
 214
 215        Some  source  code  is  based  on  code Copyright (C) 1997 by Anonymous
 216        Coders and Junkbusters, Inc. and licensed under the <i>GNU</i> <i>General</i>    <i>Public</i>
 217        <i>License</i>.
 218
 219    <b>LICENSE</b>
 220        <b>Privoxy</b>   is  free  software;  you  can redistribute it and/or modify it
 221        under the terms of the <i>GNU</i> <i>General</i> <i>Public</i> <i>License</i>, version 2,  as  pub-
 222        lished by the Free Software Foundation.
 223 </pre>
 224   </body>
 225 </html>
 226