Fixed BML link text
[privoxy.git] / doc / webserver / man-page / privoxy-man-page.html
index 206f654..7724748 100644 (file)
@@ -2,7 +2,7 @@
 <HTML><HEAD><TITLE>Manpage of PRIVOXY</TITLE>
 <LINK REL="STYLESHEET" TYPE="text/css" HREF="../p_doc.css"></HEAD><BODY>
 <H1>PRIVOXY</H1>
-Section:  (1)<BR>Updated: 08 April 2002<BR><A HREF="#index">Index</A>
+Section:  (1)<BR>Updated: 25 April 2002<BR><A HREF="#index">Index</A>
 <HR>
 
 <A NAME="lbAB">&nbsp;</A>
@@ -34,10 +34,10 @@ Print version info and exit.
 Don't  become  a daemon, i.e. don't fork and become process group
 leader, don't detach from controlling tty, and do all logging there.
 <DT><B>--pidfile </B><I>pidfile</I><B></B><DD>
-After (optionally) writing the PID file, assume the user  ID  of  user
-and the GID of group, or, if the optional group was not given, the
-default group  of user.  Exit if the privileges are not sufficient to
-do so.
+On startup, write the process ID to <I>pidfile</I>.
+Delete the <I>pidfile</I> on exit.
+Failiure to create or delete the <I>pidfile</I>
+is non-fatal. If no <B>--pidfile</B> option is given, no PID file will be used.
 <DT><B>--user </B><I>user[.group]</I><B></B><DD>
 After (optionally) writing the PID file, assume the user ID of
 <I>user</I> and the GID of
@@ -68,17 +68,8 @@ tastes. <B>Privoxy</B> has application for both
 stand-alone systems and multi-user networks.
 <P>
 
-<B>Privoxy</B> is based on the code of the 
-<B>Internet Junkbuster</B> (tm).
-<B>Junkbuster</B> was originally written by JunkBusters
-Corporation, and was released as free open-source software under the GNU GPL.
-Stefan Waldherr made many improvements, and started the SourceForge project
-to continue development.
-<P>
-
-<B>Privoxy</B> continues the
-<B>Junkbuster</B> tradition, but adds many 
-refinements, enhancements and new features.
+<B>Privoxy</B> is based on <B>Internet
+Junkbuster</B> (tm).
 <A NAME="lbAF">&nbsp;</A>
 <H2>INSTALLATION AND USAGE</H2>
 
@@ -110,11 +101,14 @@ For other browsers, check the documentation.
 
 <B>Privoxy</B> can be configured with the various configuration
 files. The default configuration files are: <I>config</I>,
-<I>default.action</I>, and
-<I>default.filter</I>. These are well commented.  On Unix and
-Unix-like systems, these are located in <I>/etc/privoxy/</I> by
-default. On Windows, OS/2 and AmigaOS, these files are in the same directory
-as the <B>Privoxy</B> executable.
+<I>default.filter</I>, and
+<I>default.action</I>. <I>user.action</I> should 
+be used for locally defined exceptions to the default rules of
+<I>default.action</I> These are all well commented.  On Unix
+and Unix-like systems, these are located in
+<I>/etc/privoxy/</I> by default. On Windows, OS/2 and AmigaOS,
+these files are in the same directory as the <B>Privoxy</B>
+executable.
 <P>
 
 The name and number of configuration files has changed from previous
@@ -134,100 +128,88 @@ This is an internal page.
 
 <P>
 
-A brief example of what a <I>default.action</I> configuration
-might look like:
+A brief example of what a simple <I>default.action</I>
+configuration might look like:
 <P>
 <PRE>
-
  # Define a few useful custom aliases for later use
  {{alias}}
 
