r1048 - in zope-common/trunk (debian/changelog dzhandle.sgml)

[Bernd Zeimetz]

    Date: Thursday, November 29, 2007 @ 19:16:05
  Author: bzed-guest
Revision: 1048

* Describe the requiered options and default settings for make-instance.
  Thanks to Ross Boylan (Closes: #436148).

Modified:
  zope-common/trunk/debian/changelog
  zope-common/trunk/dzhandle.sgml

Modified: zope-common/trunk/debian/changelog
===================================================================
--- zope-common/trunk/debian/changelog	2007-11-29 18:56:40 UTC (rev 1047)
+++ zope-common/trunk/debian/changelog	2007-11-29 19:16:05 UTC (rev 1048)
@@ -16,8 +16,10 @@
     (Closes: #429393, #431604)
   * Handle manually installed products gracefully with dzhandle, thanks to
     Ronan KERYELL and Jochen Pawletta for reporting (Closes: #417745).
+  * Describe the requiered options and default settings for make-instance.
+    Thanks to Ross Boylan (Closes: #436148).
 
- -- Bernd Zeimetz <bernd at bzed.de>  Thu, 29 Nov 2007 19:09:39 +0100
+ -- Bernd Zeimetz <bernd at bzed.de>  Thu, 29 Nov 2007 20:12:55 +0100
 
 zope-common (0.5.37) unstable; urgency=low
 

Modified: zope-common/trunk/dzhandle.sgml
===================================================================
--- zope-common/trunk/dzhandle.sgml	2007-11-29 18:56:40 UTC (rev 1047)
+++ zope-common/trunk/dzhandle.sgml	2007-11-29 19:16:05 UTC (rev 1048)
@@ -99,7 +99,7 @@
     <title>ACTIONS (instances handling)</title>
     <variablelist>
       <varlistentry>
-        <term><option>make-instance</option> &lt;instance&gt;</term>
+        <term><option>make-instance</option> &lt;instance&gt; -m AMODE [&lt;options&gt;]</term>
         <listitem>
           <para>Create a new instance running Zope version specific mkzopeinstance.</para>
           <variablelist>
@@ -107,43 +107,49 @@
               <term>-m AMODE, --addon-mode=AMODE</term>
               <listitem><para>Which products and extensions will be installed: `all' means every product 
               or extension available will be automatically installed, `manual' means that the products
-              or extensions will be installed manually through &dhpackage;.</para></listitem>
+              or extensions will be installed manually through &dhpackage;. This option is mandatory.</para></listitem>
             </varlistentry>
             <varlistentry>
               <term>-t ATECHNIQUE, --addon-install-technique=ATECHNIQUE</term>
               <listitem><para>How to install addons: `linked' means the product or extension directory
               will be symlinked into the instance home, `tree-linked' means the directory structure will 
               be re-created and then files symlinked, `copied' means the file will be copied into the 
-              instance home.</para></listitem>
+              instance home.</para>
+              <para>Default: tree-linked.</para></listitem>
             </varlistentry>
             <varlistentry>
               <term>-r RESTART, --restart=RESTART</term>
               <listitem><para>when to restart on configuration of new products or extensions: `configuring'
               means after every product or extension configuration, `end' means at the end of the installation
-              of all packages, `manually' means no automatic restart will happen.</para></listitem>
+              of all packages, `manually' means no automatic restart will happen.</para>
+              <para>Default: end</para></listitem>
             </varlistentry>
             <varlistentry>
               <term>-u USER, --user=USER</term>
               <listitem><para>user and password for the initial user (in the form `user:password'); these 
-              settigs can be modified later using zpasswd.py utility from Zope.</para></listitem>
+              settigs can be modified later using zpasswd.py utility from Zope.</para>
+              <para>You'll be prompted for an username and password if the options is omitted.</para></listitem>
             </varlistentry>
             <varlistentry>
               <term>--service-user=SRVUSER</term>
-              <listitem><para>system user used to run this instance (in the form `user:groupdefault', the
-              default is `zope:zope'); this setting can be modified later editing the zope.conf file of
-              the instance.</para></listitem>
+              <listitem><para>system user used to run this instance (in the form `user:groupdefault');
+              this setting can be modified later editing the zope.conf file of
+              the instance. `groupdefault' can be omitted.</para>
+              <para>Default: zope:zope</para></listitem>
             </varlistentry>
             <varlistentry>
               <term>--service-port=SRVPORT</term>
-              <listitem><para>HTTP port used to run this instance (default 9673); this setting can be modified
-              later editing the zope.conf file of the instance.</para></listitem>
+              <listitem><para>HTTP port used to run this instance; this setting can be modified
+              later editing the zope.conf file of the instance.</para>
+              <para>Default: 9673</para></listitem>
             </varlistentry>
             <varlistentry>
               <term>--skelsrc=SKEL</term>
               <listitem><para>the directory from which skeleton files should be copied; must at least contain
               the following directories: `bin', `etc', `Extensions', `import', `lib', `log', `Products', `var'
               and files: `bin/zopeservice.py.in', `bin/runzope.bat.in', `bin/runzope.in',
-              `bin/runzope.in', `bin/zopectl.in', `etc/zope.conf.in'.</para></listitem>
+              `bin/runzope.in', `bin/zopectl.in', `etc/zope.conf.in'.</para>
+              <para>Default: /usr/lib/zopeVER/skel</para></listitem>
             </varlistentry>
           </variablelist>
         </listitem>