Rename the 'Other' section to 'Mailing Lists' and reword it to make it clear that...
[privoxy.git] / doc / source / contacting.sgml
index daa5fc2..9701dd4 100644 (file)
@@ -3,14 +3,10 @@
 
  Purpose     :  Entity included in other project documents.
                 
- $Id: contacting.sgml,v 1.8 2002/04/12 10:20:58 swa Exp $
+ $Id: contacting.sgml,v 2.19 2010/11/13 10:06:41 fabiankeil Exp $
 
- Written by and Copyright (C) 2001 the SourceForge
- Privoxy team. http://www.privoxy.org/
-
- Based on the Internet Junkbuster originally written
- by and Copyright (C) 1997 Anonymous Coders and 
- Junkbusters Corporation.  http://www.junkbusters.com
+ Copyright (C) 2001-2010 Privoxy Developers http://www.privoxy.org/
+ See LICENSE.
 
  ======================================================================
   This file used for inclusion with other documents only.
   README
   user-manual
   webserver/index.sgml
+  announce.sgml
 
 -->
 
 <!-- READ: -->
-<!-- Careful of the literllayout tags and finished formatting -->
+<!-- Careful of the literallayout tags and finished formatting -->
+
+<para>
+ We value your feedback. In fact, we rely on it to improve
+ <application>Privoxy</application> and its configuration.
+ However, please note the following hints, so we can 
+ provide you with the best support:
+</para>
+
+<sect2 id="contact-support"><title>Get Support</title>
+<para>
+ For casual users, our 
+ <ulink url="http://sourceforge.net/tracker/?group_id=11118&#38;atid=211118">support forum at SourceForge</ulink>
+ is probably best suited:
+ <ulink url="http://sourceforge.net/tracker/?group_id=11118&#38;atid=211118">http://sourceforge.net/tracker/?group_id=11118&#38;atid=211118</ulink>
+</para>
 
 <para>
- We value your feedback. However, to provide you with the best support, please
- note:
+ All users are of course welcome to discuss their issues on the <ulink
+ url="http://lists.sourceforge.net/lists/listinfo/ijbswa-users">users
+ 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>
+<para>
+<quote>Problems</quote> for our purposes, come in two forms:
+</para>
  <itemizedlist>
 
   <listitem>
-   <literallayout class="normal">
-Use the Sourceforge Support Forum to get help:
-   
-    <ulink url="http://sourceforge.net/tracker/?group_id=11118&#38;atid=211118">http://sourceforge.net/tracker/?group_id=11118&#38;atid=211118</ulink>
-   </literallayout>
-  </listitem>
+   <para>
+    Configuration issues, such as ads that slip through, or sites that 
+    don't function properly due to one <application>Privoxy</application> 
+    <quote>action</quote> or another being turned <quote>on</quote>.
+   </para>
+  </listitem> 
+
   <listitem>
-   <literallayout class="normal">
-Submit bugs only through our Sourceforge Bug Forum:
-    <ulink url="http://sourceforge.net/tracker/?group_id=11118&#38;atid=111118">http://sourceforge.net/tracker/?group_id=11118&#38;atid=111118</ulink>. 
-    </literallayout>
-  <para>
-   Make sure that the bug has not already been submitted.  Please try to
-   verify that it is a <application>Privoxy</application> bug, and not a
-   browser or site bug first. 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. Please be sure to include the
-   <application>Privoxy</application>/<application>Junkbuster</application>
-   version, platform, browser, any pertinent log data, any other relevant
-   details (please be specific) and, if possible, some way to reproduce the
-   bug.
-  </para>
- </listitem>
+   <para>
+    <quote>Bugs</quote> in the programming code that makes up 
+    <application>Privoxy</application>, such as that might cause a crash.
+   </para>
+  </listitem> 
+</itemizedlist>
+
+
+<sect3 id="contact-ads"><title>Reporting Ads or Other Configuration Problems</title>
+<para>
+ Please send feedback on ads that slipped through, innocent images that were
+ blocked, sites that don't work properly, and other configuration related problem of 
+ <filename>default.action</filename> file, to 
+ <ulink url="http://sourceforge.net/tracker/?group_id=11118&amp;atid=460288">
+ http://sourceforge.net/tracker/?group_id=11118&amp;atid=460288</ulink>,
+ the Actions File Tracker.
+</para> 
+
+<para>
+ New, improved <filename>default.action</filename> files may occasionally be made
+ available based on your feedback. These will be announced on the <ulink
+ url="http://lists.sourceforge.net/lists/listinfo/ijbswa-announce">ijbswa-announce</ulink>
+ list and available from our the <ulink
+ url="http://sourceforge.net/project/showfiles.php?group_id=11118">files section</ulink> of
+ our <ulink url="http://sf.net/projects/ijbswa/">project page</ulink>.
+</para>
+</sect3>
+
+
+<sect3 id="contact-bugs"><title>Reporting Bugs</title>
+<para>
+ 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>
+
+<para>
+  Before doing so, please make sure that the bug has <emphasis>not already been submitted</emphasis>
+  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 to solve the issue.
+</para>
+
+<para>
+  Please try to verify that it is a <application>Privoxy</application> bug,
+  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 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
+  that your bug still exists.
+</para>
+<para>
+Please be sure to provide the following information:
+</para>
+<para>
+ <itemizedlist>
+
   <listitem>
