Move Lee to the team section.
[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.13 2008/01/17 01:49:51 hal9 Exp $
7
8  Copyright (C) 2001-2008 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  Note that the Privoxy mailing lists are moderated. Posts from unsubscribed
57  addresses have to be accepted manually by a moderator. This may cause a
58  delay of several days and if you use a subject that doesn't clearly
59  mention Privoxy or one of its features, your message may be accidentally
60  discarded as spam.
61 </para>
62
63 <para>
64  If you aren't subscribed, you should therefore spend a few seconds
65  to come up with a proper subject. Additionally you should make it clear
66  that you want to get CC'd. Otherwise some responses will be directed to
67  the mailing list only, and you won't see them.
68 </para>
69
70 </sect2>
71
72 <sect2 id="reporting"><title>Reporting Problems</title>
73 <para>
74 <quote>Problems</quote> for our purposes, come in two forms:
75 </para>
76  <itemizedlist>
77
78   <listitem>
79    <para>
80     Configuration issues, such as ads that slip through, or sites that 
81     don't function properly due to one <application>Privoxy</application> 
82     <quote>action</quote> or another being turned <quote>on</quote>.
83    </para>
84   </listitem> 
85
86   <listitem>
87    <para>
88     <quote>Bugs</quote> in the programming code that makes up 
89     <application>Privoxy</application>, such as that might cause a crash.
90    </para>
91   </listitem> 
92 </itemizedlist>
93
94
95 <sect3 id="contact-ads"><title>Reporting Ads or Other Configuration Problems</title>
96 <para>
97  Please send feedback on ads that slipped through, innocent images that were
98  blocked, sites that don't work properly, and other configuration related problem of 
99  <filename>default.action</filename> file, to 
100  <ulink url="http://sourceforge.net/tracker/?group_id=11118&amp;atid=460288">
101  http://sourceforge.net/tracker/?group_id=11118&amp;atid=460288</ulink>,
102  the Actions File Tracker.
103 </para> 
104
105 <para>
106  New, improved <filename>default.action</filename> files may occasionally be made
107  available based on your feedback. These will be announced on the <ulink
108  url="http://lists.sourceforge.net/lists/listinfo/ijbswa-announce">ijbswa-announce</ulink>
109  list and available from our the <ulink
110  url="http://sourceforge.net/project/showfiles.php?group_id=11118">files section</ulink> of
111  our <ulink url="http://sf.net/projects/ijbswa/">project page</ulink>.
112 </para>
113 </sect3>
114
115
116 <sect3 id="contact-bugs"><title>Reporting Bugs</title>
117 <para>
118  Please report all bugs through our bug tracker: 
119  <ulink url="http://sourceforge.net/tracker/?group_id=11118&amp;atid=111118">http://sourceforge.net/tracker/?group_id=11118&amp;atid=111118</ulink>. 
120 </para>
121
122 <para>
123   Before doing so, please make sure that the bug has <emphasis>not already been submitted</emphasis>
124   and observe the additional hints at the top of the <ulink
125   url="http://sourceforge.net/tracker/?func=add&amp;group_id=11118&amp;atid=111118">submit
126   form</ulink>. If already submitted, please feel free to add any info to the 
127   original report that might help to solve the issue.
128 </para>
129
130 <para>
131   Please try to verify that it is a <application>Privoxy</application> bug,
132   and not a browser or site bug or documented behaviour that just happens
133   to be different than what you expected. If unsure,
134   try <ulink url="http://config.privoxy.org/toggle?set=disable">toggling
135   off</ulink> <application>Privoxy</application>, and see if the problem persists.
136 </para>
137
138 <para>
139   If you are using your own custom configuration, please try
140   the stock configs to see if the problem is configuration related.
141   If you're having problems with a feature that is disabled by default,
142   please ask around on the mailing list if others can reproduce the problem.
143 </para>
144
145 <para>
146   If you aren't using the latest Privoxy version, the bug may have been found
147   and fixed in the meantime. We would appreciate if you could take the time
148   to <ulink url="http://www.privoxy.org/user-manual/installation.html">upgrade
149   to the latest version</ulink> (or  even the latest CVS snapshot) and verify
150   that your bug still exists.
151 </para>
152 <para>
153 Please be sure to provide the following information:
154 </para>
155 <para>
156  <itemizedlist>
157
158   <listitem>
159    <para>
160     The exact <application>Privoxy</application> version you are using
161     (if you got the source from CVS, please also provide the source code revisions
162      as shown in <ulink url="http://config.privoxy.org/show-version">http://config.privoxy.org/show-version</ulink>).
163    </para>
164   </listitem> 
165
166   <listitem>
167    <para>
168     The operating system and versions you run
169     <application>Privoxy</application> on, (e.g. <application>Windows
170     XP SP2</application>), if you are using a Unix flavor,
171     sending the output of <quote>uname -a</quote> should do,
172     in case of GNU/Linux, please also name the distribution.
173    </para>
174   </listitem> 
175
176   <listitem>
177    <para>
178     The name, platform, and version of the <application>browser</application> 
179     you were using (e.g. <application>Internet Explorer v5.5</application> for Mac).
180    </para>
181   </listitem>
182
183   <listitem>
184    <para>
185     The URL where the problem occurred, or some way for us to duplicate the
186     problem (e.g. <literal>http://somesite.example.com/?somethingelse=123</literal>). 
187    </para>
188   </listitem> 
189
190   <listitem>
191    <para>
192     Whether your version of <application>Privoxy</application> is one supplied
193     by the <application>Privoxy</application> developers via SourceForge,
194     or if you got your copy somewhere else.
195    </para>
196   </listitem> 
197
198   <listitem>
199    <para>
200     Whether you are using <application>Privoxy</application> in tandem with 
201     another proxy such as <application>Tor</application>. If so, please
202     temporary disable the other proxy to see if the symptoms change.
203    </para>
204   </listitem> 
205
206   <listitem>
207    <para>
208     Whether you are using a personal firewall product. If so, does 
209     <application>Privoxy</application> work without it?
210    </para>
211   </listitem> 
212
213   <listitem>
214    <para>
215     Any other pertinent information to help identify the problem such as config
216     or log file excerpts (yes, you should have log file entries for each
217     action taken).
218    </para>
219   </listitem> 
220
221 </itemizedlist>
222 </para>
223
224 <para>
225  You don't have to tell us your actual name when filing a problem
226  report, but please use a nickname so we can differentiate between
227  your messages and the ones entered by other "anonymous" users that
228  may respond to your request if they have the same problem or already
229  found a solution.
230 </para>
231
232 <para>
233  Please also check the status of your request a few days after submitting
234  it, as we may request additional information. If you use a SF id,
235  you should automatically get a mail when someone responds to your request.
236 </para>
237
238 <para>
239   The <ulink url="http://www.privoxy.org/user-manual/appendix.html#ACTIONSANAT">appendix
240   of the Privoxy User Manual</ulink> also has helpful information 
241   on understanding <literal>actions</literal>, and <literal>action</literal> debugging. 
242 </para>
243 </sect3>
244 </sect2>
245
246 <sect2 id="contact-feature"><title>Request New Features</title>
247 <para>
248  You are welcome to submit ideas on new features or other proposals
249  for improvement through our feature request tracker at
250  <ulink url="http://sourceforge.net/tracker/?atid=361118&#38;group_id=11118">http://sourceforge.net/tracker/?atid=361118&#38;group_id=11118</ulink>.
251 </para>
252 </sect2>
253
254 <sect2 id="contact-other"><title>Other</title>
255 <para>
256 For any other issues, feel free to use the mailing lists. Technically interested users
257 and people who wish to contribute to the project are also welcome on the developers list!
258 You can find an overview of all <application>Privoxy</application>-related mailing lists,
259 including list archives, at:
260 <ulink url="http://sourceforge.net/mail/?group_id=11118">http://sourceforge.net/mail/?group_id=11118</ulink>.
261 </para>
262 </sect2>