-Add privoxy-man-page.sgml, for man page.
authorhal9 <hal9@users.sourceforge.net>
Sat, 6 Apr 2002 05:07:29 +0000 (05:07 +0000)
committerhal9 <hal9@users.sourceforge.net>
Sat, 6 Apr 2002 05:07:29 +0000 (05:07 +0000)
-Add authors.sgml for AUTHORS (and p-authors.sgml)
-Reworked various aspects of various docs.
-Added additional comments to sub-docs.

14 files changed:
doc/source/authors.sgml [new file with mode: 0644]
doc/source/buildsource.sgml
doc/source/contacting.sgml
doc/source/copyright.sgml
doc/source/developer-manual.sgml
doc/source/history.sgml
doc/source/newfeatures.sgml
doc/source/p-authors.sgml [new file with mode: 0644]
doc/source/privoxy-man-page.sgml [new file with mode: 0644]
doc/source/privoxy.sgml
doc/source/readme.sgml
doc/source/seealso.sgml
doc/source/supported.sgml
doc/source/user-manual.sgml

diff --git a/doc/source/authors.sgml b/doc/source/authors.sgml
new file mode 100644 (file)
index 0000000..d916143
--- /dev/null
@@ -0,0 +1,71 @@
+<!--
+ File        :  $Source: /cvsroot/ijbswa/current/doc/source/authors.sgml,v $
+
+ Purpose     :  AUTHORS file for Privoxy
+                
+ $Id: authors.sgml,v 1.0 2002/04/04 07:06:18 hal9 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
+
+
+ ========================================================================
+ NOTE: Please read developer-manual/documentation.html before touching 
+ anything in this, or other Privoxy documentation. You have been warned!
+ Failure to abide by this rule will result in the revocation of your license 
+ to live a peaceful existence!
+ ========================================================================
+
+ ===================================================================
+ READ: Document Note: This file generates the AUTHORS file in the 
+ top level source directory. See p-authors.sgml for list of developers
+ and contributors, etc. They were split from here for use in man page.
+ ===================================================================
+
+-->
+<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook V3.1//EN" [
+<!entity % dummy "INCLUDE"> 
+<!entity authors SYSTEM "p-authors.sgml">
+<!entity p-version "2.9.13">
+<!entity p-status "BETA">
+<!entity % p-not-stable "INCLUDE"> <!-- set to IGNORE for stable release -->
+<!entity % p-stable "IGNORE">      <!-- set INCLUDE for stable release   -->
+<!entity % p-text "INCLUDE">       <!-- define we are a text only doc    -->
+<!entity % p-authors-formal "INCLUDE"> <!-- include additional text, etc -->
+]>
+
+<article id="index">
+
+<![%dummy;[
+ <para>
+ <comment>
+  This is here to keep vim syntax file from breaking :/
+  If I knew enough to fix it, I would.
+  PLEASE DO NOT REMOVE! HB: hal@foobox.net
+ </comment>
+ </para>
+]]>
+
+<literallayout>
+              Authors of <application>Privoxy</application> v2.9.x and 3.x
+===========================================================================
+</literallayout>
+
+<!-- include boilerplate p-authors.sgml -->
+ &authors;
+<!-- end boilerplate -->
+
+<para>
+ If we've missed you off this list, please let us know!
+</para>
+
+<literallayout>
+ Privoxy team. <ulink url="http://www.privoxy.org/">http://www.privoxy.org/</ulink>
+ <email>ijbswa-developers@lists.sourceforge.net</email>
+</literallayout>
+
+</article>
index bc439ba..d180c02 100644 (file)
@@ -3,7 +3,7 @@
 
  Purpose     :  Entity included in other project documents.
                 
- $Id: buildsource.sgml,v 1.0 2002/04/04 01:14:18 hal9 Exp $
+ $Id: buildsource.sgml,v 1.1 2002/04/04 06:48:37 hal9 Exp $
 
  Written by and Copyright (C) 2001 the SourceForge
  Privoxy team. http://www.privoxy.org/
   This file used for inclusion with other documents only.
  ======================================================================
 
+ If you make changes to this file, please verify the finished 
+ docs all display as intended.
+
+ This file is included into:
+
+  user-manual
+  README
+
 -->
+
 <para>
  There are several ways to install <application>Privoxy</application>.
 </para>
