Commit 888831d5 authored by Hanno Schlichting's avatar Hanno Schlichting

Documentation tweaks

parent 99c5ca57
Running Zope in Debug Mode
==========================
If you wish to run Zope in debug mode, set the 'debug-mode'
configuration file parameter to 'on' (this is the default). This
will have the following effects:
- On UNIX, Zope will not detach from the controlling terminal.
A utility known as 'zopectl' is installed into generated instance homes.
- The Z_DEBUG_MODE environment variable gets set, which causes
behavioral changes to Zope appropriate for software development.
See the configuration file description of 'debug-mode' for more
information.
If you wish to run Zope in debug mode, run zopectl in foreground mode::
Using 'zopectl debug'
---------------------
$ bin/zopectl fg
A utility known as 'zopectl' is installed into generated instance homes.
You can use it to inspect a Zope instance's running state via an
interactive Python interpreter by passing zopectl the 'debug' parameter
on the command line. The 'top-level' Zope object (the root folder) will
be bound to the name 'app' within the interpreter. You can then use
normal Python method calls against app and use the Python interpreter
normally to inspect results::
You can also use it to inspect a Zope instance's running state via an
interactive Python interpreter by passing zopectl the 'debug' parameter on the
command line.
The 'top-level' Zope object (the root folder) will be bound to the name 'app'
within the interpreter. You can then use normal Python method calls against app
and use the Python interpreter normally to inspect results::
[chrism@james Trunk]$ bin/zopectl debug
$ bin/zopectl debug
Starting debugger (the name "app" is bound to the top-level Zope object)
>>> app.objectIds()
>>> app.keys()
['acl_users', 'Control_Panel', 'temp_folder', 'browser_id_manager', 'session_data_manager', 'error_log', 'index_html', 'standard_error_message']
>>>
......@@ -3,7 +3,7 @@ Installing and Zope with ``zc.buildout``
.. highlight:: bash
This document descibes how to get going with Zope using ``zc.buildout``.
This document describes how to get going with Zope using ``zc.buildout``.
About ``zc.buildout``
......
......@@ -75,4 +75,3 @@ command-line options, run the script with the ``--help`` option::
The traditional "inplace" build is no longer supported. Always use
``mkzopeinstance`` to create instances outside the virtualenv environment.
......@@ -6,7 +6,7 @@ Zope effective user support
Apache, Squid or Varnish. In this case, you do not need to run
or install Zope with root privileges, since the reverse proxy
will bind to port 80 and proxy back all request to Zope running
on an unpriviledged port.
on an unprivileged port.
Zope can bind its network service to low ports such as 21 (FTP) and
80 (HTTP). In order to bind to low ports, Zope must be started as
......
......@@ -51,7 +51,7 @@ copyright = u'2009-2010, The Zope Developers Community'
# The short X.Y version.
version = '2.13'
# The full version, including alpha/beta/rc tags.
release = '2.13.0dev'
release = '2.13'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
......
......@@ -16,7 +16,7 @@ Your instance's configuration is defined in its ``etc/zope.conf`` file.
Unless you created the file manually, that file should contain fully-
annotated examples of each directive.
You can also pass an explicit configuration file on the commandline::
You can also pass an explicit configuration file on the command line::
$ /path/to/zope/instance/bin/zopectl -c /tmp/other.conf show
...
......@@ -52,7 +52,8 @@ command (short for ``foreground``)::
$ /path/to/zope/instance/bin/zopectl fg
In this mode, Zope emits its log messages to the console, and does not
detach from the terminal.
detach from the terminal. This also automatically enables debug-mode. Do
not use this for production servers.
Running Zope as a Daemon
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment