fb61f0adcc5eaaf6bf32ab47e7303d4eafc99047
[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.28">
8 <!entity p-status "stable">
9 <!entity % p-not-stable "IGNORE">
10 <!entity % p-stable "INCLUDE">
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        :  doc/source/readme.sgml
17
18  Purpose     :  README for Privoxy
19
20  Copyright (C) 2001-2018 Privoxy Developers https://www.privoxy.org/
21  See LICENSE.
22
23  ========================================================================
24  NOTE: Please read developer-manual/documentation.html before touching
25  anything in this, or other Privoxy documentation. You have been warned!
26  Failure to abide by this rule will result in the revocation of your license
27  to live a peaceful existence!
28  ========================================================================
29
30  ===================================================================
31  READ: Document Note: This file generates the README in the top level
32  source directory. It is generated as only a plain text file. The
33  current markup is not suitable for other formats. Build from
34  Makefile with 'make dok-readme'.
35  ===================================================================
36
37  READ:
38
39  ======================================================================
40  NOTE: The left margin spacing is *important* when using 'literallayout'
41  WYSISWYG!!! Don't mess this up!!! Careful with linebreaks too, ie
42  the para tag forces a linebreak. Tags need to be carefully placed as a result
43  to avoid extra blank lines, etc.
44  ======================================================================
45
46  For stable releases, change
47
48   entity % p-not-stable "INCLUDE"
49
50  to
51
52   entity % p-not-stable "IGNORE"
53
54  in the DTD at the top. This will toggle various text 'off'. BOTH
55  MUST be toggled in this case or you will get both text referencing
56  stable and unstable versions. You only want one or the other!
57
58 -->
59 <article id="index">
60 <artheader>
61 <![%dummy;[
62  <para>
63  <comment>
64   This is here to keep vim syntax file from breaking :/
65   If I knew enough to fix it, I would.
66   PLEASE DO NOT REMOVE! HB: hal@foobox.net
67  </comment>
68  </para>
69 ]]>
70 <abstract>
71 <para>
72  <literal>
73   <msgtext>
74    <literallayout>
75 /*********************************************************************
76  *
77  * File        :  doc/source/readme.sgml
78  *
79  * Purpose     :  README file to give a short intro.
80  *
81  * Copyright   :  Written by and Copyright (C) 2001-2018 the
82  *                Privoxy team. https://www.privoxy.org/
83  *
84  *                Based on the Internet Junkbuster originally written
85  *                by and Copyright (C) 1997 Anonymous Coders and
86  *                Junkbusters Corporation.  http://www.junkbusters.com
87  *
88  *                This program is free software; you can redistribute it
89  *                and/or modify it under the terms of the GNU General
90  *                Public License as published by the Free Software
91  *                Foundation; either version 2 of the License, or (at
92  *                your option) any later version.
93  *
94  *                This program is distributed in the hope that it will
95  *                be useful, but WITHOUT ANY WARRANTY; without even the
96  *                implied warranty of MERCHANTABILITY or FITNESS FOR A
97  *                PARTICULAR PURPOSE.  See the GNU General Public
98  *                License for more details.
99  *
100  *                The GNU General Public License should be included with
101  *                this file.  If not, you can view it at
102  *                http://www.gnu.org/copyleft/gpl.html
103  *                or write to the Free Software Foundation, Inc.,
104  *                51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
105  *                USA
106  *
107  *********************************************************************/
108 </literallayout>
109 </msgtext>
110 </literal>
111 </para>
112
113 <para>
114  <!-- include some conditional text -->
115  This README is included with <![%p-not-stable;[ the development version of]]>
116  Privoxy &p-version;. See https://www.privoxy.org/ for more information. The current code maturity
117  level is <quote>&p-status;</quote><![%p-not-stable;[, but seems stable to us :)]]>.
118 </para>
119 </abstract>
120 </artheader>
121
122 <!-- Include privoxy.sgml boilerplate: -->
123 &p-intro;
124 <!-- end boilerplate -->
125
126 <!--   ~~~~~       New section      ~~~~~     -->
127 <sect1 id="changes" ><title>CHANGES</title>
128 <para>
129  For a list of changes in this release, please have a
130  look at the "ChangeLog", the "What's New" section or
131  the "Upgrader's Notes" in <citetitle>the User Manual</citetitle>.
132 </para>
133
134 </sect1>
135
136 <!--   ~~~~~       New section      ~~~~~     -->
137 <sect1 id="install" ><title>INSTALL</title>
138 <para>
139  See the <filename>INSTALL</filename> file in this directory, for installing
140  from raw source, and the <citetitle>User Manual</citetitle>, for all other
141  installation types.
142 </para>
143 </sect1>
144
145 <!--   ~~~~~       New section      ~~~~~     -->
146 <sect1 id="run"><title>RUN</title>
147 <para>
148  privoxy [--help] [--version]
149  [--no-daemon] [--pidfile PIDFILE] [--user USER[.GROUP]] [--chroot]  [--pre-chroot-nslookup
150  HOSTNAME ][config_file]
151 </para>
152 <para>
153  See the man page or <citetitle>User Manual</citetitle> for an explanation of each option, and
154  other configuration and usage issues.
155 </para>
156 <para>
157  If no config_file is specified on the command line, Privoxy will look for a
158  file named 'config' in the current directory (except Win32 which will look
159  for 'config.txt'). If no config_file is found, Privoxy will fail to start.
160 </para>
161 </sect1>
162
163 <!--   ~~~~~       New section      ~~~~~     -->
164 <sect1 id="configuration"><title>CONFIGURATION</title>
165 <para>
166  See: 'config', 'default.action', 'user.action', 'default.filter', and
167  'user.filter'. 'user.action' and 'user.filter' are for personal and local
168  configuration preferences. These are all well commented. Most of the magic is
169  in '*.action' files. 'user.action' should be used for any actions
170  customizations. On Unix-like systems, these files are typically installed in
171  /etc/privoxy.  On Windows, then wherever the executable itself is installed.
172  There are many significant changes and advances from earlier versions. The
173  <citetitle>User Manual</citetitle> has an explanation of all configuration
174  options, and examples: https://www.privoxy.org/user-manual/.
175 </para>
176 <para>
177  Be sure to set your browser(s) for HTTP/HTTPS Proxy at &lt;IP&gt;:&lt;Port&gt;, or
178  whatever you specify in the config file under 'listen-address'. DEFAULT is
179  127.0.0.1:8118. Note that Privoxy ONLY proxies HTTP (and HTTPS) traffic. Do not try it
180  with FTP or other protocols for the simple reason it does not work.
181 </para>
182 <para>
183  The actions list can be configured via the web interface accessed via
184  http://p.p/, as well other options.
185 </para>
186 <![%p-not-stable;[
187 <para>
188  All configuration files are subject to unannounced changes during the
189  development process.
190 </para>
191 ]]>
192 </sect1>
193
194 <!--   ~~~~~       New section      ~~~~~     -->
195 <sect1 id="documentation"><title>DOCUMENTATION</title>
196 <para>
197  There should be documentation in the 'doc' subdirectory<![%p-not-stable;[, but it
198  may not be completed at this point]]>. In particular, see the
199  <citetitle>User Manual</citetitle> there,
200  the <citetitle>FAQ</citetitle>, and those interested in Privoxy development, should look at
201  <citetitle>developer-manual</citetitle>.
202 </para>
203 <para>
204  <![%p-not-stable;[
205  The most up to date source of information on the current development version,
206  may still be either comments in the source code, or the included
207  configuration files. ]]>The source and configuration files are all well
208  commented. The main configuration files are: 'config', 'default.action', and
209  'default.filter'<![%p-not-stable;[ in the top-level source directory]]>.
210 </para>
211
212 <para>
213  Included documentation may vary according to platform and packager. All
214  documentation is posted on https://www.privoxy.org, in case you don't have it,
215  or can't find it.
216 </para>
217 </sect1>
218
219 <!--   ~~~~~       New section      ~~~~~     -->
220 <sect1 id="contact"><title>CONTACTING THE DEVELOPERS, BUG REPORTING AND FEATURE REQUESTS</title>
221 <!-- Include contacting.sgml boilerplate: -->
222   &contacting;
223 <!-- end boilerplate -->
224 </sect1>
225
226 </article>