50109f30ae03a0e1734b35410742dd4c340506d5
[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.24 2011/05/03 10:13:21 fabiankeil Exp $
7
8  Copyright (C) 2001-2011 Privoxy Developers http://www.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 <para>
51  Please don't sent private support requests to individual Privoxy
52  developers, either use the mailing lists or the support trackers.
53 </para>
54
55 <para>
56  If you have to contact a Privoxy developer directly for other reasons,
57  please send a real mail and do not bother with SourceForge's messaging
58  system. Answers to SourceForge messages are usually bounced by SourceForge's
59  mail server in which case the developer wasted time writing a response you
60  don't get. From your point of view it will look like your message has
61  been completely ignored, so this is frustrating for all parties involved.
62 </para>
63
64 <para>
65  Note that the Privoxy mailing lists are moderated. Posts from unsubscribed
66  addresses have to be accepted manually by a moderator. This may cause a
67  delay of several days and if you use a subject that doesn't clearly
68  mention Privoxy or one of its features, your message may be accidentally
69  discarded as spam.
70 </para>
71
72 <para>
73  If you aren't subscribed, you should therefore spend a few seconds
74  to come up with a proper subject. Additionally you should make it clear
75  that you want to get CC'd. Otherwise some responses will be directed to
76  the mailing list only, and you won't see them.
77 </para>
78
79 </sect2>
80
81 <sect2 id="reporting"><title>Reporting Problems</title>
82 <para>
83 <quote>Problems</quote> for our purposes, come in two forms:
84 </para>
85  <itemizedlist>
86
87   <listitem>
88    <para>
89     Configuration issues, such as ads that slip through, or sites that 
90     don't function properly due to one <application>Privoxy</application> 
91     <quote>action</quote> or another being turned <quote>on</quote>.
92    </para>
93   </listitem> 
94
95   <listitem>
96    <para>
97     <quote>Bugs</quote> in the programming code that makes up 
98     <application>Privoxy</application>, such as that might cause a crash.
99    </para>
100   </listitem> 
101 </itemizedlist>
102
103
104 <sect3 id="contact-ads"><title>Reporting Ads or Other Configuration Problems</title>
105 <para>
106  Please send feedback on ads that slipped through, innocent images that were
107  blocked, sites that don't work properly, and other configuration related problem of 
108  <filename>default.action</filename> file, to 
109  <ulink url="http://sourceforge.net/tracker/?group_id=11118&amp;atid=460288">
110  http://sourceforge.net/tracker/?group_id=11118&amp;atid=460288</ulink>,
111  the Actions File Tracker.
112 </para> 
113
114 <para>
115  New, improved <filename>default.action</filename> files may occasionally be made
116  available based on your feedback. These will be announced on the <ulink
117  url="http://lists.sourceforge.net/lists/listinfo/ijbswa-announce">ijbswa-announce</ulink>
118  list and available from our the <ulink
119  url="http://sourceforge.net/project/showfiles.php?group_id=11118">files section</ulink> of
120  our <ulink url="http://sf.net/projects/ijbswa/">project page</ulink>.
121 </para>
122 </sect3>
123
124
125 <sect3 id="contact-bugs"><title>Reporting Bugs</title>
126 <para>
127  Please report all bugs through our bug tracker: 
128  <ulink url="http://sourceforge.net/tracker/?group_id=11118&amp;atid=111118">http://sourceforge.net/tracker/?group_id=11118&amp;atid=111118</ulink>. 
129 </para>
130
131 <para>
132   Before doing so, please make sure that the bug has <emphasis>not already been submitted</emphasis>
133   and observe the additional hints at the top of the <ulink
134   url="http://sourceforge.net/tracker/?func=add&amp;group_id=11118&amp;atid=111118">submit
135   form</ulink>. If already submitted, please feel free to add any info to the 
136   original report that might help to solve the issue.
137 </para>
138
139 <para>
140   Please try to verify that it is a <application>Privoxy</application> bug,
141   and not a browser or site bug or documented behaviour that just happens
142   to be different than what you expected. If unsure,
143   try <ulink url="http://config.privoxy.org/toggle?set=disable">toggling
144   off</ulink> <application>Privoxy</application>, and see if the problem persists.
145 </para>
146
147 <para>
148   If you are using your own custom configuration, please try
149   the stock configs to see if the problem is configuration related.
150   If you're having problems with a feature that is disabled by default,
151   please ask around on the mailing list if others can reproduce the problem.
152 </para>
153
154 <para>
155   If you aren't using the latest Privoxy version, the bug may have been found
156   and fixed in the meantime. We would appreciate if you could take the time
157   to <ulink url="http://www.privoxy.org/user-manual/installation.html">upgrade
158   to the latest version</ulink> (or  even the latest CVS snapshot) and verify
159   that your bug still exists.
160 </para>
161 <para>
162 Please be sure to provide the following information:
163 </para>
164 <para>
165  <itemizedlist>
166
167   <listitem>
168    <para>
169     The exact <application>Privoxy</application> version you are using
170     (if you got the source from CVS, please also provide the source code revisions
171      as shown in <ulink url="http://config.privoxy.org/show-version">http://config.privoxy.org/show-version</ulink>).
172    </para>
173   </listitem> 
174
175   <listitem>
176    <para>
177     The operating system and versions you run
178     <application>Privoxy</application> on, (e.g. <application>Windows
179     XP SP2</application>), if you are using a Unix flavor,
180     sending the output of <quote>uname -a</quote> should do,
181     in case of GNU/Linux, please also name the distribution.
182    </para>
183   </listitem> 
184
185   <listitem>
186    <para>
187     The name, platform, and version of the <application>browser</application> 
188     you were using (e.g. <application>Internet Explorer v5.5</application> for Mac).
189    </para>
190   </listitem>
191
192   <listitem>
193    <para>
194     The URL where the problem occurred, or some way for us to duplicate the
195     problem (e.g. <literal>http://somesite.example.com/?somethingelse=123</literal>). 
196    </para>
197   </listitem> 
198
199   <listitem>
200    <para>
201     Whether your version of <application>Privoxy</application> is one supplied
202     by the <application>Privoxy</application> developers via SourceForge,
203     or if you got your copy somewhere else.
204    </para>
205   </listitem> 
206
207   <listitem>
208    <para>
209     Whether you are using <application>Privoxy</application> in tandem with 
210     another proxy such as <application>Tor</application>. If so, please
211     temporary disable the other proxy to see if the symptoms change.
212    </para>
213   </listitem> 
214
215   <listitem>
216    <para>
217     Whether you are using a personal firewall product. If so, does 
218     <application>Privoxy</application> work without it?
219    </para>
220   </listitem> 
221
222   <listitem>
223    <para>
224     Any other pertinent information to help identify the problem such as config
225     or log file excerpts (yes, you should have log file entries for each
226     action taken). To get a meaningful logfile, please make sure that the
227     <ulink url="../user-manual/config.html#LOGFILE">logfile directive</ulink>
228     is being used and the following <ulink
229     url="../user-manual/config.html#DEBUG">debug options</ulink> are enabled:
230     <literallayout>debug     1 # Log the destination for each request Privoxy let through. See also debug 1024.
231 debug     2 # show each connection status
232 debug     4 # show I/O status
233 debug     8 # show header parsing
234 debug   128 # debug redirects
235 debug   256 # debug GIF de-animation
236 debug   512 # Common Log Format
237 debug  1024 # Log the destination for requests Privoxy didn't let through, and the reason why.
238 debug  4096 # Startup banner and warnings.
239 debug  8192 # Non-fatal errors</literallayout>
240     If you are having trouble with a filter, please additionally enable
241     <literallayout>debug    64 # debug regular expression filters</literallayout>
242     If you are using Privoxy 3.0.17 or later and suspect that it interprets the
243     request or the response incorrectly, please enable
244     <literallayout>debug 32768 # log all data read from the network</literallayout>
245     Note that Privoxy log files may contain sensitive information so please don't
246     submit any logfiles you didn't read first. You can mask sensitive information
247     as long as it's clear that you removed something.
248    </para>
249   </listitem> 
250
251 </itemizedlist>
252 </para>
253
254 <para>
255  You don't have to tell us your actual name when filing a problem
256  report, but if you don't, please use a nickname so we can differentiate
257  between your messages and the ones entered by other "anonymous" users that
258  may respond to your request if they have the same problem or already
259  found a solution. Note that due to spam the trackers may not always
260  allow to post without being logged into SourceForge. If that's the
261  case, you are still free to create a login that isn't directly linked
262  to your name, though.
263 </para>
264
265 <para>
266  Please also check the status of your request a few days after submitting
267  it, as we may request additional information. If you use a SF id,
268  you should automatically get a mail when someone responds to your request.
269  Please don't bother to add an email address when using the tracker.
270  If you prefer to communicate through email, just use one of the mailing
271  lists directly.
272 </para>
273
274 <para>
275   The <ulink url="http://www.privoxy.org/user-manual/appendix.html#ACTIONSANAT">appendix
276   of the Privoxy User Manual</ulink> also has helpful information 
277   on understanding <literal>actions</literal>, and <literal>action</literal> debugging. 
278 </para>
279 </sect3>
280 </sect2>
281
282 <sect2 id="contact-feature"><title>Request New Features</title>
283 <para>
284  You are welcome to submit ideas on new features or other proposals
285  for improvement through our feature request tracker at
286  <ulink url="http://sourceforge.net/tracker/?atid=361118&#38;group_id=11118">http://sourceforge.net/tracker/?atid=361118&#38;group_id=11118</ulink>.
287 </para>
288 </sect2>
289
290 <sect2 id="mailing-lists"><title>Mailing Lists</title>
291 <para>
292 If you prefer to communicate through email, instead of using a web interface,
293 feel free to use one of the mailing lists.
294 To discuss issues that haven't been completely diagnosed yet, please use the Privoxy
295 users list. Technically interested users and people who wish to contribute to
296 the project are always welcome on the developers list.
297 You can find an overview of all <application>Privoxy</application>-related mailing lists,
298 including list archives, at:
299 <ulink url="http://sourceforge.net/mail/?group_id=11118">http://sourceforge.net/mail/?group_id=11118</ulink>.
300 </para>
301 </sect2>