Clean up a variable type declaration which just

[privoxy.git] / privoxy.1

diff --git a/privoxy.1 b/privoxy.1
index 3928b96..de4b32a 100644 (file)
--- a/privoxy.1
+++ b/privoxy.1
@@ -3,15 +3,12 @@
 .\" <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" "05 May 2002" "Privoxy 2.9.15 beta" ""
+.TH "PRIVOXY" "1" "05 September 2006" "Privoxy 3.0.4 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] \fB(UNIX)\fR
-
-
-\fBprivoxy.exe\fR [\fB\fIconfigfile\fB\fR] \fB(Windows)\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--chroot\fR ] [\fB\fIconfigfile\fB\fR ]

 
 .SH "OPTIONS"
 .PP
 
 .SH "OPTIONS"
 .PP


@@ -31,7 +28,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


@@ -41,17 +38,24 @@ After (optionally) writing the PID file, assume the user ID of
 \fIgroup\fR was not given, the default group of
 \fIuser\fR. Exit if the privileges are not
 sufficient to do so.
 \fIgroup\fR was not given, the default group of
 \fIuser\fR. Exit if the privileges are not
 sufficient to do so.

+.TP
+\fB--chroot\fR
+Before changing to the user ID given in the --user option, chroot to
+that user's home directory, i.e. make the kernel pretend to the
+\fBPrivoxy\fR process that the directory tree starts
+there. If set up carefully, this can limit the impact of possible
+vulnerabilities in \fBPrivoxy\fR to the files contained in
+that hierarchy. 

 .PP
 If the \fIconfigfile\fR is not specified on  the  command  line,
 \fBPrivoxy\fR  will  look for a file named
 .PP
 If the \fIconfigfile\fR is not specified on  the  command  line,
 \fBPrivoxy\fR  will  look for a file named

-\fIconfig\fR in the current directory (except on Win32 where
-it will try \fIconfig.txt\fR). If no
+\fIconfig\fR in the current directory . If no

 \fIconfigfile\fR is found, \fBPrivoxy\fR will 
 fail to start.
 .SH "DESCRIPTION"
 .PP
 \fBPrivoxy\fR is a web proxy with advanced filtering
 \fIconfigfile\fR is found, \fBPrivoxy\fR will 
 fail to start.
 .SH "DESCRIPTION"
 .PP
 \fBPrivoxy\fR is a web proxy with advanced filtering

-capabilities for protecting privacy, filtering web page content, managing
+capabilities for protecting privacy, modifying web page data, managing

 cookies, controlling access, and removing ads, banners, pop-ups and other
 obnoxious Internet junk. \fBPrivoxy\fR has a very
 flexible configuration and can be customized to suit individual needs and
 cookies, controlling access, and removing ads, banners, pop-ups and other
 obnoxious Internet junk. \fBPrivoxy\fR has a very
 flexible configuration and can be customized to suit individual needs and


@@ -70,12 +74,20 @@ and Mozilla, go through:  \fBEdit\fR;
 \fBProxies\fR;  \fBManual Proxy Configuration\fR;
 \fBView\fR. 
 .PP
 \fBProxies\fR;  \fBManual Proxy Configuration\fR;
 \fBView\fR. 
 .PP

+For Firefox, go through: \fBTools\fR; 
+\fBOptions\fR; \fBGeneral\fR;
+\fBConnection Settings\fR;
+\fBManual Proxy Configuration\fR. 
+.PP

 For Internet Explorer, go through: \fBTools\fR; 
 \fBInternet Properties\fR; \fBConnections\fR;
 \fBLAN Settings\fR. 
 .PP
 The Secure (SSL) Proxy should also be set to the same values, otherwise
 For Internet Explorer, go through: \fBTools\fR; 
 \fBInternet Properties\fR; \fBConnections\fR;
 \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.
+HTTPS presents some limitations, and not all features will work with HTTPS 
+connections.

 .PP
 For other browsers, check the documentation.
 .SH "CONFIGURATION"
 .PP
 For other browsers, check the documentation.
 .SH "CONFIGURATION"


@@ -85,23 +97,20 @@ files. The default configuration files are: \fIconfig\fR,
 \fIdefault.filter\fR, and
 \fIdefault.action\fR. \fIuser.action\fR should 
 be used for locally defined exceptions to the default rules of
 \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
