doc/webserver/man-page/privoxy-man-page.html

   1 <html><head><title>Privoxy Man page</title><link rel="stylesheet" type="text/css" href="../p_web.css"></head><body><H2>NAME</H2>
   2 <PRE>
   3 <!-- Manpage converted by man2html 3.0.1 -->
   4        <B>privoxy</B> - Privacy enhancing Proxy
   5
   6
   7 </PRE>
   8 <H2>SYNOPSIS</H2><PRE>
   9        <B>privoxy</B> [--help] [--version] [--no-daemon] [--pidfile <I>pid</I>
  10        <I>file</I>] [--user <I>user</I>[.<I>group</I>]] <I>[configfile]</I> (Unix)
  11
  12        <B>privoxy.exe</B> <I>[configfile]</I> (Windows)
  13
  14
  15
  16 </PRE>
  17 <H2>OPTIONS</H2><PRE>
  18        <B>Privoxy</B> may be invoked  with  the  following  command-line
  19        options:
  20
  21        <B>--version</B> (unix only)
  22               Print version info and exit.
  23
  24        <B>--help</B> (unix only)
  25               Print a short usage info and exit.
  26
  27        <B>--no-daemon</B> (unix only)
  28               Don't  become  a daemon, i.e. don't fork and become
  29               process group leader, don't detach from controlling
  30               tty, and do all logging there.
  31
  32         <B>--pidfile</B> <I>pidfile</I> (unix only)
  33               On startup, write the process ID to <I>pidfile</I>. Delete
  34               the <I>pidfile</I> on exit. Failiure to create  or  delete
  35               the <I>pidfile</I> is non-fatal. If no <B>--pidfile</B> option is
  36               given, no PID file will be used.
  37
  38         <B>--user</B> <I>user</I>[.<I>group</I>] (unix only)
  39               After (optionally) writing the PID file, assume the
  40               user  ID  of  <I>user</I> and the GID of <I>group</I>, or, if the
  41               optional <I>group</I> was not given, the default group  of
  42               <I>user</I>.  Exit if the privileges are not sufficient to
  43               do so.
  44
  45
  46        If the <I>configfile</I> is not specified on  the  command  line,
  47        <B>Privoxy</B>  will  look for a file named <B>config</B> in the current
  48        directory (except on Win32 where it will try  <B>config.txt</B>).
  49
  50
  51
  52
  53 </PRE>
  54 <H2>DESCRIPTION</H2><PRE>
  55        <B>Privoxy</B>  is  a web proxy with advanced filtering capabili
  56        ties for protecting privacy, filtering web  page  content,
  57        managing  cookies,  controlling  access, and removing ads,
  58        banners,  pop-ups  and  other  obnoxious  Internet   junk.
  59        <B>Privoxy</B>  has a very flexible configuration and can be cus
  60        tomized to suit individual needs and tastes.  <B>Privoxy</B>  has
  61        application  for  both  stand-alone systems and multi-user
  62        <B>Junkbuster</B>  was originally written by JunkBusters Corpora
  63        tion, and was released as free open-source software  under
  64        the  GNU  GPL. Stefan Waldherr made many improvements, and
  65        started the SourceForge project to continue development.
  66
  67
  68
  69 </PRE>
  70 <H2>INSTALLATION AND USE</H2><PRE>
  71        Browsers must be individually configured to use <B>Privoxy</B> as
  72        a  HTTP  proxy.   The default setting is for localhost, on
  73        port 8118 (configurable in the main config file).  To  set
  74        the  HTTP proxy in Netscape and Mozilla, go through: <B>Edit</B>;
  75        <B>Preferences</B>; <B>Advanced</B>; <B>Proxies</B>;  <B>Manual</B>  <B>Proxy</B>  <B>Configura</B>
  76        <B>tion</B>; <B>View</B>.
  77
  78        For Internet Explorer, go through: <B>Tools</B>; <B>Internet</B> <B>Proper</B>
  79        <B>ties</B>; <B>Connections</B>; <B>LAN</B> <B>Settings</B>.
  80
  81        The Secure (SSL) Proxy should also be set to the same val
  82        ues, otherwise <B>https:</B> URLs will not be proxied.
  83
  84        For other browsers, check the documentation.
  85
  86
  87
  88 </PRE>
  89 <H2>CONFIGURATION</H2><PRE>
  90        <B>Privoxy</B>  can  be configured with the various configuration
  91        files.  The  default  configuration  files  are:   <I>config</I>,
  92        <I>default.action</I>,  and  <I>default.filter</I>.  These are well com
  93        mented.  On Unix and Unix-like systems, these are  located
  94        in <I>/etc/privoxy/</I> by default. On Windows, OS/2 and AmigaOS,
  95        these files are in the same directory as the <B>Privoxy</B>  exe
  96        cutable.
  97
  98        The  name  and  number  of configuration files has changed
  99        from previous versions, and is subject to change as devel
 100        opment  progresses.  In  fact, the configuration itself is
 101        changed and much more sophisticated. See  the  user-manual
 102        for a brief explanation of all configuration options.
 103
 104        The  actions  list (ad blocks, etc) can also be configured
 105        with your web  browser  at  <I>http://www.privoxy.org/config</I>.
 106        <B>Privoxy's</B>  configuration  parameters can also be viewed at
 107        the same page. In addition, <B>Privoxy</B> can be toggled on/off.
 108        This is an internal page.
 109
 110
 111
 112 </PRE>
 113 <H2>SAMPLE CONFIGURATION</H2><PRE>
 114        A  brief  example  of  what a <I>default.action</I> configuration
 115        might look like:
 116
 117
 118        # Define a few useful custom aliases for later use
 119        {{alias}}
 120        +no-cookies = +no-cookies-set +no-cookies-read
 121
 122        # Do accept cookies
 123        -no-cookies = -no-cookies-set -no-cookies-read
 124
 125        # Treat these blocked URLs as images.
 126        +imageblock = +block +image
 127
 128        # Define page filters we want to use.
 129        myfilters = +filter{html-annoyances} +filter{js-annoyances}\
 130                    +filter{no-popups} +filter{webbugs}
 131
 132        ## Default Policies (actions) ############################
 133        { \
 134         -block \
 135         -downgrade \
 136         +fast-redirects \
 137         myfilters \
 138         +no-compression \
 139         +hide-forwarded \
 140         +hide-from{block} \
 141         +hide-referer{forge} \
 142         -hide-user-agent \
 143         -image \
 144         +image-blocker{blank} \
 145         +no-cookies-keep \
 146         -no-cookies-read \
 147         -no-cookies-set \
 148         +no-popups \
 149         -vanilla-wafer \
 150         -wafer \
 151        }
 152        /
 153
 154        # Now set exceptions to the above defined policies #######
 155
 156        # Sites where we want persistant cookies
 157        {-no-cookies -no-cookies-keep}
 158         .redhat.com
 159         .sun.com
 160         .yahoo.com
 161         .msdn.microsoft.com
 162
 163        # This site requires cookies AND 'fast-redirects' on
 164        {-no-cookies -no-cookies-keep -fast-redirects}
 165         .nytimes.com
 166
 167        # Add custom headers, and turn off filtering of page source
 168        {+add-header{X-Privacy: Yes please} #-add-header{*} \
 169         +add-header{X-User-Tracking: No thanks!} -filter}
 170         privacy.net
 171
 172         .adforce.imgis.com
 173         .ad.preferences.com/image.*
 174         .ads.web.aol.com
 175         .ad-adex3.flycast.com
 176         .ad.doubleclick.net
 177         .ln.doubleclick.net
 178         .ad.de.doubleclick.net
 179         /.*/count\.cgi\?.*df=
 180         194.221.183.22[1-7]
 181         a196.g.akamai.net/7/196/2670/000[12]/images.gmx.net/i4/images/.*/
 182
 183        # Block any URLs that match these patterns
 184        {+block}
 185         /.*/(.*[-_.])?ads?[0-9]?(/|[-_.].*|\.(gif|jpe?g))
 186         /.*/(plain|live|rotate)[-_.]?ads?/
 187         /.*/(sponsor)s?[0-9]?/
 188         /.*/ad(server|stream|juggler)\.(cgi|pl|dll|exe)
 189         /.*/adbanners/
 190         /.*/adv((er)?ts?|ertis(ing|ements?))?/
 191         /.*/banners?/
 192         /.*/popupads/
 193         /.*/advert[0-9]+\.jpg
 194         /ad_images/
 195         /.*/ads/
 196         /images/.*/.*_anim\.gif
 197         /rotations/
 198         /.*(ms)?backoff(ice)?.*\.(gif|jpe?g)
 199         195.63.104.*/(inbox|log|meld|folderlu|folderru|log(in|out)[lmr]u|)
 200         .images.nytimes.com
 201         .images.yahoo.com/adv/
 202         /.*cnnstore\.gif
 203
 204
 205
 206        See the comments in the configuration files themselves, or
 207        the  user-manual for explanations of the above syntax, and
 208        other <B>Privoxy</B> configuration options.
 209
 210
 211
 212 </PRE>
 213 <H2>FILES</H2><PRE>
 214        <I>/usr/sbin/privoxy</I>
 215        <I>/etc/privoxy/config</I>
 216        <I>/etc/privoxy/default.action</I>
 217        <I>/etc/privoxy/advanced.action</I>
 218        <I>/etc/privoxy/basic.action</I>
 219        <I>/etc/privoxy/intermediate.action</I>
 220        <I>/etc/privoxy/default.filter</I>
 221        <I>/etc/privoxy/trust</I>
 222        <I>/etc/privoxy/templates/*</I>
 223        <I>/var/log/privoxy/logfile</I>
 224
 225
 226        mentation should be included in  the  local  documentation
 227        directory, though is not complete at this time.
 228
 229
 230
 231 </PRE>
 232 <H2>SIGNALS</H2><PRE>
 233        <B>Privoxy</B> terminates on the <B>SIGINT</B>, <B>SIGTERM</B> and <B>SIGABRT</B> sig
 234        nals. Log rotation scripts may cause a re-opening  of  the
 235        logfile  by  sending a <B>SIGHUP</B> to <B>Privoxy</B>. Note that unlike
 236        other daemons, <B>Privoxy</B> does not need to be made  aware  of
 237        config file changes by <B>SIGHUP</B> -- it will detect them auto
 238        matically.
 239
 240
 241
 242 </PRE>
 243 <H2>NOTES</H2><PRE>
 244        This is a <B>BETA</B> version of <B>Privoxy</B>. Not  all  features  are
 245        well tested.
 246
 247        Please see the user-maual on how to contact the developers
 248        for feature requests, reporting problems, and other  ques
 249        tions.
 250
 251
 252
 253 </PRE>
 254 <H2>BUGS</H2><PRE>
 255        Probably.  Please see the user-manual for how and where to
 256        report bugs.
 257
 258
 259
 260 </PRE>
 261 <H2>SEE ALSO</H2><PRE>
 262        http://www.privoxy.org/
 263        http://config.privoxy.org/
 264        http://www.privoxy.org/faq/
 265        http://www.privoxy.org/user-manual/
 266        http://www.privoxy.org/developer-manual/
 267        http://sourceforge.net/projects/ijbswa  (Privoxy   Project
 268        Page)
 269        http://www.waldherr.org/junkbuster/
 270        http://www.junkbusters.com/ht/en/cookies.html
 271        http://privacy.net/analyze/
 272        http://www.squid-cache.org/
 273        http://linuxalpha.ch/steudten/software/
 274
 275
 276
 277 </PRE>
 278 <H2>DEVELOPMENT TEAM</H2><PRE>
 279         Stefan Waldherr
 280         Andreas Oesterhelt
 281         Jon Foster
 282         Markus Breitenbach
 283         Thomas Steudten
 284         David Schmidt
 285         Haroon Rafique
 286         Joerg Strohmayer
 287         Shamim Mohamed
 288         John Venvertloh
 289         Hal Burgiss
 290         Rodrigo Barbosa
 291         Gábor Lipták
 292
 293
 294
 295 </PRE>
 296 <H2>COPYRIGHT AND LICENSE</H2><PRE>
 297        This  program  is  free  software; you can redistribute it
 298        and/or modify it under the terms of the GNU General Public
 299        License  as  published  by  the  Free Software Foundation;
 300        either version 2 of the License, or (at your  option)  any
 301        later version.
 302
 303        This  program  is  distributed in the hope that it will be
 304        useful, but WITHOUT ANY WARRANTY; without even the implied
 305        warranty  of  MERCHANTABILITY  or FITNESS FOR A PARTICULAR
 306        PURPOSE.  See the GNU  General  Public  License  for  more
 307        details.
 308
 309        You  should have received a copy of the GNU General Public
 310        License along with this program; if not, write to the Free
 311        Software  Foundation,  Inc.,  59  Temple Place, Suite 330,
 312        Boston, MA  02111-1307  USA
 313
 314        Internet Junkbuster Proxy is a  trademark  of  Junkbusters
 315        Corporation.
 316
 317
 318
 319
 320
 321
 322
 323
 324
 325
 326
 327
 328
 329
 330
 331
 332
 333
 334
 335
 336
 337
 338
 339
 340
 341
 342 </PRE>
 343 </body></html>