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 2.2 2002/09/05 05:45:30 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. You have been warned!
30 Failure to abide by this rule will result in the revocation of your license
31 to live a peaceful existence!
32 ========================================================================
34 ===================================================================
35 READ: Document Note: This file generates the README in the top level
36 source directory. It is generated as only a plain text file. The
37 current markup is not suitable for other formats. Build from
38 Makefile with 'make dok-readme'.
39 ===================================================================
43 ======================================================================
44 NOTE: The left margin spacing is *important* when using 'literallayout'
45 WYSISWYG!!! Don't mess this up!!! Careful with linebreaks too, ie
46 the para tag forces a linebreak. Tags need to be carefully placed as a result
47 to avoid extra blank lines, etc.
48 ======================================================================
50 For stable releases, change
52 entity % p-not-stable "INCLUDE"
56 entity % p-not-stable "IGNORE"
58 in the DTD at the top. This will toggle various text 'off'. BOTH
59 MUST be toggled in this case or you will get both text referencing
60 stable and unstable versions. You only want one or the other!
68 This is here to keep vim syntax file from breaking :/
69 If I knew enough to fix it, I would.
70 PLEASE DO NOT REMOVE! HB: hal@foobox.net
79 /*********************************************************************
81 * File : $Source: /cvsroot/ijbswa/current/doc/source/readme.sgml,v $
83 * Purpose : README file to give a short intro.
85 * Copyright : Written by and Copyright (C) 2001,2002 the SourceForge
86 * Privoxy team. http://www.privoxy.org/
88 * Based on the Internet Junkbuster originally written
89 * by and Copyright (C) 1997 Anonymous Coders and
90 * Junkbusters Corporation. http://www.junkbusters.com
92 * This program is free software; you can redistribute it
93 * and/or modify it under the terms of the GNU General
94 * Public License as published by the Free Software
95 * Foundation; either version 2 of the License, or (at
96 * your option) any later version.
98 * This program is distributed in the hope that it will
99 * be useful, but WITHOUT ANY WARRANTY; without even the
100 * implied warranty of MERCHANTABILITY or FITNESS FOR A
101 * PARTICULAR PURPOSE. See the GNU General Public
102 * License for more details.
104 * The GNU General Public License should be included with
105 * this file. If not, you can view it at
106 * http://www.gnu.org/copyleft/gpl.html
107 * or write to the Free Software Foundation, Inc., 59
108 * Temple Place - Suite 330, Boston, MA 02111-1307, USA.
110 *********************************************************************/
117 <!-- include some conditional text -->
118 This README is included with <![%p-not-stable;[ the development version of]]>
119 Privoxy &p-version;<![%p-not-stable;[, which will someday become Privoxy
120 v3.2]]>. See http://www.privoxy.org/ for more information. The current code
121 level is technically &p-status;<![%p-not-stable;[, but is not yet
122 significantly different from the 3.0.0 stable branch at this time.]]>.
127 <!-- Include privoxy.sgml boilerplate: -->
129 <!-- end boilerplate -->
131 <!-- ~~~~~ New section ~~~~~ -->
132 <sect1 id="importantchanges" ><title>IMPORTANT CHANGES</title>
134 REALLY BIG NEWS! August 2002: The long-awaited, oft-delayed stable version
135 of Privoxy 3.0 is finally released! This is way behind schedule, but better
136 late than never. The developers all hope the wait was worth it.
139 NEWS! As of 03/24/02, the name of this project has been changed from
140 ijbswa/Junkbuster to Privoxy. This is reflected in many of the included
144 WARNING! If upgrading from earlier versions of this project via RPM packages,
145 the new package will delete any previously installed 'Junkbuster' packages.
148 IMPORTANT! READ! Configuration Change as of 17 Mar 2002: The default listening
149 port is now 8118 due to conflicts with port 8000 assignment. You will need to
150 change your browser if upgrading!!! And maybe firewall, etc.
154 <!-- ~~~~~ New section ~~~~~ -->
155 <sect1 id="install" ><title>INSTALL</title>
156 <!-- include buildsource.sgml boilerplate: -->
158 <!-- end boilderplate -->
161 <!-- ~~~~~ New section ~~~~~ -->
162 <sect1 id="run"><title>RUN</title>
164 privoxy [——help] [——version]
165 [——no-daemon] [——pidfile PIDFILE] [——user
166 USER[.GROUP]] [config_file]
169 See the man page or User Manual for an explanation of each option, and
170 other configuration and usage issues.
173 If no config_file is specified on the command line, Privoxy will look for a
174 file named 'config' in the current directory (except Win32 which will look
175 for 'config.txt'). If no config_file is found, Privoxy will fail to start.
178 Or for Red Hat based distributions: /etc/rc.d/init.d/privoxy start
181 Or for SuSE: /etc/rc.d/privoxy start
184 Or Debian: /etc/init.d/privoxy start
188 <!-- ~~~~~ New section ~~~~~ -->
189 <sect1 id="configuration"><title>CONFIGURATION</title>
191 See: 'config', 'default.action', 'user.action', and 'default.filter'.
192 'user.action' is for personal and local configuration preferences. These are
193 all well commented. Most of the magic is in '*.action' files. 'user.action'
194 should be used for any actions customizations. On Unix-like systems, these
195 files are installed in /etc/privoxy. On Windows, then wherever the
196 executable itself is installed. There are many significant changes and
197 advances since Junkbuster v2.0.x. The User Manual has an explanation of
198 all configuration options, and examples: http://www.privoxy.org/user-manual/.
201 Be sure to set your browser(s) for HTTP/HTTPS Proxy at <IP>:<Port>, or
202 whatever you specify in the config file under 'listen-address'. DEFAULT is
203 localhost:8118. Note that Privoxy ONLY proxies HTTP (and HTTPS) traffic. Do not try it
204 with FTP or other protocols for the simple reason it does not work.
207 The actions list can be configured via the web interface accessed via
208 http://p.p/, as well other options.
212 All configuration files are subject to unannounced changes during the
218 <!-- ~~~~~ New section ~~~~~ -->
219 <sect1 id="documentation"><title>DOCUMENTATION</title>
221 There should be documentation in the 'doc' subdirectory<![%p-not-stable;[, but it
222 is not completed at this point]]>. In particular, see the User Manual there,
223 the FAQ, and those interested in Privoxy development, should look at
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. ]]>The source and configuration files are all well
231 commented. The main configuration files are: 'config', 'default.action', and
232 'default.filter'<![%p-not-stable;[ in the toplevel source directory]]>.
236 Included documentation may vary according to platform and packager. All
237 documentation is posted on http://www.privoxy.org, in case you don't have it,
242 <!-- ~~~~~ New section ~~~~~ -->
243 <sect1 id="contact"><title>CONTACTING THE DEVELOPERS, BUG REPORTING AND FEATURE REQUESTS</title>
244 <!-- Include contacting.sgml boilerplate: -->
246 <!-- end boilerplate -->
250 <!-- <LiteralLayout> -->
251 <!-- ------------------------------------------------------------------------- -->
252 <!-- ijbswa-developers@lists.sourceforge.net -->
253 <!-- </LiteralLayout> -->
256 <!-- $Id: readme.sgml,v 2.2 2002/09/05 05:45:30 hal9 Exp $ -->