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