Adaptions to changes in actions.c
[privoxy.git] / privoxy.1
index d92ff11..4384046 100644 (file)
--- a/privoxy.1
+++ b/privoxy.1
@@ -3,7 +3,7 @@
 .\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> 
 .\" Please send any bug reports, improvements, comments, patches, 
 .\" etc. to Steve Cheng <steve@ggi-project.org>.
 .\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> 
 .\" Please send any bug reports, improvements, comments, patches, 
 .\" etc. to Steve Cheng <steve@ggi-project.org>.
-.TH "PRIVOXY" "1" "24 April 2002" "Privoxy 2.9.14 beta" ""
+.TH "PRIVOXY" "1" "25 April 2002" "Privoxy 2.9.14 beta" ""
 .SH NAME
 privoxy \- Privacy Enhancing Proxy
 .SH SYNOPSIS
 .SH NAME
 privoxy \- Privacy Enhancing Proxy
 .SH SYNOPSIS
@@ -82,11 +82,14 @@ For other browsers, check the documentation.
 .PP
 \fBPrivoxy\fR can be configured with the various configuration
 files. The default configuration files are: \fIconfig\fR,
 .PP
 \fBPrivoxy\fR can be configured with the various configuration
 files. The default configuration files are: \fIconfig\fR,
-\fIdefault.action\fR, and
-\fIdefault.filter\fR. These are well commented.  On Unix and
-Unix-like systems, these are located in \fI/etc/privoxy/\fR by
-default. On Windows, OS/2 and AmigaOS, these files are in the same directory
-as the \fBPrivoxy\fR executable.
+\fIdefault.filter\fR, and
+\fIdefault.action\fR. \fIuser.action\fR should 
+be used for locally defined exceptions to the default rules of
+\fIdefault.action\fR These are all well commented.  On Unix
+and Unix-like systems, these are located in
+\fI/etc/privoxy/\fR by default. On Windows, OS/2 and AmigaOS,
+these files are in the same directory as the \fBPrivoxy\fR
+executable.
 .PP
 The name and number of configuration files has changed from previous
 versions, and is subject to change as development progresses. In fact, the
 .PP
 The name and number of configuration files has changed from previous
 versions, and is subject to change as development progresses. In fact, the
@@ -101,99 +104,86 @@ the same page. In addition, \fBPrivoxy\fR can be toggled on/off.
 This is an internal page.
 .SH "SAMPLE CONFIGURATION"
 .PP
 This is an internal page.
 .SH "SAMPLE CONFIGURATION"
 .PP
-A brief example of what a \fIdefault.action\fR configuration
-might look like:
+A brief example of what a simple \fIdefault.action\fR
+configuration might look like:
 
 .nf
 
 .nf
-
  # Define a few useful custom aliases for later use
  {{alias}}
 
  # 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.
+.fi
+.PP
+Then for a \fIuser.action\fR, we would put local,
+narrowly defined exceptions:
 
 
- # Now set exceptions to the above defined policies #######
+.nf
+ # Set personal exceptions to the policies in default.action #######
 
  # Sites where we want persistant cookies
 
  # Sites where we want persistant cookies
- {-no-cookies -no-cookies-keep}
+ {-prevent-reading-cookies -prevent-setting-cookies -session-cookies-only}
   .redhat.com
   .sun.com
   .redhat.com
   .sun.com
-  .yahoo.com
   .msdn.microsoft.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}
-  .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
 .fi
 .PP
 See the comments in the configuration files themselves, or the 
 .fi
 .PP
 See the comments in the configuration files themselves, or the