-   <literallayout class="normal">
-Submit feature requests only through our Sourceforge feature request forum:
-    <ulink url="http://sourceforge.net/tracker/?atid=361118&#38;group_id=11118&#38;func=browse"></ulink>.
-   </literallayout>
-  </listitem>
+   <para>
+    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> 
 
+  <listitem>
+   <para>
+    The operating system and versions you run
+    <application>Privoxy</application> on, (e.g. <application>Windows
+    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> 
 
   <listitem>
-   <literallayout class="normal">
-You can also send feedback on websites that Privoxy has problems with. Please bookmark
-the following link: <ulink url="javascript:w=Math.floor(screen.width/2);h=Math.floor(screen.height*0.9);void(window.open('http://www.privoxy.org/actions','Feedback','screenx='+w+',width='+w+',height='+h+',scrollbars=yes,toolbar=no,location=no,directories=no,status=no,menubar=no,copyhistory=no').focus());"><quote>Privoxy - Submit Filter Feedback</quote></ulink>. Once you surf to a page with problems, use the
-bookmark to send us feedback. We will look into the issue as soon as possible.
-   </literallayout>
+   <para>
+    The name, platform, and version of the <application>browser</application> 
+    you were using (e.g. <application>Internet Explorer v5.5</application> for Mac).
+   </para>
   </listitem>
 
+  <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>). 
+   </para>
+  </listitem> 
+
+  <listitem>
+   <para>
+    Whether your version of <application>Privoxy</application> is one supplied
+    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
+    temporary disable the other proxy to see if the symptoms change.
+   </para>
+  </listitem> 
+
+  <listitem>
+   <para>
+    Whether you are using a personal firewall product. If so, does 
+    <application>Privoxy</application> work without it?
+   </para>
+  </listitem> 
+
+  <listitem>
+   <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). 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>
 
- <listitem>
-   <literallayout class="normal">
-For any other issues, feel free to use the mailing lists:
-    <ulink url="http://sourceforge.net/mail/?group_id=11118">http://sourceforge.net/mail/?group_id=11118</ulink>.
- </literallayout>
- <para>
-  Anyone interested in actively participating in development and related
-  discussions can also join the appropriate mailing list. Archives are
-  available, too. 
- </para>
- </listitem>
+<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>
 
- </itemizedlist>
+<para>
+  The <ulink url="http://www.privoxy.org/user-manual/appendix.html#ACTIONSANAT">appendix
+  of the Privoxy User Manual</ulink> also has helpful information 
+  on understanding <literal>actions</literal>, and <literal>action</literal> debugging. 
 </para>
+</sect3>
+</sect2>
 
+<sect2 id="contact-feature"><title>Request New Features</title>
+<para>
+ You are welcome to submit ideas on new features or other proposals
+ for improvement through our feature request tracker at
+ <ulink url="http://sourceforge.net/tracker/?atid=361118&#38;group_id=11118">http://sourceforge.net/tracker/?atid=361118&#38;group_id=11118</ulink>.
+</para>
+</sect2>
+
+<sect2 id="mailing-lists"><title>Mailing Lists</title>
+<para>
+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>.
+</para>
+</sect2>