provide correct feedback channels
[privoxy.git] / doc / source / user-manual.sgml
index 3c83360..716d685 100644 (file)
@@ -6,7 +6,7 @@
                 This file belongs into
                 ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/
                 
- $Id: user-manual.sgml,v 1.34 2002/03/04 19:32:07 oes Exp $
+ $Id: user-manual.sgml,v 1.39 2002/03/06 16:19:28 hal9 Exp $
 
  Written by and Copyright (C) 2001 the SourceForge
  IJBSWA team.  http://ijbswa.sourceforge.net
@@ -28,7 +28,7 @@ Hal Burgiss <hal@foobox.net>
 <artheader>
 <title>Junkbuster User Manual</title>
 
-<pubdate>$Id: user-manual.sgml,v 1.34 2002/03/04 19:32:07 oes Exp $</pubdate>
+<pubdate>$Id: user-manual.sgml,v 1.39 2002/03/06 16:19:28 hal9 Exp $</pubdate>
 
 <authorgroup>
  <author>
@@ -226,7 +226,7 @@ You can find the latest version of the user manual at  <ulink url="http://ijbswa
 <para>
  <screen>
  tar xzvf ijb_source_* [.tgz or .tar.gz]
- cd ijb_source_2.9.10_beta
+ cd ijb_source_2.9.11_beta
  </screen>
 </para>
 
@@ -446,7 +446,7 @@ configuration section below. HB.)
 
 
 <!--   ~~~~~       New section      ~~~~~     -->
-<sect1 id="configuration"><title>Invoking and Configuring Junkbuster</title>
+<sect1 id="configuration"><title>Invoking and Configuring JunkBuster</title>
 <para>
  For Unix, *BSD and Linux, all configuration files are located in
  <filename>/etc/junkbuster/</filename> by default. For MS Windows, OS/2, and
@@ -565,6 +565,17 @@ configuration section below. HB.)
    option is given, no PID file will be used. Unix only.
   </para>
  </listitem> 
+ <listitem>
+  <para>
+   <emphasis>--user USER</emphasis>
+  
+  </para>
+  <para>
+   After (optionally) writing the PID file, assume the user  ID  of
+   <emphasis>USER</emphasis>.  Exit if the privileges are not sufficient to do
+   so. Unix only.
+  </para>
+ </listitem> 
  <listitem>
   <para>
     <emphasis>configfile</emphasis>
@@ -578,7 +589,6 @@ configuration section below. HB.)
   </para>
  </listitem> 
 
-
  </itemizedlist>
 </para>
 
@@ -710,10 +720,11 @@ configuration section below. HB.)
  apply to requests for each site. Default: Cookies to and from all
  destinations are kept only during the current browser session (i.e. they 
  are not saved to disk). Pop-ups are disabled for all sites. All sites are
- filtered if <quote>re_filterfile</quote> specified. No sites are blocked. An
- empty image is displayed for filtered ads and other images (formerly
- <quote>tinygif</quote>). The syntax of this file is explained in detail <link
- linkend="actionsfile">below</link>.
+ filtered if <quote>re_filterfile</quote> specified according to the 
+ contents of <quote>re_filterfile</quote>. No sites are blocked. The 
+ JunkBuster logo is displayed for filtered ads and other images . The syntax
+ of this file is explained in detail <link
+ linkend="actionsfile">below</link>. 
 </para>
 
 <para>
@@ -735,6 +746,15 @@ configuration section below. HB.)
  content modification, or whatever the developers are playing with :-/
 </para>
 
+<para>
+ Filtering requires buffering the page content, which may appear to slow down
+ page rendering since nothing is displayed until all content has passed 
+ the filters. (It does not really take longer, but seems that way since 
+ the page is not incrementally displayed.) This effect will be more noticeable
+ on slower connections.
+
+</para>
+
 <para>
  <literal>
   <msgtext> 
@@ -2980,19 +3000,29 @@ For RedHat: /etc/rc.d/init.d/junkbuster start
 <sect1 id="contact"><title>Contacting the Developers, Bug Reporting and Feature
 Requests</title>
 <para>
- Please do not use the mailing lists for feature requests or 
- bug reports. They are not as easily tracked this way!
-
+We value your feedback. However, to provide you with the best support,
+please note:
+ <simplelist>
+  <member>Use the <ulink url="http://sourceforge.net/tracker/?group_id=11118&atid=211118">support forum</ulink> to get
+  help.</member>
+  <member>Submit bugs only thru our <ulink url="http://sourceforge.net/tracker/?group_id=11118&atid=111118">bug
+      forum</ulink>. 
+Make sure that the bug has not yet been submitted.  Please try to
+verify that it is a <application>Junkbuster</application> bug, and not
+a browser or site bug first. Also, check to make sure this is not
+already a known bug. If you are using your own custom configuration,
+please try the stock configs to see if the problem is a configuration
+related bug.  And if not using the latest development snapshot, please
+try the latest one. Or even better, CVS sources.
+</member>
+  <member>Submit feature requests only thru our <ulink
+      url="http://sourceforge.net/tracker/?atid=361118&group_id=11118&func=browse">feature request forum</ulink>.</member>
+ </simplelist>
 </para>
 
 <para>
-<!--
-To be filled. mention the support forums as the primary channel of
-communication (bugs, feature requests, etc.)
--->
- Feature requests and other questions should be posted to the <ulink
- url="http://sourceforge.net/tracker/?atid=361118&amp;group_id=11118&amp;func=browse">Feature
- request page</ulink> at SourceForge. There is also an archive there.
+For any other issues, feel free to use the <a
+href="http://sourceforge.net/mail/?group_id=11118">mailing lists</a>.
 </para>
 
 <para>
@@ -3002,15 +3032,6 @@ communication (bugs, feature requests, etc.)
  Archives are available here too.
 </para>
 
-<para>
- Please report bugs, using the form at 
- <ulink url="http://sourceforge.net/tracker/?group_id=11118&amp;atid=111118">Sourceforge</ulink>.
- Please try to verify that it is a <application>Junkbuster</application> bug,
- and not a browser or site bug first. Also, check to make sure this is not
- already a known bug. If you are using your own custom configuration, please
- try the stock configs to see if the problem is a configuration related bug.
-</para>
-
 </sect1>
 
 
@@ -3362,6 +3383,21 @@ communication (bugs, feature requests, etc.)
  Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 
  $Log: user-manual.sgml,v $
+ Revision 1.39  2002/03/06 16:19:28  hal9
+ Note on perceived filtering slowdown per FR.
+
+ Revision 1.38  2002/03/05 23:55:14  hal9
+ Stupid I did it again. Double hyphen in comment breaks jade.
+
+ Revision 1.37  2002/03/05 23:53:49  hal9
+ jade barfs on '- -' embedded in comments. - -user option broke it.
+
+ Revision 1.36  2002/03/05 22:53:28  hal9
+ Add new - - user option.
+
+ Revision 1.35  2002/03/05 00:17:27  hal9
+ Added section on command line options.
+
  Revision 1.34  2002/03/04 19:32:07  oes
  Changed default port to 8118