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