Moved comments on how build man page from Makefile to sgml.

[privoxy.git] / doc / source / privoxy-man-page.sgml

diff --git a/doc/source/privoxy-man-page.sgml b/doc/source/privoxy-man-page.sgml
index 10c3307..5b62dc8 100644 (file)
--- a/doc/source/privoxy-man-page.sgml
+++ b/doc/source/privoxy-man-page.sgml
@@ -5,7 +5,7 @@
                 This file belongs into
                 ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/
                 
- $Id: privoxy-man-page.sgml,v 1.1 2002/04/06 05:07:29 hal9 Exp $
+ $Id: privoxy-man-page.sgml,v 1.6 2002/04/12 01:55:43 hal9 Exp $
 
  Written by and Copyright (C) 2001 the SourceForge
  Privoxy team. http://www.privoxy.org/
@@ -16,22 +16,24 @@
 
  ========================================================================
  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!
+ anything in this, or other Privoxy documentation. 
  ========================================================================
 
- Doc NOTES: This is some tricky stuff! There are some quirks
+ Doc NOTES: This is some tricky markup! 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! 
+ Please don't change the markup unless you can verify the changes 
+ will improve finished output! 
  
  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'
+ Create man page: 'make man'
 
+ Requires docbook2man (short perl script), see CVS
+ http://sources.redhat.com/docbook-tools/. Also requires openjade and SGMLSpm
+ perl module. 
+ 
  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
@@ -43,7 +45,7 @@
 <!entity seealso SYSTEM "seealso.sgml">
 <!entity copyright SYSTEM "copyright.sgml">
 <!entity authors SYSTEM "p-authors.sgml">
-<!entity p-version "2.9.13">
+<!entity p-version "2.9.14">
 <!entity p-status "beta">
 <!entity % p-not-stable "INCLUDE">
 <!entity % p-stable "IGNORE">
@@ -53,7 +55,7 @@
 
 <refentry id="privoxy">
 <refentryinfo>
- <date>2002-04-04</date>
+ <date>2002-04-11</date>
 </refentryinfo>
 
 <refmeta>
@@ -127,13 +129,14 @@
     <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.
+        On startup, write the process ID to <replaceable class="parameter">pidfile</replaceable>.
+        Delete the <replaceable class="parameter">pidfile</replaceable> on exit.
+        Failiure to create or delete the <replaceable class="parameter">pidfile</replaceable>
+        is non-fatal. If no <command>--pidfile</command> option is given, no PID file will be used.
       </para>
     </listitem>
   </varlistentry>
+
   <varlistentry>
     <term>--user <replaceable class="parameter">user[.group]</replaceable></term>
      <listitem>
@@ -141,10 +144,10 @@
        <!-- 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
+       <replaceable class="parameter">user</replaceable> and the GID of
+       <replaceable class="parameter">group</replaceable>, or, if the optional
+       <replaceable class="parameter">group</replaceable> was not given, the default group of
+       <replaceable class="parameter">user</replaceable>. Exit if the privileges are not
        sufficient to do so.
      </para>
     </listitem>