Fix a typo
[privoxy.git] / README
1 /*********************************************************************
2  *
3  * File        :  $Source: /cvsroot/ijbswa/current/README,v $
4  *
5  * Purpose     :  README file to give a short intro.
6  *
7  * Copyright   :  Written by and Copyright (C) 2001-2011 the
8  *                Privoxy team. http://www.privoxy.org/
9  *
10  *                Based on the Internet Junkbuster originally written
11  *                by and Copyright (C) 1997 Anonymous Coders and
12  *                Junkbusters Corporation.  http://www.junkbusters.com
13  *
14  *                This program is free software; you can redistribute it
15  *                and/or modify it under the terms of the GNU General
16  *                Public License as published by the Free Software
17  *                Foundation; either version 2 of the License, or (at
18  *                your option) any later version.
19  *
20  *                This program is distributed in the hope that it will
21  *                be useful, but WITHOUT ANY WARRANTY; without even the
22  *                implied warranty of MERCHANTABILITY or FITNESS FOR A
23  *                PARTICULAR PURPOSE.  See the GNU General Public
24  *                License for more details.
25  *
26  *                The GNU General Public License should be included with
27  *                this file.  If not, you can view it at
28  *                http://www.gnu.org/copyleft/gpl.html
29  *                or write to the Free Software Foundation, Inc.,
30  *                51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
31  *                USA
32  *
33  *********************************************************************/
34
35 This README is included with the development version of Privoxy 3.0.20. See
36 http://www.privoxy.org/ for more information. The current code maturity level
37 is "beta", but seems stable to us :).
38
39 -------------------------------------------------------------------------------
40
41 Privoxy is a non-caching web proxy with advanced filtering capabilities for
42 enhancing privacy, modifying web page data and HTTP headers, controlling
43 access, and removing ads and other obnoxious Internet junk. Privoxy has a
44 flexible configuration and can be customized to suit individual needs and
45 tastes. It has application for both stand-alone systems and multi-user
46 networks.
47
48 Privoxy is Free Software and licensed under the GNU GPLv2.
49
50 Privoxy is an associated project of Software in the Public Interest (SPI).
51
52 Helping hands and donations are welcome:
53
54   * http://www.privoxy.org/faq/general.html#PARTICIPATE
55
56   * http://www.privoxy.org/faq/general.html#DONATE
57
58 -------------------------------------------------------------------------------
59
60 1. CHANGES
61
62 For a list of changes in this release, please have a look at the "ChangeLog",
63 the "What's New" section or the "Upgrader's Notes" in the User Manual.
64
65 -------------------------------------------------------------------------------
66
67 2. INSTALL
68
69 See the INSTALL file in this directory, for installing from raw source, and the
70 User Manual, for all other installation types.
71
72 -------------------------------------------------------------------------------
73
74 3. RUN
75
76 privoxy [--help] [--version] [--no-daemon] [--pidfile PIDFILE] [--user USER
77 [.GROUP]] [--chroot] [--pre-chroot-nslookup HOSTNAME ][config_file]
78
79 See the man page or User Manual for an explanation of each option, and other
80 configuration and usage issues.
81
82 If no config_file is specified on the command line, Privoxy will look for a
83 file named 'config' in the current directory (except Win32 which will look for
84 'config.txt'). If no config_file is found, Privoxy will fail to start.
85
86 -------------------------------------------------------------------------------
87
88 4. CONFIGURATION
89
90 See: 'config', 'default.action', 'user.action', 'default.filter', and
91 'user.filter'. 'user.action' and 'user.filter' are for personal and local
92 configuration preferences. These are all well commented. Most of the magic is
93 in '*.action' files. 'user.action' should be used for any actions
94 customizations. On Unix-like systems, these files are typically installed in /
95 etc/privoxy. On Windows, then wherever the executable itself is installed.
96 There are many significant changes and advances from earlier versions. The User
97 Manual has an explanation of all configuration options, and examples: http://
98 www.privoxy.org/user-manual/.
99
100 Be sure to set your browser(s) for HTTP/HTTPS Proxy at <IP>:<Port>, or whatever
101 you specify in the config file under 'listen-address'. DEFAULT is
102 127.0.0.1:8118. Note that Privoxy ONLY proxies HTTP (and HTTPS) traffic. Do not
103 try it with FTP or other protocols for the simple reason it does not work.
104
105 The actions list can be configured via the web interface accessed via http://
106 p.p/, as well other options.
107
108 All configuration files are subject to unannounced changes during the
109 development process.
110
111 -------------------------------------------------------------------------------
112
113 5. DOCUMENTATION
114
115 There should be documentation in the 'doc' subdirectory, but it may not be
116 completed at this point. In particular, see the User Manual there, the FAQ, and
117 those interested in Privoxy development, should look at developer-manual.
118
119 The most up to date source of information on the current development version,
120 may still be either comments in the source code, or the included configuration
121 files. The source and configuration files are all well commented. The main
122 configuration files are: 'config', 'default.action', and 'default.filter' in
123 the top-level source directory.
124
125 Included documentation may vary according to platform and packager. All
126 documentation is posted on http://www.privoxy.org, in case you don't have it,
127 or can't find it.
128
129 -------------------------------------------------------------------------------
130
131 6. CONTACTING THE DEVELOPERS, BUG REPORTING AND FEATURE REQUESTS
132
133 We value your feedback. In fact, we rely on it to improve Privoxy and its
134 configuration. However, please note the following hints, so we can provide you
135 with the best support:
136
137 -------------------------------------------------------------------------------
138
139 6.1. Get Support
140
141 For casual users, our support forum at SourceForge is probably best suited:
142 http://sourceforge.net/tracker/?group_id=11118&atid=211118
143
144 All users are of course welcome to discuss their issues on the users mailing
145 list, where the developers also hang around.
146
147 Please don't sent private support requests to individual Privoxy developers,
148 either use the mailing lists or the support trackers.
149
150 If you have to contact a Privoxy developer directly for other reasons, please
151 send a real mail and do not bother with SourceForge's messaging system. Answers
152 to SourceForge messages are usually bounced by SourceForge's mail server in
153 which case the developer wasted time writing a response you don't get. From
154 your point of view it will look like your message has been completely ignored,
155 so this is frustrating for all parties involved.
156
157 Note that the Privoxy mailing lists are moderated. Posts from unsubscribed
158 addresses have to be accepted manually by a moderator. This may cause a delay
159 of several days and if you use a subject that doesn't clearly mention Privoxy
160 or one of its features, your message may be accidentally discarded as spam.
161
162 If you aren't subscribed, you should therefore spend a few seconds to come up
163 with a proper subject. Additionally you should make it clear that you want to
164 get CC'd. Otherwise some responses will be directed to the mailing list only,
165 and you won't see them.
166
167 -------------------------------------------------------------------------------
168
169 6.2. Reporting Problems
170
171 "Problems" for our purposes, come in two forms:
172
173   * Configuration issues, such as ads that slip through, or sites that don't
174     function properly due to one Privoxy "action" or another being turned "on".
175
176   * "Bugs" in the programming code that makes up Privoxy, such as that might
177     cause a crash.
178
179 -------------------------------------------------------------------------------
180
181 6.2.1. Reporting Ads or Other Configuration Problems
182
183 Please send feedback on ads that slipped through, innocent images that were
184 blocked, sites that don't work properly, and other configuration related
185 problem of default.action file, to http://sourceforge.net/tracker/?group_id=
186 11118&atid=460288, the Actions File Tracker.
187
188 New, improved default.action files may occasionally be made available based on
189 your feedback. These will be announced on the ijbswa-announce list and
190 available from our the files section of our project page.
191
192 -------------------------------------------------------------------------------
193
194 6.2.2. Reporting Bugs
195
196 Please report all bugs through our bug tracker: http://sourceforge.net/tracker
197 /?group_id=11118&atid=111118.
198
199 Before doing so, please make sure that the bug has not already been submitted
200 and observe the additional hints at the top of the submit form. If already
201 submitted, please feel free to add any info to the original report that might
202 help to solve the issue.
203
204 Please try to verify that it is a Privoxy bug, and not a browser or site bug or
205 documented behaviour that just happens to be different than what you expected.
206 If unsure, try toggling off Privoxy, and see if the problem persists.
207
208 If you are using your own custom configuration, please try the stock configs to
209 see if the problem is configuration related. If you're having problems with a
210 feature that is disabled by default, please ask around on the mailing list if
211 others can reproduce the problem.
212
213 If you aren't using the latest Privoxy version, the bug may have been found and
214 fixed in the meantime. We would appreciate if you could take the time to
215 upgrade to the latest version (or even the latest CVS snapshot) and verify that
216 your bug still exists.
217
218 Please be sure to provide the following information:
219
220   * The exact Privoxy version you are using (if you got the source from CVS,
221     please also provide the source code revisions as shown in http://
222     config.privoxy.org/show-version).
223
224   * The operating system and versions you run Privoxy on, (e.g. Windows XP
225     SP2), if you are using a Unix flavor, sending the output of "uname -a"
226     should do, in case of GNU/Linux, please also name the distribution.
227
228   * The name, platform, and version of the browser you were using (e.g.
229     Internet Explorer v5.5 for Mac).
230
231   * The URL where the problem occurred, or some way for us to duplicate the
232     problem (e.g. http://somesite.example.com/?somethingelse=123).
233
234   * Whether your version of Privoxy is one supplied by the Privoxy developers
235     via SourceForge, or if you got your copy somewhere else.
236
237   * Whether you are using Privoxy in tandem with another proxy such as Tor. If
238     so, please temporary disable the other proxy to see if the symptoms change.
239
240   * Whether you are using a personal firewall product. If so, does Privoxy work
241     without it?
242
243   * Any other pertinent information to help identify the problem such as config
244     or log file excerpts (yes, you should have log file entries for each action
245     taken). To get a meaningful logfile, please make sure that the logfile
246     directive is being used and the following debug options are enabled:
247
248     debug     1 # Log the destination for each request Privoxy let through. See also debug 1024.
249     debug     2 # show each connection status
250     debug     4 # show I/O status
251     debug     8 # show header parsing
252     debug   128 # debug redirects
253     debug   256 # debug GIF de-animation
254     debug   512 # Common Log Format
255     debug  1024 # Log the destination for requests Privoxy didn't let through, and the reason why.
256     debug  4096 # Startup banner and warnings.
257     debug  8192 # Non-fatal errors
258
259     If you are having trouble with a filter, please additionally enable
260
261     debug    64 # debug regular expression filters
262
263     If you are using Privoxy 3.0.17 or later and suspect that it interprets the
264     request or the response incorrectly, please enable
265
266     debug 32768 # log all data read from the network
267
268     Note that Privoxy log files may contain sensitive information so please
269     don't submit any logfiles you didn't read first. You can mask sensitive
270     information as long as it's clear that you removed something.
271
272 You don't have to tell us your actual name when filing a problem report, but if
273 you don't, please use a nickname so we can differentiate between your messages
274 and the ones entered by other "anonymous" users that may respond to your
275 request if they have the same problem or already found a solution. Note that
276 due to spam the trackers may not always allow to post without being logged into
277 SourceForge. If that's the case, you are still free to create a login that
278 isn't directly linked to your name, though.
279
280 Please also check the status of your request a few days after submitting it, as
281 we may request additional information. If you use a SF id, you should
282 automatically get a mail when someone responds to your request. Please don't
283 bother to add an email address when using the tracker. If you prefer to
284 communicate through email, just use one of the mailing lists directly.
285
286 If you are new to reporting problems, you might be interested in How to Report
287 Bugs Effectively.
288
289 The appendix of the Privoxy User Manual also has helpful information on
290 understanding actions, and action debugging.
291
292 -------------------------------------------------------------------------------
293
294 6.3. Request New Features
295
296 You are welcome to submit ideas on new features or other proposals for
297 improvement through our feature request tracker at http://sourceforge.net/
298 tracker/?atid=361118&group_id=11118.
299
300 -------------------------------------------------------------------------------
301
302 6.4. Mailing Lists
303
304 If you prefer to communicate through email, instead of using a web interface,
305 feel free to use one of the mailing lists. To discuss issues that haven't been
306 completely diagnosed yet, please use the Privoxy users list. Technically
307 interested users and people who wish to contribute to the project are always
308 welcome on the developers list. You can find an overview of all Privoxy-related
309 mailing lists, including list archives, at: http://sourceforge.net/mail/?
310 group_id=11118.
311