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.16.2.4 2002/08/25 17:12:20 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 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 eventually become Privoxy v3.0 (and soon we
120 hope!)]]>. See http://www.privoxy.org/ for more information. The current code
121 level is &p-status;<![%p-not-stable;[, and seems stable to us :)]]>.
126 <!-- Include privoxy.sgml boilerplate: -->
128 <!-- end boilerplate -->
130 <!-- ~~~~~ New section ~~~~~ -->
131 <sect1 id="importantchanges" ><title>IMPORTANT CHANGES</title>
133 REALLY BIG NEWS! August 2002: The long-awaited, oft-delayed stable version
134 of Privoxy 3.0 is finally released! This is way behind schedule, but better
135 late than never. The developers all hope the wait was worth it.
138 NEWS! As of 03/24/02, the name of this project has been changed from
139 ijbswa/Junkbuster to Privoxy. This is reflected in many of the included
143 WARNING! If upgrading from earlier versions of this project via RPM packages,
144 the new package will delete any previously installed 'Junkbuster' packages.
147 IMPORTANT! READ! Configuration Change as of 17 Mar 2002: The default listening
148 port is now 8118 due to conflicts with port 8000 assignment. You will need to
149 change your browser if upgrading!!! And maybe firewall, etc.
153 <!-- ~~~~~ New section ~~~~~ -->
154 <sect1 id="install" ><title>INSTALL</title>
155 <!-- include buildsource.sgml boilerplate: -->
157 <!-- end boilderplate -->
160 <!-- ~~~~~ New section ~~~~~ -->
161 <sect1 id="run"><title>RUN</title>
163 privoxy [——help] [——version]
164 [——no-daemon] [——pidfile PIDFILE] [——user
165 USER[.GROUP]] [config_file]
168 See the man page or User Manual for an explanation of each option, and
169 other configuration and usage issues.
172 If no config_file is specified on the command line, Privoxy will look for a
173 file named 'config' in the current directory (except Win32 which will look
174 for 'config.txt'). If no config_file is found, Privoxy will fail to start.
177 Or for Red Hat based distributions: /etc/rc.d/init.d/privoxy start
180 Or for SuSE: /etc/rc.d/privoxy start
183 Or Debian: /etc/init.d/privoxy start
187 <!-- ~~~~~ New section ~~~~~ -->
188 <sect1 id="configuration"><title>CONFIGURATION</title>
190 See: 'config', 'default.action', 'user.action', and 'default.filter'.
191 'user.action' is for personal and local configuration preferences. These are
192 all well commented. Most of the magic is in '*.action' files. 'user.action'
193 should be used for any actions customizations. On Unix-like systems, these
194 files are installed in /etc/privoxy. On Windows, then wherever the
195 executable itself is installed. There are many significant changes and
196 advances since Junkbuster v2.0.x. The User Manual has an explanation of
197 all configuration options, and examples: http://www.privoxy.org/user-manual/.
200 Be sure to set your browser(s) for HTTP/HTTPS Proxy at <IP>:<Port>, or
201 whatever you specify in the config file under 'listen-address'. DEFAULT is
202 localhost:8118. Note that Privoxy ONLY proxies HTTP (and HTTPS) traffic. Do not try it
203 with FTP or other protocols for the simple reason it does not work.
206 The actions list can be configured via the web interface accessed via
207 http://p.p/, as well other options.
211 All configuration files are subject to unannounced changes during the
217 <!-- ~~~~~ New section ~~~~~ -->
218 <sect1 id="documentation"><title>DOCUMENTATION</title>
220 There should be documentation in the 'doc' subdirectory<![%p-not-stable;[, but it
221 is not completed at this point]]>. In particular, see the User Manual there,
222 the FAQ, and those interested in Privoxy development, should look at
227 The most up to date source of information on the current development version,
228 may still be either comments in the source code, or the included
229 configuration files. ]]>The source and configuration files are all well
230 commented. The main configuration files are: 'config', 'default.action', and
231 'default.filter'<![%p-not-stable;[ in the toplevel source directory]]>.
235 Included documentation may vary according to platform and packager. All
236 documentation is posted on http://www.privoxy.org, in case you don't have it,
241 <!-- ~~~~~ New section ~~~~~ -->
242 <sect1 id="contact"><title>CONTACTING THE DEVELOPERS, BUG REPORTING AND FEATURE REQUESTS</title>
243 <!-- Include contacting.sgml boilerplate: -->
245 <!-- end boilerplate -->
249 <!-- <LiteralLayout> -->
250 <!-- ------------------------------------------------------------------------- -->
251 <!-- ijbswa-developers@lists.sourceforge.net -->
252 <!-- </LiteralLayout> -->
255 <!-- $Id: readme.sgml,v 1.16.2.4 2002/08/25 17:12:20 hal9 Exp $ -->