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.14 2002/05/05 13:46:59 swa Exp $
22 Written by and Copyright (C) 2001 the SourceForge
23 Privoxy team. http://www.privoxy.org/
25 Based on the Internet Junkbuster originally written
26 by and Copyright (C) 1997 Anonymous Coders and
27 Junkbusters Corporation. http://www.junkbusters.com
30 ========================================================================
31 NOTE: Please read developer-manual/documentation.html before touching
32 anything in this, or other Privoxy documentation. You have been warned!
33 Failure to abide by this rule will result in the revocation of your license
34 to live a peaceful existence!
35 ========================================================================
37 ===================================================================
38 READ: Document Note: This file generates the README in the top level
39 source directory. It is generated as only a plain text file. The
40 current markup is not suitable for other formats. Build from
41 Makefile with 'make dok-readme'.
42 ===================================================================
46 ======================================================================
47 NOTE: The left margin spacing is *important* when using 'literallayout'
48 WYSISWYG!!! Don't mess this up!!! Careful with linebreaks too, ie
49 the para tag forces a linebreak. Tags need to be carefully placed as a result
50 to avoid extra blank lines, etc.
51 ======================================================================
53 For stable releases, change
55 entity % p-not-stable "INCLUDE"
59 entity % p-not-stable "IGNORE"
61 in the DTD at the top. This will toggle various text 'off'. BOTH
62 MUST be toggled in this case or you will get both text referencing
63 stable and unstable versions. You only want one or the other!
71 This is here to keep vim syntax file from breaking :/
72 If I knew enough to fix it, I would.
73 PLEASE DO NOT REMOVE! HB: hal@foobox.net
82 /*********************************************************************
84 * File : $Source: /cvsroot/ijbswa/current/doc/source/readme.sgml,v $
86 * Purpose : README file to give a short intro.
88 * Copyright : Written by and Copyright (C) 2001 the SourceForge
89 * Privoxy team. http://www.privoxy.org/
91 * Based on the Internet Junkbuster originally written
92 * by and Copyright (C) 1997 Anonymous Coders and
93 * Junkbusters Corporation. http://www.junkbusters.com
95 * This program is free software; you can redistribute it
96 * and/or modify it under the terms of the GNU General
97 * Public License as published by the Free Software
98 * Foundation; either version 2 of the License, or (at
99 * your option) any later version.
101 * This program is distributed in the hope that it will
102 * be useful, but WITHOUT ANY WARRANTY; without even the
103 * implied warranty of MERCHANTABILITY or FITNESS FOR A
104 * PARTICULAR PURPOSE. See the GNU General Public
105 * License for more details.
107 * The GNU General Public License should be included with
108 * this file. If not, you can view it at
109 * http://www.gnu.org/copyleft/gpl.html
110 * or write to the Free Software Foundation, Inc., 59
111 * Temple Place - Suite 330, Boston, MA 02111-1307, USA.
113 *********************************************************************/
120 <!-- include some conditional text -->
121 This README is included with <![%p-not-stable;[ the development version of]]>
122 Privoxy &p-version;<![%p-not-stable;[, which will eventually become Privoxy v3.0 (and soon we
123 hope!)]]>. See http://www.privoxy.org/ for more information. The current code
124 level is &p-status;<![%p-not-stable;[, and seems stable to us :)]]>.
129 <!-- Include privoxy.sgml boilerplate: -->
131 <!-- end boilerplate -->
133 <!-- ~~~~~ New section ~~~~~ -->
134 <sect1 id="importantchanges" ><title>IMPORTANT CHANGES</title>
136 NEWS! As of 03/24/02, the name of this project has been changed from
137 ijbswa/Junkbuster to Privoxy. This is reflected in many of the included
141 WARNING! If upgrading from earlier versions of this project via RPM packages,
142 the new package will delete any previously installed 'Junkbuster' packages.
145 IMPORTANT! READ! Configuration Change as of 17 Mar 2002: The default listening
146 port is now 8118 due to conflicts with port 8000 assignment. You will need to
147 change your browser if upgrading!!! And maybe firewall, etc.
151 <!-- ~~~~~ New section ~~~~~ -->
152 <sect1 id="install" ><title>INSTALL</title>
153 <!-- include buildsource.sgml boilerplate: -->
155 <!-- end boilderplate -->
158 <!-- ~~~~~ New section ~~~~~ -->
159 <sect1 id="run"><title>RUN</title>
161 privoxy [——help] [——version]
162 [——no-daemon] [——pidfile PIDFILE] [——user
163 USER[.GROUP]] [config_file]
166 See the man page or user-manual for a brief explanation of each option.
169 If no config_file is specified on the command line, Privoxy will look for a
170 file named 'config' in the current directory (except Win32 which will look
171 for 'config.txt'). If no config_file is found, Privoxy will fail to start.
174 Or for Red Hat: /etc/rc.d/init.d/privoxy start
177 Or for SuSE: /etc/rc.d/privoxy start
181 <!-- ~~~~~ New section ~~~~~ -->
182 <sect1 id="configuration"><title>CONFIGURATION</title>
184 See: 'config', 'default.action', 'user.action', and 'default.filter'.
185 'user.action' is for personal configuration. These are all well commented.
186 Most of the magic is in '*.action' files. 'user.action' should be
187 used for any actions customizations. On Unix-like systems, these files
188 are installed in /etc/privoxy. On Windows, then wherever the executable
189 itself is installed. There are many significant changes and advances since
190 Junkbuster v2.0.x. The user-manual has a run down of configuration options,
191 and examples: http://www.privoxy.org/user-manual/.
194 Be sure to set your browser(s) for HTTP/HTTPS Proxy at <IP>:<Port>, or
195 whatever you specify in the config file under 'listen-address'. DEFAULT is
199 The actions list can be configured via the web interface accessed via
200 http://p.p/, as well other options.
204 All configuration files are subject to unannounced changes during the
210 <!-- ~~~~~ New section ~~~~~ -->
211 <sect1 id="documentation"><title>DOCUMENTATION</title>
213 There should be documentation in the 'doc' subdirectory<![%p-not-stable;[, but it
214 is not completed at this point]]>. In particular, see the user-manual there,
215 the faq, and those interested in Privoxy development, should look at
220 The most up to date source of information on the current development version,
221 may still be either comments in the source code, or the included
222 configuration files. ]]>The source and configuration files are all well
223 commented. The main configuration files are: 'config', 'default.action', and
224 'default.filter'<![%p-not-stable;[ in the toplevel source directory]]>.
228 Included documentation may vary according to platform and packager.
232 <!-- ~~~~~ New section ~~~~~ -->
233 <sect1 id="contact"><title>CONTACTING THE DEVELOPERS, BUG REPORTING AND FEATURE REQUESTS</title>
234 <!-- Include contacting.sgml boilerplate: -->
236 <!-- end boilerplate -->
240 <!-- <LiteralLayout> -->
241 <!-- ------------------------------------------------------------------------- -->
242 <!-- ijbswa-developers@lists.sourceforge.net -->
243 <!-- </LiteralLayout> -->
246 <!-- $Id: readme.sgml,v 1.14 2002/05/05 13:46:59 swa Exp $ -->