Move user-manual directive to top of section. Notes on read/write permissions

for files by user running Privoxy.

diff --git a/config b/config
index bfa0b2e..b940498 100644 (file)
--- a/config
+++ b/config
@@ -1,6 +1,6 @@
 #  Sample Configuration file for Privoxy
 #
-# $Id: config,v 1.36 2002/04/26 12:54:51 oes Exp $
+# $Id: config,v 1.37 2002/04/27 21:05:27 hal9 Exp $
 #
 ###################################################################
 #                                                                 #
@@ -64,8 +64,52 @@
 #  Privoxy can (and normally does) use a number of other files for
 #  additional configuration 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.
+
+#  1.1. user-manual
+#  ================
 # 
-#  1.1. confdir
+#  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.                               |
+#   +-----------------------------------------------------------------+
+# 
+#    
+#user-manual http://www.privoxy.org/user-manual/
+
+#  1.2. confdir
 #  ============
 # 
 #  Specifies:
@@ -97,7 +141,7 @@
 confdir .
 
 
-#  1.2. logdir
+#  1.3. logdir
 #  ===========
 #  
 #  Specifies:
@@ -124,7 +168,7 @@ confdir .
 logdir .
 
 
-#  1.3. actionsfile
+#  1.4. actionsfile
 #  ================ 
 #  
 #  Specifies:
@@ -160,7 +204,7 @@ actionsfile default   # Main actions file
 actionsfile user      # User customizations
 
 
-#  1.4. filterfile
+#  1.5. filterfile
 #  ===============
 #  
 #  Specifies:
@@ -192,7 +236,7 @@ actionsfile user      # User customizations
 filterfile default.filter
 
 
-#  1.5. logfile
+#  1.6. logfile
 #  ============
 #  
 #  Specifies:
@@ -233,11 +277,13 @@ filterfile default.filter
 #      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").
 # 
 logfile logfile
 
 
-#  1.6. jarfile
+#  1.7. jarfile
 #  ============
 #  
 #  Specifies:
@@ -263,7 +309,7 @@ logfile logfile
 jarfile jarfile
 
 
-#  1.7. trustfile
+#  1.8. trustfile
 #  ==============
 #  
 #  Specifies:
@@ -303,39 +349,6 @@ jarfile jarfile
 #trustfile trust
 
 
-#  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/
-#    
-#user-manual http://www.privoxy.org/user-manual/
-
-
 #  2. LOCAL SET-UP DOCUMENTATION
 #  =============================
 #