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: 08 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 After (optionally) writing the PID file, assume the user  ID  of  user
  38 and the GID of group, or, if the optional group was not given, the
  39 default group  of user.  Exit if the privileges are not sufficient to
  40 do so.
  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 the code of the
  72 <B>Internet Junkbuster</B> (tm).
  73 <B>Junkbuster</B> was originally written by JunkBusters
  74 Corporation, and was released as free open-source software under the GNU GPL.
  75 Stefan Waldherr made many improvements, and started the SourceForge project
  76 to continue development.
  77 <P>
  78
  79 <B>Privoxy</B> continues the
  80 <B>Junkbuster</B> tradition, but adds many
  81 refinements, enhancements and new features.
  82 <A NAME="lbAF">&nbsp;</A>
  83 <H2>INSTALLATION AND USAGE</H2>
  84
  85 <P>
  86
  87 Browsers must be individually configured to use <B>Privoxy</B> as
  88 a HTTP proxy.  The default setting is  for  localhost,  on port  8118
  89 (configurable in the main config file).  To set the HTTP proxy in Netscape
  90 and Mozilla, go through:  <B>Edit</B>;
  91 <B>Preferences</B>;  <B>Advanced</B>;
  92 <B>Proxies</B>;  <B>Manual Proxy Configuration</B>;
  93 <B>View</B>.
  94 <P>
  95
  96 For Internet Explorer, go through: <B>Tools</B>;
  97 <B>Internet Properties</B>; <B>Connections</B>;
  98 <B>LAN Settings</B>.
  99 <P>
 100
 101 The Secure (SSL) Proxy should also be set to the same values, otherwise
 102 https: URLs will not be proxied.
 103 <P>
 104
 105 For other browsers, check the documentation.
 106 <A NAME="lbAG">&nbsp;</A>
 107 <H2>CONFIGURATION</H2>
 108
 109 <P>
 110
 111 <B>Privoxy</B> can be configured with the various configuration
 112 files. The default configuration files are: <I>config</I>,
 113 <I>default.action</I>, and
 114 <I>default.filter</I>. These are well commented.  On Unix and
 115 Unix-like systems, these are located in <I>/etc/privoxy/</I> by
 116 default. On Windows, OS/2 and AmigaOS, these files are in the same directory
 117 as the <B>Privoxy</B> executable.
 118 <P>
 119
 120 The name and number of configuration files has changed from previous
 121 versions, and is subject to change as development progresses. In fact, the
 122 configuration itself is changed  and  much more sophisticated. See the
 123 user-manual for a
 124 brief explanation of all configuration options.
 125 <P>
 126
 127 The actions list (ad blocks, etc) can also be configured with your
 128 web browser at <A HREF="http://ijbswa.sourceforge.net/config.">http://ijbswa.sourceforge.net/config.</A>
 129 <B>Privoxy's</B> configuration parameters  can also  be viewed at
 130 the same page. In addition, <B>Privoxy</B> can be toggled on/off.
 131 This is an internal page.
 132 <A NAME="lbAH">&nbsp;</A>
 133 <H2>SAMPLE CONFIGURATION</H2>
 134
 135 <P>
 136
 137 A brief example of what a <I>default.action</I> configuration
 138 might look like:
 139 <P>
 140 <PRE>
 141
 142  # Define a few useful custom aliases for later use
 143  {{alias}}
 144
 145  # Don't accept cookies
 146  +no-cookies = +no-cookies-set +no-cookies-read
 147
 148  # Do accept cookies
 149  -no-cookies = -no-cookies-set -no-cookies-read
 150
 151  # Treat these blocked URLs as images.
 152  +imageblock = +block +image
 153
 154  # Define page filters we want to use.
 155  myfilters = +filter{html-annoyances} +filter{js-annoyances}\
 156              +filter{no-popups} +filter{webbugs}
 157
 158  ## Default Policies (actions) ############################
 159  { \
 160   -block \
 161   -downgrade \
 162   +fast-redirects \
 163   myfilters \
 164   +no-compression \
 165   +hide-forwarded \
 166   +hide-from{block} \
 167   +hide-referer{forge} \
 168   -hide-user-agent \
 169   -image \
 170   +image-blocker{blank} \
 171   +no-cookies-keep \
 172   -no-cookies-read \
 173   -no-cookies-set \
 174   +no-popups \
 175   -vanilla-wafer \
 176   -wafer \
 177  }
 178  /
 179
 180  # Now set exceptions to the above defined policies #######
 181
 182  # Sites where we want persistant cookies
 183  {-no-cookies -no-cookies-keep}
 184   .redhat.com
 185   .sun.com
 186   .yahoo.com
 187   .msdn.microsoft.com
 188
 189  # This site requires cookies AND 'fast-redirects' on
 190  {-no-cookies -no-cookies-keep -fast-redirects}
 191   .nytimes.com
 192
 193  # Add custom headers, and turn off filtering of page source
 194  {+add-header{X-Privacy: Yes please} #-add-header{*} \
 195   +add-header{X-User-Tracking: No thanks!} -filter}
 196   privacy.net
 197
 198  # Block, and treat these URLs as 'images'.
 199  {+imageblock}
 200   .adforce.imgis.com
 201   .ad.preferences.com/image.*
 202   .ads.web.aol.com
 203   .ad-adex3.flycast.com
 204   .ad.doubleclick.net
 205   .ln.doubleclick.net
 206   .ad.de.doubleclick.net
 207   /.*/count\.cgi\?.*df=
 208   194.221.183.22[1-7]
 209   a196.g.akamai.net/7/196/2670/000[12]/images.gmx.net/i4/images/.*/
 210
 211  # Block any URLs that match these patterns
 212  {+block}
 213   /.*/(.*[-_.])?ads?[0-9]?(/|[-_.].*|\.(gif|jpe?g))
 214   /.*/(plain|live|rotate)[-_.]?ads?/
 215   /.*/(sponsor)s?[0-9]?/
 216   /.*/ad(server|stream|juggler)\.(cgi|pl|dll|exe)
 217   /.*/adbanners/
 218   /.*/adv((er)?ts?|ertis(ing|ements?))?/
 219   /.*/banners?/
 220   /.*/popupads/
 221   /.*/advert[0-9]+\.jpg
 222   /ad_images/
 223   /.*/ads/
 224   /images/.*/.*_anim\.gif
 225   /rotations/
 226   /.*(ms)?backoff(ice)?.*\.(gif|jpe?g)
 227   195.63.104.*/(inbox|log|meld|folderlu|folderru|log(in|out)[lmr]u|)
 228   .images.nytimes.com
 229   .images.yahoo.com/adv/
 230   /.*cnnstore\.gif
 231 </PRE>
 232
 233 <P>
 234
 235 See the comments in the configuration files themselves, or the
 236 <I>user-manual</I>
 237 for explanations of the above syntax, and other <B>Privoxy</B>
 238 configuration options.
 239 <A NAME="lbAI">&nbsp;</A>
 240 <H2>FILES</H2>
 241
 242 <P>
 243 <PRE>
 244
 245  <I>/usr/sbin/privoxy</I>
 246  <I>/etc/privoxy/config</I>
 247  <I>/etc/privoxy/default.action</I>
 248  <I>/etc/privoxy/advanced.action</I>
 249  <I>/etc/privoxy/basic.action</I>
 250  <I>/etc/privoxy/intermediate.action</I>
 251  <I>/etc/privoxy/default.filter</I>
 252  <I>/etc/privoxy/trust</I>
 253  <I>/etc/privoxy/templates/*</I>
 254  <I>/var/log/privoxy/logfile</I>
 255 </PRE>
 256
 257 <P>
 258
 259 Various other files should be included, but may vary depending on platform
 260 and build configuration. More documentation should be included in the local
 261 documentation directory, though is not complete at this time.
 262 <A NAME="lbAJ">&nbsp;</A>
 263 <H2>SIGNALS</H2>
 264
 265 <P>
 266
 267 <B>Privoxy</B> terminates on the <B>SIGINT</B>,
 268 <B>SIGTERM</B> and <B>SIGABRT</B> signals. Log
 269 rotation scripts may cause a re-opening of the logfile by sending a
 270 <B>SIGHUP</B> to <B>Privoxy</B>. Note that unlike
 271 other daemons,  <B>Privoxy</B> does not need to be made aware of
 272 config file changes by <B>SIGHUP</B> -- it will detect them
 273 automatically.
 274 <A NAME="lbAK">&nbsp;</A>
 275 <H2>NOTES</H2>
 276
 277 <P>
 278
 279 This is a beta version of <B>Privoxy</B>. Not
 280 all features are well tested.
 281 <P>
 282
 283 Please see the <I>user-manual</I> on how to contact the
 284 developers for feature requests, reporting problems, and other questions.
 285 <A NAME="lbAL">&nbsp;</A>
 286 <H2>SEE ALSO</H2>
 287
 288 <P>
 289
 290 Other references and sites of interest to <B>Privoxy</B>
 291 users:
 292 <P>
 293
 294 <P>
 295 <A HREF="http://www.privoxy.org/,">http://www.privoxy.org/,</A>
 296 The <B>Privoxy</B> Home page.
 297 <P>
 298 <A HREF="http://sourceforge.net/projects/ijbswa,">http://sourceforge.net/projects/ijbswa,</A>
 299 the Project Page for <B>Privoxy</B> on
 300 Sourceforge.
 301 <P>
 302 <A HREF="http://p.p/,">http://p.p/,</A> access
 303 <B>Privoxy</B> from your browser. Alternately,
 304 <A HREF="http://config.privoxy.org">http://config.privoxy.org</A>
 305 may work in some situations where the first does not.
 306 <P>
 307 <A HREF="http://www.junkbusters.com/ht/en/cookies.html">http://www.junkbusters.com/ht/en/cookies.html</A>
 308 <P>
 309 <A HREF="http://www.waldherr.org/junkbuster/">http://www.waldherr.org/junkbuster/</A>
 310 <P>
 311 <A HREF="http://privacy.net/analyze/">http://privacy.net/analyze/</A>
 312 <P>
 313 <A HREF="http://www.squid-cache.org/">http://www.squid-cache.org/</A>
 314 <A NAME="lbAM">&nbsp;</A>
 315 <H2>DEVELOPMENT TEAM</H2>
 316
 317 <P>
 318 <PRE>
 319  Stefan Waldherr
 320  Andreas Oesterhelt
 321  Jon Foster
 322  Markus Breitenbach
 323  Thomas Steudten
 324  David Schmidt (OS/2, Mac OSX ports)
 325  Gabriel L. Somlo
 326  Hal Burgiss (docs)
 327  Haroon Rafique
 328  John Venvertloh
 329  Joerg Strohmayer
 330  Rodney Stromlund
 331  Rodrigo Barbosa (RPM specfiles)
 332  Sarantis Paskalis
 333  Shamim Mohamed
 334  G&#225;bor Lipt&#225;k
 335  Alexander Lazic
 336 </PRE>
 337
 338 <A NAME="lbAN">&nbsp;</A>
 339 <H2>COPYRIGHT AND LICENSE</H2>
 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 GNU General Public
 345 License as published by the Free Software Foundation; either version 2 of the
 346 License, or (at your option) any later version.
 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 GNU General Public License for
 352 more details, which is available from the Free Software Foundation, Inc, 59
 353 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 354 <P>
 355
 356 You should have received a copy of the GNU General Public License
 357 along with this program; if not, write to the Free Software Foundation, Inc.,
 358 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA.
 359 <P>
 360
 361 <HR>
 362 <A NAME="index">&nbsp;</A><H2>Index</H2>
 363 <DL>
 364 <DT><A HREF="#lbAB">NAME</A><DD>
 365 <DT><A HREF="#lbAC">SYNOPSIS</A><DD>
 366 <DT><A HREF="#lbAD">OPTIONS</A><DD>
 367 <DT><A HREF="#lbAE">DESCRIPTION</A><DD>
 368 <DT><A HREF="#lbAF">INSTALLATION AND USAGE</A><DD>
 369 <DT><A HREF="#lbAG">CONFIGURATION</A><DD>
 370 <DT><A HREF="#lbAH">SAMPLE CONFIGURATION</A><DD>
 371 <DT><A HREF="#lbAI">FILES</A><DD>
 372 <DT><A HREF="#lbAJ">SIGNALS</A><DD>
 373 <DT><A HREF="#lbAK">NOTES</A><DD>
 374 <DT><A HREF="#lbAL">SEE ALSO</A><DD>
 375 <DT><A HREF="#lbAM">DEVELOPMENT TEAM</A><DD>
 376 <DT><A HREF="#lbAN">COPYRIGHT AND LICENSE</A><DD>
 377 </DL>
 378 <HR>
 379 This document was created by
 380 man2html,
 381 using the manual pages.<BR>
 382 Time: 15:13:15 GMT, April 08, 2002
 383 </BODY>
 384 </HTML>