1 <!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook V3.1//EN" [
2 <!entity % dummy "IGNORE">
3 <!entity supported SYSTEM "supported.sgml">
4 <!entity p-intro SYSTEM "privoxy.sgml">
5 <!entity contacting SYSTEM "contacting.sgml">
6 <!entity buildsource SYSTEM "buildsource.sgml">
7 <!entity p-version SYSTEM "doc_version.tmp">
8 <!entity p-status SYSTEM "doc_status.tmp">
9 <!entity % p-stable "IGNORE">
10 <!entity % p-not-stable "IGNORE"> <!-- beta or alpha -->
11 <!entity % p-alpha "IGNORE">
12 <!entity % p-beta "IGNORE">
13 <!entity % p-text "INCLUDE"> <!-- define we are a text only doc -->
14 <!entity % p-doc "IGNORE"> <!-- and never a text doc -->
15 <!entity % p-readme "INCLUDE"> <!-- all your README belong to us -->
18 File : $Source: /cvsroot/ijbswa/current/doc/source/readme.sgml,v $
20 Purpose : README for Privoxy
22 $Id: readme.sgml,v 1.17 2002/06/03 00:28:17 hal9 Exp $
24 Copyright (C) 2001, 2002 Privoxy Developers <developers@privoxy.org>
27 ========================================================================
28 NOTE: Please read developer-manual/documentation.html before touching
29 anything in this, or other Privoxy documentation.
30 ========================================================================
32 ===================================================================
33 READ: Document Note: This file generates the README in the top level
34 source directory. It is generated as only a plain text file. The
35 current markup is not suitable for other formats. Build from
36 Makefile with 'make dok-readme'.
37 ===================================================================
41 ======================================================================
42 NOTE: The left margin spacing is *important* when using 'literallayout'
43 WYSISWYG!!! Don't mess this up!!! Careful with linebreaks too, ie
44 the para tag forces a linebreak. Tags need to be carefully placed as a result
45 to avoid extra blank lines, etc.
46 ======================================================================
54 This is here to keep vim syntax file from breaking :/
55 If I knew enough to fix it, I would.
56 PLEASE DO NOT REMOVE! HB: hal@foobox.net
65 /*********************************************************************
67 * File : $Source: /cvsroot/ijbswa/current/doc/source/readme.sgml,v $
69 * Purpose : README file to give a short intro.
71 * Copyright : Written by and Copyright (C) 2001 the SourceForge
72 * Privoxy team. http://www.privoxy.org/
74 * Based on the Internet Junkbuster originally written
75 * by and Copyright (C) 1997 Anonymous Coders and
76 * Junkbusters Corporation. http://www.junkbusters.com
78 * This program is free software; you can redistribute it
79 * and/or modify it under the terms of the GNU General
80 * Public License as published by the Free Software
81 * Foundation; either version 2 of the License, or (at
82 * your option) any later version.
84 * This program is distributed in the hope that it will
85 * be useful, but WITHOUT ANY WARRANTY; without even the
86 * implied warranty of MERCHANTABILITY or FITNESS FOR A
87 * PARTICULAR PURPOSE. See the GNU General Public
88 * License for more details.
90 * The GNU General Public License should be included with
91 * this file. If not, you can view it at
92 * http://www.gnu.org/copyleft/gpl.html
93 * or write to the Free Software Foundation, Inc., 59
94 * Temple Place - Suite 330, Boston, MA 02111-1307, USA.
96 *********************************************************************/
103 <!-- include some conditional text -->
104 This README is included with <![%p-not-stable;[ the development version of]]>
105 Privoxy &p-version;<![%p-not-stable;[, which will eventually become Privoxy v3.2]]><![%p-beta;[ (and soon we hope!)]]>.
106 See http://www.privoxy.org/ for more information. The current code
107 level is &p-status;<![%p-beta;[, but seems stable to us :)]]><![%p-alpha;[,
108 and may break in mysterious ways :) There may be features only partially
109 implemented, or worse, not functional]]>.
114 <!-- Include privoxy.sgml boilerplate: -->
116 <!-- end boilerplate -->
118 <!-- ~~~~~ New section ~~~~~ -->
119 <sect1 id="importantchanges" ><title>IMPORTANT CHANGES</title>
121 NEWS! As of 03/24/02, the name of this project has been changed from
122 ijbswa/Junkbuster to Privoxy. This is reflected in many of the included
126 WARNING! If upgrading from earlier versions of this project via RPM packages,
127 the new package will delete any previously installed 'Junkbuster' packages.
130 IMPORTANT! READ! Configuration Change as of 17 Mar 2002: The default listening
131 port is now 8118 due to conflicts with port 8000 assignment. You will need to
132 change your browser if upgrading!!! And maybe firewall, etc.
136 <!-- ~~~~~ New section ~~~~~ -->
137 <sect1 id="install" ><title>INSTALL</title>
138 <!-- include buildsource.sgml boilerplate: -->
140 <!-- end boilderplate -->
143 <!-- ~~~~~ New section ~~~~~ -->
144 <sect1 id="run"><title>RUN</title>
146 privoxy [——help] [——version]
147 [——no-daemon] [——pidfile PIDFILE] [——user
148 USER[.GROUP]] [config_file]
151 See the man page or User Manual for an explanation of each option, and
152 other configuration and usage issues.
155 If no config_file is specified on the command line, Privoxy will look for a
156 file named 'config' in the current directory (except Win32 which will look
157 for 'config.txt'). If no config_file is found, Privoxy will fail to start.
160 Or for Red Hat based distributions: /etc/rc.d/init.d/privoxy start
163 Or for SuSE: /etc/rc.d/privoxy start
166 Or Debian: /etc/init.d/privoxy start
170 <!-- ~~~~~ New section ~~~~~ -->
171 <sect1 id="configuration"><title>CONFIGURATION</title>
173 See: 'config', 'default.action', 'user.action', and 'default.filter'.
174 'user.action' is for personal and local configuration preferences. These are
175 all well commented. Most of the magic is in '*.action' files. 'user.action'
176 should be used for any actions customizations. On Unix-like systems, these
177 files are installed in /etc/privoxy. On Windows, then wherever the
178 executable itself is installed. There are many significant changes and
179 advances since Junkbuster v2.0.x. The User Manual has an explanation of
180 all configuration options, and examples: http://www.privoxy.org/user-manual/.
183 Be sure to set your browser(s) for HTTP/HTTPS Proxy at <IP>:<Port>, or
184 whatever you specify in the config file under 'listen-address'. DEFAULT is
188 The actions list can be configured via the web interface accessed via
189 http://p.p/, as well other options.
193 All configuration files are subject to unannounced changes during the
199 <!-- ~~~~~ New section ~~~~~ -->
200 <sect1 id="documentation"><title>DOCUMENTATION</title>
202 There should be documentation in the 'doc' subdirectory<![%p-not-stable;[, but it
203 may not be in sync with current code]]>. In particular, see the User Manual there,
204 the FAQ, and those interested in Privoxy development, should look at
209 The most up to date source of information on the current development version,
210 may be either comments in the source code, or the included
211 configuration files. ]]>The source and configuration files are all well
212 commented. The main configuration files are: 'config', 'default.action', and
213 'default.filter'<![%p-not-stable;[ in the toplevel source directory]]>.
217 Included documentation may vary according to platform and packager.
221 <!-- ~~~~~ New section ~~~~~ -->
222 <sect1 id="contact"><title>CONTACTING THE DEVELOPERS, BUG REPORTING AND FEATURE REQUESTS</title>
223 <!-- Include contacting.sgml boilerplate: -->
225 <!-- end boilerplate -->
229 <!-- <LiteralLayout> -->
230 <!-- ------------------------------------------------------------------------- -->
231 <!-- ijbswa-developers@lists.sourceforge.net -->
232 <!-- </LiteralLayout> -->
235 <!-- $Id: readme.sgml,v 1.17 2002/06/03 00:28:17 hal9 Exp $ -->