Updated trustfile comments to match U-M.
[privoxy.git] / privoxy.1
index 4384046..5690eee 100644 (file)
--- a/privoxy.1
+++ b/privoxy.1
@@ -3,15 +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>.
-.TH "PRIVOXY" "1" "25 April 2002" "Privoxy 2.9.14 beta" ""
+.TH "PRIVOXY" "1" "05 September 2002" "Privoxy 3.1.1 alpha" ""
 .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] \fB(UNIX)\fR
+\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] \fB(Windows)\fR
+\fBprivoxy.exe\fR [\fB\fIconfigfile\fB\fR ]\fB (Windows)\fR
 
 .SH "OPTIONS"
 .PP
 
 .SH "OPTIONS"
 .PP
@@ -31,7 +31,7 @@ leader, don't detach from controlling tty, and do all logging there.
 \fB--pidfile \fIpidfile\fB\fR
 On startup, write the process ID to \fIpidfile\fR.
 Delete the \fIpidfile\fR on exit.
 \fB--pidfile \fIpidfile\fB\fR
 On startup, write the process ID to \fIpidfile\fR.
 Delete the \fIpidfile\fR on exit.
-Failiure to create or delete the \fIpidfile\fR
+Failure 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
 is non-fatal. If no \fB--pidfile\fR option is given, no PID file will be used.
 .TP
 \fB--user \fIuser[.group]\fB\fR
@@ -75,7 +75,8 @@ For Internet Explorer, go through: \fBTools\fR;
 \fBLAN Settings\fR. 
 .PP
 The Secure (SSL) Proxy should also be set to the same values, otherwise
 \fBLAN Settings\fR. 
 .PP
 The Secure (SSL) Proxy should also be set to the same values, otherwise
-https: URLs will not be proxied. 
+https: URLs will not be proxied. Note: \fBPrivoxy\fR can only
+proxy HTTP and HTTPS traffic. Do not try it with FTP or other protocols.
 .PP
 For other browsers, check the documentation.
 .SH "CONFIGURATION"
 .PP
 For other browsers, check the documentation.
 .SH "CONFIGURATION"
@@ -92,16 +93,18 @@ these files are in the same directory as the \fBPrivoxy\fR
 executable.
 .PP
 The name and number of configuration files has changed from previous
 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. 
+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 complete
+explanation of all configuration options and general usage, and notes for 
+upgrading from \fBJunkbuster\fR and earlier \fBPrivoxy\fR
+versions.
 .PP
 The actions list (ad blocks, etc) can also be configured with your
 .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.
 \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.
+This is an internal page, and does not require Internet access.
 .SH "SAMPLE CONFIGURATION"
 .PP
 A brief example of what a simple \fIdefault.action\fR
 .SH "SAMPLE CONFIGURATION"
 .PP
 A brief example of what a simple \fIdefault.action\fR
@@ -112,8 +115,8 @@ configuration might look like:
  {{alias}}
 
  # Useful aliases
  {{alias}}
 
  # Useful aliases
- +prevent-cookies = +prevent-setting-cookies +prevent-reading-cookies
- -prevent-cookies = -prevent-setting-cookies -prevent-reading-cookies
+ +crunch-cookies = +crunch-incoming-cookies +crunch-outgoing-cookies
+ -crunch-cookies = -crunch-incoming-cookies -crunch-outgoing-cookies
  +imageblock      = +block +handle-as-image
 
  # Fragile sites should have the minimum changes
  +imageblock      = +block +handle-as-image
 
  # Fragile sites should have the minimum changes
@@ -141,13 +144,13 @@ configuration might look like:
  -limit-connect \\
  +prevent-compression \\
  +session-cookies-only \\
  -limit-connect \\
  +prevent-compression \\
  +session-cookies-only \\
- +prevent-reading-cookies \\
- +prevent-setting-cookies \\
+ -crunch-cookies \\
  -kill-popups \\
  }
  -kill-popups \\
  }
- /   # Match all URLs
+ /   # '/' Matches *all* URL patterns
  
  # Block, and treat these URL patterns as if they were 'images'.
  
  # Block, and treat these URL patterns as if they were 'images'.
+ # We would expect these to be ads.
  {+imageblock}
   .ad.doubleclick.net
   .a[0-9].yimg.com/(?:(?!/i/).)*$
  {+imageblock}
   .ad.doubleclick.net
   .a[0-9].yimg.com/(?:(?!/i/).)*$
@@ -159,11 +162,10 @@ configuration might look like:
   .*ads.
   banner?.
   /.*count(er)?\\.(pl|cgi|exe|dll|asp|php[34]?)
   .*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 
   .hitbox.com 
 
  # Make exceptions for these harmless ones that would be 
- # caught by +block above.
+ # caught by our +block patterns just above.
  {-block}
   adsl.
   advice.
  {-block}
   adsl.
   advice.
