- Ditch the pathetic "and security holes fixed" "feature" which should
[privoxy.git] / doc / source / user-manual.sgml
index de0723f..427cf0f 100644 (file)
 <!entity license SYSTEM "license.sgml">
 <!entity p-authors SYSTEM "p-authors.sgml">
 <!entity config SYSTEM "p-config.sgml">
-<!entity p-version "3.0.7">
-<!entity p-status "beta">
+<!entity p-version "3.0.8">
+<!entity p-status "stable">
 <!entity % p-authors-formal "INCLUDE"> <!-- include additional text, etc  -->
-<!entity % p-not-stable "INCLUDE">
-<!entity % p-stable "IGNORE">
+<!entity % p-not-stable "IGNORE">
+<!entity % p-stable "INCLUDE">
 <!entity % p-text "IGNORE">        <!-- define we are not a text only doc -->
 <!entity % p-doc "INCLUDE">        <!-- and we are a formal doc           -->
 <!entity % p-readme "IGNORE">
@@ -33,9 +33,9 @@
                 This file belongs into
                 ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/
 
- $Id: user-manual.sgml,v 2.47 2007/11/18 14:59:47 fabiankeil Exp $
+ $Id: user-manual.sgml,v 2.54 2008/01/19 17:52:39 hal9 Exp $
 
- Copyright (C) 2001-2007 Privoxy Developers http://www.privoxy.org/
+ Copyright (C) 2001-2008 Privoxy Developers http://www.privoxy.org/
  See LICENSE.
 
  ========================================================================
  <subscript>
 <!-- Completely the wrong markup, but very little is allowed  -->
 <!-- in this part of an article. FIXME -->
- <link linkend="copyright">Copyright</link> &my-copy; 2001 - 2007 by 
+ <link linkend="copyright">Copyright</link> &my-copy; 2001 - 2008 by 
  <ulink url="http://www.privoxy.org/">Privoxy Developers</ulink>
  </subscript>
 </pubdate>
 
-<pubdate>$Id: user-manual.sgml,v 2.47 2007/11/18 14:59:47 fabiankeil Exp $</pubdate>
+<pubdate>$Id: user-manual.sgml,v 2.54 2008/01/19 17:52:39 hal9 Exp $</pubdate>
 
 <!--
 
@@ -589,155 +589,6 @@ How to install the binary packages depends on your operating system:
    </para>
   </listitem>
 
