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

Andreas Jung andreas@zope.com
Thu, 25 Oct 2001 09:59:59 -0400


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

Modified Files:
      Tag: ajung-topicindex
	ENVIRONMENT.txt 
Log Message:
grouped into different sections


=== Zope/doc/ENVIRONMENT.txt 1.1.2.2 => 1.1.2.3 ===
 
 
-DISALLOW_LOCAL_PRODUCTS
+Zope installation
 
-    unknown
+    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.
 
-INSTANCE_HOME
+        See also: SOFTWARE_HOME
 
-    If an INSTANCE_HOME is defined and has a 'lib/python'
-    subdirectory, it will be added to the front of the Python path.
-    INSTANCE_HOME is usually used to seperate the Zope core installation
-    from application code and third-party modules/products.
 
-    See also SOFTWARE_HOME
+    SOFTWARE_HOME 
+        
+        The SOFTWARE_HOME usually keeps the directory name of the 
+        Zope core installation.
 
+        Order of product initialization:
+            
+            All Products are initialized in ascending alphabetical order by
+            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.
 
-SOFTWARE_HOME 
-    
-    The SOFTWARE_HOME usually keeps the directory name of the 
-    Zope core installation.
+        See also: INSTANCE_HOME
 
 
-    Order of product initialization:
-        
-        All Products are initialized in ascending alphabetical order by
-        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.
+Profiling
+
+    PROFILE_PUBLISHER
+
+        If set, Zope is forced profile every request of the ZPublisher.
+        The profiling information is written to the value of the
+        PROFILE_PUBLISHER.
+
 
-    See also INSTANCE_HOME
+SiteAccess
 
+    SUPPRESS_ACCESSRULE
 
-NO_SECURITY
+        If set, all SiteRoots are suppressed (used by SiteAccess products).
 
-   Unknown. Used by TAL
 
+    SUPPRESS_SITEROOT
 
-PROFILE_PUBLISHER
+        If set, all site access rules are suppressed (used by SiteAccess products).
 
-    If set, Zope is forced profile every request of the ZPublisher.
-    The profiling information is written to the value of the
-    PROFILE_PUBLISHER.
 
 
-CLIENT_HOME
+ZEO
 
-    Used by ZEO clients to easily keep distinct pid and log files.
-    
+    CLIENT_HOME
 
-SUPPRESS_ACCESSRULE
+        Used by ZEO clients to easily keep distinct pid and log files.
 
-    If set, all SiteRoots are suppressed (used by SiteAccess products).
 
+    ZEO_CLIENT
+        
+        Used by ZEO
+        
+
+Debugging and Logging
 
-SUPPRESS_SITEROOT
+    STUPID_LOG_FORMAT
+        
+        Set this variable if you like to customize the output format of
+        Zope stupid logger.
+        
 
-    If set, all site access rules are suppressed (used by SiteAccess products).
+    STUPID_LOG_FILE="path"
 
+        The stupid file logger writes Zope logging information to a file.
+        It is not very smart about it - it just dumps it to a file and the
+        format is not very configurable - hence the name.
 
-ZDAEMON_MANAGED
+        See also: LOGGING.txt
 
-    Used for internal purposes of zdaemon
 
+    STUPID_LOG_SEVERITY
 
-Z_DEBUG_MODE
- 
-    Run Zope in debug mode. Same as -D options (z2.py)
+        If set, Zope logs only messages whose severity is level
+        is higher than the specified one.
 
 
-ZDIR
 
-    Only used by Zope when running with PCGI. This variable holds the
-    directory of your Zope installation.
+    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.
 
-ZEO_CLIENT
-    
-    Used by ZEO
+        See also: LOGGING.txt
 
 
-Z_MAX_STACK_SIZE
+    ZSYSLOG_FACILITY="facilityname"
 
-    This variable allows you to customize the size of the Zope stack (default 100).
-    !!!
+        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
 
-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.
+    ZSYSLOG_SERVER="machine.name:port"
 
+        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' 
+        but Zope does not pick a sane default, you must specify a port.
+        This may change, so check back here in future Zope releases.
 
-ZOPE_SECURITY_POLICY
+        See also: LOGGING.txt
 
-    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+)
 
+    Z_DEBUG_MODE
+     
+        Run Zope in debug mode. Same as -D options (z2.py)
 
-FORCE_PRODUCT_RELOAD
 
-    unknown (Shane's Refresh product ???)
+Security issues
 
+    NO_SECURITY
 
-ZOPE_DATABASE_QUOTA
+       Unknown. Used by TAL
 
-    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_SECURITY_POLICY
 
-Z_REALM
+        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+)
 
-    unknown
 
+    DISALLOW_LOCAL_PRODUCTS
 
-BOBO_REALM
+        unknown
 
-    unknown
 
+ZODB related
 
-STUPID_LOG_FILE="path"
+    ZOPE_DATABASE_QUOTA
 
-    The stupid file logger writes Zope logging information to a file.
-    It is not very smart about it - it just dumps it to a file and the
-    format is not very configurable - hence the name.
+        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. 
 
-    See also LOGGING.txt
 
+    ZOPE_READ_ONLY
 
-STUPID_LOG_SEVERITY
+        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 set, Zope logs only messages whose severity is level
-    is higher than the specified one.
 
+Esoteric 
 
-STUPID_LOG_FORMAT
-    
-    Set this variable if you like to customize the output format of
-    Zope stupid logger.
-    
 
+    Z_MAX_STACK_SIZE
 
-ZSYSLOG="/dev/log"
+        This variable allows you to customize the size of the Zope stack (default 100).
 
-    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.
 
-    See also LOGGING.txt
+    FORCE_PRODUCT_RELOAD
 
+        unknown (Shane's Refresh product ???)
 
-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.
+    Z_REALM
 
-    See also LOGGING.txt
+        unknown
 
 
-ZSYSLOG_SERVER="machine.name:port"
+    BOBO_REALM
 
-    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' 
-    but Zope does not pick a sane default, you must specify a port.
-    This may change, so check back here in future Zope releases.
+        unknown
 
-    See also LOGGING.txt