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

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