[Zope-Checkins] CVS: Zope/doc - ENVIRONMENT.txt:1.1.2.4

Andreas Jung andreas@zope.com
Thu, 25 Oct 2001 11:02:11 -0400


Update of /cvs-repository/Zope/doc
In directory cvs.zope.org:/tmp/cvs-serv9110/doc

Modified Files:
      Tag: ajung-topicindex
	ENVIRONMENT.txt 
Log Message:
updated 


=== Zope/doc/ENVIRONMENT.txt 1.1.2.3 => 1.1.2.4 ===
     INSTANCE_HOME
 
-        If an INSTANCE_HOME is defined and has a 'lib/python'
-        sub directory, it will be added to the front of the Python path.
-        INSTANCE_HOME is usually used to separate the Zope core installation
-        from application code and third-party modules/products.
+        If an INSTANCE_HOME is defined and has a 'lib/python' sub
+        directory, it will be added to the front of the Python path.
+        INSTANCE_HOME is usually used to separate the Zope core
+        installation from application code and third-party
+        modules/products.
 
         See also: SOFTWARE_HOME
 
@@ -24,8 +25,8 @@
             product name, regardless of whether an INSTANCE_HOME exists.
             If two products with the same name exist in both SOFTWARE_HOME
             and INSTANCE_HOME, the order in which they appear in
-            Application.Products.__path__ determines whether they
-            are loaded first or second.
+            Application.Products.__path__ determines whether they are
+            loaded first or second.
 
         See also: INSTANCE_HOME
 
@@ -48,7 +49,8 @@
 
     SUPPRESS_SITEROOT
 
-        If set, all site access rules are suppressed (used by SiteAccess products).
+        If set, all site access rules are suppressed (used by SiteAccess
+        products).
 
 
 
@@ -56,12 +58,19 @@
 
     CLIENT_HOME
 
-        Used by ZEO clients to easily keep distinct pid and log files.
-
+        CLIENT_HOME allows ZEO clients to easily keep distinct pid and log
+        files. This is currently an *experimental* feature. 
+ 
 
     ZEO_CLIENT
         
-        Used by ZEO
+        If you want a persistent client cache which retains cache contents
+        across ClientStorage restarts, you need to define the environment
+        variable, ZEO_CLIENT, to a unique name for the client.  This is
+        needed so that unique cache name files can be computed.  Otherwise,
+        the client cache is stored in temporary files which are removed
+        when the ClientStorage shuts down.
+
         
 
 Debugging and Logging
@@ -91,18 +100,18 @@
     ZSYSLOG="/dev/log"
 
         Setting this environment variable will cause Zope to try and write
-        to the named UNIX domain socket (usually '/dev/log').  This will only 
-        work on UNIX.
+        to the named UNIX domain socket (usually '/dev/log').  This will
+        only work on UNIX.
 
         See also: LOGGING.txt
 
 
     ZSYSLOG_FACILITY="facilityname"
 
-        Setting this environment variable will cause Zope to use the
-        syslog logger with the given facility. This environment variable
-        is optional and  overrides the default facility "user". This will
-        only work on UNIX.
+        Setting this environment variable will cause Zope to use the syslog
+        logger with the given facility. This environment variable is
+        optional and  overrides the default facility "user". This will only
+        work on UNIX.
 
         See also: LOGGING.txt
 
@@ -111,16 +120,17 @@
 
         Setting this environment variable tells Zope to connect a UDP
         socket to machine.name (which can be a name or IP address) and
-        'port' which must be an integer.  The default syslogd port is '514' 
+        'port' which must be an integer.  The default syslogd port is '514'
         but Zope does not pick a sane default, you must specify a port.
         This may change, so check back here in future Zope releases.
 
         See also: LOGGING.txt
 
 
-    Z_DEBUG_MODE
+    Z_DEBUG_MODE      "yes"
+    BOBO_DEBUG_MODE   "yes"  (obsolete)
      
-        Run Zope in debug mode. Same as -D options (z2.py)
+        Run Zope in debug mode if set. Same as -D options (z2.py)
 
 
 Security issues
@@ -133,8 +143,9 @@
     ZOPE_SECURITY_POLICY
 
         If this variable is set to "PYTHON", Zope will use the traditional
-        Python based AccessControl implementation. By default and for performance
-        reasons Zope will use the cAccessControl module (Zope 2.5+)
+        Python based AccessControl implementation. By default and for
+        performance reasons Zope will use the cAccessControl module (Zope
+        2.5+)
 
 
     DISALLOW_LOCAL_PRODUCTS
@@ -146,38 +157,37 @@
 
     ZOPE_DATABASE_QUOTA
 
-        If this variable is set, it should be set to
-        an integer number of bytes.  Additions to the database are
-        not allowed if the database size exceeds the quota. 
+        If this variable is set, it should be set to an integer number of
+        bytes.  Additions to the database are not allowed if the database
+        size exceeds the quota. 
 
 
     ZOPE_READ_ONLY
 
-        If this variable is set, then the database is opened in read only mode.  If
-        this variable is set to a string parsable by DateTime.DateTime, then the
-        database is opened read-only as of the time given.  Note that changes made by
-        another process after the database has been opened are not visible.
+        If this variable is set, then the database is opened in read only
+        mode.  If this variable is set to a string parsable by
+        DateTime.DateTime, then the database is opened read-only as of the
+        time given.  Note that changes made by another process after the
+        database has been opened are not visible.
 
 
 Esoteric 
 
-
     Z_MAX_STACK_SIZE
 
-        This variable allows you to customize the size of the Zope stack (default 100).
+        This variable allows you to customize the size of the Zope stack
+        used by the SecurityManager (default 100).
 
 
-    FORCE_PRODUCT_RELOAD
-
-        unknown (Shane's Refresh product ???)
+    Z_REALM       "your realm"
+    BOBO_REALM    "your realm" (obsolete)
 
+        Realm to be used when send HTTP authentication requests to a web
+        client.
 
-    Z_REALM
-
-        unknown
 
+    FORCE_PRODUCT_RELOAD
 
-    BOBO_REALM
+        unknown (Shane's Refresh product ???)
 
-        unknown