File: dzhandle.sgml

package info (click to toggle)
zope-common 0.5.54
  • links: PTS, VCS
  • area: main
  • in suites: bullseye, buster, jessie, jessie-kfreebsd, sid, stretch
  • size: 424 kB
  • ctags: 298
  • sloc: python: 2,140; sh: 62; makefile: 43
file content (341 lines) | stat: -rw-r--r-- 14,793 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
<!doctype refentry PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [

  <!-- Fill in your name for FIRSTNAME and SURNAME. -->
  <!ENTITY dhfirstname "<firstname>Fabio</firstname>">
  <!ENTITY dhsurname   "<surname>Tranchitella</surname>">
  <!-- Please adjust the date whenever revising the manpage. -->
  <!ENTITY dhdate      "<date>Apr 18, 2007</date>">
  <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
       allowed: see man(7), man(1). -->
  <!ENTITY dhsection   "<manvolnum>1</manvolnum>">
  <!ENTITY dhemail     "<email>kobold@debian.org</email>">
  <!ENTITY dhusername  "Fabio Tranchitella">
  <!ENTITY dhucpackage "<refentrytitle>dzhandle</refentrytitle>">
  <!ENTITY dhpackage   "dzhandle">

  <!ENTITY debian      "<productname>Debian GNU/Linux</productname> and <productname>Ubuntu Linux</productname>">
  <!ENTITY gnu         "<acronym>GNU</acronym>">
]>

