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  # Don't accept cookies
 137  +no-cookies = +no-cookies-set +no-cookies-read
 138
 139  # Do accept cookies
 140  -no-cookies = -no-cookies-set -no-cookies-read
 141
 142  # Treat these blocked URLs as images.
 143  +imageblock = +block +image
 144
 145  # Define page filters we want to use.
 146  myfilters = +filter{html-annoyances} +filter{js-annoyances}\
 147              +filter{no-popups} +filter{webbugs}
 148
 149  ## Default Policies (actions) ############################
 150  { \
 151   -block \
 152   -downgrade \
 153   +fast-redirects \
 154   myfilters \
 155   +no-compression \
 156   +hide-forwarded \
 157   +hide-from{block} \
 158   +hide-referer{forge} \
 159   -hide-user-agent \
 160   -image \
 161   +image-blocker{blank} \
 162   +no-cookies-keep \
 163   -no-cookies-read \
 164   -no-cookies-set \
 165   +no-popups \
 166   -vanilla-wafer \
 167   -wafer \
 168  }
 169  /
 170
 171  # Now set exceptions to the above defined policies #######
 172
 173  # Sites where we want persistant cookies
 174  {-no-cookies -no-cookies-keep}
 175   .redhat.com
 176   .sun.com
 177   .yahoo.com
 178   .msdn.microsoft.com
 179
 180  # This site requires cookies AND 'fast-redirects' on
 181  {-no-cookies -no-cookies-keep -fast-redirects}
 182   .nytimes.com
 183
 184  # Add custom headers, and turn off filtering of page source
 185  {+add-header{X-Privacy: Yes please} #-add-header{*} \
 186   +add-header{X-User-Tracking: No thanks!} -filter}
 187   privacy.net
 188
 189  # Block, and treat these URLs as 'images'.
 190  {+imageblock}
 191   .ad.preferences.com/image.*
 192   .ads.web.aol.com
 193   .ad-adex3.flycast.com
 194   .ad.doubleclick.net
 195   .ln.doubleclick.net
 196   .ad.de.doubleclick.net
 197   /.*/count\.cgi\?.*df=
 198   194.221.183.22[1-7]
 199   a196.g.akamai.net/7/196/2670/000[12]/images.gmx.net/i4/images/.*/
 200
 201  # Block any URLs that match these patterns
 202  {+block}
 203   /.*/(.*[-_.])?ads?[0-9]?(/|[-_.].*|\.(gif|jpe?g))
 204   /.*/(plain|live|rotate)[-_.]?ads?/
 205   /.*/(sponsor)s?[0-9]?/
 206   /.*/ad(server|stream|juggler)\.(cgi|pl|dll|exe)
 207   /.*/adbanners/
 208   /.*/adv((er)?ts?|ertis(ing|ements?))?/
 209   /.*/banners?/
 210   /.*/popupads/
 211   /.*/advert[0-9]+\.jpg
 212   /ad_images/
 213   /.*/ads/
 214   /images/.*/.*_anim\.gif
 215   /rotations/
 216   /.*(ms)?backoff(ice)?.*\.(gif|jpe?g)
 217   195.63.104.*/(inbox|log|meld|folderlu|folderru|log(in|out)[lmr]u|)
 218   .images.nytimes.com
 219   .images.yahoo.com/adv/
 220   /.*cnnstore\.gif
 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, though is not complete at this time.
 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 This is a beta version of <B>Privoxy</B>. Not
 269 all features are well tested.
 270 <P>
 271
 272 Please see the <I>user-manual</I> on how to contact the
 273 developers for feature requests, reporting problems, and other questions.
 274 <A NAME="lbAL">&nbsp;</A>
 275 <H2>SEE ALSO</H2>
 276
 277 <P>
 278
 279 Other references and sites of interest to <B>Privoxy</B>
 280 users:
 281 <P>
 282
 283 <P>
 284 <A HREF="http://www.privoxy.org/,">http://www.privoxy.org/,</A>
 285 The <B>Privoxy</B> Home page.
 286 <P>
 287 <A HREF="http://sourceforge.net/projects/ijbswa,">http://sourceforge.net/projects/ijbswa,</A>
 288 the Project Page for <B>Privoxy</B> on
 289 Sourceforge.
 290 <P>
 291 <A HREF="http://p.p/,">http://p.p/,</A> access
 292 <B>Privoxy</B> from your browser. Alternately,
 293 <A HREF="http://config.privoxy.org">http://config.privoxy.org</A>
 294 may work in some situations where the first does not.
 295 <P>
 296 <A HREF="http://p.p/">http://p.p/</A>
 297 to submit ``misses'' to the developers.
 298 <P>
 299 <A HREF="http://www.junkbusters.com/ht/en/cookies.html">http://www.junkbusters.com/ht/en/cookies.html</A>
 300 <P>
 301 <A HREF="http://www.waldherr.org/junkbuster/">http://www.waldherr.org/junkbuster/</A>
 302 <P>
 303 <A HREF="http://privacy.net/analyze/">http://privacy.net/analyze/</A>
 304 <P>
 305 <A HREF="http://www.squid-cache.org/">http://www.squid-cache.org/</A>
 306 <A NAME="lbAM">&nbsp;</A>
 307 <H2>DEVELOPMENT TEAM</H2>
 308
 309 <P>
 310 <PRE>
 311  Jon Foster
 312  Andreas Oesterhelt
 313  Stefan Waldherr
 314  Thomas Steudten
 315  Rodney Stromlund
 316  Rodrigo Barbosa (RPM specfiles)
 317  Hal Burgiss (docs)
 318  Alexander Lazic
 319  G&#225;bor Lipt&#225;k
 320  Guy
 321  Haroon Rafique
 322  David Schmidt (OS/2, Mac OSX ports)
 323  Joerg Strohmayer
 324  Sarantis Paskalis
 325 </PRE>
 326
 327 <A NAME="lbAN">&nbsp;</A>
 328 <H2>COPYRIGHT AND LICENSE</H2>
 329
 330 <P>
 331
 332 <B>Privoxy</B> is free software; you can
 333 redistribute it and/or modify it under the terms of the GNU General Public
 334 License as published by the Free Software Foundation; either version 2 of the
 335 License, or (at your option) any later version.
 336 <P>
 337
 338 This program is distributed in the hope that it will be useful, but WITHOUT
 339 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 340 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
 341 more details, which is available from the Free Software Foundation, Inc, 59
 342 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 343 <P>
 344
 345 You should have received a copy of the GNU General Public License
 346 along with this program; if not, write to the Free Software Foundation, Inc.,
 347 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA.
 348 <P>
 349
 350 <HR>
 351 <A NAME="index">&nbsp;</A><H2>Index</H2>
 352 <DL>
 353 <DT><A HREF="#lbAB">NAME</A><DD>
 354 <DT><A HREF="#lbAC">SYNOPSIS</A><DD>
 355 <DT><A HREF="#lbAD">OPTIONS</A><DD>
 356 <DT><A HREF="#lbAE">DESCRIPTION</A><DD>
 357 <DT><A HREF="#lbAF">INSTALLATION AND USAGE</A><DD>
 358 <DT><A HREF="#lbAG">CONFIGURATION</A><DD>
 359 <DT><A HREF="#lbAH">SAMPLE CONFIGURATION</A><DD>
 360 <DT><A HREF="#lbAI">FILES</A><DD>
 361 <DT><A HREF="#lbAJ">SIGNALS</A><DD>
 362 <DT><A HREF="#lbAK">NOTES</A><DD>
 363 <DT><A HREF="#lbAL">SEE ALSO</A><DD>
 364 <DT><A HREF="#lbAM">DEVELOPMENT TEAM</A><DD>
 365 <DT><A HREF="#lbAN">COPYRIGHT AND LICENSE</A><DD>
 366 </DL>
 367 <HR>
 368 This document was created by
 369 man2html,
 370 using the manual pages.<BR>
 371 Time: 05:09:36 GMT, April 24, 2002
 372 </BODY>
 373 </HTML>