1 <!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook V3.1//EN" [
2 <!entity % dummy "INCLUDE">
3 <!entity supported SYSTEM "supported.sgml">
4 <!entity newfeatures SYSTEM "newfeatures.sgml">
5 <!entity p-intro SYSTEM "privoxy.sgml">
6 <!entity seealso SYSTEM "seealso.sgml">
9 File : $Source: /cvsroot/ijbswa/current/doc/source/readme.sgml,v $
11 Purpose : README for Privoxy
13 $Id: readme.sgml,v 1.0 2002/04/03 03:53:43 hal9 Exp $
15 Written by and Copyright (C) 2001 the SourceForge
16 Privoxy team. http://www.privoxy.org/
18 Based on the Internet Junkbuster originally written
19 by and Copyright (C) 1997 Anonymous Coders and
20 Junkbusters Corporation. http://www.junkbusters.com
22 ===================================================================
23 READ: Document note: This file generates the README in the top level
24 source directory. It is generated as only a plain text file. The
25 current markup is not suitable for other formats. Build from
26 Makefile with 'make readme'.
27 ===================================================================
36 This is here to keep vim syntax file from breaking :/
37 If I knew enough to fix it, I would.
38 PLEASE DO NOT REMOVE! HB: hal@foobox.net
48 /*********************************************************************
50 * File : $Source: /cvsroot/ijbswa/current/README,v $
52 * Purpose : README file to give a short intro.
54 * Copyright : Written by and Copyright (C) 2001 the SourceForge
55 * Privoxy team. http://www.privoxy.org/
57 * Based on the Internet Junkbuster originally written
58 * by and Copyright (C) 1997 Anonymous Coders and
59 * Junkbusters Corporation. http://www.junkbusters.com
61 * This program is free software; you can redistribute it
62 * and/or modify it under the terms of the GNU General
63 * Public License as published by the Free Software
64 * Foundation; either version 2 of the License, or (at
65 * your option) any later version.
67 * This program is distributed in the hope that it will
68 * be useful, but WITHOUT ANY WARRANTY; without even the
69 * implied warranty of MERCHANTABILITY or FITNESS FOR A
70 * PARTICULAR PURPOSE. See the GNU General Public
71 * License for more details.
73 * The GNU General Public License should be included with
74 * this file. If not, you can view it at
75 * http://www.gnu.org/copyleft/gpl.html
76 * or write to the Free Software Foundation, Inc., 59
77 * Temple Place - Suite 330, Boston, MA 02111-1307, USA.
79 *********************************************************************/
86 This README is included with the development version of Privoxy, which will
87 eventually become Privoxy v3.0 (and soon we hope!). See
88 http://www.privoxy.org/. The current code level is BETA, and seems stable to
101 ------------------</LiteralLayout>
104 NEWS! As of 03/24/02, the name of this project has been changed from
105 ijbswa/Junkbuster to Privoxy. This is reflected in many of the included
109 WARNING! If upgrading from earlier versions of this project via RPM packages,
110 the new package will delete any previously installed 'Junkbuster' packages.
113 IMPORTANT! READ! Configuration Change as of 3 Apr 2002: The default listening
114 port is now 8118 due to conflicts with port 8000 assignment. You will need to
115 change your browser if upgrading!!! And maybe firewall, etc.
122 --------</LiteralLayout>
125 For tarball, first unpack:
129 tar xzvf privoxy-2.9.13-beta-src.tar.gz
130 cd privoxy-2.9.13-beta
136 ./configure (--help to see options)
137 gmake (the make from gnu)
139 make -n install (to see where all the files will go)
140 make install (to really install)
144 Redhat and SuSE src and binary RPMs can be built with 'make redhat-dist' or
145 'make suse-dist' (run ./configure first) from unpacked sources. BSD will
146 (probably?) require gmake (from http://gnu.org). See the user-manual for OS/2
150 Privoxy is also available via anonymous CVS:
154 cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
155 cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co current
158 This will create a directory named 'current'. Then, 'cd current', and then
166 ---- </LiteralLayout>
170 privoxy [--help] [--version] [--no-daemon] [--pidfile PIDFILE]
171 [--user USER[.GROUP]] [config_file]
174 See the man page or user-manual for a brief explanation of each option.
177 If no config_file is specified on the command line, Privoxy will look for a
178 file named 'config' in the current directory (except Win32 which will look
179 for 'config.txt'). If no config_file is found, Privoxy will fail to start.
182 Or for Red Hat: /etc/rc.d/init.d/privoxy start
185 Or for SuSE: /etc/rc.d/privoxy start
192 -------------- </LiteralLayout>
195 See: 'config', 'default.action', and 'default.filter'. There are several
196 actions files included. These are all well commented. Most of the magic is in
197 '*.action', and there are several of these included with varying degrees of
198 aggressiveness. On Unix-like systems, these files are installed in
199 /etc/privoxy. On Windows, then wherever the executable itself is installed.
200 There are many significant changes and advances since Junkbuster v2.0.x. The
201 user-manual has a run down of configuration options, and examples:
202 http://www.privoxy.org/user-manual/.
205 Be sure to set your browser(s) for HTTP/HTTPS Proxy at <IP>:<Port>, or
206 whatever you specify in the config file under 'listen-address'. DEFAULT is
210 The default.action file can be configured via the web interface accessed via
211 http://p.p/, as well other options.
214 All configuration files are subject to unannounced changes during the
222 --------------</LiteralLayout>
223 There is a growing amount of documentation in the 'doc' subdirectory, but it
224 is not completed at this point. In particular, see the user-manual there, the
225 faq, and developers should look at developer-manual.
228 The most up to date source of information on the current development version,
229 may still be either comments in the source code, or the included
230 configuration files, which are all well commented. These are 'config',
231 '*.action', and 'default.filter' in the toplevel source directory.
235 Included documentation may vary according to platform and packager.
241 CONTACTING THE DEVELOPERS, BUG REPORTING AND FEATURE REQUESTS
242 --------------------------------------------------------------</LiteralLayout>
246 We value your feedback. However, to provide you with the best support,
251 * Use the support forum to get help:
252 http://sourceforge.net/tracker/?group_id=11118&atid=211118
257 * Submit bugs only thru our bug forum:
258 http://sourceforge.net/tracker/?group_id=11118&atid=111118
262 Make sure that the bug has not already been submitted. Please try
263 to verify that it is a Privoxy bug, and not a browser or site
264 bug first. If you are using your own custom configuration, please
265 try the stock configs to see if the problem is a configuration
266 related bug. And if not using the latest development snapshot,
267 please try the latest one. Or even better, CVS sources. Please
268 be sure to include the Privoxy/Junkbuster version, platform,
269 browser, any pertinent log data, any other relevant details
270 (please be specific) and, if possible, some way to reproduce the
275 * Submit feature requests only thru our feature request forum:
276 http://sourceforge.net/tracker/?atid=361118&group_id=11118&func=browse
282 For any other issues, feel free to use the mailing lists:
283 http://sourceforge.net/mail/?group_id=11118
289 Anyone interested in actively participating in development and related
290 discussions can join the appropriate mailing list here:
291 http://sourceforge.net/mail/?group_id=11118. Archives are available here
297 -------------------------------------------------------------------------
298 ijbswa-developers@lists.sourceforge.net
302 $Id: readme.sgml,v 1.0 2002/03/31 02:03:36 hal9 Exp $