-
-<!-- pre-3.0.6 changes: 
- <listitem>
-  <para>  
-   There are a number of new <link linkend="actions-file">actions</link>:
-  </para>
-  
-  <para>
-  <itemizedlist>
-     
-     <listitem>
-      <para>
-       <literal><link linkend="content-type-overwrite">content-type-overwrite</link></literal>
-      </para>
-     </listitem>
-     <listitem>
-      <para>
-       <literal><link linkend="crunch-client-header">crunch-client-header</link></literal>
-      </para>
-     </listitem>
-     <listitem>
-      <para>
-       <literal><link linkend="crunch-if-none-match">crunch-if-none-match</link></literal>
-      </para>
-     </listitem>
-     <listitem>
-      <para>
-       <literal><link linkend="crunch-server-header">crunch-server-header</link></literal>
-      </para>
-     </listitem>
-     <listitem>
-      <para>
-       <literal><link linkend="filter-client-headers">filter-client-headers</link></literal>
-      </para>
-     </listitem>
-     <listitem>
-      <para>
-       <literal><link linkend="filter-server-headers">filter-server-headers</link></literal>
-      </para>
-     </listitem>
-     <listitem>
-      <para>
-       <literal><link linkend="force-text-mode">force-text-mode</link></literal>
-      </para>
-     </listitem>
-     <listitem>
-      <para>
-       <literal><link linkend="handle-as-empty-document">handle-as-empty-document</link></literal>
-      </para>
-     </listitem>
-     <listitem>
-      <para>
-       <literal><link linkend="hide-accept-language">hide-accept-language</link></literal>
-      </para>
-     </listitem>
-     <listitem>
-      <para>
-       <literal><link linkend="hide-content-disposition">hide-content-disposition</link></literal>
-      </para>
-     </listitem>
-     <listitem>
-      <para>
-       <literal><link linkend="hide-if-modified-since">hide-if-modified-since</link></literal>
-      </para>
-     </listitem>
-    <listitem>
-      <para>
-       <literal><link linkend="inspect-jpegs">inspect-jpegs</link></literal>
-      </para>
-     </listitem>
-     <listitem>
-      <para>
-       <literal><link linkend="overwrite-last-modified">overwrite-last-modified</link></literal>
-      </para>
-     </listitem>
-     <listitem>
-      <para>
-       <literal><link linkend="redirect">redirect</link></literal>
-      </para>
-     </listitem>
-     <listitem>
-      <para>
-       <literal><link linkend="treat-forbidden-connects-like-blocks">treat-forbidden-connects-like-blocks</link></literal>
-      </para>
-     </listitem>
-
-  </itemizedlist>
-  </para>
-  <para>
-     In addition, <literal><link linkend="fast-redirects">fast-redirects</link></literal>
-     has been significantly improved with enhanced syntax.
-  </para>
-   <para>
-     And <literal><link linkend="hide-referrer">hide-referrer</link></literal>
-     has a new option, <literal>conditional block</literal>.
-   </para>
- </listitem>
-
-  <listitem>
-   <para>
-    <application>MS-Windows</application> versions can now be 
-    <link
-    linkend="installation-pack-win">installed and 
-    started as a <emphasis>Windows service</emphasis></link>.
-   </para>
-  </listitem>
-
-  <listitem>
-   <para>
-    <filename>config</filename> has two new options: 
-    <link
-    linkend="enable-remote-http-toggle">enable-remote-http-toggle</link>, 
-    and <link
-    linkend="forwarded-connect-retries">forwarded-connect-retries</link>.
-   </para>
-   <para>
-    And there is improved handling of the <link
-    linkend="user-manual">user-manual</link>
-    option, for placing documentation and help files on the local system.
-   </para>
-  </listitem>
-  
-  <listitem>
-   <para>
-    There are six new <link linkend="FILTER">filters</link>.
-   </para>
-  </listitem>
-
-  <listitem>
-   <para>
-    Actions files problems and suggestions are now being directed to: 
-    <ulink url="http://sourceforge.net/tracker/?group_id=11118&amp;atid=460288">http://sourceforge.net/tracker/?group_id=11118&amp;atid=460288</ulink>.
-    Please use this to report such configuration related problems as missed
-    ads, sites that don't function properly due to one action or another, 
-    innocent images being blocked, etc.
-   </para>
-  </listitem>
-  
-  <listitem>
-   <para>
-    In addition, there are numerous bug fixes and significant enhancements,
-    including error pages should no longer be cached if the problem is fixed,
-    much better DNS error handling, various logging improvements, and 
-    configuration updates for better ad blocking and junk elimination.
-   </para>
-  </listitem>
--->
-
  </itemizedlist>
 </para>
 <para>
@@ -793,10 +644,11 @@ How to install the binary packages depends on your operating system:
  </listitem>
  <listitem>
   <para>
-   Logging is off by default now. If you need logging, it can be turned on
-   in the <link linkend="logfile">config file</link>. You may also want
-   to enable logging until you verified that the new &my-app; version
-   is working as expected.
+   In the default configuration only fatal errors are logged now.
+   You can change that in the <link linkend="DEBUG">debug section</link>
+   of the configuration file. You may also want to enable more verbose
+   logging until you verified that the new &my-app; version is working
+   as expected.
   </para>
  </listitem>
 
@@ -1343,7 +1195,7 @@ How to install the binary packages depends on your operating system:
 </para>
  
 <literallayout>
- <guibutton>Tools</guibutton> -> <guibutton>Options</guibutton> -> <guibutton>General</guibutton> -> <guibutton>Connection Settings</guibutton> -> <guibutton>Manual Proxy Configuration</guibutton>
+ <guibutton>Tools</guibutton> -> <guibutton>Options</guibutton> ->  <guibutton>Advanced</guibutton> -> <guibutton>Network</guibutton> -><guibutton>Connection</guibutton> -> <guibutton>Settings</guibutton>
 
 </literallayout>
 
