[Repoze-checkins] r818 - buildouts/repoze.plone/trunk

[Chris McDonough]

Author: Chris McDonough <chrism at agendaless.com>
Date: Wed Mar 12 00:22:52 2008
New Revision: 818

Log:
Better docs about installed files and supervisor.


Modified:
   buildouts/repoze.plone/trunk/README.txt

Modified: buildouts/repoze.plone/trunk/README.txt
==============================================================================
--- buildouts/repoze.plone/trunk/README.txt	(original)
+++ buildouts/repoze.plone/trunk/README.txt	Wed Mar 12 00:22:52 2008
@@ -34,8 +34,11 @@
   interactive shell.  To stop Zope, type "stop zope".  To stop ZEO,
   type "stop zeo".  To restart Zope, type "restart zope", to start it,
   type "start zope".  and so on.  You may also issue the command
-  'bin/supervisorctl {start|stop|restart} {zope|zeo|}' from the command
-  line without entering interactive shell mode.
+  'bin/supervisorctl {start|stop|restart} {zope|zeo}' from the command
+  line to avoid entering supervisorctl's interactive shell mode.
+
+  To shut down supervisor (and all processes it runs, including Zope
+  and ZEO in this case), use "supervisorctl shutdown".
 
   See http://supervisord.org for more information about supervisor.
 
@@ -45,6 +48,37 @@
   invoke 'bin/paster serve etc/zope2.ini'.  This is functionally
   equivalent to a stock Zope2's "runzope" command.
 
+Notable Configuration Files
+
+    etc/zope2.ini -- the "PasteDeploy" configuration file that
+    configures a WSGI pipeline that Zope runs under.
+
+    etc/supervisord.conf -- the configuration file that tells
+    supervisor which programs to start when you invoke
+    "bin/supervisord".
+
+    etc/zope.conf -- the Zope 2 configuration file.
+
+Notable Executable Files
+
+    bin/addzope2user -- add an administrative user to the Zope root
+    user folder.
+
+    bin/debugzope2 -- start up an interactive Python shell with Zope's
+    libraries preloaded and its database configured (equivalent to
+    stock Zope's "zopectl debug").
+
+    bin/paster -- the program which controls the "Paste" server that
+    Zope runs under.
+
+    bin/runzeo -- the program which runs a ZEO server.
+
+    bin/runzope2script -- run a script in a Zope environment
+    (equivalent to stock Zope's "zopectl run").
+
+    bin/zope2testrunner -- find and run unit tests in a Zope 2
+    environment (equivalent to stock Zope's "zopectl test").
+
 FAQ:
 
   - My buildout loops while attempting to install setuptools!