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 "3.0.4">
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 2.5 2006/07/18 14:48:51 david__schmidt Exp $
22 Copyright (C) 2001 - 2006 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 - 2006 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;. See http://www.privoxy.org/ for more information. The current code maturity
118 level is <quote>&p-status;</quote><![%p-not-stable;[, but seems stable to us :)]]>.
123 <!-- Include privoxy.sgml boilerplate: -->
125 <!-- end boilerplate -->
127 <!-- ~~~~~ New section ~~~~~ -->
128 <sect1 id="importantchanges" ><title>IMPORTANT CHANGES</title>
130 BIG NEWS! 2006, Privoxy 3.0.4 is released. This is a significant upgrade
131 with many new and enhanced features, and many bugs fixed. There
132 are fifteen new actions available, and several actions have enhanced
133 capabilites. Multiple filter files are now supported as well. See the "What's
134 New" section and the "Upgrader's Notes" in <citetitle>the User
135 Manual</citetitle> for details and specifics.
138 NEWS! January 2004, Privoxy 3.0.3 is released. This is the another
139 maintenance release of Privoxy which fixes more bugs, further refines
140 the configuration and works around some known third-party problems. See the
141 ChangeLog for complete details. Upgrading from 3.0.2 is recommended.
144 NEWS! March 2003, Privoxy 3.0.2 is released. This is the first maintenance
145 release of Privoxy. There are no significant new features in this release.
146 Some bugs are fixed, and some existing features have been enhanced. See
147 ChangeLog for details. Upgrading from 3.0.0 is recommended.
150 REALLY BIG NEWS! August 2002: The long-awaited, oft-delayed stable version
151 of Privoxy 3.0 is finally released! This is way behind schedule, but better
152 late than never. The developers all hope the wait was worth it.
155 NEWS! As of 03/24/02, the name of this project has been changed from
156 ijbswa/Junkbuster to Privoxy. This is reflected in many of the included
160 IMPORTANT! READ! Configuration Change as of 17 Mar 2002: The default listening
161 port is now 8118 due to conflicts with port 8000 assignment. You will need to
162 change your browser if upgrading!!! And maybe firewall, etc.
166 <!-- ~~~~~ New section ~~~~~ -->
167 <sect1 id="install" ><title>INSTALL</title>
169 See the <filename>INSTALL</filename> file in this directory, for installing
170 from raw source, and the <citetitle>User Manual</citetitle>, for all other
175 <!-- ~~~~~ New section ~~~~~ -->
176 <sect1 id="run"><title>RUN</title>
178 privoxy [——help] [——version]
179 [——no-daemon] [——pidfile PIDFILE] [——user
180 USER[.GROUP]] [——chroot] [config_file]
183 See the man page or <citetitle>User Manual</citetitle> for an explanation of each option, and
184 other configuration and usage issues.
187 If no config_file is specified on the command line, Privoxy will look for a
188 file named 'config' in the current directory (except Win32 which will look
189 for 'config.txt'). If no config_file is found, Privoxy will fail to start.
192 Or for Red Hat based distributions: /etc/rc.d/init.d/privoxy start
195 Or for SuSE: /etc/rc.d/privoxy start
198 Or Debian: /etc/init.d/privoxy start
202 <!-- ~~~~~ New section ~~~~~ -->
203 <sect1 id="configuration"><title>CONFIGURATION</title>
205 See: 'config', 'default.action', 'user.action', 'default.filter', and
206 'user.filter'. 'user.action' and 'user.filter' are for personal and local
207 configuration preferences. These are all well commented. Most of the magic is
208 in '*.action' files. 'user.action' should be used for any actions
209 customizations. On Unix-like systems, these files are installed in
210 /etc/privoxy. On Windows, then wherever the executable itself is installed.
211 There are many significant changes and advances from earlier versions. The
212 <citetitle>User Manual</citetitle> has an explanation of all configuration
213 options, and examples: http://www.privoxy.org/user-manual/.
216 Be sure to set your browser(s) for HTTP/HTTPS Proxy at <IP>:<Port>, or
217 whatever you specify in the config file under 'listen-address'. DEFAULT is
218 localhost:8118. Note that Privoxy ONLY proxies HTTP (and HTTPS) traffic. Do not try it
219 with FTP or other protocols for the simple reason it does not work.
222 The actions list can be configured via the web interface accessed via
223 http://p.p/, as well other options.
227 All configuration files are subject to unannounced changes during the
233 <!-- ~~~~~ New section ~~~~~ -->
234 <sect1 id="documentation"><title>DOCUMENTATION</title>
236 There should be documentation in the 'doc' subdirectory<![%p-not-stable;[, but it
237 may not be completed at this point]]>. In particular, see the
238 <citetitle>User Manual</citetitle> there,
239 the <citetitle>FAQ</citetitle>, and those interested in Privoxy development, should look at
240 <citetitle>developer-manual</citetitle>.
244 The most up to date source of information on the current development version,
245 may still be either comments in the source code, or the included
246 configuration files. ]]>The source and configuration files are all well
247 commented. The main configuration files are: 'config', 'default.action', and
248 'default.filter'<![%p-not-stable;[ in the toplevel source directory]]>.
252 Included documentation may vary according to platform and packager. All
253 documentation is posted on http://www.privoxy.org, in case you don't have it,
258 <!-- ~~~~~ New section ~~~~~ -->
259 <sect1 id="contact"><title>CONTACTING THE DEVELOPERS, BUG REPORTING AND FEATURE REQUESTS</title>
260 <!-- Include contacting.sgml boilerplate: -->
262 <!-- end boilerplate -->
266 <!-- <LiteralLayout> -->
267 <!-- ------------------------------------------------------------------------- -->
268 <!-- ijbswa-developers@lists.sourceforge.net -->
269 <!-- </LiteralLayout> -->
272 <!-- $Id: readme.sgml,v 2.5 2006/07/18 14:48:51 david__schmidt Exp $ -->