Rename the 'Other' section to 'Mailing Lists' and reword it to make it clear that...
[privoxy.git] / doc / source / contacting.sgml
index 59a8986..9701dd4 100644 (file)
@@ -3,9 +3,9 @@
 
  Purpose     :  Entity included in other project documents.
                 
- $Id: contacting.sgml,v 2.6 2006/08/27 22:01:55 hal9 Exp $
+ $Id: contacting.sgml,v 2.19 2010/11/13 10:06:41 fabiankeil Exp $
 
- Copyright (C) 2001 - 2006 Privoxy Developers <developers@privoxy.org>
+ Copyright (C) 2001-2010 Privoxy Developers http://www.privoxy.org/
  See LICENSE.
 
  ======================================================================
  mailing list</ulink>, where the developers also hang around.
 </para>
 
+<para>
+ Please don't sent private support requests to individual Privoxy
+ developers, either use the mailing lists or the support trackers.
+</para>
+
+<para>
+ Note that the Privoxy mailing lists are moderated. Posts from unsubscribed
+ addresses have to be accepted manually by a moderator. This may cause a
+ delay of several days and if you use a subject that doesn't clearly
+ mention Privoxy or one of its features, your message may be accidentally
+ discarded as spam.
+</para>
+
+<para>
+ If you aren't subscribed, you should therefore spend a few seconds
+ to come up with a proper subject. Additionally you should make it clear
+ that you want to get CC'd. Otherwise some responses will be directed to
+ the mailing list only, and you won't see them.
+</para>
+
 </sect2>
 
 <sect2 id="reporting"><title>Reporting Problems</title>
 
 <sect3 id="contact-bugs"><title>Reporting Bugs</title>
 <para>
- Please report all bugs <emphasis>only</emphasis> through our
- bug tracker: 
+ Please report all bugs through our bug tracker: 
  <ulink url="http://sourceforge.net/tracker/?group_id=11118&amp;atid=111118">http://sourceforge.net/tracker/?group_id=11118&amp;atid=111118</ulink>. 
 </para>
 
   and observe the additional hints at the top of the <ulink
   url="http://sourceforge.net/tracker/?func=add&amp;group_id=11118&amp;atid=111118">submit
   form</ulink>. If already submitted, please feel free to add any info to the 
-  original report that might help solve the issue.
+  original report that might help to solve the issue.
 </para>
 
-<para> 
+<para>
   Please try to verify that it is a <application>Privoxy</application> bug,
-  and not a browser or site bug first. If unsure,
-  try <ulink url="javascript:void(window.open('http://config.privoxy.org/toggle?mini=y&amp;set=disabled','ijbstatus','width=250,height=100,resizable=yes,scrollbars=no,toolbar=no,location=no,directories=no,status=no,menubar=no,copyhistory=no').focus());">toggling
+  and not a browser or site bug or documented behaviour that just happens
+  to be different than what you expected. If unsure,
+  try <ulink url="http://config.privoxy.org/toggle?set=disable">toggling
   off</ulink> <application>Privoxy</application>, and see if the problem persists.
+</para>
+
+<para>
   If you are using your own custom configuration, please try
   the stock configs to see if the problem is configuration related.
+  If you're having problems with a feature that is disabled by default,
+  please ask around on the mailing list if others can reproduce the problem.
 </para>
 
 <para>
-  If not using the latest version, the bug may have been found
+  If you aren't using the latest Privoxy version, the bug may have been found
   and fixed in the meantime. We would appreciate if you could take the time
   to <ulink url="http://www.privoxy.org/user-manual/installation.html">upgrade
   to the latest version</ulink> (or  even the latest CVS snapshot) and verify
-  your bug.
+  that your bug still exists.
 </para>
 <para>
 Please be sure to provide the following information:
@@ -132,8 +157,9 @@ Please be sure to provide the following information:
 
   <listitem>
    <para>
-    The exact <application>Privoxy</application> version of the proxy software
-(if you got the source from CVS, please also give the date).
+    The exact <application>Privoxy</application> version you are using
+    (if you got the source from CVS, please also provide the source code revisions
+     as shown in <ulink url="http://config.privoxy.org/show-version">http://config.privoxy.org/show-version</ulink>).
    </para>
   </listitem> 
 
@@ -141,7 +167,9 @@ Please be sure to provide the following information:
    <para>
     The operating system and versions you run
     <application>Privoxy</application> on, (e.g. <application>Windows
-    XP</application>).
+    XP SP2</application>), if you are using a Unix flavor,
+    sending the output of <quote>uname -a</quote> should do,
+    in case of GNU/Linux, please also name the distribution.
    </para>
   </listitem> 
 
