Change Tor links to use the new domain torproject.org.
[privoxy.git] / doc / source / privoxy-man-page.sgml
index 445a715..db95a76 100644 (file)
@@ -5,9 +5,9 @@
                 This file belongs into
                 ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/
                 
- $Id: privoxy-man-page.sgml,v 2.6 2006/08/26 02:37:27 hal9 Exp $
+ $Id: privoxy-man-page.sgml,v 2.12 2006/11/14 01:57:47 hal9 Exp $
 
- Copyright (C) 2001-2006 Privoxy Developers <developers@privoxy.org>
+ Copyright (C) 2001-2007 Privoxy Developers http://www.privoxy.org/
  See LICENSE.
 
  ========================================================================
 <!entity copyright SYSTEM "copyright.sgml">
 <!entity license SYSTEM "license.sgml">
 <!entity authors SYSTEM "p-authors.sgml">
-<!entity p-version "3.0.4">
-<!entity p-status "beta">
-<!entity % p-not-stable "INCLUDE">
-<!entity % p-stable "IGNORE">
+<!entity p-version "3.0.7">
+<!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  -->
@@ -53,7 +53,7 @@
 
 <refentry id="privoxy">
 <refentryinfo>
- <date>2006-08-24</date>
+ <date>2007-04-12</date>
 </refentryinfo>
 <refmeta>
  <refentrytitle>privoxy</refentrytitle> 
   <arg><option>--user </option><replaceable class="parameter">user[.group]</replaceable></arg> 
   <arg><option>--chroot</option></arg>
   <arg><replaceable class="parameter">configfile</replaceable></arg>        
-  <command>&nbsp;(UNIX)</command>
  </cmdsynopsis>
 
- <cmdsynopsis> 
-  <command>privoxy.exe</command>              
-  <arg><replaceable class="parameter">configfile</replaceable></arg>
-  <command>&nbsp;(Windows)</command>
- </cmdsynopsis>                                      
 </refsynopsisdiv>
 
 
  <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 (except on Win32 where
-  it will try <filename>config.txt</filename>). If no
+  <filename>config</filename> in the current directory . If no
   <filename>configfile</filename> is found, <command>Privoxy</command> will 
   fail to start.
  </para>
  <command>Proxies</command>;  <command>Manual Proxy Configuration</command>;
  <command>View</command>. 
 </para>
+<para>
+ For Firefox, go through: <command>Tools</command>; 
+ <command>Options</command>; <command>General</command>;
+ <command>Connection Settings</command>;
+ <command>Manual Proxy Configuration</command>. 
+</para>
 <para>
  For Internet Explorer, go through: <command>Tools</command>; 
  <command>Internet Properties</command>; <command>Connections</command>;
  <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. On Windows, OS/2 and AmigaOS,
- these files are in the same directory as the <command>Privoxy</command>
- executable.
+ <filename>/etc/privoxy/</filename> by default. 
 </para>
-<para>
- See the <ulink
- url="http://www.privoxy.org/user-manual/">user-manual</ulink> for a complete
- explanation of installation, general usage, all configuration options, new
- features and notes on upgrading.
+<para> 
+ <command>Privoxy</command> uses the concept of <command>actions</command> 
+ 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.
 </para>
 <para>
  The actions list (ad blocks, etc) can also be configured with your
  the same page. In addition, <command>Privoxy</command> can be toggled on/off.
  This is an internal page, and does not require Internet access.
 </para>
+<para>
+ See the <ulink
+ url="http://www.privoxy.org/user-manual/"><citetitle>User Manual</citetitle></ulink> for a detailed
+ explanation of installation, general usage, all configuration options, new
+ features and notes on upgrading.
+</para>
 </refsect1>
 
 
  # 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 \
 { \
 -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{last} \
+-deanimate-gifs \
 -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{refresh-tags} \
+-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{webbugs} \
 -filter{tiny-textforms} \
-+filter{jumping-windows} \
+-filter{jumping-windows} \
 -filter{frameset-borders} \
 -filter{demoronizer} \
 -filter{shockwave-flash} \
 -filter{quicktime-kioskmode} \
 -filter{fun} \
 -filter{crude-parental} \
-+filter{ie-exploits} \
+-filter{ie-exploits} \
 -filter{site-specifics} \
--filter-client-headers \
--filter-server-headers \
+-filter{google} \
+-filter{yahoo} \
+-filter{msn} \
+-filter{blogspot} \
+-filter{no-ping} \
 -force-text-mode \
--handle-as-empty-document
+-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-referrer \
 -hide-user-agent \
 -inspect-jpegs \
 -kill-popups \
 -limit-connect \
 -overwrite-last-modified \
+-prevent-compression \
 -redirect \
-+prevent-compression \
 -send-vanilla-wafer \
 -send-wafer \
-+session-cookies-only \
+-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.
- {+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
 </literallayout>
 
 <para>
  
  # 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
 
 </literallayout>
 
 <para>
  See the comments in the configuration files themselves, or the 
- <citetitle>user-manual</citetitle>
- for explanations of the above syntax, and other <command>Privoxy</command>
+ <citetitle>User Manual</citetitle>
+ for full explanations of the above syntax, and other <command>Privoxy</command>
  configuration options.
 </para>