@@ -77,7 +86,7 @@
  <quote><command>make suse-dist</command></quote> from unpacked sources. You
  will need to run <quote><command>autoconf; autoheader;
  ./configure</command></quote> beforehand. *BSD will require gmake (from
- <ulink url="http://gnu.org">http://gnu.org</ulink>). 
+ <ulink url="http://www.gnu.org">http://www.gnu.org</ulink>). 
  <![%p-readme;[See the user-manual for OS/2 build instructions.]]>
 </para>
 
index 0f173b3..3c97b4f 100644 (file)
@@ -3,7 +3,7 @@
 
  Purpose     :  Entity included in other project documents.
                 
- $Id: contacting.sgml,v 1.1 2002/04/04 01:14:18 hal9 Exp $
+ $Id: contacting.sgml,v 1.2 2002/04/04 06:48:37 hal9 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
--->
 
-<!-- 
- READ:
  ======================================================================
- NOTE: The left margin spacing is *important* when using 'literallayout'
- WYSISWYG!!! Don't mess this up!!! Careful with linebreaks too, ie 
- <para> forces a linebreak.
+  This file used for inclusion with other documents only.
  ======================================================================
 
+ This file is included into:
 
- ======================================================================
-  This file used for inclusion with other documents only.
- ======================================================================
+  faq
+  developer-manual
+  README
+  user-manual
 
 -->
 
index d323425..6fe5fa9 100644 (file)
@@ -1,9 +1,9 @@
 <!--
- File        :  $Source: /cvsroot/ijbswa/current/doc/source/seealso.sgml,v $
+ File        :  $Source: /cvsroot/ijbswa/current/doc/source/copyright.sgml,v $
 
  Purpose     :  Entity included in other project documents.
                 
- $Id: seealso.sgml,v 1.1 2002/04/02 01:48:33 hal9 Exp $
+ $Id: copyright.sgml,v 1.1 2002/04/04 17:27:56 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
+
+ ======================================================================
+  This file used for inclusion with other documents only.
+ ======================================================================
+
+ If you make changes to this file, please verify the finished 
+ docs all display as intended.
+
+ This file is included into:
+
+  privoxy-man-page
+  user-manual
+  developer-manual
+  faq
+
 -->
 
 <para>
 
 <para>
  This program is distributed in the hope that it will be useful, but WITHOUT
- ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
- FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
- details, which is available from the Free Software Foundation,
Inc, 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+ ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
+ more details, which is available from the Free Software Foundation, Inc, 59
+ Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 </para>
 
 <para>
@@ -46,3 +61,4 @@
  along with this program; if not, write to the Free Software Foundation, Inc.,
  59 Temple Place, Suite 330, Boston, MA  02111-1307  USA.
 </para>
+
index 66a07c4..a8c8fa2 100644 (file)
@@ -21,7 +21,7 @@
                 This file belongs into
                 ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/
                 
- $Id: developer-manual.sgml,v 1.23 2002/04/04 18:46:47 swa Exp $
+ $Id: developer-manual.sgml,v 1.24 2002/04/04 21:33:37 hal9 Exp $
 
  Written by and Copyright (C) 2001 the SourceForge
  Privoxy team. http://www.privoxy.org/
@@ -44,7 +44,7 @@
   <artheader>
     <title>Privoxy Developer Manual</title>
 
-    <pubdate>$Id: developer-manual.sgml,v 1.23 2002/04/04 18:46:47 swa Exp $</pubdate>
+    <pubdate>$Id: developer-manual.sgml,v 1.24 2002/04/04 21:33:37 hal9 Exp $</pubdate>
 
     <authorgroup>
       <author>
@@ -336,7 +336,7 @@ following guidelines for changing stuff in the code. If it is
    </listitem> 
    <listitem>
     <para>
-      Tags should be nested like:
+      Tags should be nested and step indented like:
        <literallayout>
  &lt;para&gt;
   &lt;itemizedlist&gt;
@@ -371,6 +371,13 @@ following guidelines for changing stuff in the code. If it is
      idiosyncrasies (too many to list :).
    </para>
   </listitem> 
+  <listitem>
+   <para>
+    Try to keep overall line lengths in source files to 80 characters or less
+    for obvious reasons. This is not always possible, with lenghty URLs for
+    instance.
+   </para>
+  </listitem> 
   <listitem>
    <para>
     Our documents are available in differing formats. Right now, they 
@@ -1615,7 +1622,7 @@ static void unload_re_filterfile( void *f ) { ... }</programlisting>
 
     <para><emphasis>Example for file comments:</emphasis></para>
 <programlisting>
-const char FILENAME_rcs[] = "$Id: developer-manual.sgml,v 1.23 2002/04/04 18:46:47 swa Exp $";
+const char FILENAME_rcs[] = "$Id: developer-manual.sgml,v 1.24 2002/04/04 21:33:37 hal9 Exp $";
 /*********************************************************************
  *
  * File        :  $S<!-- Break CVS Substitution -->ource$
@@ -1675,7 +1682,7 @@ const char FILENAME_h_rcs[] = FILENAME_H_VERSION;
 <programlisting>
 #ifndef _FILENAME_H
 #define _FILENAME_H
-#define FILENAME_H_VERSION "$Id: developer-manual.sgml,v 1.23 2002/04/04 18:46:47 swa Exp $"
+#define FILENAME_H_VERSION "$Id: developer-manual.sgml,v 1.24 2002/04/04 21:33:37 hal9 Exp $"
 /*********************************************************************
  *
  * File        :  $S<!-- Break CVS Substitution -->ource$
@@ -2401,6 +2408,9 @@ zip -r privoxyosx_setup_x.y.z.zip Privoxy.pkg
   Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 
   $Log: developer-manual.sgml,v $
+  Revision 1.24  2002/04/04 21:33:37  hal9
+  More on documenting the documents.
+
   Revision 1.23  2002/04/04 18:46:47  swa
   consistent look. reuse of copyright, history et. al.
 
index 2ed79fb..f8a59bd 100644 (file)
@@ -1,9 +1,9 @@
 <!--
- File        :  $Source: /cvsroot/ijbswa/current/doc/source/seealso.sgml,v $
+ File        :  $Source: /cvsroot/ijbswa/current/doc/source/history.sgml,v $
 
  Purpose     :  Entity included in other project documents.
                 
- $Id: seealso.sgml,v 1.1 2002/04/02 01:48:33 hal9 Exp $
+ $Id: history.sgml,v 1.1 2002/04/04 17:27:57 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
+
+ ======================================================================
+  This file used for inclusion with other documents only.
+ ======================================================================
+
+ If you make changes to this file, please verify the finished 
+ docs all display as intended.
+
+ This file is included into:
+
+  user-manual
+  developer-manual
+  faq
+
 -->
 
 <para>
index d9aa60f..7624f2c 100644 (file)
@@ -1,9 +1,9 @@
 <!--
- File        :  $Source: /cvsroot/ijbswa/current/doc/source/newfeaturs.sgml,v $
+ File        :  $Source: /cvsroot/ijbswa/current/doc/source/newfeatures.sgml,v $
 
  Purpose     :  Entity included in other project documents.
                 
- $Id: newfeatures.sgml,v 1.0 2002/04/01 16:24:49 hal9 Exp $
+ $Id: newfeatures.sgml,v 1.2 2002/04/02 00:55:46 hal9 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
+
+ ======================================================================
+  This file used for inclusion with other documents only.
+ ======================================================================
+
+ If you make changes to this file, please verify the finished 
+ docs all display as intended.
+
+ This file is included into:
+
+  user-manual
+  faq
+
 -->
 <para>
  <itemizedlist>
diff --git a/doc/source/p-authors.sgml b/doc/source/p-authors.sgml
new file mode 100644 (file)
index 0000000..afcc208
--- /dev/null
@@ -0,0 +1,95 @@
+<!--
+ File        :  $Source: /cvsroot/ijbswa/current/doc/source/p-authors.sgml,v $
+
+ Purpose     :  Entity included in other project documents.
+                
+ $Id: p-authors.sgml,v 1.0 2002/04/02 01:48:33 hal9 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
+
+
+ ======================================================================
+  This file used for inclusion with other documents only.
+ ======================================================================
+
+ If you make changes to this file, please verify the finished 
+ docs all display as intended.
+
+ This file is included into:
+
+  privoxy-man-page
+  AUTHORS
+
+-->
+<![%p-authors-formal;[
+<para>
+ Current Project Developers:
+</para>
+]]>
+
+<literallayout>
+ Stefan Waldherr
+ Andreas Oesterhelt
+ Jon Foster
+<![%p-authors-formal;[
+ ]]>
+ Markus Breitenbach
+ Thomas Steudten
+<![%p-authors-formal;[
+</literallayout>
+
+<para>
+ Current Project Contributors:
+</para>
+
+<literallayout>
+]]>
+ David Schmidt (OS/2, Mac OSX ports)
+ Gabriel L. Somlo
+ Hal Burgiss (docs)
+ Haroon Rafique
+ John Venvertloh
+ Joerg Strohmayer
+ Rodney Stromlund
+ Rodrigo Barbosa (RPM specfiles)
+ Sarantis Paskalis
+ Shamim Mohamed
+ Gábor Lipták
+</literallayout>
+
+<![%p-authors-formal;[
+<para>
+ Originally developed by:
+</para>
+
+<literallayout>
+ Junkbusters Corp.
+ Anonymous Coders
+</literallayout>
+
+<para>
+ Thanks to the many people who have tested Privoxy, reported bugs, or made
+ suggestions. These include (in alphabetical order):
+</para>
+
+<literallayout>
+ Aaron Hamid
+ Alexander Lazic  (FreeBSD patch)
+ Andrew J. Caines
+ Bart Schelstraete
+ Clifford Caoile
+ Darren Wiebe
+ Gabor Liptak
+ Guy
+ Ken Arromdee
+ Magnus Holmgren
+ Paul Lieverse
+ Peter E
+ Reiner Buehl
+</literallayout>
+]]>
diff --git a/doc/source/privoxy-man-page.sgml b/doc/source/privoxy-man-page.sgml
new file mode 100644 (file)
index 0000000..8644ce0
--- /dev/null
@@ -0,0 +1,414 @@
+<!--
+ File        :  $Source: /cvsroot/ijbswa/current/doc/source/privoxy-man-page.sgml,v $
+
+ Purpose     :  Manual Page
+                This file belongs into
+                ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/
+                
+ $Id: privoxy-man-page.sgml,v 1.0 2002/04/04 21:59:53 hal9 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
+
+ ========================================================================
+ NOTE: Please read developer-manual/documentation.html before touching 
+ anything in this, or other Privoxy documentation. You have been warned!
+ Failure to abide by this rule will result in the revocation of your license 
+ to live a peaceful existence!
+ ========================================================================
+
+ Doc NOTES: This is some tricky stuff! There are some quirks
+ to how this markup is handled. It is not always so co-operative.
+ Please don't change the markup, unless you are willing to 
+ un-do your changes! 
+ literallayout tags are particularly sensitive to where they are placed.
+ The 'replaceable' and 'command' tags are used here somewhat unconventionally,
+ since it seems to generate the proper formatting (at least for me :).
+
+ Create man page: 'docbook2man privoxy-man-page.sgml'
+
+ For man page references, see:
+ http://www.linuxdoc.org/HOWTO/mini/DocBook-Install/using.html
+ http://docbook.org/tdg/en/html/ch02.html#making-refentry
+
+-->
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN"[
+<!entity % dummy "INCLUDE"> 
+<!entity p-intro SYSTEM "privoxy.sgml">
+<!entity seealso SYSTEM "seealso.sgml">
+<!entity copyright SYSTEM "copyright.sgml">
+<!entity authors SYSTEM "p-authors.sgml">
+<!entity p-version "2.9.13">
+<!entity p-status "BETA">
+<!entity % p-not-stable "INCLUDE">    <!-- set to IGNORE for stable release  -->
+<!entity % p-stable "IGNORE">         <!-- set INCLUDE for stable release    -->
+<!entity % p-text "IGNORE">           <!-- define we are not a text only doc -->
+<!entity % p-authors-formal "IGNORE"> <!-- exclude additional formating      -->
+]>
+
+<refentry id="privoxy">
+<refentryinfo>
+ <date>2002-04-04</date>
+</refentryinfo>
+
+<refmeta>
+ <refentrytitle>privoxy</refentrytitle> 
+ <manvolnum>1</manvolnum>
+ <refmiscinfo>Privoxy &p-version;<![%p-not-stable;[ &p-status;]]></refmiscinfo>
+</refmeta>
+
+<refnamediv>
+ <refname><application>privoxy</application></refname>
+ <refpurpose>Privacy Enhancing Proxy</refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+ <cmdsynopsis> 
+  <command>privoxy</command>
+  <arg><option>--help</option></arg>
+  <arg><option>--version</option></arg>
+  <arg><option>--no-daemon</option></arg>
+  <arg><option>--pidfile </option><replaceable class="parameter">pidfile</replaceable></arg>  
+  <arg><option>--user </option><replaceable class="parameter">user[.group]</replaceable></arg> 
+  <arg><replaceable class="parameter">configfile</replaceable></arg>        
+  <command>(UNIX)</command>
+ </cmdsynopsis>
+
+ <cmdsynopsis> 
+  <command>privoxy.exe</command>              
+  <arg><replaceable class="parameter">configfile</replaceable></arg>
+  <command>(Windows)</command>
+ </cmdsynopsis>                                      
+</refsynopsisdiv>
+
+
+<!--   ~~~~~       New section      ~~~~~     -->
+<refsect1><title>Options</title>
+ <para>
+  <command>Privoxy</command> may be invoked with the following command line
+  options:
+ </para>
+
+ <variablelist>                                          
+  <varlistentry>
+    <term>--help</term>
+      <listitem>
+       <para>
+         Print brief usage info and exit.
+        </para>
+      </listitem>
+  </varlistentry>
+
+  <varlistentry>
+    <term>--version</term>
+      <listitem>
+       <para>
+         Print version info and exit.
+        </para>
+      </listitem>
+  </varlistentry>
+
+  <varlistentry>
+    <term>--no-daemon</term>
+     <listitem>
+      <para>
+        Don't  become  a daemon, i.e. don't fork and become process group
+        leader, don't detach from controlling tty, and do all logging there.
+      </para>
+    </listitem>
+  </varlistentry>
+
+  <varlistentry>
+    <term>--pidfile <replaceable class="parameter">pidfile</replaceable></term>
+     <listitem>
+      <para>
+       After (optionally) writing the PID file, assume the user  ID  of  user
+       and the GID of group, or, if the optional group was not given, the
+       default group  of user.  Exit if the privileges are not sufficient to
+       do so.
+      </para>
+    </listitem>
+  </varlistentry>
+  <varlistentry>
+    <term>--user <replaceable class="parameter">user[.group]</replaceable></term>
+     <listitem>
+      <para>
+       <!-- Note: replaceable is maybe the wrong tag, but generates  -->
+       <!-- correct looking man output.                              -->
+       After (optionally) writing the PID file, assume the user ID of
+       <replaceable>user</replaceable> and the GID of
+       <replaceable>group</replaceable>, or, if the optional
+       <replaceable>group</replaceable> was not given, the default group of
+       <replaceable>user</replaceable>. Exit if the privileges are not
+       sufficient to do so.
+     </para>
+    </listitem>
+  </varlistentry>
+ </variablelist>
+ <para>
+  If the <filename>configfile</filename> is not specified on  the  command  line,
+  <command>Privoxy</command>  will  look for a file named
+  <filename>config</filename> in the current directory (except on Win32 where
+  it will try <filename>config.txt</filename>). If no
+  <filename>configfile</filename> is found, <command>Privoxy</command> will 
+  fail to start.
+ </para>
+
+</refsect1>
+
+
+<!--   ~~~~~       New section      ~~~~~     -->
+<refsect1><title>Description</title>
+<!-- Include privoxy.sgml boilerplate: -->
+ &p-intro;
+<!-- end boilerplate -->
+</refsect1>
+
+
+<!--   ~~~~~       New section      ~~~~~     -->
+<refsect1><title>Installation and Usage</title>
+<para>
+ Browsers must be individually configured to use <command>Privoxy</command> as
+ a HTTP proxy.  The default setting is  for  localhost,  on port  8118
+ (configurable in the main config file).  To set the HTTP proxy in Netscape
+ and Mozilla, go through:  <command>Edit</command>;
+ <command>Preferences</command>;  <command>Advanced</command>;
+ <command>Proxies</command>;  <command>Manual Proxy Configuration</command>;
+ <command>View</command>. 
+</para>
+<para>
+ For Internet Explorer, go through: <command>Tools</command>; 
+ <command>Internet Properties</command>; <command>Connections</command>;
+ <command>LAN Settings</command>. 
+</para>
+<para>
+ The Secure (SSL) Proxy should also be set to the same values, otherwise
+ https: URLs will not be proxied. 
+</para>
+<para>
+ For other browsers, check the documentation.
+</para>
+</refsect1>
+
+
+<!--   ~~~~~       New section      ~~~~~     -->
+<refsect1><title>Configuration</title>
+<para>
+ <command>Privoxy</command> can be configured with the various configuration
+ files. The default configuration files are: <filename>config</filename>,
+ <filename>default.action</filename>, and
+ <filename>default.filter</filename>. These are well commented.  On Unix and
+ Unix-like systems, these are located in <filename>/etc/privoxy/</filename> by
+ default. On Windows, OS/2 and AmigaOS, these files are in the same directory
+ as the <command>Privoxy</command> executable.
+</para>
+<para>
+ The name and number of configuration files has changed from previous
+ versions, and is subject to change as development progresses. In fact, the
+ configuration itself is changed  and  much more sophisticated. See the
+ <ulink url="http://www.privoxy.org/user-manual/">user-manual</ulink> for a
+ brief explanation of all configuration options. 
+</para>
+<para>
+ The actions list (ad blocks, etc) can also be configured with your
+ web browser at <ulink url="http://ijbswa.sourceforge.net/config">http://ijbswa.sourceforge.net/config</ulink>.
+ <command>Privoxy's</command> configuration parameters  can also  be viewed at
+ the same page. In addition, <command>Privoxy</command> can be toggled on/off.
+ This is an internal page.
+</para>
+</refsect1>
+
+
+<!--   ~~~~~       New section      ~~~~~     -->
+<refsect1><title>Sample Configuration</title>
+<para>
+ A brief example of what a <filename>default.action</filename> configuration
+ might look like:
+</para>
+
+<literallayout>
+
+ # Define a few useful custom aliases for later use
+ {{alias}}
+
+ # Don't accept cookies
+ +no-cookies = +no-cookies-set +no-cookies-read
+
+ # Do accept cookies
+ -no-cookies = -no-cookies-set -no-cookies-read
+
+ # Treat these blocked URLs as images.
+ +imageblock = +block +image
+
+ # Define page filters we want to use.
+ myfilters = +filter{html-annoyances} +filter{js-annoyances}\
+             +filter{no-popups} +filter{webbugs}
+
+ ## Default Policies (actions) ############################
+ { \
+  -block \
+  -downgrade \
+  +fast-redirects \
+  myfilters \
+  +no-compression \
+  +hide-forwarded \
+  +hide-from{block} \
+  +hide-referer{forge} \
+  -hide-user-agent \
+  -image \
+  +image-blocker{blank} \
+  +no-cookies-keep \
+  -no-cookies-read \
+  -no-cookies-set \
+  +no-popups \
+  -vanilla-wafer \
+  -wafer \
+ }
+ /
+
+ # Now set exceptions to the above defined policies #######
+
+ # Sites where we want persistant cookies
+ {-no-cookies -no-cookies-keep}
+  .redhat.com
+  .sun.com
+  .yahoo.com
+  .msdn.microsoft.com
+
+ # This site requires cookies AND 'fast-redirects' on
+ {-no-cookies -no-cookies-keep -fast-redirects}
+  .nytimes.com
+
+ # Add custom headers, and turn off filtering of page source
+ {+add-header{X-Privacy: Yes please} #-add-header{*} \
+  +add-header{X-User-Tracking: No thanks!} -filter}
+  privacy.net
+
+ # Block, and treat these URLs as 'images'.
+ {+imageblock}
+  .adforce.imgis.com
+  .ad.preferences.com/image.*
+  .ads.web.aol.com
+  .ad-adex3.flycast.com
+  .ad.doubleclick.net
+  .ln.doubleclick.net
+  .ad.de.doubleclick.net
+  /.*/count\.cgi\?.*df=
+  194.221.183.22[1-7]
+  a196.g.akamai.net/7/196/2670/000[12]/images.gmx.net/i4/images/.*/
+
+ # Block any URLs that match these patterns
+ {+block}
+  /.*/(.*[-_.])?ads?[0-9]?(/|[-_.].*|\.(gif|jpe?g))
+  /.*/(plain|live|rotate)[-_.]?ads?/
+  /.*/(sponsor)s?[0-9]?/
+  /.*/ad(server|stream|juggler)\.(cgi|pl|dll|exe)
+  /.*/adbanners/
+  /.*/adv((er)?ts?|ertis(ing|ements?))?/
+  /.*/banners?/
+  /.*/popupads/
+  /.*/advert[0-9]+\.jpg
+  /ad_images/
+  /.*/ads/
+  /images/.*/.*_anim\.gif
+  /rotations/ 
+  /.*(ms)?backoff(ice)?.*\.(gif|jpe?g)
+  195.63.104.*/(inbox|log|meld|folderlu|folderru|log(in|out)[lmr]u|)
+  .images.nytimes.com
+  .images.yahoo.com/adv/
+  /.*cnnstore\.gif
+
+</literallayout>
+
+<para>
+ See the comments in the configuration files themselves, or the 
+ <citetitle>user-manual</citetitle>
+ for explanations of the above syntax, and other <command>Privoxy</command>
+ configuration options.
+</para>
+
+</refsect1>
+
+
+<!--   ~~~~~       New section      ~~~~~     -->
+<refsect1><title>Files</title>
+<!-- this is a cheesy way to do this, but WTF. -->
+<literallayout> 
+ <filename>/usr/sbin/privoxy</filename>
+ <filename>/etc/privoxy/config</filename>
+ <filename>/etc/privoxy/default.action</filename>
+ <filename>/etc/privoxy/advanced.action</filename>
+ <filename>/etc/privoxy/basic.action</filename>
+ <filename>/etc/privoxy/intermediate.action</filename>
+ <filename>/etc/privoxy/default.filter</filename>
+ <filename>/etc/privoxy/trust</filename>
+ <filename>/etc/privoxy/templates/*</filename>
+ <filename>/var/log/privoxy/logfile</filename>
+</literallayout>
+
+<para>
+ Various other files should be included, but may vary depending on platform
+ and build configuration. More documentation should be included in the local
+ documentation directory, though is not complete at this time.
+</para>
+
+</refsect1>
+
+
+<!--   ~~~~~       New section      ~~~~~     -->
+<refsect1><title>Signals</title>
+<para>
+ <!-- command tag is used here to get proper looking format  -->
+ <command>Privoxy</command> terminates on the <command>SIGINT</command>,
+ <command>SIGTERM</command> and <command>SIGABRT</command> signals. Log
+ rotation scripts may cause a re-opening of the logfile by sending a 
+ <command>SIGHUP</command> to <command>Privoxy</command>. Note that unlike
+ other daemons,  <command>Privoxy</command> does not need to be made aware of
+ config file changes by <command>SIGHUP</command> -- it will detect them
+ automatically. 
+</para>
+
+</refsect1>
+
+<!--   ~~~~~       New section      ~~~~~     -->
+<refsect1><title>Notes</title>
+<![%p-not-stable;[
+<para>
+ This is a &p-status; version of <command>Privoxy</command>. Not 
+ all features are well tested.
+</para>]]>
+<para>
+ Please see the <citetitle>user-manual</citetitle> on how to contact the
+ developers for feature requests, reporting problems, and other questions.
+</para>
+
+</refsect1>
+
+<!--   ~~~~~       New section      ~~~~~     -->
+<refsect1><title>See Also</title>
+<!-- Include seealso.sgml boilerplate: -->
+ &seealso;
+<!-- end boilerplate -->
+</refsect1>
+
+<!--   ~~~~~       New section      ~~~~~     -->
+<refsect1><title>Development Team</title>
+<!-- Include p-authors.sgml boilerplate: -->
+ &authors;
+<!-- end boilerplate -->
+</refsect1>
+
+<!--   ~~~~~       New section      ~~~~~     -->
+<refsect1><title>Copyright and License</title>
+<!-- Include seealso.sgml boilerplate: -->
+ &copyright;
+<!-- end boilerplate -->
+</refsect1>
+
+</refentry>
index d6174e5..d4bfa3a 100644 (file)
@@ -3,7 +3,7 @@
 
  Purpose     :  Entity included in other project documents.
                 
- $Id: privoxy.sgml,v 1.1 2002/04/02 00:54:19 hal9 Exp $
+ $Id: privoxy.sgml,v 1.2 2002/04/04 06:48:37 hal9 Exp $
 
  Written by and Copyright (C) 2001 the SourceForge
  Privoxy team. http://www.privoxy.org/
  by and Copyright (C) 1997 Anonymous Coders and 
  Junkbusters Corporation.  http://www.junkbusters.com
 
--->
-
-<!--
 
  ======================================================================
   This file used for inclusion with other documents only.
  ======================================================================
 
+ If you make changes to this file, please verify the finished 
+ docs all display as intended.
+
+ This file is included into:
+
+  privoxy-man-page
+  user-manual
+  faq
+  developer-manual
+  README
+
 -->
 
 <para>
@@ -34,7 +42,7 @@
 
 <para>
  <application>Privoxy</application> is based on the code of the 
- <application>Internet Junkbuster</application>.
+ <application>Internet Junkbuster</application> (tm).
  <application>Junkbuster</application> was originally written by JunkBusters
  Corporation, and was released as free open-source software under the GNU GPL.
  Stefan Waldherr made many improvements, and started the SourceForge project
@@ -44,6 +52,6 @@
 <para>
  <application>Privoxy</application> continues the
  <application>Junkbuster</application> tradition, but adds many 
- refinements and enhancements.
+ refinements, enhancements and new features.
 </para>
 
index 10a515c..23810bf 100644 (file)
@@ -17,7 +17,7 @@
 
  Purpose     :  README for Privoxy
                 
- $Id: readme.sgml,v 1.2 2002/04/04 06:48:37 hal9 Exp $
+ $Id: readme.sgml,v 1.3 2002/04/04 07:06:18 hal9 Exp $
 
  Written by and Copyright (C) 2001 the SourceForge
  Privoxy team. http://www.privoxy.org/
  by and Copyright (C) 1997 Anonymous Coders and 
  Junkbusters Corporation.  http://www.junkbusters.com
 
+
+ ========================================================================
+ NOTE: Please read developer-manual/documentation.html before touching 
+ anything in this, or other Privoxy documentation. You have been warned!
+ Failure to abide by this rule will result in the revocation of your license 
+ to live a peaceful existence!
+ ========================================================================
+
  ===================================================================
  READ: Document Note: This file generates the README in the top level 
  source directory. It is generated as only a plain text file. The 
@@ -39,7 +47,7 @@
  NOTE: The left margin spacing is *important* when using 'literallayout'
  WYSISWYG!!! Don't mess this up!!! Careful with linebreaks too, ie 
  the para tag forces a linebreak. Tags need to be carefully placed as a result
- to avoid extra blank lines, etc.
+ to avoid extra blank lines, etc. 
  ======================================================================
 
  For stable releases, change 
@@ -51,7 +59,8 @@
   entity % p-not-stable "IGNORE" 
   
  in the DTD at the top. This will toggle various text 'off'. BOTH
- MUST be toggled in this case.
+ MUST be toggled in this case or you will get both text referencing 
+ stable and unstable versions. You only want one or the other!
 
 -->
 
   [--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 a brief explanation of each option.
 </para>
 <para>
  If no config_file is specified on the command line, Privoxy will look for a
@@ -253,7 +262,7 @@ See the man page or user-manual for a brief explanation of each option.
  </LiteralLayout>
 </para>
 <para>
- $Id: readme.sgml,v 1.2 2002/04/04 06:48:37 hal9 Exp $
+ $Id: readme.sgml,v 1.3 2002/04/04 07:06:18 hal9 Exp $
 </para>
 
 </article>
index fb5d226..a2040ef 100644 (file)
@@ -3,7 +3,7 @@
 
  Purpose     :  Entity included in other project documents.
                 
- $Id: seealso.sgml,v 1.0 2002/04/02 00:54:19 hal9 Exp $
+ $Id: seealso.sgml,v 1.1 2002/04/02 01:48:33 hal9 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
+
+      ===========================================
+
+ If you make changes to this file, please verify the finished 
+ docs all display as intended.
+
+ This file is included into:
+
+  privoxy-man-page
+  user-manual
+  faq
+  developer-manual
+
+ NOTE: 04/05/02, HB Removed &nbsp; tags. They were causing docbook2man 
+ to barf.
+
 -->
 
 <para>
 <para>
  <simplelist>
   <member>
-   &nbsp; <ulink
+    <ulink
    url="http://www.privoxy.org/">http://www.privoxy.org/</ulink>, 
    The <application>Privoxy</application> Home page. 
   </member>
  </simplelist>
  <simplelist>
   <member>
-   &nbsp; <ulink url="http://sourceforge.net/projects/ijbswa">http://sourceforge.net/projects/ijbswa</ulink>, 
+    <ulink url="http://sourceforge.net/projects/ijbswa">http://sourceforge.net/projects/ijbswa</ulink>, 
    the Project Page for <application>Privoxy</application> on 
    <ulink url="http://sourceforge.net">Sourceforge</ulink>.
   </member>
  </simplelist>
  <simplelist>
   <member>
-   &nbsp; <ulink url="http://p.p/">http://p.p/</ulink>, access
+    <ulink url="http://p.p/">http://p.p/</ulink>, access
    <application>Privoxy</application> from your browser. Alternately, 
    <ulink url="http://config.privoxy.org">http://config.privoxy.org</ulink>
    may work in some situations where the first does not.
  </simplelist>
  <simplelist>
   <member>
-   &nbsp; <ulink url="http://www.junkbusters.com/ht/en/cookies.html">http://www.junkbusters.com/ht/en/cookies.html</ulink>
+    <ulink url="http://www.junkbusters.com/ht/en/cookies.html">http://www.junkbusters.com/ht/en/cookies.html</ulink>
   </member>
  </simplelist>
  <simplelist>
   <member>
-   &nbsp; <ulink url="http://www.waldherr.org/junkbuster/">http://www.waldherr.org/junkbuster/</ulink>
+    <ulink url="http://www.waldherr.org/junkbuster/">http://www.waldherr.org/junkbuster/</ulink>
   </member>
  </simplelist>
  <simplelist>
   <member>
-   &nbsp; <ulink url="http://privacy.net/analyze/">http://privacy.net/analyze/</ulink>
+    <ulink url="http://privacy.net/analyze/">http://privacy.net/analyze/</ulink>
   </member>
  </simplelist>
  <simplelist>
   <member>
-   &nbsp;<ulink url="http://www.squid-cache.org/">http://www.squid-cache.org/</ulink>
+   <ulink url="http://www.squid-cache.org/">http://www.squid-cache.org/</ulink>
   </member>
  </simplelist>
 
index f45f48f..9ce71c5 100644 (file)
@@ -3,7 +3,7 @@
 
  Purpose     :  Entity included in other project documents.
                 
- $Id: supported.sgml,v 1.3 2002/04/04 06:48:37 hal9 Exp $
+ $Id: supported.sgml,v 1.4 2002/04/04 14:59:13 swa Exp $
 
  Written by and Copyright (C) 2001 the SourceForge
  Privoxy team. http://www.privoxy.org/
   This file used for inclusion with other documents only.
  ======================================================================
 
+ If you make changes to this file, please verify the finished 
+ docs all display as intended.
+
+ This file is included into:
+
+  user-manual
+  faq
+
 -->
 <para>
  At present, <application>Privoxy</application> is known to run on Win32, Mac
index bb79008..5510575 100644 (file)
@@ -24,7 +24,7 @@
                 This file belongs into
                 ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/
                 
- $Id: user-manual.sgml,v 1.67 2002/04/04 17:27:57 swa Exp $
+ $Id: user-manual.sgml,v 1.68 2002/04/04 18:46:47 swa Exp $
 
  Written by and Copyright (C) 2001 the SourceForge
  Privoxy team. http://www.privoxy.org/
  by and Copyright (C) 1997 Anonymous Coders and 
  Junkbusters Corporation.  http://www.junkbusters.com
 
+
+ ========================================================================
+ NOTE: Please read developer-manual/documentation.html before touching 
+ anything in this, or other Privoxy documentation. You have been warned!
+ Failure to abide by this rule will result in the revocation of your license 
+ to live a peaceful existence!
+ ========================================================================
+
 -->
 
 <article id="index">
 <artheader>
 <title>Privoxy User Manual</title>
 
-<pubdate>$Id: user-manual.sgml,v 1.67 2002/04/04 17:27:57 swa Exp $</pubdate>
+<pubdate>$Id: user-manual.sgml,v 1.68 2002/04/04 18:46:47 swa Exp $</pubdate>
 
 <authorgroup>
  <author>
 
 <para>
  This documentation is included with the current &p-status; version of
- <application>Privoxy</application> and is mostly complete at this
- point. The most up to date reference for the time being is still the comments
- in the source files and in the individual configuration files. Development
- of version 3.0 is currently nearing completion, and includes many significant
- changes and enhancements over earlier versions. The target release date for
- stable v3.0 is <quote>soon</quote> ;-)
+ <application>Privoxy</application>, v.&p-version;<![%p-not-stable;[, 
+ and is mostly complete at this point. The most up to date reference for the
+ time being is still the comments in the source files and in the individual
+ configuration files. Development of version 3.0 is currently nearing
+ completion, and includes many significant changes and enhancements over
+ earlier versions. The target release date for
+ stable v3.0 is <quote>soon</quote> ;-)]]>.
 </para>
 
 <![%p-not-stable;[
@@ -287,9 +296,9 @@ Thanx David Schmidt!
  source distribution because it differs based on platform.  You will also
  need a compiler.
  The distribution has been created using IBM VisualAge compilers, but you
- can use any compiler you like.  GCC/EMX has the disadvantage of needing 
+ can use any compiler you like. GCC/EMX has the disadvantage of needing 
  to be single-threaded due to a limitation of EMX's implementation of the
select() socket call.
<function>select()</function> socket call.
 </para>
 
 <para>
@@ -393,11 +402,11 @@ configuration section below. HB.)
 </para>
 
 <para>
-For for SuSE: /etc/rc.d/privoxy start
+ For for SuSE: <command>/etc/rc.d/privoxy start</command>
 </para>
 
 <para>
-For RedHat: /etc/rc.d/init.d/privoxy start
+ For RedHat: <command>/etc/rc.d/init.d/privoxy start</command>
 </para>
 
 
@@ -635,15 +644,15 @@ Please choose from the following options:
  For Unix, *BSD and Linux, all configuration files are located in
  <filename>/etc/privoxy/</filename> by default. For MS Windows, OS/2, and
  AmigaOS these are all in the same directory as the 
- <application>Privoxy</application> executable. The name and number of
- configuration files has changed from previous versions, and is subject to
- change as development progresses.
+ <application>Privoxy</application> executable. <![%p-not-stable;[ The name
+ and number of configuration files has changed from previous versions, and is
+ subject to change as development progresses.]]>
 </para>
 
 <para>
  The installed defaults provide a reasonable starting point, though possibly
  aggressive by some standards. For the time being, there are only three
- default configuration files (this will change in time):
+ default configuration files (this may change in time):
 </para>
 
 <para>
@@ -691,12 +700,14 @@ Please choose from the following options:
  automatically.
 </para>
 
+<![%p-not-stable;[
 <para>
  While under development, the configuration content is subject to change. 
  The below documentation may not be accurate by the time you read this. 
  Also, what constitutes a <quote>default</quote> setting, may change, so 
  please check all your configuration files on important issues.
 </para>
+]]>
 </sect2>
 
 
@@ -1102,10 +1113,12 @@ Please choose from the following options:
  </literal>
 </para>
 
+<![%p-not-stable;[
 <para>
  It is <emphasis>highly recommended</emphasis> that you enable ERROR
  reporting (debug 8192), at least until v3.0 is released.
 </para>
+]]>
 
 <para>
  The reporting of FATAL errors (i.e. ones which crash 
@@ -2341,7 +2354,7 @@ Removed references to Win32. HB 09/23/01
    will link to some script on their own server, giving the destination as a
    parameter, which will then redirect you to the final target. URLs resulting
    from this scheme typically look like:
-   http://some.place/some_script?http://some.where-else.
+   <emphasis>http://some.place/some_script?http://some.where-else</emphasis>.
   </para>
   <para>
    Sometimes, there are even multiple consecutive redirects encoded in the
@@ -2572,7 +2585,8 @@ Removed references to Win32. HB 09/23/01
    <emphasis>images</emphasis> and <emphasis>blocked</emphasis>. And also, 
    <quote>image-blocker</quote>  should be set to <quote>blank</quote>. Note you 
    cannot treat HTML pages as images in most cases. For instance, frames 
-   require an HTML page to display. Forcing an <quote>image</quote> in this 
+   require an HTML page to display. So a frame that is an ad, cannot be 
+   treated as an image. Forcing an <quote>image</quote> in this 
    situation just will not work.
   </para>
   <para>
@@ -2933,7 +2947,6 @@ icon being being cached by the browser, which will speed up the display.
  content he may depend on. There is no way to have hard and fast rules 
  for all sites. See the <link linkend="ACTIONSANAT">Appendix</link>
  for a brief example on troubleshooting actions.
-
 </para>
 
 </sect3>
@@ -2965,7 +2978,7 @@ icon being being cached by the browser, which will speed up the display.
  <literal>
   <msgtext> 
    <literallayout>
- # Useful customer aliases we can use later. These must come first!
+ # Useful custom aliases we can use later. These must come first!
  {{alias}}
  +no-cookies = +no-cookies-set +no-cookies-read
  -no-cookies = -no-cookies-set -no-cookies-read
@@ -3663,7 +3676,7 @@ Requests</title>
  actual URL that is pasted into the prompt area -- not any sub-URLs. If you
  want to know about embedded URLs like ads, you will have to dig those out of
  the HTML source. Use your browser's <quote>View Page Source</quote> option
- for this.
+ for this. Or right click on the ad, and grab the URL.
 </para>
 
 <para>
@@ -3847,13 +3860,11 @@ Requests</title>
 <para>
  Now the page displays ;-) Be sure to flush your browser's caches when 
  making such changes. Or, try using <literal>Shift+Reload</literal>.
-
 </para>
 
 <para>
  But now what about a situation where we get no explicit matches like 
  we did with:
-
 </para>
 
 <para>
@@ -3935,6 +3946,9 @@ Requests</title>
  Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 
  $Log: user-manual.sgml,v $
+ Revision 1.68  2002/04/04 18:46:47  swa
+ consistent look. reuse of copyright, history et. al.
+
  Revision 1.67  2002/04/04 17:27:57  swa
  more single file to be included at multiple points. make maintaining easier