- # Don't accept cookies
- +no-cookies = +no-cookies-set +no-cookies-read
-
- # Do accept cookies
- -no-cookies = -no-cookies-set -no-cookies-read
-
- # Treat these blocked URLs as images.
- +imageblock = +block +image
+ # Useful aliases
+ +prevent-cookies = +prevent-setting-cookies +prevent-reading-cookies
+ -prevent-cookies = -prevent-setting-cookies -prevent-reading-cookies
+ +imageblock      = +block +handle-as-image
 
- # Define page filters we want to use.
myfilters = +filter{html-annoyances} +filter{js-annoyances}\
-             +filter{no-popups} +filter{webbugs}
+ # Fragile sites should have the minimum changes
fragile     = -block -deanimate-gifs -fast-redirects -filter \
+               -hide-referer -prevent-cookies -kill-popups
 
- ## Default Policies (actions) ############################
+ ## Turn some actions on ################################
  { \
-  -block \
-  -downgrade \
-  +fast-redirects \
-  myfilters \
-  +no-compression \
-  +hide-forwarded \
-  +hide-from{block} \
-  +hide-referer{forge} \
-  -hide-user-agent \
-  -image \
-  +image-blocker{blank} \
-  +no-cookies-keep \
-  -no-cookies-read \
-  -no-cookies-set \
-  +no-popups \
-  -vanilla-wafer \
-  -wafer \
+ -add-header \
+ -block \
+ +deanimate-gifs{last} \
+ -downgrade-http-version \
+ -fast-redirects \
+ +filter{html-annoyances} \
+ +filter{js-annoyances} \
+ +filter{content-cookies} \
+ +filter{webbugs} \
+ +filter{banners-by-size} \
+ +hide-forwarded-for-headers \
+ +hide-from-header{block} \
+ +hide-referrer{forge} \
+ -hide-user-agent \
+ -handle-as-image \
+ +set-image-blocker{pattern} \
+ -limit-connect \
+ +prevent-compression \
+ +session-cookies-only \
+ +prevent-reading-cookies \
+ +prevent-setting-cookies \
+ -kill-popups \
  }
- /
+ /   # Match all URLs
+ # Block, and treat these URL patterns as if they were 'images'.
+ {+imageblock}
+  .ad.doubleclick.net
+  .a[0-9].yimg.com/(?:(?!/i/).)*$
+  ad.*.doubleclick.net
+
+ # Block any URLs that match these patterns
+ {+block}
+  ad*.
+  .*ads.
+  banner?.
+  /.*count(er)?\.(pl|cgi|exe|dll|asp|php[34]?)
+  /(?:.*/)?(publicite|werbung|rekla(ma|me|am)|maino(kset|nta|s)?)/
+  .hitbox.com 
+
+ # Make exceptions for these harmless ones that would be 
+ # caught by +block above.
+ {-block}
+  adsl.
+  advice.
+  .*downloads.
+</PRE>
 
- # Now set exceptions to the above defined policies #######
+<P>
+
+Then for a <I>user.action</I>, we would put local,
+narrowly defined exceptions:
+<P>
+<PRE>
+ # Set personal exceptions to the policies in default.action #######
 
  # Sites where we want persistant cookies
- {-no-cookies -no-cookies-keep}
+ {-prevent-reading-cookies -prevent-setting-cookies -session-cookies-only}
   .redhat.com
   .sun.com
-  .yahoo.com
   .msdn.microsoft.com
