Temporary workaround for BR#1730105.
[privoxy.git] / privoxy.1
index 120033d..801eda7 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>.
-.TH "PRIVOXY" "1" "01 September 2006" "Privoxy 3.0.4 beta" ""
+.TH "PRIVOXY" "1" "13 November 2006" "Privoxy 3.0.6" ""
 .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--chroot\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
@@ -52,22 +49,22 @@ that hierarchy.
 .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
-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
-tastes. \fBPrivoxy\fR has application for both
-stand-alone systems and multi-user networks.
+Privoxy is a 
+web proxy
+with advanced filtering capabilities for protecting
+privacy, modifying web page data, managing 
+cookies, 
+controlling access, and removing ads, banners, pop-ups and other obnoxious
+Internet junk. Privoxy has a very flexible configuration and can be
+customized to suit individual needs and tastes. Privoxy has application for
+both stand-alone systems and multi-user networks.
 .PP
-\fBPrivoxy\fR is based on \fBInternet
-Junkbuster\fR (tm).
+Privoxy is based on Internet Junkbuster (tm).
 .SH "INSTALLATION AND USAGE"
 .PP
 Browsers must be individually configured to use \fBPrivoxy\fR as
@@ -78,6 +75,11 @@ and Mozilla, go through:  \fBEdit\fR;
 \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. 
@@ -99,19 +101,25 @@ be used for locally defined exceptions to the default rules of
 \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
-\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
-See the user-manual for a complete
-explanation of installation, general usage, all configuration options, new
-features and notes on upgrading.
+\fBPrivoxy\fR uses the concept of \fBactions\fR 
+in order to manipulate the data stream between the browser and remote sites.
+There are various actions available with specific functions for such things 
+as blocking web sites, managing cookies, etc. These actions can be invoked
+individually or combined, and used against individual URLs, or groups of URLs 
+that can be defined using wildcards and regular expressions. The result is
+that the user has greatly enhanced control and freedom.
 .PP
 The actions list (ad blocks, etc) can also be configured with your
 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, and does not require Internet access.
+.PP
+See the \fIUser Manual\fR for a detailed
+explanation of installation, general usage, all configuration options, new
+features and notes on upgrading.
 .SH "SAMPLE CONFIGURATION"
 .PP
 A brief example of what a simple \fIdefault.action\fR
@@ -121,10 +129,10 @@ configuration might look like:
  # Define a few useful custom aliases for later use
  {{alias}}
 
- # Useful aliases
+ # Useful aliases that combine more than one action
  +crunch-cookies = +crunch-incoming-cookies +crunch-outgoing-cookies
  -crunch-cookies = -crunch-incoming-cookies -crunch-outgoing-cookies
- +imageblock      = +block +handle-as-image
+ +block-as-image = +block +handle-as-image
 
  # Fragile sites should have the minimum changes
  fragile     = -block -deanimate-gifs -fast-redirects -filter \\
@@ -132,7 +140,7 @@ configuration might look like:
 
  ## Turn some actions on ################################
  ## NOTE: Actions are off by default, unless explictily turned on 
- ## otherwise.
+ ## otherwise with the '+' operator.
 
 { \\
 -add-header \\
@@ -146,15 +154,15 @@ configuration might look like:
 +deanimate-gifs{last} \\
 -downgrade-http-version \\
 -fast-redirects \\
-+filter{js-annoyances} \\
+-filter{js-annoyances} \\
 -filter{js-events} \\
-+filter{html-annoyances} \\
+-filter{html-annoyances} \\
 -filter{content-cookies} \\
 +filter{refresh-tags} \\
-+filter{unsolicited-popups} \\
+-filter{unsolicited-popups} \\
 -filter{all-popups} \\
-+filter{img-reorder} \\
-+filter{banners-by-size} \\
+-filter{img-reorder} \\
+-filter{banners-by-size} \\
 -filter{banners-by-link} \\
 +filter{webbugs} \\
 -filter{tiny-textforms} \\
@@ -167,6 +175,14 @@ configuration might look like:
 -filter{crude-parental} \\
 +filter{ie-exploits} \\
 -filter{site-specifics} \\
+-filter{google} \\
+-filter{yahoo} \\
+-filter{msn} \\
+-filter{blogspot} \\
+-filter{xml-to-html} \\
+-filter{html-to-xml} \\
+-filter{no-ping} \\
+-filter{hide-tor-exit-notation} \\
 -filter-client-headers \\
 -filter-server-headers \\
 -force-text-mode \\
@@ -193,29 +209,33 @@ configuration might look like:
 }
 / # '/' Match *all* URL patterns
 
