Suggest to enable debug 32768 when suspecting parsing problems.
[privoxy.git] / doc / source / privoxy-man-page.sgml
index dd12c01..9a27a00 100644 (file)
@@ -5,9 +5,9 @@
                 This file belongs into
                 ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/
                 
                 This file belongs into
                 ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/
                 
- $Id: privoxy-man-page.sgml,v 2.13 2007/04/12 11:30:37 fabiankeil Exp $
+ $Id: privoxy-man-page.sgml,v 2.35 2010/02/13 17:38:27 fabiankeil Exp $
 
 
- Copyright (C) 2001-2007 Privoxy Developers http://www.privoxy.org/
+ Copyright (C) 2001-2009 Privoxy Developers http://www.privoxy.org/
  See LICENSE.
 
  ========================================================================
  See LICENSE.
 
  ========================================================================
 <!entity copyright SYSTEM "copyright.sgml">
 <!entity license SYSTEM "license.sgml">
 <!entity authors SYSTEM "p-authors.sgml">
 <!entity copyright SYSTEM "copyright.sgml">
 <!entity license SYSTEM "license.sgml">
 <!entity authors SYSTEM "p-authors.sgml">
-<!entity p-version "3.0.7">
-<!entity p-status "UNRELEASED">
-<!entity % p-not-stable "INCLUDE">
-<!entity % p-stable "IGNORE">
+<!entity p-version "3.0.17">
+<!entity p-status "stable">
+<!entity % p-not-stable "IGNORE">
+<!entity % p-stable "INCLUDE">
 <!entity % p-text "IGNORE">           <!-- define we are not a text only doc -->
 <!entity % p-authors-formal "IGNORE"> <!-- exclude additional formating      -->
 <!entity my-copy "(C)">               <!-- db2man barfs on copyright symbol  -->
 <!entity % p-text "IGNORE">           <!-- define we are not a text only doc -->
 <!entity % p-authors-formal "IGNORE"> <!-- exclude additional formating      -->
 <!entity my-copy "(C)">               <!-- db2man barfs on copyright symbol  -->
+<!entity % seealso-extra "IGNORE">    <!-- for excluding sections of seealso -->
 ]>
 
 <refentry id="privoxy">
 <refentryinfo>
 ]>
 
 <refentry id="privoxy">
 <refentryinfo>
- <date>2007-04-12</date>
+ <date>2009-02-15</date>
 </refentryinfo>
 <refmeta>
  <refentrytitle>privoxy</refentrytitle> 
 </refentryinfo>
 <refmeta>
  <refentrytitle>privoxy</refentrytitle> 
  <para>
   If the <filename>configfile</filename> is not specified on  the  command  line,
   <command>Privoxy</command>  will  look for a file named
  <para>
   If the <filename>configfile</filename> is not specified on  the  command  line,
   <command>Privoxy</command>  will  look for a file named
-  <filename>config</filename> in the current directory . If no
+  <filename>config</filename> in the current directory. If no
   <filename>configfile</filename> is found, <command>Privoxy</command> will 
   fail to start.
  </para>
   <filename>configfile</filename> is found, <command>Privoxy</command> will 
   fail to start.
  </para>
 <refsect1><title>Installation and Usage</title>
 <para>
  Browsers can either be individually configured to use
 <refsect1><title>Installation and Usage</title>
 <para>
  Browsers can either be individually configured to use
- <command>Privoxy</command> as a HTTP proxy, or <command>Privoxy</command> can
- be set to act as an intercepting proxy (see <filename>config</filename>).  The default setting is  for
+ <command>Privoxy</command> as a HTTP proxy (recommended),
+ or <command>Privoxy</command> can be combined with a packet
+ filter to build an intercepting proxy
+ (see <filename>config</filename>).  The default setting is  for
  localhost,  on port  8118 (configurable in the main config file).  To set the
  localhost,  on port  8118 (configurable in the main config file).  To set the
- HTTP proxy in Netscape and Mozilla, go through:  <command>Edit</command>;
- <command>Preferences</command>;  <command>Advanced</command>;
- <command>Proxies</command>;  <command>Manual Proxy Configuration</command>;
- <command>View</command>. 
-</para>
-<para>
- For Firefox, go through: <command>Tools</command>; 
+ HTTP proxy in Firefox, go through: <command>Tools</command>; 
  <command>Options</command>; <command>General</command>;
  <command>Connection Settings</command>;
  <command>Manual Proxy Configuration</command>. 
  <command>Options</command>; <command>General</command>;
  <command>Connection Settings</command>;
  <command>Manual Proxy Configuration</command>. 
 <para>
  <command>Privoxy</command> can be configured with the various configuration
  files. The default configuration files are: <filename>config</filename>,
 <para>
  <command>Privoxy</command> can be configured with the various configuration
  files. The default configuration files are: <filename>config</filename>,
- <filename>default.filter</filename>, and
+ <filename>default.filter</filename>, <filename>default.action</filename> and
  <filename>default.action</filename>. <filename>user.action</filename> should 
  <filename>default.action</filename>. <filename>user.action</filename> should 
