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