-
  
+ # Block all URLs that match these patterns
+ { +block }
+  ad.
+  ad[sv].
+  .*ads.
+  banner?.
+  /.*count(er)?\\.(pl|cgi|exe|dll|asp|php[34]?)
+  .hitbox.com 
+  media./.*(ads|banner)
+
  # Block, and treat these URL patterns as if they were 'images'.
  # We would expect these to be ads.
- {+imageblock}
+ { +block-as-image }
   .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]?)
-  .hitbox.com 
-
  # Make exceptions for these harmless ones that would be 
  # caught by our +block patterns just above.
- {-block}
+ { -block }
   adsl.
+  adobe.
   advice.
   .*downloads.
+  # uploads or downloads
+  /.*loads
 .fi
 .PP
 Then for a \fIuser.action\fR, we would put local,
@@ -230,20 +250,25 @@ narrowly defined exceptions:
  
  # Set personal exceptions to the policies in default.action #######
 
- # Sites where we want persistant cookies, so allow *all* cookies
- {-crunch-cookies -session-cookies-only}
+ # Sites where we want persistent cookies, so allow *all* cookies
+ { -crunch-cookies -session-cookies-only }
   .redhat.com
   .sun.com
   .msdn.microsoft.com
  
- # This site breaks easily.
- {-block -fast-redirects}
+ # These sites breaks easily. Use our "fragile" alias here.
+ { fragile }
   .forbes.com
+  mybank.example.com
+
+ # Replace example.com's style sheet with one of my choosing
+ { +redirect{http://localhost/css-replacements/example.com.css} }
+  example.com/stylesheet.css
 .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"
 
@@ -275,9 +300,6 @@ config file changes by \fBSIGHUP\fR -- it will detect them
 automatically. 
 .SH "NOTES"
 .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.
 .SH "SEE ALSO"
@@ -300,7 +322,8 @@ http://config.privoxy.org/,
 the web-based user interface. \fBPrivoxy\fR must be
 running for this to work. Shortcut: http://p.p/
 
-http://www.privoxy.org/actions/, to submit ``misses'' to the developers. 
+http://sourceforge.net/tracker/?group_id=11118&atid=460288, to submit ``misses'' and other
+configuration related suggestions to the developers. 
 
 http://www.junkbusters.com/ht/en/cookies.html,
 an explanation how cookies are used to track web users.
@@ -308,25 +331,26 @@ an explanation how cookies are used to track web users.
 http://www.junkbusters.com/ijb.html,
 the original Internet Junkbuster.
 
-http://privacy.net/analyze/, a useful site
+http://privacy.net/, 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://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
- Fabian Keil
- David Schmidt
-
-
- Johny Agotnes 
- Moritz Barsnick
+ Fabian Keil, developer
+ David Schmidt, developer
  Hal Burgiss
- Mattes Dolak 
+ Ian Cummings
  Roland Rosenfeld
 .fi
 .SH "COPYRIGHT AND LICENSE"
@@ -348,11 +372,11 @@ 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 
 \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.
+more details, which is available from the Free Software Foundation, Inc, 
+51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
 .PP
 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
+Foundation, Inc. 51 Franklin Street, Fifth Floor
+Boston, MA 02110-1301
 USA