<refentry>
    <docinfo>
        <address>&dhemail;</address>
        <author>&dhfirstname; &dhsurname;</author>
        <copyright>
            <year>2005</year>
            <holder>&dhusername;</holder>
        </copyright>
        &dhdate;
    </docinfo>

    <refmeta>
        &dhucpackage;
        &dhsection;
    </refmeta>

    <refnamediv>
        <refname>&dhpackage;</refname>
        <refpurpose>Debian/Ubuntu Zope packages handling command line utility </refpurpose>
    </refnamediv>


  <refsynopsisdiv>
    <cmdsynopsis>
      <command>&dhpackage;</command>
      <arg>options</arg>
      <command>action</command>
      <arg>action options</arg>
    </cmdsynopsis>
  </refsynopsisdiv>

  <refsect1>
    <title>DESCRIPTION</title>
        
    <para>
      <command>&dhpackage;</command> is the command-line utility for handling 
      Zope servers, instances and products. It is a system administration tool and a 
      Debian/Ubuntu maintainer's helper script at the same time: using &dhpackage; 
      you can manage your Zope installations, create instances, add Zope products to 
      them, start and stop them, but it is also used by the Debian/Ubuntu Zope 
      packages for their installation and removal.
    </para>
  </refsect1>

  <refsect1>
    <title>OPTIONS</title>
    <variablelist>
      <varlistentry>
        <term><option>-h, --help</option></term>
        <listitem><para>Print usage information and exit</para></listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-f, --force</option></term>
        <listitem><para>Force things, for example file overwriting or removing</para></listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-z, --zope-version=ZVERSIONS</option></term>
        <listitem><para>limit actions to a comma separated list of zope versions; default behaviour is to act on all zope versions available</para></listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-u, --user=USER[:GROUP]</option></term>
        <listitem><para>User/Group ownership for new and copied files</para></listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-c, --config-file=FILE</option></term>
        <listitem><para>Configuration file; default is /etc/dzhandle.conf</para></listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-v, --verbose</option></term>
        <listitem><para>Enable verbose mode (not yet implemented)</para></listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-n, --dry-run</option></term>
        <listitem><para>Do not execute commands, print only them (not yet implemented)</para></listitem>
      </varlistentry>
    </variablelist>
  </refsect1>

  <refsect1>
    <title>ACTIONS (instances handling)</title>
    <variablelist>
      <varlistentry>
        <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>
            <varlistentry>
              <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;. 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>
              <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>
              <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>
              <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');
              this setting can be modified later editing the zope.conf file of the instance.</para>
              <para>Default: zope:zope</para></listitem>
            </varlistentry>
            <varlistentry>
              <term>--service-port=SRVPORT</term>
              <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>
              <para>Default: /usr/lib/zopeVER/skel</para></listitem>
            </varlistentry>
          </variablelist>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>remove-instance</option> &lt;instance&gt;</term>
        <listitem><para>Remove an instance (except data files) and mark it as removed.</para></listitem>
      </varlistentry>
      <varlistentry>
        <term><option>purge-instance</option> &lt;instance&gt;</term>
        <listitem><para>Purge files for an instance (including data files).</para></listitem>
      </varlistentry>
      <varlistentry>
        <term><option>show-instance</option> &lt;instance&gt;</term>
        <listitem><para>Print a short summary about an instance.</para></listitem>
      </varlistentry>
      <varlistentry>
        <term><option>list-instances</option></term>
        <listitem><para>Print the list of available instances.</para></listitem>
      </varlistentry>

      <varlistentry>
        <term><option>instance-addon-mode</option> &lt;instance&gt; [&lt;mode&gt;]</term>
        <listitem><para>Get or set an addon-mode for an instance. </para></listitem>
      </varlistentry>
      <varlistentry>
        <term><option>instance-addon-technique</option> &lt;instance&gt; [&lt;technique&gt;]</term>
        <listitem><para>Get or set an addon-install-technique for an instance.</para></listitem>
      </varlistentry>
      <varlistentry>
        <term><option>instance-restart-policy</option> &lt;instance&gt; [&lt;restart-policy&gt;]</term>
        <listitem><para>Get or set a policy on addon-installation for an instance.</para></listitem>
      </varlistentry>

      <varlistentry>
        <term><option>zopectl</option> &lt;instance&gt; &lt;zdctl-action&gt; [&lt;zdctl options&gt;]</term>
        <listitem><para>Call a zopectl action (e.g. `start', `stop' or `restart') for a given instance.</para></listitem>
      </varlistentry>
      <varlistentry>
        <term><option>restart-pending-instances</option></term>
        <listitem><para>Restart instances with `restart-pending' markers.</para></listitem>
      </varlistentry>
    </variablelist>
  </refsect1>

  <refsect1>
    <title>ACTIONS (ZEO instances handling)</title>
    <variablelist>
      <varlistentry>
        <term><option>make-zeoinstance</option> &lt;instance&gt;</term>
        <listitem>
          <para>Create a new instance running Zope version specific mkzeoinstance.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>purge-zeoinstance</option> &lt;instance&gt;</term>
        <listitem><para>Purge files for a ZEO instance (including data files).</para></listitem>
      </varlistentry>
      <varlistentry>
        <term><option>list-zeoinstances</option></term>
        <listitem><para>Print the list of available ZEO instances.</para></listitem>
      </varlistentry>

      <varlistentry>
        <term><option>zeoctl</option> &lt;instance&gt; &lt;zeotl-action&gt; [&lt;zeotl options&gt;]</term>
        <listitem><para>Call a zeoctl action (e.g. `start', `stop' or `restart') for a given ZEO instance.</para></listitem>
      </varlistentry>
    </variablelist>
  </refsect1>


  <refsect1>
    <title>ACTIONS (products and extensions handling)</title>
    <variablelist>
      <varlistentry>
        <term><option>list-products</option>, <option>list-extensions</option></term>
        <listitem><para>show all products or extensions managed by dzhandle</para></listitem>
      </varlistentry>
      <varlistentry>
        <term><option>add-product</option>, <option>add-extension</option></term>
        <listitem>
          <para>add a product or extension to an instance</para>
          <variablelist>
            <varlistentry>
              <term>-l, --lazy</term>
              <listitem><para>Add missing addons only (error on manually installed addons).</para></listitem>
            </varlistentry>
            <varlistentry>
              <term>-t ATECHNIQUE, --addon-install-technique=ATECHNIQUE</term>
              <listitem><para>How to install the specified addons.</para></listitem>
            </varlistentry>
          </variablelist>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>remove-product</option>, <option>remove-extension</option></term>
        <listitem>
          <para>remove a product or extension from an instance</para>
          <variablelist>
            <varlistentry>
              <term>-l, --lazy</term>
              <listitem><para>Do not complain about already removed addons.</para></listitem>
            </varlistentry>
            <varlistentry>
              <term>-f, --force</term>
              <listitem><para>Force removal of the addons.</para></listitem>
            </varlistentry>
          </variablelist>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>

  <refsect1>
    <title>ACTIONS (for Zope products maintainers)</title>
    <para>
      The following actions should be used inside the maintainer scripts of Debian/Ubuntu
      packages of Zope products and extensions. If the package uses zope-debhelper's
      <productname>dh_installzope</productname>, these actions will be automatically included.
    </para>
    <variablelist>
      <varlistentry>
        <term><option>dinstall-extension, dinstall-product</option></term>
        <listitem><para>install a packaged extension/product</para></listitem>
      </varlistentry>
      <varlistentry>
        <term><option>dremove-extension, dremove-product</option></term>
        <listitem><para>remove a packaged extension/product</para></listitem>
      </varlistentry>
      <varlistentry>
        <term><option>postinst-extension, postinst-product</option></term>
        <listitem><para>handle postinst of a packaged extension/product</para></listitem>
      </varlistentry>
      <varlistentry>
        <term><option>postrm-extension, postrm-product</option></term>
        <listitem><para>handle postrm of a packaged extension/product</para></listitem>
      </varlistentry>
      <varlistentry>
        <term><option>preinst-extension, preinst-product</option></term>
        <listitem><para>handle preinst of a packaged extension/product</para></listitem>
      </varlistentry>
      <varlistentry>
        <term><option>prerm-extension, prerm-product</option></term>
        <listitem><para>handle prerm of a packaged extension/product</para></listitem>
      </varlistentry>
      <varlistentry>
        <term><option>show-package-info</option></term>
        <listitem><para>show various information about zope packages</para></listitem>
      </varlistentry>
    </variablelist>
  </refsect1>

  <refsect1>
    <title>SEE ALSO</title>
    <para>dh_installzope(1), dh_installzopeinstance(1)</para>
  </refsect1>

  <refsect1>
    <title>AUTHOR</title>

    <para>This manual page was written by &dhusername; &lt;&dhemail;&gt; for
    the &debian; systems (but may be used by others).</para>

    <para>Permission is granted to copy, distribute and/or modify
    this document under the terms of the <acronym>GNU</acronym> Free
    Documentation License, Version 1.1 or any later version
    published by the Free Software Foundation; with no Invariant
    Sections, no Front-Cover Texts and no Back-Cover Texts.  A copy
    of the license can be found under
    <filename>/usr/share/common-licenses/FDL</filename>.</para>
  </refsect1>

</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:2
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:nil
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
-->