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: 13 November 2010<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 GNU GPLv2.
  78 <P>
  79
  80 Privoxy is an associated project of Software in the Public Interest (SPI).
  81 <P>
  82
  83 Helping hands and donations are welcome:
  84 <DL COMPACT>
  85 <DT>&bull;<DD>
  86 <A HREF="http://www.privoxy.org/faq/general.html#PARTICIPATE">http://www.privoxy.org/faq/general.html#PARTICIPATE</A>
  87 <DT>&bull;<DD>
  88 <A HREF="http://www.privoxy.org/faq/general.html#DONATE">http://www.privoxy.org/faq/general.html#DONATE</A>
  89 </DL>
  90 <A NAME="lbAF">&nbsp;</A>
  91 <H2>INSTALLATION AND USAGE</H2>
  92
  93 <P>
  94
  95 Browsers can either be individually configured to use
  96 <B>Privoxy</B> as a HTTP proxy (recommended),
  97 or <B>Privoxy</B> can be combined with a packet
  98 filter to build an intercepting proxy
  99 (see <I>config</I>).  The default setting is  for
 100 localhost,  on port  8118 (configurable in the main config file).  To set the
 101 HTTP proxy in Firefox, go through: <B>Tools</B>;
 102 <B>Options</B>; <B>General</B>;
 103 <B>Connection Settings</B>;
 104 <B>Manual Proxy Configuration</B>.
 105 <P>
 106
 107 For Internet Explorer, go through: <B>Tools</B>;
 108 <B>Internet Properties</B>; <B>Connections</B>;
 109 <B>LAN Settings</B>.
 110 <P>
 111
 112 The Secure (SSL) Proxy should also be set to the same values, otherwise
 113 https: URLs will not be proxied. Note: <B>Privoxy</B> can only
 114 proxy HTTP and HTTPS traffic. Do not try it with FTP or other protocols.
 115 HTTPS presents some limitations, and not all features will work with HTTPS
 116 connections.
 117 <P>
 118
 119 For other browsers, check the documentation.
 120 <A NAME="lbAG">&nbsp;</A>
 121 <H2>CONFIGURATION</H2>
 122
 123 <P>
 124
 125 <B>Privoxy</B> can be configured with the various configuration
 126 files. The default configuration files are: <I>config</I>,
 127 <I>default.filter</I>, <I>default.action</I> and
 128 <I>default.action</I>. <I>user.action</I> should
 129 be used for locally defined exceptions to the default rules in
 130 <I>match-all.action</I> and <I>default.action</I>,
 131 and <I>user.filter</I> for locally defined filters. These are
 132 well commented.  On Unix and Unix-like systems, these are located in
 133 <I>/etc/privoxy/</I> by default.
 134 <P>
 135
 136 <B>Privoxy</B> uses the concept of <B>actions</B>
 137 in order to manipulate the data stream between the browser and remote sites.
 138 There are various actions available with specific functions for such things
 139 as blocking web sites, managing cookies, etc. These actions can be invoked
 140 individually or combined, and used against individual URLs, or groups of URLs
 141 that can be defined using wildcards and regular expressions. The result is
 142 that the user has greatly enhanced control and freedom.
 143 <P>
 144
 145 The actions list (ad blocks, etc) can also be configured with your
 146 web browser at <A HREF="http://config.privoxy.org/">http://config.privoxy.org/</A>
 147 (assuming the configuration allows it).
 148 <B>Privoxy's</B> configuration parameters  can also  be viewed at
 149 the same page. In addition, <B>Privoxy</B> can be toggled on/off.
 150 This is an internal page, and does not require Internet access.
 151 <P>
 152
 153 See the <I>User Manual</I> for a detailed
 154 explanation of installation, general usage, all configuration options, new
 155 features and notes on upgrading.
 156 <A NAME="lbAH">&nbsp;</A>
 157 <H2>FILES</H2>
 158
 159 <P>
 160 <PRE>
 161
 162  <I>/usr/sbin/privoxy</I>
 163  <I>/etc/privoxy/config</I>
 164  <I>/etc/privoxy/match-all.action</I>
 165  <I>/etc/privoxy/default.action</I>
 166  <I>/etc/privoxy/user.action</I>
 167  <I>/etc/privoxy/default.filter</I>
 168  <I>/etc/privoxy/user.filter</I>
 169  <I>/etc/privoxy/trust</I>
 170  <I>/etc/privoxy/templates/*</I>
 171  <I>/var/log/privoxy/logfile</I>
 172 </PRE>
 173
 174 <P>
 175
 176 Various other files should be included, but may vary depending on platform
 177 and build configuration. Additional documentation should be included in the local
 178 documentation directory.
 179 <A NAME="lbAI">&nbsp;</A>
 180 <H2>SIGNALS</H2>
 181
 182 <P>
 183
 184 <B>Privoxy</B> terminates on the <B>SIGINT</B>,
 185 <B>SIGTERM</B> and <B>SIGABRT</B> signals. Log
 186 rotation scripts may cause a re-opening of the logfile by sending a
 187 <B>SIGHUP</B> to <B>Privoxy</B>. Note that unlike
 188 other daemons,  <B>Privoxy</B> does not need to be made aware of
 189 config file changes by <B>SIGHUP</B> -- it will detect them
 190 automatically.
 191 <A NAME="lbAJ">&nbsp;</A>
 192 <H2>NOTES</H2>
 193
 194 <P>
 195
 196 Please see the <I>User Manual</I> on how to contact the
 197 developers, for feature requests, reporting problems, and other questions.
 198 <A NAME="lbAK">&nbsp;</A>
 199 <H2>SEE ALSO</H2>
 200
 201 <P>
 202
 203 Other references and sites of interest to <B>Privoxy</B>
 204 users:
 205 <P>
 206
 207 <P>
 208 <A HREF="http://www.privoxy.org/">http://www.privoxy.org/,</A>
 209 the <B>Privoxy</B> Home page.
 210 <P>
 211 <A HREF="http://www.privoxy.org/faq/">http://www.privoxy.org/faq/,</A>
 212 the <B>Privoxy</B> FAQ.
 213 <P>
 214 <A HREF="http://www.privoxy.org/developer-manual/">http://www.privoxy.org/developer-manual/,</A>
 215 the <B>Privoxy</B> developer manual.
 216 <P>
 217 <A HREF="https://sourceforge.net/projects/ijbswa/">https://sourceforge.net/projects/ijbswa/,</A>
 218 the Project Page for <B>Privoxy</B> on
 219 SourceForge.
 220 <P>
 221 <A HREF="http://config.privoxy.org/">http://config.privoxy.org/,</A>
 222 the web-based user interface. <B>Privoxy</B> must be
 223 running for this to work. Shortcut: <A HREF="http://p.p/">http://p.p/</A>
 224 <P>
 225 <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
 226 configuration related suggestions to the developers.
 227 <A NAME="lbAL">&nbsp;</A>
 228 <H2>DEVELOPMENT TEAM</H2>
 229
 230 <P>
 231 <PRE>
 232  Fabian Keil, lead developer
 233  David Schmidt, developer
 234
 235  Hal Burgiss
 236  Mark Miller
 237  Gerry Murphy
 238  Lee Rian
 239  Roland Rosenfeld
 240 </PRE>
 241
 242 <A NAME="lbAM">&nbsp;</A>
 243 <H2>COPYRIGHT AND LICENSE</H2>
 244
 245 <A NAME="lbAN">&nbsp;</A>
 246 <H3>COPYRIGHT</H3>
 247
 248 <P>
 249
 250 Copyright (C) 2001-2010 by Privoxy Developers &lt;<A HREF="mailto:ijbswa-developers@lists.sourceforge.net">ijbswa-developers@lists.sourceforge.net</A>&gt;
 251 <P>
 252
 253 Some source code is based on code Copyright (C) 1997 by Anonymous Coders
 254 and Junkbusters, Inc. and licensed under the <I>GNU General Public
 255 License</I>.
 256 <A NAME="lbAO">&nbsp;</A>
 257 <H3>LICENSE</H3>
 258
 259 <P>
 260
 261 <B>Privoxy</B> is free software; you can
 262 redistribute it and/or modify it under the terms of the
 263 <I>GNU General Public License</I>, version 2,
 264 as published by the Free Software Foundation.
 265 <P>
 266
 267 This program is distributed in the hope that it will be useful, but WITHOUT
 268 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 269 FITNESS FOR A PARTICULAR PURPOSE.  See the  <I>GNU General Public License</I> for details.
 270 <P>
 271
 272 You should have received a copy of the <I>GNU GPL</I>
 273 along with this program; if not, write to the  Free Software
 274 Foundation, Inc. 51 Franklin Street, Fifth Floor
 275 Boston, MA 02110-1301
 276 USA
 277 <P>
 278
 279 <HR>
 280 <A NAME="index">&nbsp;</A><H2>Index</H2>
 281 <DL>
 282 <DT><A HREF="#lbAB">NAME</A><DD>
 283 <DT><A HREF="#lbAC">SYNOPSIS</A><DD>
 284 <DT><A HREF="#lbAD">OPTIONS</A><DD>
 285 <DT><A HREF="#lbAE">DESCRIPTION</A><DD>
 286 <DT><A HREF="#lbAF">INSTALLATION AND USAGE</A><DD>
 287 <DT><A HREF="#lbAG">CONFIGURATION</A><DD>
 288 <DT><A HREF="#lbAH">FILES</A><DD>
 289 <DT><A HREF="#lbAI">SIGNALS</A><DD>
 290 <DT><A HREF="#lbAJ">NOTES</A><DD>
 291 <DT><A HREF="#lbAK">SEE ALSO</A><DD>
 292 <DT><A HREF="#lbAL">DEVELOPMENT TEAM</A><DD>
 293 <DT><A HREF="#lbAM">COPYRIGHT AND LICENSE</A><DD>
 294 <DL>
 295 <DT><A HREF="#lbAN">COPYRIGHT</A><DD>
 296 <DT><A HREF="#lbAO">LICENSE</A><DD>
 297 </DL>
 298 </DL>
 299 <HR>
 300 This document was created by
 301 man2html,
 302 using the manual pages.<BR>
 303 Time: 11:11:21 GMT, November 14, 2010
 304 </BODY>
 305 </HTML>