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

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