@@ -174,14 +176,21 @@ Then for a \fIuser.action\fR, we would put local,
 narrowly defined exceptions:
 
 .nf
 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 #######
 
  # Set personal exceptions to the policies in default.action #######
 
- # Sites where we want persistant cookies
- {-prevent-reading-cookies -prevent-setting-cookies -session-cookies-only}
+ # Sites where we want persistant cookies, so allow *all* cookies
+ {-crunch-cookies -session-cookies-only}
   .redhat.com
   .sun.com
   .msdn.microsoft.com
  
   .redhat.com
   .sun.com
   .msdn.microsoft.com
  
+ # This site breaks easily.
  {-block -fast-redirects}
   .forbes.com
 .fi
  {-block -fast-redirects}
   .forbes.com
 .fi
@@ -207,7 +216,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
 .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,
 .SH "SIGNALS"
 .PP
 \fBPrivoxy\fR terminates on the \fBSIGINT\fR,
@@ -219,10 +228,10 @@ config file changes by \fBSIGHUP\fR -- it will detect them
 automatically. 
 .SH "NOTES"
 .PP
 automatically. 
 .SH "NOTES"
 .PP
-This is a beta version of \fBPrivoxy\fR. Not 
+This is a alpha version of \fBPrivoxy\fR. Not 
 all features are well tested.
 .PP
 all features are well tested.
 .PP
-Please see the \fIuser-manual\fR on how to contact the
+Please see the \fIUser Manual\fR on how to contact the
 developers for feature requests, reporting problems, and other questions.
 .SH "SEE ALSO"
 .PP
 developers for feature requests, reporting problems, and other questions.
 .SH "SEE ALSO"
 .PP
@@ -231,27 +240,42 @@ users:
 .PP
 
 http://www.privoxy.org/, 
 .PP
 
 http://www.privoxy.org/, 
-The \fBPrivoxy\fR Home page. 
+the \fBPrivoxy\fR Home page. 
+
+http://www.privoxy.org/faq/, 
+the \fBPrivoxy\fR FAQ. 
 
 
-http://sourceforge.net/projects/ijbswa, 
+http://sourceforge.net/projects/ijbswa/
 the Project Page for \fBPrivoxy\fR on 
 the Project Page for \fBPrivoxy\fR on 
-Sourceforge.
+SourceForge.
 
 
-http://p.p/, access
-\fBPrivoxy\fR from your browser. Alternately, 
-http://config.privoxy.org
-may work in some situations where the first does not.
+http://config.privoxy.org/,
+the web-based user interface. \fBPrivoxy\fR must be
+running for this to work. Shortcut: http://p.p/
 
 
-http://p.p/  
-to submit ``misses'' to the developers. 
+http://www.privoxy.org/actions/, to submit ``misses'' to the developers. 
 
 
-http://www.junkbusters.com/ht/en/cookies.html
+http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/ijbswa/contrib/, cool
+and fun ideas from \fBPrivoxy\fR users.
 
 
-http://www.waldherr.org/junkbuster/
+http://www.junkbusters.com/ht/en/cookies.html,
+an explanation how cookies are used to track web users.
 
 
-http://privacy.net/analyze/
+http://www.junkbusters.com/ijb.html,
+the original Internet Junkbuster.
 
 
-http://www.squid-cache.org/
+http://www.waldherr.org/junkbuster/,
+Stefan Waldherr's version of Junkbuster, from which \fBPrivoxy\fR was
+derived.
+
+http://privacy.net/analyze/, a useful site
+to check what information about you is leaked while you browse the web.
+
+http://www.squid-cache.org/, a very popular
+caching proxy, which is often used together with \fBPrivoxy\fR.
+
+http://www.privoxy.org/developer-manual/, 
+the \fBPrivoxy\fR developer manual. 
 .SH "DEVELOPMENT TEAM"
 
 .nf
 .SH "DEVELOPMENT TEAM"
 
 .nf
@@ -261,28 +285,43 @@ http://www.squid-cache.org/
  Thomas Steudten
  Rodney Stromlund
  Rodrigo Barbosa (RPM specfiles)
  Thomas Steudten
  Rodney Stromlund
  Rodrigo Barbosa (RPM specfiles)
+ Moritz Barsnick
  Hal Burgiss (docs)
  Hal Burgiss (docs)
+ Karsten Hopp (Red Hat)
  Alexander Lazic
  Gábor Lipták
  Guy
  Haroon Rafique
  Alexander Lazic
  Gábor Lipták
  Guy
  Haroon Rafique
+ Roland Rosenfeld (Debian)
+ Georg Sauthoff (Gentoo)
  David Schmidt (OS/2, Mac OSX ports)
  David Schmidt (OS/2, Mac OSX ports)
- Joerg Strohmayer
+ Joerg Strohmayer (Amiga)
  Sarantis Paskalis
 .fi
 .SH "COPYRIGHT AND LICENSE"
  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
 .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
 .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
 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