+\fIdefault.action\fR, and \fIuser.filter\fR for 
+locally defined filters. These are well commented.  On Unix

 and Unix-like systems, these are located in
 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.
+\fI/etc/privoxy/\fR by default. 

 .PP
 .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. 
+See the \fIUser Manual\fR for a detailed
+explanation of installation, general usage, all configuration options, new
+features and notes on upgrading.

 .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 +121,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


@@ -121,33 +130,71 @@ configuration might look like:
                -hide-referer -prevent-cookies -kill-popups
 
  ## Turn some actions on ################################
                -hide-referer -prevent-cookies -kill-popups
 
  ## Turn some actions on ################################

- { \\
- -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
+ ## NOTE: Actions are off by default, unless explictily turned on 
+ ## otherwise with the '+' operator.
+
+{ \\
+-add-header \\
+-block \\
+-content-type-overwrite \\
+-crunch-client-header \\
+-crunch-if-none-match \\
+-crunch-outgoing-cookies \\
+-crunch-incoming-cookies \\
+-crunch-server-header \\
++deanimate-gifs{last} \\
+-downgrade-http-version \\
+-fast-redirects \\
++filter{js-annoyances} \\
+-filter{js-events} \\
++filter{html-annoyances} \\
+-filter{content-cookies} \\
++filter{refresh-tags} \\
++filter{unsolicited-popups} \\
+-filter{all-popups} \\
++filter{img-reorder} \\
++filter{banners-by-size} \\
+-filter{banners-by-link} \\
++filter{webbugs} \\
+-filter{tiny-textforms} \\
++filter{jumping-windows} \\
+-filter{frameset-borders} \\
+-filter{demoronizer} \\
+-filter{shockwave-flash} \\
+-filter{quicktime-kioskmode} \\
+-filter{fun} \\
+-filter{crude-parental} \\
++filter{ie-exploits} \\
+-filter{site-specifics} \\
+-filter-client-headers \\
+-filter-server-headers \\
+-force-text-mode \\
+-handle-as-empty-document
+-handle-as-image \\
+-hide-accept-language \\
+-hide-content-disposition \\
+-hide-if-modified-since \\
++hide-forwarded-for-headers \\
++hide-from-header{block} \\
++hide-referrer{forge} \\
+-hide-user-agent \\
+-inspect-jpegs \\
+-kill-popups \\
+-limit-connect \\
+-overwrite-last-modified \\
+-redirect \\
++prevent-compression \\
+-send-vanilla-wafer \\
+-send-wafer \\
++session-cookies-only \\
++set-image-blocker{pattern} \\
+-treat-forbidden-connects-like-blocks \\
+}
+/ # '/' Match *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 +206,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,21 +220,28 @@ 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
 .PP
 See the comments in the configuration files themselves, or the 
  {-block -fast-redirects}
   .forbes.com
 .fi
 .PP
 See the comments in the configuration files themselves, or the 

-\fIuser-manual\fR
-for explanations of the above syntax, and other \fBPrivoxy\fR
+\fIUser Manual\fR
+for full explanations of the above syntax, and other \fBPrivoxy\fR

 configuration options.
 .SH "FILES"
 
 configuration options.
 .SH "FILES"
 


@@ -200,14 +253,15 @@ configuration options.
  \fI/etc/privoxy/standard.action\fR
  \fI/etc/privoxy/user.action\fR
  \fI/etc/privoxy/default.filter\fR
  \fI/etc/privoxy/standard.action\fR
  \fI/etc/privoxy/user.action\fR
  \fI/etc/privoxy/default.filter\fR

+ \fI/etc/privoxy/user.filter\fR

  \fI/etc/privoxy/trust\fR
  \fI/etc/privoxy/templates/*\fR
  \fI/var/log/privoxy/logfile\fR
 .fi
 .PP
 Various other files should be included, but may vary depending on platform
  \fI/etc/privoxy/trust\fR
  \fI/etc/privoxy/templates/*\fR
  \fI/var/log/privoxy/logfile\fR
 .fi
 .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.
+and build configuration. Additional documentation should be included in the local
+documentation directory.

 .SH "SIGNALS"
 .PP
 \fBPrivoxy\fR terminates on the \fBSIGINT\fR,
 .SH "SIGNALS"
 .PP
 \fBPrivoxy\fR terminates on the \fBSIGINT\fR,


@@ -222,8 +276,8 @@ automatically.
 This is a beta version of \fBPrivoxy\fR. Not 
 all features are well tested.
 .PP
 This is a beta version of \fBPrivoxy\fR. Not 
 all features are well tested.
 .PP

-Please see the \fIuser-manual\fR on how to contact the
-developers for feature requests, reporting problems, and other questions.
+Please see the \fIUser Manual\fR on how to contact the
+developers, for feature requests, reporting problems, and other questions.

 .SH "SEE ALSO"
 .PP
 Other references and sites of interest to \fBPrivoxy\fR
 .SH "SEE ALSO"
 .PP
 Other references and sites of interest to \fBPrivoxy\fR


@@ -231,66 +285,77 @@ users:
 .PP
 
 http://www.privoxy.org/, 
 .PP
 
 http://www.privoxy.org/, 

-The \fBPrivoxy\fR Home page. 
+the \fBPrivoxy\fR Home page. 

 
 

-http://sourceforge.net/projects/ijbswa, 
+http://www.privoxy.org/faq/, 
+the \fBPrivoxy\fR FAQ. 
+
+http://sourceforge.net/projects/ijbswa/, 

 the Project Page for \fBPrivoxy\fR on 
 the Project Page for \fBPrivoxy\fR on 

-Sourceforge.
+SourceForge.
+
+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/, access
-\fBPrivoxy\fR from your browser. Alternately, 
-http://config.privoxy.org
-may work in some situations where the first does not.
+http://sourceforge.net/tracker/?group_id=11118&atid=460288, to submit ``misses'' and other
+configuration related suggestions to the developers. 

 
 

-http://p.p/ to submit ``misses'' to the developers. 
+http://www.junkbusters.com/ht/en/cookies.html,
+an explanation how cookies are used to track web users.

 
 

-http://www.junkbusters.com/ht/en/cookies.html
+http://www.junkbusters.com/ijb.html,
+the original Internet Junkbuster.

 
 

-http://www.waldherr.org/junkbuster/
+http://privacy.net/, a useful site
+to check what information about you is leaked while you browse the web.

 
 

-http://privacy.net/analyze/
+http://www.squid-cache.org/, a very popular
+caching proxy, which is often used together with \fBPrivoxy\fR.

 
 

-http://www.squid-cache.org/
+http://tor.eff.org/, 
+\fBTOR\fR can help anonymize web browsing, 
+web publishing, instant messaging, IRC, SSH, and other applications.
+
+http://www.privoxy.org/developer-manual/, 
+the \fBPrivoxy\fR developer manual. 

 .SH "DEVELOPMENT TEAM"
 
 .nf
 .SH "DEVELOPMENT TEAM"
 
 .nf

- Jon Foster
- Andreas Oesterhelt
- Stefan Waldherr
- Thomas Steudten
- Rodney Stromlund
- Rodrigo Barbosa (RPM specfiles)
- Hal Burgiss (docs)
- Alexander Lazic
- Gábor Lipták
- Guy
- Haroon Rafique
- David Schmidt (OS/2, Mac OSX ports)
- Joerg Strohmayer
- Sarantis Paskalis
+ Fabian Keil
+ David Schmidt
+
+
+ Johny Agotnes 
+ Moritz Barsnick
+ Hal Burgiss
+ Mattes Dolak 
+ Roland Rosenfeld

 .fi
 .SH "COPYRIGHT AND LICENSE"
 .SS "COPYRIGHT"
 .PP
 .fi
 .SH "COPYRIGHT AND LICENSE"
 .SS "COPYRIGHT"
 .PP

-Permission is granted to copy, distribute and/or modify this document under
-the terms of the \fIGNU Free
-Documentation License\fR, Version 1.1 or any later version
-published by the Free Software Foundation with no Invariant Sections, no
-Front-Cover Texts, and no Back-Cover Texts.  A copy of the license can be
-found http://www.gnu.org/licenses/fdl.html.
+Copyright (C) 2001 - 2006 by Privoxy Developers <ijbswa-developers@lists.sourceforge.net>
+.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
 .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
 .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