- be used for locally defined exceptions to the default rules of
- <filename>default.action</filename>, and <filename>user.filter</filename> for 
- locally defined filters. These are well commented.  On Unix
- and Unix-like systems, these are located in
+ be used for locally defined exceptions to the default rules in
+ <filename>match-all.action</filename> and <filename>default.action</filename>,
+ and <filename>user.filter</filename> for locally defined filters. These are
well commented.  On Unix and Unix-like systems, these are located in
  <filename>/etc/privoxy/</filename> by default. 
 </para>
 <para> 
  <filename>/etc/privoxy/</filename> by default. 
 </para>
 <para> 
 </refsect1>
 
 
 </refsect1>
 
 
-<!--   ~~~~~       New section      ~~~~~     -->
-<refsect1><title>Sample Configuration</title>
-<para>
- A brief example of what a simple <filename>default.action</filename>
- configuration might look like:
-</para>
-
-<literallayout>
- # Define a few useful custom aliases for later use
- {{alias}}
-
- # Useful aliases that combine more than one action
- +crunch-cookies = +crunch-incoming-cookies +crunch-outgoing-cookies
- -crunch-cookies = -crunch-incoming-cookies -crunch-outgoing-cookies
- +block-as-image = +block +handle-as-image
-
- # Fragile sites should have the minimum changes
- fragile     = -block -deanimate-gifs -fast-redirects -filter \
-               -hide-referer -prevent-cookies -kill-popups
-
- ## Turn some actions on ################################
- ## NOTE: Actions are off by default, unless explictily turned on 
- ## otherwise with the '+' operator.
-
-{ \
--add-header \
--block \
--client-header-filter{hide-tor-exit-notation} \
--content-type-overwrite \
--crunch-client-header \
--crunch-if-none-match \
--crunch-outgoing-cookies \
--crunch-incoming-cookies \
--crunch-server-header \
--deanimate-gifs \
--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{google} \
--filter{yahoo} \
--filter{msn} \
--filter{blogspot} \
--filter{no-ping} \
--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 \
--hide-user-agent \
--inspect-jpegs \
--kill-popups \
--limit-connect \
--overwrite-last-modified \
--prevent-compression \
--redirect \
--send-vanilla-wafer \
--send-wafer \
--server-header-filter{xml-to-html} \
--server-header-filter{html-to-xml} \
--session-cookies-only \
-+set-image-blocker{pattern} \
--treat-forbidden-connects-like-blocks \
-}
-/ # '/' 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.
- { +block-as-image }
-  .ad.doubleclick.net
-  .a[0-9].yimg.com/(?:(?!/i/).)*$
-  ad.*.doubleclick.net
-
- # Make exceptions for these harmless ones that would be 
- # caught by our +block patterns just above.
- { -block }
-  adsl.
-  adobe.
-  advice.
-  .*downloads.
-  # uploads or downloads
-  /.*loads
-</literallayout>
-
-<para>
- Then for a <filename>user.action</filename>, we would put local,
- narrowly defined exceptions:
-</para>
-
-<literallayout>
- # 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 persistent cookies, so allow *all* cookies
- { -crunch-cookies -session-cookies-only }
-  .redhat.com
-  .sun.com
-  .msdn.microsoft.com
- # These sites break 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
-
-</literallayout>
-
-<para>
- See the comments in the configuration files themselves, or the 
- <citetitle>User Manual</citetitle>
- for full explanations of the above syntax, and other <command>Privoxy</command>
- configuration options.
-</para>
-
-</refsect1>
-
 
 <!--   ~~~~~       New section      ~~~~~     -->
 <refsect1><title>Files</title>
 
 <!--   ~~~~~       New section      ~~~~~     -->
 <refsect1><title>Files</title>
 <literallayout> 
  <filename>/usr/sbin/privoxy</filename>
  <filename>/etc/privoxy/config</filename>
 <literallayout> 
  <filename>/usr/sbin/privoxy</filename>
  <filename>/etc/privoxy/config</filename>
+ <filename>/etc/privoxy/match-all.action</filename>
  <filename>/etc/privoxy/default.action</filename>
  <filename>/etc/privoxy/default.action</filename>
- <filename>/etc/privoxy/standard.action</filename>
  <filename>/etc/privoxy/user.action</filename>
  <filename>/etc/privoxy/default.filter</filename>
  <filename>/etc/privoxy/user.filter</filename>
  <filename>/etc/privoxy/user.action</filename>
  <filename>/etc/privoxy/default.filter</filename>
  <filename>/etc/privoxy/user.filter</filename>
 <refsect1><title>Notes</title>
 <![%p-not-stable;[
 <para>
 <refsect1><title>Notes</title>
 <![%p-not-stable;[
 <para>
- This is a &p-status; version of <command>Privoxy</command>. Not 
+ This is a &p-status; version of <command>Privoxy</command>. Not
  all features are well tested.
 </para>]]>
 <para>
  all features are well tested.
 </para>]]>
 <para>