Dump all docs prior to 3.0.6 release. Various minor changes to faq and user
[privoxy.git] / doc / source / contacting.sgml
1 <!--
2  File        :  $Source: /cvsroot/ijbswa/current/doc/source/contacting.sgml,v $
3
4  Purpose     :  Entity included in other project documents.
5                 
6  $Id: contacting.sgml,v 2.9 2006/09/22 13:30:57 fabiankeil Exp $
7
8  Copyright (C) 2001 - 2006 Privoxy Developers http://privoxy.org
9  See LICENSE.
10
11  ======================================================================
12   This file used for inclusion with other documents only.
13  ======================================================================
14
15  This file is included into:
16
17   faq
18   developer-manual
19   README
20   user-manual
21   webserver/index.sgml
22   announce.sgml
23
24 -->
25
26 <!-- READ: -->
27 <!-- Careful of the literallayout tags and finished formatting -->
28
29 <para>
30  We value your feedback. In fact, we rely on it to improve
31  <application>Privoxy</application> and its configuration.
32  However, please note the following hints, so we can 
33  provide you with the best support:
34 </para>
35
36 <sect2 id="contact-support"><title>Get Support</title>
37 <para>
38  For casual users, our 
39  <ulink url="http://sourceforge.net/tracker/?group_id=11118&#38;atid=211118">support forum at SourceForge</ulink>
40  is probably best suited:
41  <ulink url="http://sourceforge.net/tracker/?group_id=11118&#38;atid=211118">http://sourceforge.net/tracker/?group_id=11118&#38;atid=211118</ulink>
42 </para>
43
44 <para>
45  All users are of course welcome to discuss their issues on the <ulink
46  url="http://lists.sourceforge.net/lists/listinfo/ijbswa-users">users
47  mailing list</ulink>, where the developers also hang around.
48 </para>
49
50 </sect2>
51
52 <sect2 id="reporting"><title>Reporting Problems</title>
53 <para>
54 <quote>Problems</quote> for our purposes, come in two forms:
55 </para>
56  <itemizedlist>
57
58   <listitem>
59    <para>
60     Configuration issues, such as ads that slip through, or sites that 
61     don't function properly due to one <application>Privoxy</application> 
62     <quote>action</quote> or another being turned <quote>on</quote>.
63    </para>
64   </listitem> 
65
66   <listitem>
67    <para>
68     <quote>Bugs</quote> in the programming code that makes up 
69     <application>Privoxy</application>, such as that might cause a crash.
70    </para>
71   </listitem> 
72 </itemizedlist>
73
74
75 <sect3 id="contact-ads"><title>Reporting Ads or Other Configuration Problems</title>
76 <para>
77  Please send feedback on ads that slipped through, innocent images that were
78  blocked, sites that don't work properly, and other configuration related problem of 
79  <filename>default.action</filename> file, to 
80  <ulink url="http://sourceforge.net/tracker/?group_id=11118&amp;atid=460288">
81  http://sourceforge.net/tracker/?group_id=11118&amp;atid=460288</ulink>,
82  the Actions File Tracker.
83 </para> 
84
85 <para>
86  New, improved <filename>default.action</filename> files may occasionally be made
87  available based on your feedback. These will be announced on the <ulink
88  url="http://lists.sourceforge.net/lists/listinfo/ijbswa-announce">ijbswa-announce</ulink>
89  list and available from our the <ulink
90  url="http://sourceforge.net/project/showfiles.php?group_id=11118">files section</ulink> of
91  our <ulink url="http://sf.net/projects/ijbswa/">project page</ulink>.
92 </para>
93 </sect3>
94
95
96 <sect3 id="contact-bugs"><title>Reporting Bugs</title>
97 <para>
98  Please report all bugs <emphasis>only</emphasis> through our
99  bug tracker: 
100  <ulink url="http://sourceforge.net/tracker/?group_id=11118&amp;atid=111118">http://sourceforge.net/tracker/?group_id=11118&amp;atid=111118</ulink>. 
101 </para>
102
103 <para>
104   Before doing so, please make sure that the bug has <emphasis>not already been submitted</emphasis>
105   and observe the additional hints at the top of the <ulink
106   url="http://sourceforge.net/tracker/?func=add&amp;group_id=11118&amp;atid=111118">submit
107   form</ulink>. If already submitted, please feel free to add any info to the 
108   original report that might help to solve the issue.
109 </para>
110
111 <para> 
112   Please try to verify that it is a <application>Privoxy</application> bug,
113   and not a browser or site bug first. If unsure,
114   try <ulink url="http://config.privoxy.org/toggle?set=disable">toggling
115   off</ulink> <application>Privoxy</application>, and see if the problem persists.
116   If you are using your own custom configuration, please try
117   the stock configs to see if the problem is configuration related.
118 </para>
119
120 <para>
121   If not using the latest version, the bug may have been found
122   and fixed in the meantime. We would appreciate if you could take the time
123   to <ulink url="http://www.privoxy.org/user-manual/installation.html">upgrade
124   to the latest version</ulink> (or  even the latest CVS snapshot) and verify
125   your bug.
126 </para>
127 <para>
128 Please be sure to provide the following information:
129 </para>
130 <para>
131  <itemizedlist>
132
133   <listitem>
134    <para>
135     The exact <application>Privoxy</application> version of the proxy software
136     (if you got the source from CVS, please also provide the source code revisions
137      as shown in <ulink url="http://config.privoxy.org/show-version">http://config.privoxy.org/show-version</ulink>).
138    </para>
139   </listitem> 
140
141   <listitem>
142    <para>
143     The operating system and versions you run
144     <application>Privoxy</application> on, (e.g. <application>Windows
145     XP SP2</application>), if you are using a Unix flavor,
146     sending the output of <quote>uname -a</quote> should do.
147    </para>
148   </listitem> 
149
150   <listitem>
151    <para>
152     The name, platform, and version of the <application>browser</application> 
153     you were using (e.g. <application>Internet Explorer v5.5</application> for Mac).
154    </para>
155   </listitem>
156
157   <listitem>
158    <para>
159     The URL where the problem occurred, or some way for us to duplicate the
160     problem (e.g. <literal>http://somesite.example.com/?somethingelse=123</literal>). 
161    </para>
162   </listitem> 
163
164   <listitem>
165    <para>
166     Whether your version of <application>Privoxy</application> is one supplied
167     by the developers of <application>Privoxy</application> via SourceForge,
168     or somewhere else.
169    </para>
170   </listitem> 
171
172   <listitem>
173    <para>
174     Whether you are using <application>Privoxy</application> in tandem with 
175     another proxy such as <application>Tor</application>. If so, please try 
176     disabling the other proxy.
177    </para>
178   </listitem> 
179
180   <listitem>
181    <para>
182     Whether you are using a personal firewall product. If so, does 
183     <application>Privoxy</application> work without it?
184    </para>
185   </listitem> 
186
187   <listitem>
188    <para>
189     Any other pertinent information to help identify the problem such as config
190     or log file excerpts (yes, you should have log file entries for each
191     action taken).
192    </para>
193   </listitem> 
194
195   <listitem>
196    <para>
197     <emphasis>Please provide your SF login, or email address</emphasis>, in case we 
198     need to contact you.
199    </para>
200   </listitem> 
201
202 </itemizedlist>
203 </para>
204 <para>
205   The <ulink url="http://www.privoxy.org/user-manual/appendix.html#ACTIONSANAT">appendix
206   of the Privoxy User Manual</ulink> also has helpful information 
207   on understanding <literal>actions</literal>, and <literal>action</literal> debugging. 
208 </para>
209 </sect3>
210 </sect2>
211
212 <sect2 id="contact-feature"><title>Request New Features</title>
213 <para>
214  You are welcome to submit ideas on new features or other proposals
215  for improvement through our feature request tracker at
216  <ulink url="http://sourceforge.net/tracker/?atid=361118&#38;group_id=11118">http://sourceforge.net/tracker/?atid=361118&#38;group_id=11118</ulink>.
217 </para>
218 </sect2>
219
220 <sect2 id="contact-other"><title>Other</title>
221 <para>
222 For any other issues, feel free to use the mailing lists. Technically interested users
223 and people who wish to contribute to the project are also welcome on the developers list!
224 You can find an overview of all <application>Privoxy</application>-related mailing lists,
225 including list archives, at:
226 <ulink url="http://sourceforge.net/mail/?group_id=11118">http://sourceforge.net/mail/?group_id=11118</ulink>.
227 </para>
228 </sect2>