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

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