516d86d079203bda3c2aa8fb40d8e87692ac1f0e
[privoxy.git] / doc / source / readme.sgml
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.25">
8 <!entity p-status "UNRELEASED">
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     -->
14 ]>
15 <!--
16  File        :  $Source: /cvsroot/ijbswa/current/doc/source/readme.sgml,v $
17
18  Purpose     :  README for Privoxy
19
20  $Id: readme.sgml,v 2.57 2016/02/26 12:27:32 fabiankeil Exp $
21
22  Copyright (C) 2001-2011 Privoxy Developers https://www.privoxy.org/
23  See LICENSE.
24
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  ========================================================================
31
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  ===================================================================
38
39  READ:
40
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  ======================================================================
47
48  For stable releases, change
49
50   entity % p-not-stable "INCLUDE"
51
52  to
53
54   entity % p-not-stable "IGNORE"
55
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!
59
60 -->
61 <article id="index">
62 <artheader>
63 <![%dummy;[
64  <para>
65  <comment>
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
69  </comment>
70  </para>
71 ]]>
72 <abstract>
73 <para>
74  <literal>
75   <msgtext>
76    <literallayout>
77 /*********************************************************************
78  *
79  * File        :  $Source: /cvsroot/ijbswa/current/doc/source/readme.sgml,v $
80  *
81  * Purpose     :  README file to give a short intro.
82  *
83  * Copyright   :  Written by and Copyright (C) 2001-2011 the
84  *                Privoxy team. https://www.privoxy.org/
85  *
86  *                Based on the Internet Junkbuster originally written
87  *                by and Copyright (C) 1997 Anonymous Coders and
88  *                Junkbusters Corporation.  http://www.junkbusters.com
89  *
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.
95  *
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.
101  *
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,
107  *                USA
108  *
109  *********************************************************************/
110 </literallayout>
111 </msgtext>
112 </literal>
113 </para>
114
115 <para>
116  <!-- include some conditional text -->
117  This README is included with <![%p-not-stable;[ the development version of]]>
118  Privoxy &p-version;. See https://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 :)]]>.
120 </para>
121 </abstract>
122 </artheader>
123
124 <!-- Include privoxy.sgml boilerplate: -->
125 &p-intro;
126 <!-- end boilerplate -->
127
128 <!--   ~~~~~       New section      ~~~~~     -->
129 <sect1 id="changes" ><title>CHANGES</title>
130 <para>
131  For a list of changes in this release, please have a
132  look at the "ChangeLog", the "What's New" section or
133  the "Upgrader's Notes" in <citetitle>the User Manual</citetitle>.
134 </para>
135
136 </sect1>
137
138 <!--   ~~~~~       New section      ~~~~~     -->
139 <sect1 id="install" ><title>INSTALL</title>
140 <para>
141  See the <filename>INSTALL</filename> file in this directory, for installing
142  from raw source, and the <citetitle>User Manual</citetitle>, for all other
143  installation types.
144 </para>
145 </sect1>
146
147 <!--   ~~~~~       New section      ~~~~~     -->
148 <sect1 id="run"><title>RUN</title>
149 <para>
150  privoxy [--help] [--version]
151  [--no-daemon] [--pidfile PIDFILE] [--user USER[.GROUP]] [--chroot]  [--pre-chroot-nslookup
152  HOSTNAME ][config_file]
153 </para>
154 <para>
155  See the man page or <citetitle>User Manual</citetitle> for an explanation of each option, and
156  other configuration and usage issues.
157 </para>
158 <para>
159  If no config_file is specified on the command line, Privoxy will look for a
160  file named 'config' in the current directory (except Win32 which will look
161  for 'config.txt'). If no config_file is found, Privoxy will fail to start.
162 </para>
163 </sect1>
164
165 <!--   ~~~~~       New section      ~~~~~     -->
166 <sect1 id="configuration"><title>CONFIGURATION</title>
167 <para>
168  See: 'config', 'default.action', 'user.action', 'default.filter', and
169  'user.filter'. 'user.action' and 'user.filter' are for personal and local
170  configuration preferences. These are all well commented. Most of the magic is
171  in '*.action' files. 'user.action' should be used for any actions
172  customizations. On Unix-like systems, these files are typically installed in
173  /etc/privoxy.  On Windows, then wherever the executable itself is installed.
174  There are many significant changes and advances from earlier versions. The
175  <citetitle>User Manual</citetitle> has an explanation of all configuration
176  options, and examples: https://www.privoxy.org/user-manual/.
177 </para>
178 <para>
179  Be sure to set your browser(s) for HTTP/HTTPS Proxy at &lt;IP&gt;:&lt;Port&gt;, or
180  whatever you specify in the config file under 'listen-address'. DEFAULT is
181  127.0.0.1:8118. Note that Privoxy ONLY proxies HTTP (and HTTPS) traffic. Do not try it
182  with FTP or other protocols for the simple reason it does not work.
183 </para>
184 <para>
185  The actions list can be configured via the web interface accessed via
186  http://p.p/, as well other options.
187 </para>
188 <![%p-not-stable;[
189 <para>
190  All configuration files are subject to unannounced changes during the
191  development process.
192 </para>
193 ]]>
194 </sect1>
195
196 <!--   ~~~~~       New section      ~~~~~     -->
197 <sect1 id="documentation"><title>DOCUMENTATION</title>
198 <para>
199  There should be documentation in the 'doc' subdirectory<![%p-not-stable;[, but it
200  may not be completed at this point]]>. In particular, see the
201  <citetitle>User Manual</citetitle> there,
202  the <citetitle>FAQ</citetitle>, and those interested in Privoxy development, should look at
203  <citetitle>developer-manual</citetitle>.
204 </para>
205 <para>
206  <![%p-not-stable;[
207  The most up to date source of information on the current development version,
208  may still be either comments in the source code, or the included
209  configuration files. ]]>The source and configuration files are all well
210  commented. The main configuration files are: 'config', 'default.action', and
211  'default.filter'<![%p-not-stable;[ in the top-level source directory]]>.
212 </para>
213
214 <para>
215  Included documentation may vary according to platform and packager. All
216  documentation is posted on https://www.privoxy.org, in case you don't have it,
217  or can't find it.
218 </para>
219 </sect1>
220
221 <!--   ~~~~~       New section      ~~~~~     -->
222 <sect1 id="contact"><title>CONTACTING THE DEVELOPERS, BUG REPORTING AND FEATURE REQUESTS</title>
223 <!-- Include contacting.sgml boilerplate: -->
224   &contacting;
225 <!-- end boilerplate -->
226 </sect1>
227
228 <!-- <para> -->
229 <!--  <LiteralLayout> -->
230 <!--  ------------------------------------------------------------------------- -->
231 <!--  ijbswa-developers@lists.sourceforge.net -->
232 <!-- </LiteralLayout> -->
233 <!-- </para> -->
234 <!-- <para> -->
235 <!--  $Id: readme.sgml,v 2.57 2016/02/26 12:27:32 fabiankeil Exp $ -->
236 <!-- </para> -->
237
238 </article>