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