@@ -1371,7 +1223,7 @@ How to install the binary packages depends on your operating system:
 </literallayout>
 
 <para>
- For <application>Internet Explorer v.5-6</application>: 
+ For <application>Internet Explorer v.5-7</application>: 
 </para>
 
 <literallayout>
@@ -1456,23 +1308,6 @@ How to install the binary packages depends on your operating system:
 </para>
 </sect2>
 
-<!--
- omitting 10/31/06 HB
-
-<sect2 id="start-suse">
-<title>SuSE</title>
-<para>
-We use a script. It will use the file <filename>/etc/privoxy/config</filename>
-as its main configuration file. Note that SuSE starts Privoxy upon booting
-your PC.
-</para>
-<para>
- <screen>
- # rcprivoxy start
-</screen>
-</para>
-</sect2>
--->
 <sect2 id="start-windows">
 <title>Windows</title>
 <para>
@@ -2475,8 +2310,11 @@ for details.
   <term><literal>.example.com</literal></term>
   <listitem>
    <para>
-    matches any domain that <emphasis>ENDS</emphasis> in
-    <literal>.example.com</literal>
+    matches any domain with first-level domain <literal>com</literal>
+    and second-level domain <literal>example</literal>.
+    For example <literal>www.example.com</literal>,
+    <literal>example.com</literal> and <literal>foo.bar.baz.example.com</literal>.
+    Note that it wouldn't match if the second-level domain was <literal>another-example</literal>.
    </para>
   </listitem>
  </varlistentry>
@@ -2485,7 +2323,8 @@ for details.
   <listitem>
    <para>
     matches any domain that <emphasis>STARTS</emphasis> with
-    <literal>www.</literal>
+    <literal>www.</literal> (It also matches the domain
+    <literal>www</literal> but most of the time that doesn't matter.)
    </para>
   </listitem>
  </varlistentry>
@@ -4821,7 +4660,7 @@ new action
  <varlistentry>
   <term>Typical use:</term>
   <listitem>
-   <para>Improve privacy by not embedding the source of the request in the HTTP headers.</para>
+   <para>Improve privacy by not forwarding the source of the request in the HTTP headers.</para>
   </listitem>
  </varlistentry>
 
@@ -4829,8 +4668,7 @@ new action
   <term>Effect:</term>
   <listitem>
    <para>
-    Deletes any existing <quote>X-Forwarded-for:</quote> HTTP header from client requests,
-    and prevents adding a new one.
+    Deletes any existing <quote>X-Forwarded-for:</quote> HTTP header from client requests.
    </para>
   </listitem>
  </varlistentry>
@@ -4856,7 +4694,7 @@ new action
   <term>Notes:</term>
   <listitem>
    <para>
-    It is safe and strongly recommended to leave this on.
+    It is safe and recommended to leave this on.
    </para>
   </listitem>
  </varlistentry>
@@ -9082,6 +8920,31 @@ In file: user.action <guibutton>[ View ]</guibutton> <guibutton>[ Edit ]</guibut
  USA
 
  $Log: user-manual.sgml,v $
+ Revision 2.54  2008/01/19 17:52:39  hal9
+ Re-commit to fix various minor issues for new release.
+
+ Revision 2.53  2008/01/19 15:03:05  hal9
+ Doc sources tagged for 3.0.8 release.
+
+ Revision 2.52  2008/01/17 01:49:51  hal9
+ Change copyright notice for docs s/2007/2008/. All these will be rebuilt soon
+ enough.
+
+ Revision 2.51  2007/12/23 16:48:24  fabiankeil
+ Use more precise example descriptions for the mysterious domain patterns.
+
+ Revision 2.50  2007/12/08 12:44:36  fabiankeil
+ - Remove already commented out pre-3.0.7 changes.
+ - Update the "new log defaults" paragraph.
+
+ Revision 2.49  2007/12/06 18:21:55  fabiankeil
+ Update hide-forwarded-for-headers description.
+
+ Revision 2.48  2007/11/24 19:07:17  fabiankeil
+ - Mention request rewriting.
+ - Enable the conditional-forge paragraph.
+ - Minor rewordings.
+
  Revision 2.47  2007/11/18 14:59:47  fabiankeil
  A few "Note to Upgraders" updates.