Rebuild documentation with the updated contact section
[privoxy.git] / doc / webserver / developer-manual / contact.html
index 1c5345e..16f3f1c 100644 (file)
 
     <p>We value your feedback. In fact, we rely on it to improve <span class=
     "APPLICATION">Privoxy</span> and its configuration. However, please note
-    the following hints, so we can provide you with the best support:</p>
+    the following hints, so we can provide you with the best support.</p>
 
     <div class="SECT2">
-      <h2 class="SECT2"><a name="CONTACT-SUPPORT" id="CONTACT-SUPPORT">8.1.
+      <h2 class="SECT2"><a name="SUFFICIENT-INFORMATION" id=
+      "SUFFICIENT-INFORMATION">8.1. Please provide sufficient
+      information</a></h2>
+
+      <p>A lot of support requests don't contain enough information and can't
+      be solved without a lot of back and forth which causes unnecessary
+      delays. Reading this section should help to prevent that.</p>
+
+      <p>Before contacting us to report a problem, please try to verify that
+      it is a <span class="APPLICATION">Privoxy</span> problem, and not a
+      browser or site problem or documented behaviour that just happens to be
+      different than what you expected. If unsure, try <a href=
+      "http://config.privoxy.org/toggle?set=disable" target="_top">toggling
+      off</a> <span class="APPLICATION">Privoxy</span>, and see if the
+      problem persists.</p>
+
+      <p>If you are using your own custom configuration, please try the
+      default configuration 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.</p>
+
+      <p>If you aren't using the latest Privoxy version, the problem may have
+      been found and fixed in the meantime. We would appreciate if you could
+      take the time to <a href=
+      "http://www.privoxy.org/user-manual/installation.html" target=
+      "_top">upgrade to the latest version</a> and verify that the problem
+      still exists.</p>
+
+      <p>Please be sure to provide the following information when reporting
+      problems or requesting support:</p>
+
+      <ul>
+        <li>
+          <p>The exact <span class="APPLICATION">Privoxy</span> version you
+          are using.</p>
+        </li>
+
+        <li>
+          <p>The operating system and versions you run <span class=
+          "APPLICATION">Privoxy</span> on, e.g. <span class=
+          "APPLICATION">Windows XP SP2</span>.</p>
+        </li>
+
+        <li>
+          <p>The name, platform, and version of the <span class=
+          "APPLICATION">browser</span> you were using (e.g. <span class=
+          "APPLICATION">Internet Explorer v5.5</span> for Mac).</p>
+        </li>
+
+        <li>
+          <p>The URL where the problem occurred, or some way for us to
+          duplicate the problem (e.g. <tt class=
+          "LITERAL">http://somesite.example.com/?somethingelse=123</tt>).</p>
+        </li>
+
+        <li>
+          <p>Whether your version of <span class="APPLICATION">Privoxy</span>
+          is one supplied by the <span class="APPLICATION">Privoxy</span>
+          developers via SourceForge, or if you got your copy somewhere
+          else.</p>
+        </li>
+
+        <li>
+          <p>Whether you are using <span class="APPLICATION">Privoxy</span>
+          together with another proxy such as <span class=
+          "APPLICATION">Tor</span>. If so, please temporary disable the other
+          proxy to see if the symptoms change.</p>
+        </li>
+
+        <li>
+          <p>Whether you are using a personal firewall product. If so, does
+          <span class="APPLICATION">Privoxy</span> work without it?</p>
+        </li>
+
+        <li>
+          <p>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 <a href="../user-manual/config.html#LOGFILE"
+          target="_top">logfile directive</a> is being used and the following
+          <a href="../user-manual/config.html#DEBUG" target="_top">debug
+          options</a> are enabled (all of them):</p>
+
+          <p class="LITERALLAYOUT">
+          debug&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;1&nbsp;#&nbsp;Log&nbsp;the&nbsp;destination&nbsp;for&nbsp;each&nbsp;request&nbsp;Privoxy&nbsp;let&nbsp;through.&nbsp;See&nbsp;also&nbsp;debug&nbsp;1024.<br>
+
+          debug&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;2&nbsp;#&nbsp;show&nbsp;each&nbsp;connection&nbsp;status<br>
+
+          debug&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;4&nbsp;#&nbsp;show&nbsp;I/O&nbsp;status<br>
+
+          debug&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;8&nbsp;#&nbsp;show&nbsp;header&nbsp;parsing<br>
+
+          debug&nbsp;&nbsp;&nbsp;128&nbsp;#&nbsp;debug&nbsp;redirects<br>
+          debug&nbsp;&nbsp;&nbsp;256&nbsp;#&nbsp;debug&nbsp;GIF&nbsp;de-animation<br>
+
+          debug&nbsp;&nbsp;&nbsp;512&nbsp;#&nbsp;Common&nbsp;Log&nbsp;Format<br>
+
+          debug&nbsp;&nbsp;1024&nbsp;#&nbsp;Log&nbsp;the&nbsp;destination&nbsp;for&nbsp;requests&nbsp;Privoxy&nbsp;didn't&nbsp;let&nbsp;through,&nbsp;and&nbsp;the&nbsp;reason&nbsp;why.<br>
+
+          debug&nbsp;&nbsp;4096&nbsp;#&nbsp;Startup&nbsp;banner&nbsp;and&nbsp;warnings.<br>
+
+          debug&nbsp;&nbsp;8192&nbsp;#&nbsp;Non-fatal&nbsp;errors</p>
+
+          <p>If you are having trouble with a filter, please additionally
+          enable</p>
+
+          <p class="LITERALLAYOUT">
+          debug&nbsp;&nbsp;&nbsp;&nbsp;64&nbsp;#&nbsp;debug&nbsp;regular&nbsp;expression&nbsp;filters</p>If
+          you are using Privoxy 3.0.17 or later and suspect that it
+          interprets the request or the response incorrectly, please enable
+
+          <p class="LITERALLAYOUT">
+          debug&nbsp;32768&nbsp;#&nbsp;log&nbsp;all&nbsp;data&nbsp;read&nbsp;from&nbsp;the&nbsp;network</p>
+
+          <p>It's easy for us to ignore log messages that aren't relevant but
+          missing log messages may make it impossible to investigate a
+          problem. If you aren't sure which of the debug directives are
+          relevant, please just enable all of them and let us worry about
+          it.</p>
+
+          <p>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.</p>
+        </li>
+      </ul>
+
+      <p>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.</p>
+
+      <p>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.</p>
+
+      <p>If you are new to reporting problems, you might be interested in
+      <a href="http://www.chiark.greenend.org.uk/~sgtatham/bugs.html" target=
+      "_top">How to Report Bugs Effectively</a>.</p>
+
+      <p>The <a href=
+      "http://www.privoxy.org/user-manual/appendix.html#ACTIONSANAT" target=
+      "_top">appendix of the Privoxy User Manual</a> also has helpful
+      information on understanding <tt class="LITERAL">actions</tt>, and
+      <tt class="LITERAL">action</tt> debugging.</p>
+    </div>
+
+    <div class="SECT2">
+      <h2 class="SECT2"><a name="CONTACT-SUPPORT" id="CONTACT-SUPPORT">8.2.
       Get Support</a></h2>
 
       <p>For casual users, our <a href=
     </div>
 
     <div class="SECT2">
-      <h2 class="SECT2"><a name="REPORTING" id="REPORTING">8.2. Reporting
+      <h2 class="SECT2"><a name="REPORTING" id="REPORTING">8.3. Reporting
       Problems</a></h2>
 
       <p><span class="QUOTE">"Problems"</span> for our purposes, come in two
       </ul>
 
       <div class="SECT3">
-        <h3 class="SECT3"><a name="CONTACT-ADS" id="CONTACT-ADS">8.2.1.
+        <h3 class="SECT3"><a name="CONTACT-ADS" id="CONTACT-ADS">8.3.1.
         Reporting Ads or Other Configuration Problems</a></h3>
 
         <p>Please send feedback on ads that slipped through, innocent images
       </div>
 
       <div class="SECT3">
-        <h3 class="SECT3"><a name="CONTACT-BUGS" id="CONTACT-BUGS">8.2.2.
+        <h3 class="SECT3"><a name="CONTACT-BUGS" id="CONTACT-BUGS">8.3.2.
         Reporting Bugs</a></h3>
 
         <p>Please report all bugs through our bug tracker: <a href=
         target="_top">submit form</a>. If already submitted, please feel free
         to add any info to the original report that might help to solve the
         issue.</p>
-
-        <p>Please try to verify that it is a <span class=
-        "APPLICATION">Privoxy</span> bug, and not a browser or site bug or
-        documented behaviour that just happens to be different than what you
-        expected. If unsure, try <a href=
-        "http://config.privoxy.org/toggle?set=disable" target="_top">toggling
-        off</a> <span class="APPLICATION">Privoxy</span>, and see if the
-        problem persists.</p>
-
-        <p>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.</p>
-
-        <p>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 <a href=
-        "http://www.privoxy.org/user-manual/installation.html" target=
-        "_top">upgrade to the latest version</a> (or even the latest CVS
-        snapshot) and verify that your bug still exists.</p>
-
-        <p>Please be sure to provide the following information:</p>
-
-        <ul>
-          <li>
-            <p>The exact <span class="APPLICATION">Privoxy</span> version you
-            are using (if you got the source from CVS, please also provide
-            the source code revisions as shown in <a href=
-            "http://config.privoxy.org/show-version" target=
-            "_top">http://config.privoxy.org/show-version</a>).</p>
-          </li>
-
-          <li>
-            <p>The operating system and versions you run <span class=
-            "APPLICATION">Privoxy</span> on, (e.g. <span class=
-            "APPLICATION">Windows XP SP2</span>), if you are using a Unix
-            flavor, sending the output of <span class="QUOTE">"uname
-            -a"</span> should do, in case of GNU/Linux, please also name the
-            distribution.</p>
-          </li>
-
-          <li>
-            <p>The name, platform, and version of the <span class=
-            "APPLICATION">browser</span> you were using (e.g. <span class=
-            "APPLICATION">Internet Explorer v5.5</span> for Mac).</p>
-          </li>
-
-          <li>
-            <p>The URL where the problem occurred, or some way for us to
-            duplicate the problem (e.g. <tt class=
-            "LITERAL">http://somesite.example.com/?somethingelse=123</tt>).</p>
-          </li>
-
-          <li>
-            <p>Whether your version of <span class=
-            "APPLICATION">Privoxy</span> is one supplied by the <span class=
-            "APPLICATION">Privoxy</span> developers via SourceForge, or if
-            you got your copy somewhere else.</p>
-          </li>
-
-          <li>
-            <p>Whether you are using <span class="APPLICATION">Privoxy</span>
-            in tandem with another proxy such as <span class=
-            "APPLICATION">Tor</span>. If so, please temporary disable the
-            other proxy to see if the symptoms change.</p>
-          </li>
-
-          <li>
-            <p>Whether you are using a personal firewall product. If so, does
-            <span class="APPLICATION">Privoxy</span> work without it?</p>
-          </li>
-
-          <li>
-            <p>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 <a href=
-            "../user-manual/config.html#LOGFILE" target="_top">logfile
-            directive</a> is being used and the following <a href=
-            "../user-manual/config.html#DEBUG" target="_top">debug
-            options</a> are enabled:</p>
-
-            <p class="LITERALLAYOUT">
-            debug&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;1&nbsp;#&nbsp;Log&nbsp;the&nbsp;destination&nbsp;for&nbsp;each&nbsp;request&nbsp;Privoxy&nbsp;let&nbsp;through.&nbsp;See&nbsp;also&nbsp;debug&nbsp;1024.<br>
-
-            debug&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;2&nbsp;#&nbsp;show&nbsp;each&nbsp;connection&nbsp;status<br>
-
-            debug&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;4&nbsp;#&nbsp;show&nbsp;I/O&nbsp;status<br>
-
-            debug&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;8&nbsp;#&nbsp;show&nbsp;header&nbsp;parsing<br>
-
-            debug&nbsp;&nbsp;&nbsp;128&nbsp;#&nbsp;debug&nbsp;redirects<br>
-            debug&nbsp;&nbsp;&nbsp;256&nbsp;#&nbsp;debug&nbsp;GIF&nbsp;de-animation<br>
-
-            debug&nbsp;&nbsp;&nbsp;512&nbsp;#&nbsp;Common&nbsp;Log&nbsp;Format<br>
-
-            debug&nbsp;&nbsp;1024&nbsp;#&nbsp;Log&nbsp;the&nbsp;destination&nbsp;for&nbsp;requests&nbsp;Privoxy&nbsp;didn't&nbsp;let&nbsp;through,&nbsp;and&nbsp;the&nbsp;reason&nbsp;why.<br>
-
-            debug&nbsp;&nbsp;4096&nbsp;#&nbsp;Startup&nbsp;banner&nbsp;and&nbsp;warnings.<br>
-
-            debug&nbsp;&nbsp;8192&nbsp;#&nbsp;Non-fatal&nbsp;errors</p>If you
-            are having trouble with a filter, please additionally enable
-
-            <p class="LITERALLAYOUT">
-            debug&nbsp;&nbsp;&nbsp;&nbsp;64&nbsp;#&nbsp;debug&nbsp;regular&nbsp;expression&nbsp;filters</p>If
-            you are using Privoxy 3.0.17 or later and suspect that it
-            interprets the request or the response incorrectly, please enable
-
-            <p class="LITERALLAYOUT">
-            debug&nbsp;32768&nbsp;#&nbsp;log&nbsp;all&nbsp;data&nbsp;read&nbsp;from&nbsp;the&nbsp;network</p>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.
-          </li>
-        </ul>
-
-        <p>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.</p>
-
-        <p>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.</p>
-
-        <p>If you are new to reporting problems, you might be interested in
-        <a href="http://www.chiark.greenend.org.uk/~sgtatham/bugs.html"
-        target="_top">How to Report Bugs Effectively</a>.</p>
-
-        <p>The <a href=
-        "http://www.privoxy.org/user-manual/appendix.html#ACTIONSANAT"
-        target="_top">appendix of the Privoxy User Manual</a> also has
-        helpful information on understanding <tt class=
-        "LITERAL">actions</tt>, and <tt class="LITERAL">action</tt>
-        debugging.</p>
       </div>
     </div>
 
     <div class="SECT2">
-      <h2 class="SECT2"><a name="CONTACT-FEATURE" id="CONTACT-FEATURE">8.3.
+      <h2 class="SECT2"><a name="CONTACT-FEATURE" id="CONTACT-FEATURE">8.4.
       Request New Features</a></h2>
 
       <p>You are welcome to submit ideas on new features or other proposals
     </div>
 
     <div class="SECT2">
-      <h2 class="SECT2"><a name="MAILING-LISTS" id="MAILING-LISTS">8.4.
+      <h2 class="SECT2"><a name="MAILING-LISTS" id="MAILING-LISTS">8.5.
       Mailing Lists</a></h2>
 
       <p>If you prefer to communicate through email, instead of using a web