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.5">
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.7 2006/09/10 15:30:46 hal9 Exp $
22 Copyright (C) 2001 - 2006 Privoxy Developers http://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.,
106 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
109 *********************************************************************/
116 <!-- include some conditional text -->
117 This README is included with <![%p-not-stable;[ the development version of]]>
118 Privoxy &p-version;. See http://www.privoxy.org/ for more information. The current code maturity
119 level is <quote>&p-status;</quote><![%p-not-stable;[, but seems stable to us :)]]>.
124 <!-- Include privoxy.sgml boilerplate: -->
126 <!-- end boilerplate -->
128 <!-- ~~~~~ New section ~~~~~ -->
129 <sect1 id="importantchanges" ><title>IMPORTANT CHANGES</title>
131 BIG NEWS! September 2006, Privoxy 3.0.5 is released. This is a significant
132 upgrade with many new and enhanced features, and many bugs fixed. There are
133 fifteen new actions available, and several actions have enhanced
134 capabilities. Multiple filter files are now supported as well. See the
135 "What's New" section and the "Upgrader's Notes" in <citetitle>the User
136 Manual</citetitle> for details and specifics.
139 There was and will not be an official 3.0.4 release. This release cycle
140 was used to gather our thoughts, play with some new ideas and refine
141 some old ones. It will remain a development cycle with no actual release.
142 3.0.5 is the fruit of these efforts.
145 NEWS! January 2004, Privoxy 3.0.3 is released. This is the another
146 maintenance release of Privoxy which fixes more bugs, further refines
147 the configuration and works around some known third-party problems. See the
148 ChangeLog for complete details. Upgrading from 3.0.2 is recommended.
152 <!-- ~~~~~ New section ~~~~~ -->
153 <sect1 id="install" ><title>INSTALL</title>
155 See the <filename>INSTALL</filename> file in this directory, for installing
156 from raw source, and the <citetitle>User Manual</citetitle>, for all other
161 <!-- ~~~~~ New section ~~~~~ -->
162 <sect1 id="run"><title>RUN</title>
164 privoxy [——help] [——version]
165 [——no-daemon] [——pidfile PIDFILE] [——user
166 USER[.GROUP]] [——chroot] [config_file]
169 See the man page or <citetitle>User Manual</citetitle> 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 and Fedora based distributions: /etc/rc.d/init.d/privoxy start
181 Or Debian: /etc/init.d/privoxy start
185 <!-- ~~~~~ New section ~~~~~ -->
186 <sect1 id="configuration"><title>CONFIGURATION</title>
188 See: 'config', 'default.action', 'user.action', 'default.filter', and
189 'user.filter'. 'user.action' and 'user.filter' are for personal and local
190 configuration preferences. These are all well commented. Most of the magic is
191 in '*.action' files. 'user.action' should be used for any actions
192 customizations. On Unix-like systems, these files are typically installed in
193 /etc/privoxy. On Windows, then wherever the executable itself is installed.
194 There are many significant changes and advances from earlier versions. The
195 <citetitle>User Manual</citetitle> has an explanation of all configuration
196 options, and examples: http://www.privoxy.org/user-manual/.
199 Be sure to set your browser(s) for HTTP/HTTPS Proxy at <IP>:<Port>, or
200 whatever you specify in the config file under 'listen-address'. DEFAULT is
201 localhost:8118. Note that Privoxy ONLY proxies HTTP (and HTTPS) traffic. Do not try it
202 with FTP or other protocols for the simple reason it does not work.
205 The actions list can be configured via the web interface accessed via
206 http://p.p/, as well other options.
210 All configuration files are subject to unannounced changes during the
216 <!-- ~~~~~ New section ~~~~~ -->
217 <sect1 id="documentation"><title>DOCUMENTATION</title>
219 There should be documentation in the 'doc' subdirectory<![%p-not-stable;[, but it
220 may not be completed at this point]]>. In particular, see the
221 <citetitle>User Manual</citetitle> there,
222 the <citetitle>FAQ</citetitle>, and those interested in Privoxy development, should look at
223 <citetitle>developer-manual</citetitle>.
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 top-level 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 2.7 2006/09/10 15:30:46 hal9 Exp $ -->