Sync actions list with default.action.master, +minor_changes.
[privoxy.git] / doc / source / privoxy-man-page.sgml
index 026f511..445a715 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 1.12 2002/05/10 01:48:20 hal9 Exp $
+ $Id: privoxy-man-page.sgml,v 2.6 2006/08/26 02:37:27 hal9 Exp $
 
- Copyright (C) 2001, 2002 Privoxy Developers <developers@privoxy.org>
+ Copyright (C) 2001-2006 Privoxy Developers <developers@privoxy.org>
  See LICENSE.
 
  ========================================================================
@@ -42,7 +42,7 @@
 <!entity copyright SYSTEM "copyright.sgml">
 <!entity license SYSTEM "license.sgml">
 <!entity authors SYSTEM "p-authors.sgml">
-<!entity p-version "2.9.15">
+<!entity p-version "3.0.4">
 <!entity p-status "beta">
 <!entity % p-not-stable "INCLUDE">
 <!entity % p-stable "IGNORE">
@@ -53,7 +53,7 @@
 
 <refentry id="privoxy">
 <refentryinfo>
- <date>2002-05-14</date>
+ <date>2006-08-24</date>
 </refentryinfo>
 <refmeta>
  <refentrytitle>privoxy</refentrytitle> 
   <arg><option>--no-daemon</option></arg>
   <arg><option>--pidfile </option><replaceable class="parameter">pidfile</replaceable></arg>  
   <arg><option>--user </option><replaceable class="parameter">user[.group]</replaceable></arg> 
+  <arg><option>--chroot</option></arg>
   <arg><replaceable class="parameter">configfile</replaceable></arg>        
-  <command>(UNIX)</command>
+  <command>&nbsp;(UNIX)</command>
  </cmdsynopsis>
 
  <cmdsynopsis> 
   <command>privoxy.exe</command>              
   <arg><replaceable class="parameter">configfile</replaceable></arg>
-  <command>(Windows)</command>
+  <command>&nbsp;(Windows)</command>
  </cmdsynopsis>                                      
 </refsynopsisdiv>
 
       <para>
         On startup, write the process ID to <replaceable class="parameter">pidfile</replaceable>.
         Delete the <replaceable class="parameter">pidfile</replaceable> on exit.
-        Failiure to create or delete the <replaceable class="parameter">pidfile</replaceable>
+        Failure to create or delete the <replaceable class="parameter">pidfile</replaceable>
         is non-fatal. If no <command>--pidfile</command> option is given, no PID file will be used.
       </para>
     </listitem>
      </para>
     </listitem>
   </varlistentry>
+  <varlistentry>
+    <term>--chroot</term>
+     <listitem>
+      <para>
+       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
+       <command>Privoxy</command> process that the directory tree starts
+       there. If set up carefully, this can limit the impact of possible
+       vulnerabilities in <command>Privoxy</command> to the files contained in
+       that hierarchy. 
+      </para>
+    </listitem>
+  </varlistentry>
  </variablelist>
+
  <para>
   If the <filename>configfile</filename> is not specified on  the  command  line,
   <command>Privoxy</command>  will  look for a file named
 </para>
 <para>
  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: <command>Privoxy</command> 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.
 </para>
+
 <para>
  For other browsers, check the documentation.
 </para>
  <filename>default.filter</filename>, and
  <filename>default.action</filename>. <filename>user.action</filename> should 
  be used for locally defined exceptions to the default rules of
- <filename>default.action</filename> These are all well commented.  On Unix
+ <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.
 </para>
 <para>
- 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
- <ulink url="http://www.privoxy.org/user-manual/">user-manual</ulink> for a
- complete explanation of all configuration options and general usage.
+ 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>
 <para>
  The actions list (ad blocks, etc) can also be configured with your
  web browser at <ulink url="http://config.privoxy.org/">http://config.privoxy.org/</ulink>.
  <command>Privoxy's</command> configuration parameters  can also  be viewed at
  the same page. In addition, <command>Privoxy</command> can be toggled on/off.
- This is an internal page.
+ This is an internal page, and does not require Internet access.
 </para>
 </refsect1>
 
                -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 \
- -crunch-cookies \
- -kill-popups \
- }
- /   # '/' Matches *all* URL patterns
+ ## 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'.
  # We would expect these to be ads.
  <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/trust</filename>
  <filename>/etc/privoxy/templates/*</filename>
  <filename>/var/log/privoxy/logfile</filename>
 
 <para>
  Various other files should be included, but may vary depending on platform
- and build configuration. More documentation should be included in the local
+ and build configuration. Additional documentation should be included in the local
  documentation directory.
 </para>
 
  all features are well tested.
 </para>]]>
 <para>
- Please see the <citetitle>user-manual</citetitle> on how to contact the
- developers for feature requests, reporting problems, and other questions.
+ Please see the <citetitle>User Manual</citetitle> on how to contact the
+ developers, for feature requests, reporting problems, and other questions.
 </para>
 
 </refsect1>