Move all doc build stuff to doc/source/GNUmakefile, leaving a 'make dok'
[privoxy.git] / privoxy.1
index 1eb38b2..19cc5e2 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>.
-.TH "PRIVOXY" "1" "18 April 2002" "Privoxy 2.9.14 beta" ""
+.TH "PRIVOXY" "1" "14 May 2002" "Privoxy 2.9.15 beta" ""
 .SH NAME
 privoxy \- Privacy Enhancing Proxy
 .SH SYNOPSIS
@@ -82,119 +82,114 @@ For other browsers, check the documentation.
 .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
 configuration itself is changed  and  much more sophisticated. See the
 user-manual for a
-brief explanation of all configuration options. 
+complete explanation of all configuration options and general usage.
 .PP
 The actions list (ad blocks, etc) can also be configured with your
-web browser at http://ijbswa.sourceforge.net/config.
+web browser at http://config.privoxy.org/.
 \fBPrivoxy's\fR configuration parameters  can also  be viewed at
 the same page. In addition, \fBPrivoxy\fR can be toggled on/off.
 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
-
  # 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
+ # Useful aliases
+ +crunch-cookies = +crunch-incoming-cookies +crunch-outgoing-cookies
+ -crunch-cookies = -crunch-incoming-cookies -crunch-outgoing-cookies
+ +imageblock      = +block +handle-as-image
 
- # Treat these blocked URLs as images.
- +imageblock = +block +image
+ # Fragile sites should have the minimum changes
+ fragile     = -block -deanimate-gifs -fast-redirects -filter \\
+               -hide-referer -prevent-cookies -kill-popups
 
- # Define page filters we want to use.
- myfilters = +filter{html-annoyances} +filter{js-annoyances}\\
-             +filter{no-popups} +filter{webbugs}
-
- ## 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 \\
+ -crunch-cookies \\
+ -kill-popups \\
  }
- /
-
- # Now set exceptions to the above defined policies #######
-
- # Sites where we want persistant cookies
- {-no-cookies -no-cookies-keep}
-  .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'.
+ /   # '/' Matches *all* URL patterns
+ # Block, and treat these URL patterns as if they were 'images'.
+ # We would expect these to be ads.
  {+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/.*/
+  .a[0-9].yimg.com/(?:(?!/i/).)*$
+  ad.*.doubleclick.net
 
  # 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
+  ad*.
+  .*ads.
+  banner?.
+  /.*count(er)?\\.(pl|cgi|exe|dll|asp|php[34]?)
+  .hitbox.com 
+
+ # Make exceptions for these harmless ones that would be 
+ # caught by our +block patterns just above.
+ {-block}
+  adsl.
+  advice.
+  .*downloads.
+.fi
+.PP
+Then for a \fIuser.action\fR, we would put local,
+narrowly defined exceptions:
+
+.nf
+ # Re-define aliases as needed here
+ {{alias}}
+
+ # Useful aliases
+ -crunch-cookies = -crunch-incoming-cookies -crunch-outgoing-cookies
+ # Set personal exceptions to the policies in default.action #######
+
+ # Sites where we want persistant cookies, so allow *all* cookies
+ {-crunch-cookies -session-cookies-only}
+  .redhat.com
+  .sun.com
+  .msdn.microsoft.com
+ # This site breaks easily.
+ {-block -fast-redirects}
+  .forbes.com
 .fi
 .PP
 See the comments in the configuration files themselves, or the 
@@ -208,9 +203,8 @@ configuration options.
  \fI/usr/sbin/privoxy\fR
  \fI/etc/privoxy/config\fR
  \fI/etc/privoxy/default.action\fR
- \fI/etc/privoxy/advanced.action\fR
- \fI/etc/privoxy/basic.action\fR
- \fI/etc/privoxy/intermediate.action\fR
+ \fI/etc/privoxy/standard.action\fR
+ \fI/etc/privoxy/user.action\fR
  \fI/etc/privoxy/default.filter\fR
  \fI/etc/privoxy/trust\fR
  \fI/etc/privoxy/templates/*\fR
@@ -219,7 +213,7 @@ configuration options.
 .PP
 Various other files should be included, but may vary depending on platform
 and build configuration. More documentation should be included in the local
-documentation directory, though is not complete at this time.
+documentation directory.
 .SH "SIGNALS"
 .PP
 \fBPrivoxy\fR terminates on the \fBSIGINT\fR,
@@ -254,8 +248,7 @@ http://p.p/, access
 http://config.privoxy.org
 may work in some situations where the first does not.
 
-http://p.p/  
-to submit ``misses'' to the developers. 
+http://p.p/ to submit ``misses'' to the developers. 
 
 http://www.junkbusters.com/ht/en/cookies.html
 
@@ -283,18 +276,29 @@ http://www.squid-cache.org/
  Sarantis Paskalis
 .fi
 .SH "COPYRIGHT AND LICENSE"
+.SS "COPYRIGHT"
+.PP
+Copyright (C) 2001, 2002 by Privoxy Developers <developers@privoxy.org>
+.PP
+Some source code is based on code Copyright (C) 1997 by Anonymous Coders
+and Junkbusters, Inc. and licensed under the \fIGNU General Public
+License\fR.
+.SS "LICENSE"
 .PP
 \fBPrivoxy\fR is free software; you can
-redistribute it and/or modify it under the terms of the GNU General Public
-License as published by the Free Software Foundation; either version 2 of the
-License, or (at your option) any later version.
+redistribute it and/or modify it under the terms of the 
+\fIGNU General Public
+License\fR, version 2, as published by the Free Software Foundation.
 .PP
 This program is distributed in the hope that it will be useful, but WITHOUT
 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
-FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
+FITNESS FOR A PARTICULAR PURPOSE.  See the 
+\fIGNU General Public License\fR for
 more details, which is available from the Free Software Foundation, Inc, 59
 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 .PP
-You should have received a copy of the GNU General Public License
-along with this program; if not, write to the Free Software Foundation, Inc.,
-59 Temple Place, Suite 330, Boston, MA  02111-1307  USA.
+You should have received a copy of the  \fIGNU General Public License\fR
+along with this program; if not, write to the  Free Software
+Foundation, Inc. 59 Temple Place - Suite 330
+Boston, MA 02111-1307
+USA