From: hal9 <hal9@users.sourceforge.net>
Date: Thu, 30 May 2002 15:35:43 +0000 (+0000)
Subject: Minor changes for better Makefile/perl processing for make config-file.
X-Git-Tag: v_2_9_16~56
X-Git-Url: http://www.privoxy.org/gitweb/seealso.html?a=commitdiff_plain;h=c7e8d92b1f9f9ca77b77dd0d0fd44c5246dddfec;p=privoxy.git

Minor changes for better Makefile/perl processing for make config-file.
---

diff --git a/doc/source/p-config.sgml b/doc/source/p-config.sgml
index 1c9c8e90..b8916b68 100644
--- a/doc/source/p-config.sgml
+++ b/doc/source/p-config.sgml
@@ -1,9 +1,9 @@
 <!--
- File        :  $Source: /cvsroot/ijbswa/current/doc/source/p-config.sgml,v $
+ File        :  $Source: /cvsroot/ijbswa/current/doc/source/Attic/p-config.sgml,v $
 
  Purpose     :  Used with other docs and files only.
 
- $Id: p-config.sgml,v 1.0 2002/05/27 02:36:57 hal9 Exp $
+ $Id: p-config.sgml,v 1.1.2.1 2002/05/29 02:01:02 hal9 Exp $
 
  Copyright (C) 2001, 2002 Privoxy Developers <developers@privoxy.org>
  See LICENSE.
@@ -15,7 +15,7 @@
 
  
  This file contains all the config file comments and options. It used to 
- build both user-manual config sections, and all of config (yes, the main
+ build both the user-manual config sections, and all of config (yes, the main
  config file) itself.
 
  Rationale: This is broken up into two files since a file with a prolog 
@@ -26,7 +26,16 @@
 
  OPTIONS: The actual options are included in this file and prefixed with 
  '@@', and processed by the Makefile to strip the '@@'. Default options 
- that should appear commented out should be listed as: '@@#OPTION'.
+ that should appear commented out should be listed as: '@@#OPTION'. 
+ Otherwise, as '@@OPTION'. Example:
+
+  @@listen-address  127.0.0.1:8118
+
+ The Makefile does significant other processing too. The final results 
+ should be checked to make sure that the perl processing does not 
+ fubar something!!! Makefile processing requires w3m, fmt (shell line
+ formatter), and perl.
+ 
 
  This file is included into:
 
@@ -77,15 +86,19 @@
 
 ]]>
 
+
 <![%config-file;[
 <!-- This part only goes into the config file -->
 <sect1 id="config">
-<title>Sample Configuration File for Privoxy v&p-version;</title>
+<title>
+ @@TITLE<!-- between the @@ is stripped by Makefile -->@@
+ Sample Configuration File for Privoxy v&p-version;
+</title>
 <para>
 Copyright (C) 2001, 2002 Privoxy Developers http://privoxy.org
 </para>
 <para>
-$Id: config,v 1.39 2002/05/12 03:21:21 hal9 Exp $
+$Id: p-config.sgml,v 1.1.2.1 2002/05/29 02:01:02 hal9 Exp $
 </para>
 
 <para>
@@ -162,9 +175,9 @@ II. FORMAT OF THE CONFIGURATION FILE
 
 ]]>
 
-<!-- *************************************** -->
-<!-- The following is common to both outputs -->
-<!-- *************************************** -->
+<!-- ************************************************ -->
+<!-- The following is common to both outputs (mostly) -->
+<!-- ************************************************ -->
 
 <!--   ~~~~~       New section      ~~~~~     -->
 
@@ -179,11 +192,13 @@ II. FORMAT OF THE CONFIGURATION FILE
 </para>
 
 <para>
- The user running Privoxy, must have read permission for all 
- configuration files, and write permission to any files that would 
- be modified, such as log files.
+ The user running <application>Privoxy</application>, must have read
+ permission for all configuration files, and write permission to any files
+ that would be modified, such as log files and actions files.
 </para>
 
+
+<!--   ~~~~~       New section      ~~~~~     -->
 <sect3 renderas="sect4" id="confdir"><title>confdir</title>
 
 <variablelist>
@@ -232,6 +247,7 @@ II. FORMAT OF THE CONFIGURATION FILE
 </sect3>
 
 
+<!--   ~~~~~       New section      ~~~~~     -->
 <sect3 renderas="sect4" id="logdir"><title>logdir</title>
 
 <variablelist>
@@ -275,6 +291,8 @@ II. FORMAT OF THE CONFIGURATION FILE
 <![%config-file;[<literallayout>@@logdir .</literallayout>]]>
 </sect3>
 
+
+<!--   ~~~~~       New section      ~~~~~     -->
 <sect3 renderas="sect4" id="actionsfile"><title>
 actionsfile
 </title>
@@ -343,6 +361,8 @@ actionsfile
  </varlistentry>
 </variablelist>
 
+<!-- NOTE: alternate markup to make a simpler list doesn't work due to -->
+<!-- html -> text conversion, blah -->
 <![%config-file;[<literallayout>@@actionsfile standard  # Internal purpose, recommended</literallayout>]]>
 <![%config-file;[<literallayout>@@actionsfile default   # Main actions file</literallayout>]]>
 <![%config-file;[<literallayout>@@actionsfile user      # User customizations</literallayout>]]>
@@ -589,7 +609,6 @@ actionsfile
 <!--  ~  End section  ~  -->
 
 
-
 <!--   ~~~~~       New section      ~~~~~     -->
 <sect2 id="local-set-up">
 <title>Local Set-up Documentation</title>
@@ -848,7 +867,6 @@ actionsfile
 <!--  ~  End section  ~  -->
 
 <!--   ~~~~~       New section      ~~~~~     -->
-
 <sect2 id="debugging">
 <title>Debugging</title>
 
@@ -905,7 +923,7 @@ actionsfile
   debug         8 # show header parsing
   debug        16 # log all data into the logfile
   debug        32 # debug force feature
-  debug        64 # debug regular expression filter 
+  debug        64 # debug regular expression filter
   debug       128 # debug fast redirects
   debug       256 # debug GIF de-animation
   debug       512 # Common Log Format
@@ -993,8 +1011,10 @@ actionsfile
 
 </sect2>
 
-<!--   ~~~~~       New section      ~~~~~     -->
+<!--  ~  End section  ~  -->
 
+
+<!--   ~~~~~       New section      ~~~~~     -->
 <sect2 id="access-control">
 <title>Access Control and Security</title>
 
@@ -1701,7 +1721,7 @@ forward-socks4 and forward-socks4a</title>
 
 <para>
  Assuming that <application>Privoxy</application> and <application>squid</application>
- run on the same box, your squid configuration could then look like this:
+ run on the same box, your <application>squid</application> configuration could then look like this:
 </para>
 
 <para>
@@ -1953,7 +1973,6 @@ forward-socks4 and forward-socks4a</title>
 ]]>
 
 </sect2>
-
 </sect1>
 
 <!-- end config content common to both outputs -->
@@ -1969,3 +1988,5 @@ forward-socks4 and forward-socks4a</title>
 <anchor id="actions-file">
 </sect1>
 ]]>
+
+<!-- eof p-config.sgml -->