projects / privoxy.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
- New option "user-manual", defaults to our site
[privoxy.git] / privoxy.1
diff --git a/privoxy.1 b/privoxy.1
index 354b2c1..4384046 100644 (file)
--- a/privoxy.1
+++ b/privoxy.1
@@ -3,16 +3,15 @@
 .\" <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>.
-.\" Modified for privoxy-developers, 04/08/02.
-.TH "PRIVOXY" "1" "08 April 2002" "Privoxy 2.9.13 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
 
-\fBprivoxy\fR [\fB--help\fR]  [\fB--version\fR]  [\fB--no-daemon\fR]  [\fB--pidfile \fIpidfile\fB\fR]  [\fB--user \fIuser[.group]\fB\fR]  [\fB\fIconfigfile\fB\fR] (UNIX)
+\fBprivoxy\fR [\fB--help\fR]  [\fB--version\fR]  [\fB--no-daemon\fR]  [\fB--pidfile \fIpidfile\fB\fR]  [\fB--user \fIuser[.group]\fB\fR]  [\fB\fIconfigfile\fB\fR] \fB(UNIX)\fR
 
 
 
 
-\fBprivoxy.exe\fR [\fB\fIconfigfile\fB\fR] (Windows)
+\fBprivoxy.exe\fR [\fB\fIconfigfile\fB\fR] \fB(Windows)\fR
 
 .SH "OPTIONS"
 .PP
 
 .SH "OPTIONS"
 .PP
@@ -30,10 +29,10 @@ 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.
 .TP
 \fB--pidfile \fIpidfile\fB\fR
 leader, don't detach from controlling tty, and do all logging there.
 .TP
 \fB--pidfile \fIpidfile\fB\fR
-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 \fIpidfile\fR.
+Delete the \fIpidfile\fR on exit.
+Failiure to create or delete the \fIpidfile\fR
+is non-fatal. If no \fB--pidfile\fR option is given, no PID file will be used.
 .TP
 \fB--user \fIuser[.group]\fB\fR
 After (optionally) writing the PID file, assume the user ID of
 .TP
 \fB--user \fIuser[.group]\fB\fR
 After (optionally) writing the PID file, assume the user ID of
@@ -59,16 +58,8 @@ flexible configuration and can be customized to suit individual needs and
 tastes. \fBPrivoxy\fR has application for both
 stand-alone systems and multi-user networks.
 .PP
 tastes. \fBPrivoxy\fR has application for both
 stand-alone systems and multi-user networks.
 .PP
-\fBPrivoxy\fR is based on the code of the 
-\fBInternet Junkbuster\fR (tm).
-\fBJunkbuster\fR 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.
-.PP
-\fBPrivoxy\fR continues the
-\fBJunkbuster\fR tradition, but adds many 
-refinements, enhancements and new features.
+\fBPrivoxy\fR is based on \fBInternet
+Junkbuster\fR (tm).
 .SH "INSTALLATION AND USAGE"
 .PP
 Browsers must be individually configured to use \fBPrivoxy\fR as
 .SH "INSTALLATION AND USAGE"
 .PP
 Browsers must be individually configured to use \fBPrivoxy\fR as
@@ -91,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
@@ -110,100 +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
+ # Useful aliases
+ +prevent-cookies = +prevent-setting-cookies +prevent-reading-cookies
+ -prevent-cookies = -prevent-setting-cookies -prevent-reading-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 \\
+ +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
 
 
- # Now set exceptions to the above defined policies #######
+ # 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:
+
+.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}
-  .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
 .fi
 .PP
 See the comments in the configuration files themselves, or the 
 .fi
 .PP
 See the comments in the configuration files themselves, or the 
@@ -217,9 +197,8 @@ configuration options.
  \fI/usr/sbin/privoxy\fR
  \fI/etc/privoxy/config\fR
  \fI/etc/privoxy/default.action\fR
  \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
  \fI/etc/privoxy/default.filter\fR
  \fI/etc/privoxy/trust\fR
  \fI/etc/privoxy/templates/*\fR
@@ -263,6 +242,9 @@ http://p.p/, access
 http://config.privoxy.org
 may work in some situations where the first does not.
 
 http://config.privoxy.org
 may work in some situations where the first does not.
 
+http://p.p/  
+to submit ``misses'' to the developers. 
+
 http://www.junkbusters.com/ht/en/cookies.html
 
 http://www.waldherr.org/junkbuster/
 http://www.junkbusters.com/ht/en/cookies.html
 
 http://www.waldherr.org/junkbuster/
@@ -273,23 +255,20 @@ http://www.squid-cache.org/
 .SH "DEVELOPMENT TEAM"
 
 .nf
 .SH "DEVELOPMENT TEAM"
 
 .nf
- Stefan Waldherr
- Andreas Oesterhelt
  Jon Foster
  Jon Foster
- Markus Breitenbach
+ Andreas Oesterhelt
+ Stefan Waldherr
  Thomas Steudten
  Thomas Steudten
- David Schmidt (OS/2, Mac OSX ports)
- Gabriel L. Somlo
+ Rodney Stromlund
+ Rodrigo Barbosa (RPM specfiles)
  Hal Burgiss (docs)
  Hal Burgiss (docs)
+ Alexander Lazic
+ Gábor Lipták
+ Guy
  Haroon Rafique
  Haroon Rafique
- John Venvertloh
+ David Schmidt (OS/2, Mac OSX ports)
  Joerg Strohmayer
  Joerg Strohmayer
- Rodney Stromlund
- Rodrigo Barbosa (RPM specfiles)
  Sarantis Paskalis
  Sarantis Paskalis
- Shamim Mohamed
- Gábor Lipták
- Alexander Lazic
 .fi
 .SH "COPYRIGHT AND LICENSE"
 .PP
 .fi
 .SH "COPYRIGHT AND LICENSE"
 .PP
The official Privoxy git repository