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

   1
   2 <HTML><HEAD><TITLE>Manpage of PRIVOXY</TITLE>
   3 <LINK REL="STYLESHEET" TYPE="text/css" HREF="../p_doc.css"></HEAD><BODY>
   4 <H1>PRIVOXY</H1>
   5 Section:  (1)<BR>Updated: 25 March 2003<BR><A HREF="#index">Index</A>
   6 <HR>
   7
   8 <A NAME="lbAB">&nbsp;</A>
   9 <H2>NAME</H2>
  10
  11 privoxy - Privacy Enhancing Proxy
  12 <A NAME="lbAC">&nbsp;</A>
  13 <H2>SYNOPSIS</H2>
  14
  15 <P>
  16 <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></B><I>configfile</I><B></B> ]<B> (UNIX)</B>
  17 <P>
  18 <P>
  19 <B>privoxy.exe</B> [<B></B><I>configfile</I><B></B> ]<B> (Windows)</B>
  20 <P>
  21 <A NAME="lbAD">&nbsp;</A>
  22 <H2>OPTIONS</H2>
  23
  24 <P>
  25
  26 <B>Privoxy</B> may be invoked with the following command line
  27 options:
  28 <DL COMPACT>
  29 <DT><B>--help</B><DD>
  30 Print brief usage info and exit.
  31 <DT><B>--version</B><DD>
  32 Print version info and exit.
  33 <DT><B>--no-daemon</B><DD>
  34 Don't  become  a daemon, i.e. don't fork and become process group
  35 leader, don't detach from controlling tty, and do all logging there.
  36 <DT><B>--pidfile </B><I>pidfile</I><B></B><DD>
  37 On startup, write the process ID to <I>pidfile</I>.
  38 Delete the <I>pidfile</I> on exit.
  39 Failure to create or delete the <I>pidfile</I>
  40 is non-fatal. If no <B>--pidfile</B> option is given, no PID file will be used.
  41 <DT><B>--user </B><I>user[.group]</I><B></B><DD>
  42 After (optionally) writing the PID file, assume the user ID of
  43 <I>user</I> and the GID of
  44 <I>group</I>, or, if the optional
  45 <I>group</I> was not given, the default group of
  46 <I>user</I>. Exit if the privileges are not
  47 sufficient to do so.
  48 <DT><B>--chroot</B><DD>
  49 Before changing to the user ID given in the --user option, chroot to
  50 that user's home directory, i.e. make the kernel pretend to the
  51 <B>Privoxy</B> process that the directory tree starts
  52 there. If set up carefully, this can limit the impact of possible
  53 vulnerabilities in <B>Privoxy</B> to the files contained in
  54 that hierarchy.
  55 </DL>
  56 <P>
  57
  58 If the <I>configfile</I> is not specified on  the  command  line,
  59 <B>Privoxy</B>  will  look for a file named
  60 <I>config</I> in the current directory (except on Win32 where
  61 it will try <I>config.txt</I>). If no
  62 <I>configfile</I> is found, <B>Privoxy</B> will
  63 fail to start.
  64 <A NAME="lbAE">&nbsp;</A>
  65 <H2>DESCRIPTION</H2>
  66
  67 <P>
  68
  69 <B>Privoxy</B> is a web proxy with advanced filtering
  70 capabilities for protecting privacy, filtering web page content, managing
  71 cookies, controlling access, and removing ads, banners, pop-ups and other
  72 obnoxious Internet junk. <B>Privoxy</B> has a very
  73 flexible configuration and can be customized to suit individual needs and
  74 tastes. <B>Privoxy</B> has application for both
  75 stand-alone systems and multi-user networks.
  76 <P>
  77
  78 <B>Privoxy</B> is based on <B>Internet
  79 Junkbuster</B> (tm).
  80 <A NAME="lbAF">&nbsp;</A>
  81 <H2>INSTALLATION AND USAGE</H2>
  82
  83 <P>
  84
  85 Browsers must be individually configured to use <B>Privoxy</B> as
  86 a HTTP proxy.  The default setting is  for  localhost,  on port  8118
  87 (configurable in the main config file).  To set the HTTP proxy in Netscape
  88 and Mozilla, go through:  <B>Edit</B>;
  89 <B>Preferences</B>;  <B>Advanced</B>;
  90 <B>Proxies</B>;  <B>Manual Proxy Configuration</B>;
  91 <B>View</B>.
  92 <P>
  93
  94 For Internet Explorer, go through: <B>Tools</B>;
  95 <B>Internet Properties</B>; <B>Connections</B>;
  96 <B>LAN Settings</B>.
  97 <P>
  98
  99 The Secure (SSL) Proxy should also be set to the same values, otherwise
 100 https: URLs will not be proxied. Note: <B>Privoxy</B> can only
 101 proxy HTTP and HTTPS traffic. Do not try it with FTP or other protocols.
 102 <P>
 103
 104 For other browsers, check the documentation.
 105 <A NAME="lbAG">&nbsp;</A>
 106 <H2>CONFIGURATION</H2>
 107
 108 <P>
 109
 110 <B>Privoxy</B> can be configured with the various configuration
 111 files. The default configuration files are: <I>config</I>,
 112 <I>default.filter</I>, and
 113 <I>default.action</I>. <I>user.action</I> should
 114 be used for locally defined exceptions to the default rules of
 115 <I>default.action</I> These are all well commented.  On Unix
 116 and Unix-like systems, these are located in
 117 <I>/etc/privoxy/</I> by default. On Windows, OS/2 and AmigaOS,
 118 these files are in the same directory as the <B>Privoxy</B>
 119 executable.
 120 <P>
 121
 122 The name and number of configuration files has changed from previous
 123 versions. In fact, the configuration itself is changed  and  much more
 124 sophisticated. See the user-manual for a complete
 125 explanation of all configuration options and general usage, and notes for
 126 upgrading from <B>Junkbuster</B> and earlier <B>Privoxy</B>
 127 versions.
 128 <P>
 129
 130 The actions list (ad blocks, etc) can also be configured with your
 131 web browser at <A HREF="http://config.privoxy.org/">http://config.privoxy.org/.</A>
 132 <B>Privoxy's</B> configuration parameters  can also  be viewed at
 133 the same page. In addition, <B>Privoxy</B> can be toggled on/off.
 134 This is an internal page, and does not require Internet access.
 135 <A NAME="lbAH">&nbsp;</A>
 136 <H2>SAMPLE CONFIGURATION</H2>
 137
 138 <P>
 139
 140 A brief example of what a simple <I>default.action</I>
 141 configuration might look like:
 142 <P>
 143 <PRE>
 144  # Define a few useful custom aliases for later use
 145  {{alias}}
 146
 147  # Useful aliases
 148  +crunch-cookies = +crunch-incoming-cookies +crunch-outgoing-cookies
 149  -crunch-cookies = -crunch-incoming-cookies -crunch-outgoing-cookies
 150  +imageblock      = +block +handle-as-image
 151
 152  # Fragile sites should have the minimum changes
 153  fragile     = -block -deanimate-gifs -fast-redirects -filter \
 154                -hide-referer -prevent-cookies -kill-popups
 155
 156  ## Turn some actions on ################################
 157  { \
 158  -add-header \
 159  -block \
 160  +deanimate-gifs{last} \
 161  -downgrade-http-version \
 162  -fast-redirects \
 163  +filter{html-annoyances} \
 164  +filter{js-annoyances} \
 165  +filter{content-cookies} \
 166  +filter{webbugs} \
 167  +filter{banners-by-size} \
 168  +hide-forwarded-for-headers \
 169  +hide-from-header{block} \
 170  +hide-referrer{forge} \
 171  -hide-user-agent \
 172  -handle-as-image \
 173  +set-image-blocker{pattern} \
 174  -limit-connect \
 175  +prevent-compression \
 176  +session-cookies-only \
 177  -crunch-cookies \
 178  -kill-popups \
 179  }
 180  /   # '/' Matches *all* URL patterns
 181
 182  # Block, and treat these URL patterns as if they were 'images'.
 183  # We would expect these to be ads.
 184  {+imageblock}
 185   .ad.doubleclick.net
 186   .a[0-9].yimg.com/(?:(?!/i/).)*$
 187   ad.*.doubleclick.net
 188
 189  # Block any URLs that match these patterns
 190  {+block}
 191   ad*.
 192   .*ads.
 193   banner?.
 194   /.*count(er)?\.(pl|cgi|exe|dll|asp|php[34]?)
 195   .hitbox.com
 196
 197  # Make exceptions for these harmless ones that would be
 198  # caught by our +block patterns just above.
 199  {-block}
 200   adsl.
 201   advice.
 202   .*downloads.
 203 </PRE>
 204
 205 <P>
 206
 207 Then for a <I>user.action</I>, we would put local,
 208 narrowly defined exceptions:
 209 <P>
 210 <PRE>
 211  # Re-define aliases as needed here
 212  {{alias}}
 213
 214  # Useful aliases
 215  -crunch-cookies = -crunch-incoming-cookies -crunch-outgoing-cookies
 216
 217  # Set personal exceptions to the policies in default.action #######
 218
 219  # Sites where we want persistant cookies, so allow *all* cookies
 220  {-crunch-cookies -session-cookies-only}
 221   .redhat.com
 222   .sun.com
 223   .msdn.microsoft.com
 224
 225  # This site breaks easily.
 226  {-block -fast-redirects}
 227   .forbes.com
 228 </PRE>
 229
 230 <P>
 231
 232 See the comments in the configuration files themselves, or the
 233 <I>user-manual</I>
 234 for explanations of the above syntax, and other <B>Privoxy</B>
 235 configuration options.
 236 <A NAME="lbAI">&nbsp;</A>
 237 <H2>FILES</H2>
 238
 239 <P>
 240 <PRE>
 241
 242  <I>/usr/sbin/privoxy</I>
 243  <I>/etc/privoxy/config</I>
 244  <I>/etc/privoxy/default.action</I>
 245  <I>/etc/privoxy/standard.action</I>
 246  <I>/etc/privoxy/user.action</I>
 247  <I>/etc/privoxy/default.filter</I>
 248  <I>/etc/privoxy/trust</I>
 249  <I>/etc/privoxy/templates/*</I>
 250  <I>/var/log/privoxy/logfile</I>
 251 </PRE>
 252
 253 <P>
 254
 255 Various other files should be included, but may vary depending on platform
 256 and build configuration. More documentation should be included in the local
 257 documentation directory.
 258 <A NAME="lbAJ">&nbsp;</A>
 259 <H2>SIGNALS</H2>
 260
 261 <P>
 262
 263 <B>Privoxy</B> terminates on the <B>SIGINT</B>,
 264 <B>SIGTERM</B> and <B>SIGABRT</B> signals. Log
 265 rotation scripts may cause a re-opening of the logfile by sending a
 266 <B>SIGHUP</B> to <B>Privoxy</B>. Note that unlike
 267 other daemons,  <B>Privoxy</B> does not need to be made aware of
 268 config file changes by <B>SIGHUP</B> -- it will detect them
 269 automatically.
 270 <A NAME="lbAK">&nbsp;</A>
 271 <H2>NOTES</H2>
 272
 273 <P>
 274
 275 Please see the <I>User Manual</I> on how to contact the
 276 developers for feature requests, reporting problems, and other questions.
 277 <A NAME="lbAL">&nbsp;</A>
 278 <H2>SEE ALSO</H2>
 279
 280 <P>
 281
 282 Other references and sites of interest to <B>Privoxy</B>
 283 users:
 284 <P>
 285
 286 <P>
 287 <A HREF="http://www.privoxy.org/">http://www.privoxy.org/,</A>
 288 the <B>Privoxy</B> Home page.
 289 <P>
 290 <A HREF="http://www.privoxy.org/faq/">http://www.privoxy.org/faq/,</A>
 291 the <B>Privoxy</B> FAQ.
 292 <P>
 293 <A HREF="http://sourceforge.net/projects/ijbswa/">http://sourceforge.net/projects/ijbswa/,</A>
 294 the Project Page for <B>Privoxy</B> on
 295 SourceForge.
 296 <P>
 297 <A HREF="http://config.privoxy.org/">http://config.privoxy.org/,</A>
 298 the web-based user interface. <B>Privoxy</B> must be
 299 running for this to work. Shortcut: <A HREF="http://p.p/">http://p.p/</A>
 300 <P>
 301 <A HREF="http://www.privoxy.org/actions/">http://www.privoxy.org/actions/,</A> to submit ``misses'' to the developers.
 302 <P>
 303 <A HREF="http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/ijbswa/contrib/">http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/ijbswa/contrib/,</A> cool
 304 and fun ideas from <B>Privoxy</B> users.
 305 <P>
 306 <A HREF="http://www.junkbusters.com/ht/en/cookies.html">http://www.junkbusters.com/ht/en/cookies.html,</A>
 307 an explanation how cookies are used to track web users.
 308 <P>
 309 <A HREF="http://www.junkbusters.com/ijb.html">http://www.junkbusters.com/ijb.html,</A>
 310 the original Internet Junkbuster.
 311 <P>
 312 <A HREF="http://www.waldherr.org/junkbuster/">http://www.waldherr.org/junkbuster/,</A>
 313 Stefan Waldherr's version of Junkbuster, from which <B>Privoxy</B> was
 314 derived.
 315 <P>
 316 <A HREF="http://privacy.net/analyze/">http://privacy.net/analyze/,</A> a useful site
 317 to check what information about you is leaked while you browse the web.
 318 <P>
 319 <A HREF="http://www.squid-cache.org/">http://www.squid-cache.org/,</A> a very popular
 320 caching proxy, which is often used together with <B>Privoxy</B>.
 321 <P>
 322 <A HREF="http://www.privoxy.org/developer-manual/">http://www.privoxy.org/developer-manual/,</A>
 323 the <B>Privoxy</B> developer manual.
 324 <A NAME="lbAM">&nbsp;</A>
 325 <H2>DEVELOPMENT TEAM</H2>
 326
 327 <P>
 328 <PRE>
 329  Hal Burgiss (docs)
 330  Jon Foster
 331  Andreas Oesterhelt
 332  David Schmidt (OS/2, Mac OSX ports)
 333
 334  Johny Agotnes
 335  Rodrigo Barbosa (RPM specfiles)
 336  Moritz Barsnick
 337  Mattes Dolak
 338  Karsten Hopp (Red Hat)
 339  Alexander Lazic
 340  Daniel Leite
 341  G&#225;bor Lipt&#225;k
 342  Adam Lock (Win32)
 343  Guy Laroche
 344  Haroon Rafique
 345  Roland Rosenfeld (Debian)
 346  Georg Sauthoff (Gentoo)
 347  Thomas Steudten
 348  Joerg Strohmayer (Amiga)
 349  Rodney Stromlund
 350  Sviatoslav Sviridov
 351  Sarantis Paskalis
 352  Stefan Waldherr
 353 </PRE>
 354
 355 <A NAME="lbAN">&nbsp;</A>
 356 <H2>COPYRIGHT AND LICENSE</H2>
 357
 358 <A NAME="lbAO">&nbsp;</A>
 359 <H3>COPYRIGHT</H3>
 360
 361 <P>
 362
 363 Copyright (C) 2001 - 2003 by Privoxy Developers &lt;<A HREF="mailto:developers@privoxy.org">developers@privoxy.org</A>&gt;
 364 <P>
 365
 366 Some source code is based on code Copyright (C) 1997 by Anonymous Coders
 367 and Junkbusters, Inc. and licensed under the <I>GNU General Public
 368 License</I>.
 369 <A NAME="lbAP">&nbsp;</A>
 370 <H3>LICENSE</H3>
 371
 372 <P>
 373
 374 <B>Privoxy</B> is free software; you can
 375 redistribute it and/or modify it under the terms of the
 376 <I>GNU General Public
 377 License</I>, version 2, as published by the Free Software Foundation.
 378 <P>
 379
 380 This program is distributed in the hope that it will be useful, but WITHOUT
 381 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 382 FITNESS FOR A PARTICULAR PURPOSE.  See the
 383 <I>GNU General Public License</I> for
 384 more details, which is available from the Free Software Foundation, Inc, 59
 385 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 386 <P>
 387
 388 You should have received a copy of the  <I>GNU General Public License</I>
 389 along with this program; if not, write to the  Free Software
 390 Foundation, Inc. 59 Temple Place - Suite 330
 391 Boston, MA 02111-1307
 392 USA
 393 <P>
 394
 395 <HR>
 396 <A NAME="index">&nbsp;</A><H2>Index</H2>
 397 <DL>
 398 <DT><A HREF="#lbAB">NAME</A><DD>
 399 <DT><A HREF="#lbAC">SYNOPSIS</A><DD>
 400 <DT><A HREF="#lbAD">OPTIONS</A><DD>
 401 <DT><A HREF="#lbAE">DESCRIPTION</A><DD>
 402 <DT><A HREF="#lbAF">INSTALLATION AND USAGE</A><DD>
 403 <DT><A HREF="#lbAG">CONFIGURATION</A><DD>
 404 <DT><A HREF="#lbAH">SAMPLE CONFIGURATION</A><DD>
 405 <DT><A HREF="#lbAI">FILES</A><DD>
 406 <DT><A HREF="#lbAJ">SIGNALS</A><DD>
 407 <DT><A HREF="#lbAK">NOTES</A><DD>
 408 <DT><A HREF="#lbAL">SEE ALSO</A><DD>
 409 <DT><A HREF="#lbAM">DEVELOPMENT TEAM</A><DD>
 410 <DT><A HREF="#lbAN">COPYRIGHT AND LICENSE</A><DD>
 411 <DL>
 412 <DT><A HREF="#lbAO">COPYRIGHT</A><DD>
 413 <DT><A HREF="#lbAP">LICENSE</A><DD>
 414 </DL>
 415 </DL>
 416 <HR>
 417 This document was created by
 418 man2html,
 419 using the manual pages.<BR>
 420 Time: 02:05:48 GMT, March 26, 2003
 421 </BODY>
 422 </HTML>