Syncing from 3.0 branch - 2.9.16

[privoxy.git] / doc / source / readme.sgml

diff --git a/doc/source/readme.sgml b/doc/source/readme.sgml
index 729d503..751f7e0 100644 (file)
--- a/doc/source/readme.sgml
+++ b/doc/source/readme.sgml
@@ -17,15 +17,10 @@
 
  Purpose     :  README for Privoxy
                 
- $Id: readme.sgml,v 1.13 2002/05/04 08:44:45 swa Exp $
-
- Written by and Copyright (C) 2001 the SourceForge
- Privoxy team. http://www.privoxy.org/
-
- Based on the Internet Junkbuster originally written
- by and Copyright (C) 1997 Anonymous Coders and 
- Junkbusters Corporation.  http://www.junkbusters.com
+ $Id: readme.sgml,v 1.16.2.2 2002/07/25 21:49:52 hal9 Exp $
 
+ Copyright (C) 2001, 2002 Privoxy Developers <developers@privoxy.org>
+ See LICENSE.
 
  ========================================================================
  NOTE: Please read developer-manual/documentation.html before touching 
@@ -64,6 +59,7 @@
 
 -->
 <article id="index">
+<artheader>
 <![%dummy;[
  <para>
  <comment>
@@ -73,6 +69,7 @@
  </comment>
  </para>
 ]]>
+<abstract>
 <para>
  <literal>
   <msgtext>
@@ -113,7 +110,7 @@
 </msgtext>
 </literal>
 </para>
- 
+
 <para>
  <!-- include some conditional text -->
  This README is included with <![%p-not-stable;[ the development version of]]>
@@ -121,6 +118,8 @@
  hope!)]]>. See http://www.privoxy.org/ for more information. The current code
  level is &p-status;<![%p-not-stable;[, and seems stable to us :)]]>.
 </para>
+</abstract>
+</artheader>
 
 <!-- Include privoxy.sgml boilerplate: -->
 &p-intro;
@@ -154,11 +153,13 @@
 <!--   ~~~~~       New section      ~~~~~     -->
 <sect1 id="run"><title>RUN</title>
 <para>
- privoxy [--help] [--version] [--no-daemon] [--pidfile PIDFILE] 
-  [--user USER[.GROUP]] [config_file]
+ privoxy [&mdash;&mdash;help] [&mdash;&mdash;version]
+ [&mdash;&mdash;no-daemon] [&mdash;&mdash;pidfile PIDFILE] [&mdash;&mdash;user
+ USER[.GROUP]] [config_file]
 </para>
 <para>
- See the man page or user-manual for a brief explanation of each option.
+ See the man page or User Manual for an explanation of each option, and 
+ other configuration and usage issues.
 </para>
 <para>
  If no config_file is specified on the command line, Privoxy will look for a
@@ -166,29 +167,33 @@
  for 'config.txt'). If no config_file is found, Privoxy will fail to start.
 </para>
 <para>
- Or for Red Hat: /etc/rc.d/init.d/privoxy start
+ Or for Red Hat based distributions: /etc/rc.d/init.d/privoxy start
 </para>
 <para>
  Or for SuSE:   /etc/rc.d/privoxy start
 </para>
+<para>
+ Or Debian: /etc/init.d/privoxy start
+</para>
 </sect1>
 
 <!--   ~~~~~       New section      ~~~~~     -->
 <sect1 id="configuration"><title>CONFIGURATION</title>
 <para>
  See: 'config', 'default.action', 'user.action', and 'default.filter'.
- 'user.action' is for personal configuration. These are all well commented.
- Most of the magic is in '*.action' files. 'user.action' should be 
- used for any actions customizations. On Unix-like systems, these files
- are installed in /etc/privoxy.  On Windows, then wherever the executable
- itself is installed. There are many significant changes and advances since
- Junkbuster v2.0.x. The user-manual has a run down of configuration options,
- and examples: http://www.privoxy.org/user-manual/.
+ 'user.action' is for personal and local configuration preferences. These are
+ all well commented. Most of the magic is in '*.action' files. 'user.action'
+ should be used for any actions customizations. On Unix-like systems, these
+ files are installed in /etc/privoxy.  On Windows, then wherever the
+ executable itself is installed. There are many significant changes and
+ advances since Junkbuster v2.0.x. The User Manual has an explanation of
+ all configuration options, and examples: http://www.privoxy.org/user-manual/.
 </para>
 <para>
  Be sure to set your browser(s) for HTTP/HTTPS Proxy at &lt;IP&gt;:&lt;Port&gt;, or
  whatever you specify in the config file under 'listen-address'. DEFAULT is
- localhost:8118.
+ localhost:8118. Note that Privoxy ONLY proxies HTTP (and HTTPS) traffic. Do not try it 
+ with FTP or other protocols for the simple reason it does not work.
 </para>
 <para>
  The actions list can be configured via the web interface accessed via
@@ -206,8 +211,8 @@
 <sect1 id="documentation"><title>DOCUMENTATION</title>
 <para>
  There should be documentation in the 'doc' subdirectory<![%p-not-stable;[, but it
- is not completed at this point]]>. In particular, see the user-manual there,
- the faq, and those interested in Privoxy development, should look at
+ is not completed at this point]]>. In particular, see the User Manual there,
+ the FAQ, and those interested in Privoxy development, should look at
  developer-manual. 
 </para>
 <para>
@@ -225,7 +230,7 @@
 </sect1>
 
 <!--   ~~~~~       New section      ~~~~~     -->
-<sect1 id="contact" label=""><title>CONTACTING THE DEVELOPERS, BUG REPORTING AND FEATURE REQUESTS</title>
+<sect1 id="contact"><title>CONTACTING THE DEVELOPERS, BUG REPORTING AND FEATURE REQUESTS</title>
 <!-- Include contacting.sgml boilerplate: -->
   &contacting;
 <!-- end boilerplate -->
@@ -238,7 +243,7 @@
 <!-- </LiteralLayout> -->
 <!-- </para> -->
 <!-- <para> -->
-<!--  $Id: readme.sgml,v 1.13 2002/05/04 08:44:45 swa Exp $ -->
+<!--  $Id: readme.sgml,v 1.16.2.2 2002/07/25 21:49:52 hal9 Exp $ -->
 <!-- </para> -->
 
 </article>