Move the user-manual config directive to top of section. Add note about

[privoxy.git] / doc / text / user-manual.txt

diff --git a/doc/text/user-manual.txt b/doc/text/user-manual.txt
index d07c1c7..81b5fcb 100644 (file)
--- a/doc/text/user-manual.txt
+++ b/doc/text/user-manual.txt
@@ -2,7 +2,7 @@ Privoxy User Manual
 
 By: Privoxy Developers
 
-$Id: user-manual.sgml,v 1.99 2002/04/28 16:59:05 swa Exp $
+$Id: user-manual.sgml,v 1.100 2002/04/29 03:05:55 hal9 Exp $
 
 The user manual gives users information on how to install, configure and use 
 Privoxy.
@@ -59,14 +59,14 @@ Table of Contents
    
     8.1. Configuration and Log File Locations
        
-        8.1.1. confdir
-        8.1.2. logdir
-        8.1.3. actionsfile
-        8.1.4. filterfile
-        8.1.5. logfile
-        8.1.6. jarfile
-        8.1.7. trustfile
-        8.1.8. user-manual
+        8.1.1. user-manual
+        8.1.2. confdir
+        8.1.3. logdir
+        8.1.4. actionsfile
+        8.1.5. filterfile
+        8.1.6. logfile
+        8.1.7. jarfile
+        8.1.8. trustfile
        
     8.2. Local Set-up Documentation
        
@@ -627,9 +627,50 @@ Privoxy can (and normally does) use a number of other files for additional
 configuration, help and logging. This section of the configuration file tells
 Privoxy where to find those other files.
 
+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.
+
+-------------------------------------------------------------------------------
+
+8.1.1. user-manual
+
+Specifies:
+   
+    Location of the Privoxy User Manual.
+   
+Type of value:
+   
+    A fully qualified URI
+   
+Default value:
+   
+    http://www.privoxy.org/user-manual/
+   
+Effect if unset:
+   
+    The default will be used.
+   
+Notes:
+   
+    The User Manual is used for help hints from some of the internal CGI pages.
+    It is normally packaged with the binary distributions, and would make more
+    sense to have this pointed at a locally installed copy.
+   
+    A more useful example (Unix):
+   
+      user-manual  file:///usr/share/doc/privoxy-2.9.14/user-manual/
+   
+    +-----------------------------------------------------------------+
+    |                             Warning                             |
+    |-----------------------------------------------------------------|
+    |If this option is defined, it must come first! It is needed      |
+    |before the rest of config is read.                               |
+    +-----------------------------------------------------------------+
+
 -------------------------------------------------------------------------------
 
-8.1.1. confdir
+8.1.2. confdir
 
 Specifies:
    
@@ -659,7 +700,7 @@ Notes:
    
 -------------------------------------------------------------------------------
 
-8.1.2. logdir
+8.1.3. logdir
 
 Specifies:
    
@@ -684,7 +725,7 @@ Notes:
    
 -------------------------------------------------------------------------------
 
-8.1.3. actionsfile
+8.1.4. actionsfile
 
 Specifies:
    
@@ -721,7 +762,7 @@ Notes:
    
 -------------------------------------------------------------------------------
 
-8.1.4. filterfile
+8.1.5. filterfile
 
 Specifies:
    
@@ -750,7 +791,7 @@ Notes:
    
 -------------------------------------------------------------------------------
 
-8.1.5. logfile
+8.1.6. logfile
 
 Specifies:
    
@@ -786,9 +827,12 @@ Notes:
     644 nobody.nogroup" in /etc/logfiles, with the effect that cron.daily will
     automatically archive, gzip, and empty the log, when it exceeds 1M size.
    
+    Any log files must be writable by whatever user Privoxy is being run as
+    (default on UNIX, user id is "privoxy").
+   
 -------------------------------------------------------------------------------
 
-8.1.6. jarfile
+8.1.7. jarfile
 
 Specifies:
    
@@ -812,7 +856,7 @@ Notes:
    
 -------------------------------------------------------------------------------
 
-8.1.7. trustfile
+8.1.8. trustfile
 
 Specifies:
    
@@ -847,36 +891,6 @@ Notes:
    
 -------------------------------------------------------------------------------
 
-8.1.8. user-manual
-
-Specifies:
-   
-    Location of the Privoxy User Manual.
-   
-Type of value:
-   
-    A fully qualified URI
-   
-Default value:
-   
-    http://www.privoxy.org/user-manual/
-   
-Effect if unset:
-   
-    The default will be used.
-   
-Notes:
-   
-    The User Manual is used for help hints from some of the internal CGI pages.
-    It is normally packaged with the binary distributions, and would make more
-    sense to have this pointed at a locally installed copy.
-   
-    A more useful example (Unix):
-   
-      user-manual  file:///usr/share/doc/privoxy-2.9.14/user-manual/
-   
--------------------------------------------------------------------------------
-
 8.2. Local Set-up Documentation
 
 If you intend to operate Privoxy for more users that just yourself, it might be