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 "2.9.15">
8 <!entity p-status "beta">
9 <!entity % p-not-stable "INCLUDE">
10 <!entity % p-stable "IGNORE">
11 <!entity % p-text "INCLUDE"> <!-- define we are a text only doc -->
12 <!entity % p-doc "IGNORE"> <!-- and never a text doc -->
13 <!entity % p-readme "INCLUDE"> <!-- all your README belong to us -->
16 File : $Source: /cvsroot/ijbswa/current/doc/source/readme.sgml,v $
18 Purpose : README for Privoxy
20 $Id: readme.sgml,v 1.15 2002/05/05 17:35:32 hal9 Exp $
22 Copyright (C) 2001, 2002 Privoxy Developers <developers@privoxy.org>
25 ========================================================================
26 NOTE: Please read developer-manual/documentation.html before touching
27 anything in this, or other Privoxy documentation. You have been warned!
28 Failure to abide by this rule will result in the revocation of your license
29 to live a peaceful existence!
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 ======================================================================
48 For stable releases, change
50 entity % p-not-stable "INCLUDE"
54 entity % p-not-stable "IGNORE"
56 in the DTD at the top. This will toggle various text 'off'. BOTH
57 MUST be toggled in this case or you will get both text referencing
58 stable and unstable versions. You only want one or the other!
66 This is here to keep vim syntax file from breaking :/
67 If I knew enough to fix it, I would.
68 PLEASE DO NOT REMOVE! HB: hal@foobox.net
77 /*********************************************************************
79 * File : $Source: /cvsroot/ijbswa/current/doc/source/readme.sgml,v $
81 * Purpose : README file to give a short intro.
83 * Copyright : Written by and Copyright (C) 2001 the SourceForge
84 * Privoxy team. http://www.privoxy.org/
86 * Based on the Internet Junkbuster originally written
87 * by and Copyright (C) 1997 Anonymous Coders and
88 * Junkbusters Corporation. http://www.junkbusters.com
90 * This program is free software; you can redistribute it
91 * and/or modify it under the terms of the GNU General
92 * Public License as published by the Free Software
93 * Foundation; either version 2 of the License, or (at
94 * your option) any later version.
96 * This program is distributed in the hope that it will
97 * be useful, but WITHOUT ANY WARRANTY; without even the
98 * implied warranty of MERCHANTABILITY or FITNESS FOR A
99 * PARTICULAR PURPOSE. See the GNU General Public
100 * License for more details.
102 * The GNU General Public License should be included with
103 * this file. If not, you can view it at
104 * http://www.gnu.org/copyleft/gpl.html
105 * or write to the Free Software Foundation, Inc., 59
106 * Temple Place - Suite 330, Boston, MA 02111-1307, USA.
108 *********************************************************************/
115 <!-- include some conditional text -->
116 This README is included with <![%p-not-stable;[ the development version of]]>
117 Privoxy &p-version;<![%p-not-stable;[, which will eventually become Privoxy v3.0 (and soon we
118 hope!)]]>. See http://www.privoxy.org/ for more information. The current code
119 level is &p-status;<![%p-not-stable;[, and seems stable to us :)]]>.
124 <!-- Include privoxy.sgml boilerplate: -->
126 <!-- end boilerplate -->
128 <!-- ~~~~~ New section ~~~~~ -->
129 <sect1 id="importantchanges" ><title>IMPORTANT CHANGES</title>
131 NEWS! As of 03/24/02, the name of this project has been changed from
132 ijbswa/Junkbuster to Privoxy. This is reflected in many of the included
136 WARNING! If upgrading from earlier versions of this project via RPM packages,
137 the new package will delete any previously installed 'Junkbuster' packages.
140 IMPORTANT! READ! Configuration Change as of 17 Mar 2002: The default listening
141 port is now 8118 due to conflicts with port 8000 assignment. You will need to
142 change your browser if upgrading!!! And maybe firewall, etc.
146 <!-- ~~~~~ New section ~~~~~ -->
147 <sect1 id="install" ><title>INSTALL</title>
148 <!-- include buildsource.sgml boilerplate: -->
150 <!-- end boilderplate -->
153 <!-- ~~~~~ New section ~~~~~ -->
154 <sect1 id="run"><title>RUN</title>
156 privoxy [——help] [——version]
157 [——no-daemon] [——pidfile PIDFILE] [——user
158 USER[.GROUP]] [config_file]
161 See the man page or user-manual for a brief explanation of each option.
164 If no config_file is specified on the command line, Privoxy will look for a
165 file named 'config' in the current directory (except Win32 which will look
166 for 'config.txt'). If no config_file is found, Privoxy will fail to start.
169 Or for Red Hat: /etc/rc.d/init.d/privoxy start
172 Or for SuSE: /etc/rc.d/privoxy start
176 <!-- ~~~~~ New section ~~~~~ -->
177 <sect1 id="configuration"><title>CONFIGURATION</title>
179 See: 'config', 'default.action', 'user.action', and 'default.filter'.
180 'user.action' is for personal configuration. These are all well commented.
181 Most of the magic is in '*.action' files. 'user.action' should be
182 used for any actions customizations. On Unix-like systems, these files
183 are installed in /etc/privoxy. On Windows, then wherever the executable
184 itself is installed. There are many significant changes and advances since
185 Junkbuster v2.0.x. The user-manual has a run down of configuration options,
186 and examples: http://www.privoxy.org/user-manual/.
189 Be sure to set your browser(s) for HTTP/HTTPS Proxy at <IP>:<Port>, or
190 whatever you specify in the config file under 'listen-address'. DEFAULT is
194 The actions list can be configured via the web interface accessed via
195 http://p.p/, as well other options.
199 All configuration files are subject to unannounced changes during the
205 <!-- ~~~~~ New section ~~~~~ -->
206 <sect1 id="documentation"><title>DOCUMENTATION</title>
208 There should be documentation in the 'doc' subdirectory<![%p-not-stable;[, but it
209 is not completed at this point]]>. In particular, see the user-manual there,
210 the faq, and those interested in Privoxy development, should look at
215 The most up to date source of information on the current development version,
216 may still be either comments in the source code, or the included
217 configuration files. ]]>The source and configuration files are all well
218 commented. The main configuration files are: 'config', 'default.action', and
219 'default.filter'<![%p-not-stable;[ in the toplevel source directory]]>.
223 Included documentation may vary according to platform and packager.
227 <!-- ~~~~~ New section ~~~~~ -->
228 <sect1 id="contact"><title>CONTACTING THE DEVELOPERS, BUG REPORTING AND FEATURE REQUESTS</title>
229 <!-- Include contacting.sgml boilerplate: -->
231 <!-- end boilerplate -->
235 <!-- <LiteralLayout> -->
236 <!-- ------------------------------------------------------------------------- -->
237 <!-- ijbswa-developers@lists.sourceforge.net -->
238 <!-- </LiteralLayout> -->
241 <!-- $Id: readme.sgml,v 1.15 2002/05/05 17:35:32 hal9 Exp $ -->