@@ -155,23 +183,23 @@ Please be sure to provide the following information:
   <listitem>
    <para>
     The URL where the problem occurred, or some way for us to duplicate the
-    problem (e.g. <literal>http://somesite.example.com?somethingelse=123</literal>). 
+    problem (e.g. <literal>http://somesite.example.com/?somethingelse=123</literal>). 
    </para>
   </listitem> 
 
   <listitem>
    <para>
     Whether your version of <application>Privoxy</application> is one supplied
-    by the developers of <application>Privoxy</application> via SourceForge,
-    or somewhere else.
+    by the <application>Privoxy</application> developers via SourceForge,
+    or if you got your copy somewhere else.
    </para>
   </listitem> 
 
   <listitem>
    <para>
     Whether you are using <application>Privoxy</application> in tandem with 
-    another proxy such as <application>TOR</application>. If so, please try 
-    disabling the other proxy.
+    another proxy such as <application>Tor</application>. If so, please
+    temporary disable the other proxy to see if the symptoms change.
    </para>
   </listitem> 
 
@@ -186,22 +214,57 @@ Please be sure to provide the following information:
    <para>
     Any other pertinent information to help identify the problem such as config
     or log file excerpts (yes, you should have log file entries for each
-    action taken).
-   </para>
-  </listitem> 
-
-  <listitem>
-   <para>
-    <emphasis>Please provide your SF login, or email address</emphasis>, in case we 
-    need to contact you.
+    action taken). To get a meaningful logfile, please make sure that the
+    <ulink url="../user-manual/config.html#LOGFILE">logfile directive</ulink>
+    is being used and the following <ulink
+    url="../user-manual/config.html#DEBUG">debug options</ulink> are enabled:
+    <literallayout>debug     1 # Log the destination for each request Privoxy let through. See also debug 1024.
+debug     2 # show each connection status
+debug     4 # show I/O status
+debug     8 # show header parsing
+debug   128 # debug redirects
+debug   256 # debug GIF de-animation
+debug   512 # Common Log Format
+debug  1024 # Log the destination for requests Privoxy didn't let through, and the reason why.
+debug  4096 # Startup banner and warnings.
+debug  8192 # Non-fatal errors</literallayout>
+    If you are having trouble with a filter, please additionally enable
+    <literallayout>debug    64 # debug regular expression filters</literallayout>
+    If you using Privoxy 3.0.17 or later and suspect that it interprets the
+    request or the response incorrectly, please enable
+    <literallayout>debug 32768 # log all data read from the network</literallayout>
+    Note that Privoxy log files may contain sensitive information so please don't
+    submit any logfiles you didn't read first. You can mask sensitive information
+    as long as it's clear that you removed something.
    </para>
   </listitem> 
 
 </itemizedlist>
 </para>
+
+<para>
+ You don't have to tell us your actual name when filing a problem
+ report, but if you don't, please use a nickname so we can differentiate
+ between your messages and the ones entered by other "anonymous" users that
+ may respond to your request if they have the same problem or already
+ found a solution. Note that due to spam the trackers may not always
+ allow to post without being logged into SourceForge, if that's the
+ case you are still free to create a login that isn't directly linked
+ to your name, though.
+</para>
+
+<para>
+ Please also check the status of your request a few days after submitting
+ it, as we may request additional information. If you use a SF id,
+ you should automatically get a mail when someone responds to your request.
+ Please don't bother to add an email address when using the tracker,
+ if you prefer to communicate through email, just use one of the mailing
+ lists directly.
+</para>
+
 <para>
   The <ulink url="http://www.privoxy.org/user-manual/appendix.html#ACTIONSANAT">appendix
-  of the user manual</ulink> also has helpful information 
+  of the Privoxy User Manual</ulink> also has helpful information 
   on understanding <literal>actions</literal>, and <literal>action</literal> debugging. 
 </para>
 </sect3>
@@ -215,10 +278,13 @@ Please be sure to provide the following information:
 </para>
 </sect2>
 
-<sect2 id="contact-other"><title>Other</title>
+<sect2 id="mailing-lists"><title>Mailing Lists</title>
 <para>
-For any other issues, feel free to use the mailing lists. Technically interested users
-and people who wish to contribute to the project are also welcome on the developers list!
+If you prefer to communicate through email, instead of using a web interface,
+feel free to use one of the mailing lists.
+To discuss issues that haven't been completely diagnosed, please use the Privoxy
+users list. Technically interested users and people who wish to contribute to
+the project are always welcome on the developers list.
 You can find an overview of all <application>Privoxy</application>-related mailing lists,
 including list archives, at:
 <ulink url="http://sourceforge.net/mail/?group_id=11118">http://sourceforge.net/mail/?group_id=11118</ulink>.