-
- # This site requires cookies AND 'fast-redirects' on
- {-no-cookies -no-cookies-keep -fast-redirects}
-  .nytimes.com
-
- # Add custom headers, and turn off filtering of page source
- {+add-header{X-Privacy: Yes please} #-add-header{*} \
-  +add-header{X-User-Tracking: No thanks!} -filter}
-  privacy.net
-
- # Block, and treat these URLs as 'images'.
- {+imageblock}
-  .adforce.imgis.com
-  .ad.preferences.com/image.*
-  .ads.web.aol.com
-  .ad-adex3.flycast.com
-  .ad.doubleclick.net
-  .ln.doubleclick.net
-  .ad.de.doubleclick.net
-  /.*/count\.cgi\?.*df=
-  194.221.183.22[1-7]
-  a196.g.akamai.net/7/196/2670/000[12]/images.gmx.net/i4/images/.*/
-
- # Block any URLs that match these patterns
- {+block}
-  /.*/(.*[-_.])?ads?[0-9]?(/|[-_.].*|\.(gif|jpe?g))
-  /.*/(plain|live|rotate)[-_.]?ads?/
-  /.*/(sponsor)s?[0-9]?/
-  /.*/ad(server|stream|juggler)\.(cgi|pl|dll|exe)
-  /.*/adbanners/
-  /.*/adv((er)?ts?|ertis(ing|ements?))?/
-  /.*/banners?/
-  /.*/popupads/
-  /.*/advert[0-9]+\.jpg
-  /ad_images/
-  /.*/ads/
-  /images/.*/.*_anim\.gif
-  /rotations/ 
-  /.*(ms)?backoff(ice)?.*\.(gif|jpe?g)
-  195.63.104.*/(inbox|log|meld|folderlu|folderru|log(in|out)[lmr]u|)
-  .images.nytimes.com
-  .images.yahoo.com/adv/
-  /.*cnnstore\.gif
+ {-block -fast-redirects}
+  .forbes.com
 </PRE>
 
 <P>
@@ -245,9 +227,8 @@ configuration options.
  <I>/usr/sbin/privoxy</I>
  <I>/etc/privoxy/config</I>
  <I>/etc/privoxy/default.action</I>
- <I>/etc/privoxy/advanced.action</I>
- <I>/etc/privoxy/basic.action</I>
- <I>/etc/privoxy/intermediate.action</I>
+ <I>/etc/privoxy/standard.action</I>
+ <I>/etc/privoxy/user.action</I>
  <I>/etc/privoxy/default.filter</I>
  <I>/etc/privoxy/trust</I>
  <I>/etc/privoxy/templates/*</I>
@@ -304,6 +285,9 @@ Sourceforge.
 <A HREF="http://config.privoxy.org">http://config.privoxy.org</A>
 may work in some situations where the first does not.
 <P>
+<A HREF="http://p.p/">http://p.p/</A>  
+to submit ``misses'' to the developers. 
+<P>
 <A HREF="http://www.junkbusters.com/ht/en/cookies.html">http://www.junkbusters.com/ht/en/cookies.html</A>
 <P>
 <A HREF="http://www.waldherr.org/junkbuster/">http://www.waldherr.org/junkbuster/</A>
@@ -316,23 +300,20 @@ may work in some situations where the first does not.
 
 <P>
 <PRE>
- Stefan Waldherr
- Andreas Oesterhelt
  Jon Foster
- Markus Breitenbach
+ Andreas Oesterhelt
+ Stefan Waldherr
  Thomas Steudten
- David Schmidt (OS/2, Mac OSX ports)
- Gabriel L. Somlo
+ Rodney Stromlund
+ Rodrigo Barbosa (RPM specfiles)
  Hal Burgiss (docs)
+ Alexander Lazic
+ G&#225;bor Lipt&#225;k
+ Guy
  Haroon Rafique
- John Venvertloh
+ David Schmidt (OS/2, Mac OSX ports)
  Joerg Strohmayer
- Rodney Stromlund
- Rodrigo Barbosa (RPM specfiles)
  Sarantis Paskalis
- Shamim Mohamed
- G&#225;bor Lipt&#225;k
- Alexander Lazic
 </PRE>
 
 <A NAME="lbAN">&nbsp;</A>
@@ -379,6 +360,6 @@ along with this program; if not, write to the Free Software Foundation, Inc.,
 This document was created by
 man2html,
 using the manual pages.<BR>
-Time: 15:13:15 GMT, April 08, 2002
+Time: 14:43:58 GMT, April 25, 2002
 </BODY>
 </HTML>