Move all doc build stuff to doc/source/GNUmakefile, leaving a 'make dok'
[privoxy.git] / README
1 /*********************************************************************
2  *
3  * File        :  $Source: /cvsroot/ijbswa/current/doc/source/readme.sgml,v $
4  *
5  * Purpose     :  README file to give a short intro.
6  *
7  * Copyright   :  Written by and Copyright (C) 2001 the SourceForge
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., 59
30  *                Temple Place - Suite 330, Boston, MA  02111-1307, USA.
31  *
32  *********************************************************************/
33
34 This README is included with the development version of Privoxy 2.9.15, which
35 will eventually become Privoxy v3.0 (and soon we hope!). See http://
36 www.privoxy.org/ for more information. The current code level is beta, and
37 seems stable to us :).
38
39 -------------------------------------------------------------------------------
40
41 Table of Contents
42 1. IMPORTANT CHANGES
43 2. INSTALL
44 3. RUN
45 4. CONFIGURATION
46 5. DOCUMENTATION
47 6. CONTACTING THE DEVELOPERS, BUG REPORTING AND FEATURE REQUESTS
48    
49     6.1. Get Support
50     6.2. Report bugs
51     6.3. Request new features
52     6.4. Report ads or other filter problems
53     6.5. Other
54    
55 Privoxy is a web proxy with advanced filtering capabilities for protecting
56 privacy, filtering web page content, managing cookies, controlling access, and
57 removing ads, banners, pop-ups and other obnoxious Internet junk. Privoxy has a
58 very flexible configuration and can be customized to suit individual needs and
59 tastes. Privoxy has application for both stand-alone systems and multi-user
60 networks.
61
62 Privoxy is based on Internet Junkbuster (tm).
63
64 -------------------------------------------------------------------------------
65
66 1. IMPORTANT CHANGES
67
68 NEWS! As of 03/24/02, the name of this project has been changed from ijbswa/
69 Junkbuster to Privoxy. This is reflected in many of the included files.
70
71 WARNING! If upgrading from earlier versions of this project via RPM packages,
72 the new package will delete any previously installed 'Junkbuster' packages.
73
74 IMPORTANT! READ! Configuration Change as of 17 Mar 2002: The default listening
75 port is now 8118 due to conflicts with port 8000 assignment. You will need to
76 change your browser if upgrading!!! And maybe firewall, etc.
77
78 -------------------------------------------------------------------------------
79
80 2. INSTALL
81
82 To build Privoxy from source, autoconf, GNU make (gmake), and, of course, a C
83 compiler like gcc are required.
84
85 When building from a source tarball (either release version or nightly CVS
86 tarball), first unpack the source:
87
88  tar xzvf privoxy-2.9.15-beta-src* [.tgz or .tar.gz]                           
89  cd privoxy-2.9.15-beta                                                        
90
91 For retrieving the current CVS sources, you'll need CVS installed. Note that
92 sources from CVS are development quality, and may not be stable, or well
93 tested. To download CVS source:
94
95   cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login          
96   cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co current 
97   cd current                                                                         
98
99 This will create a directory named current/, which will contain the source
100 tree.
101
102 Then, in either case, to build from unpacked tarball or CVS source:
103
104  autoheader                                                                    
105  autoconf                                                                      
106  ./configure      # (--help to see options)                                    
107  make             # (the make from gnu, gmake for *BSD)                        
108  su                                                                            
109  make -n install  # (to see where all the files will go)                       
110  make install     # (to really install)                                        
111
112 If you have gnu make, you can have the first four steps automatically done for
113 you by just typing:
114
115   make                                                                         
116
117 in the freshly downloaded or unpacked source directory.
118
119 For more detailed instructions on how to build Redhat and SuSE RPMs, Windows
120 self-extracting installers, building on platforms with special requirements
121 etc, please consult the developer manual.
122
123 For binary RPM installation, and other platforms, see the user-manual as well.
124
125 -------------------------------------------------------------------------------
126
127 3. RUN
128
129 privoxy [--help] [--version] [--no-daemon] [--pidfile PIDFILE] [--user USER
130 [.GROUP]] [config_file]
131
132 See the man page or user-manual for a brief explanation of each option.
133
134 If no config_file is specified on the command line, Privoxy will look for a
135 file named 'config' in the current directory (except Win32 which will look for
136 'config.txt'). If no config_file is found, Privoxy will fail to start.
137
138 Or for Red Hat: /etc/rc.d/init.d/privoxy start
139
140 Or for SuSE: /etc/rc.d/privoxy start
141
142 -------------------------------------------------------------------------------
143
144 4. CONFIGURATION
145
146 See: 'config', 'default.action', 'user.action', and 'default.filter'.
147 'user.action' is for personal configuration. These are all well commented. Most
148 of the magic is in '*.action' files. 'user.action' should be used for any
149 actions customizations. On Unix-like systems, these files are installed in /etc
150 /privoxy. On Windows, then wherever the executable itself is installed. There
151 are many significant changes and advances since Junkbuster v2.0.x. The
152 user-manual has a run down of configuration options, and examples: http://
153 www.privoxy.org/user-manual/.
154
155 Be sure to set your browser(s) for HTTP/HTTPS Proxy at <IP>:<Port>, or whatever
156 you specify in the config file under 'listen-address'. DEFAULT is localhost:
157 8118.
158
159 The actions list can be configured via the web interface accessed via http://
160 p.p/, as well other options.
161
162 All configuration files are subject to unannounced changes during the
163 development process.
164
165 -------------------------------------------------------------------------------
166
167 5. DOCUMENTATION
168
169 There should be documentation in the 'doc' subdirectory, but it is not
170 completed at this point. In particular, see the user-manual there, the faq, and
171 those interested in Privoxy development, should look at developer-manual.
172
173 The most up to date source of information on the current development version,
174 may still be either comments in the source code, or the included configuration
175 files. The source and configuration files are all well commented. The main
176 configuration files are: 'config', 'default.action', and 'default.filter' in
177 the toplevel source directory.
178
179 Included documentation may vary according to platform and packager.
180
181 -------------------------------------------------------------------------------
182
183 6. CONTACTING THE DEVELOPERS, BUG REPORTING AND FEATURE REQUESTS
184
185 We value your feedback. However, to provide you with the best support, please
186 note the following sections.
187
188 -------------------------------------------------------------------------------
189
190 6.1. Get Support
191
192 To get support, use the Sourceforge Support Forum:
193
194     http://sourceforge.net/tracker/?group_id=11118&atid=211118
195
196 -------------------------------------------------------------------------------
197
198 6.2. Report bugs
199
200 To submit bugs, use the Sourceforge Bug Forum:
201
202     http://sourceforge.net/tracker/?group_id=11118&atid=111118. 
203
204 Make sure that the bug has not already been submitted. Please try to verify
205 that it is a Privoxy bug, and not a browser or site bug first. If you are using
206 your own custom configuration, please try the stock configs to see if the
207 problem is a configuration related bug. And if not using the latest development
208 snapshot, please try the latest one. Or even better, CVS sources. Please be
209 sure to include the Privoxy version, platform, browser, any pertinent log data,
210 any other relevant details (please be specific) and, if possible, some way to
211 reproduce the bug.
212
213 -------------------------------------------------------------------------------
214
215 6.3. Request new features
216
217 To submit ideas on new features, use the Sourceforge feature request forum:
218
219     http://sourceforge.net/tracker/?atid=361118&group_id=11118&func=browse.
220
221 -------------------------------------------------------------------------------
222
223 6.4. Report ads or other filter problems
224
225 You can also send feedback on websites that Privoxy has problems with. Please
226 bookmark the following link: "Privoxy - Submit Filter Feedback". Once you surf
227 to a page with problems, use the bookmark to send us feedback. We will look
228 into the issue as soon as possible.
229
230 New, improved default.action files will occasionally be made available based on
231 your feedback. These will be announced on the ijbswa-announce list.
232
233 -------------------------------------------------------------------------------
234
235 6.5. Other
236
237 For any other issues, feel free to use the mailing lists:
238  
239     http://sourceforge.net/mail/?group_id=11118.
240
241 Anyone interested in actively participating in development and related
242 discussions can also join the appropriate mailing list. Archives are available,
243 too. See the page on Sourceforge.
244