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