.TH "dzhandle" "1" .SH "NAME" dzhandle \(em Debian/Ubuntu Zope packages handling command line utility .SH "SYNOPSIS" .PP \fBdzhandle\fR [options] \fBaction\fR [action options] .SH "DESCRIPTION" .PP \fBdzhandle\fR 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 dzhandle 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. .SH "OPTIONS" .IP "\fB-h, \-\-help\fP" 10 Print usage information and exit .IP "\fB-f, \-\-force\fP" 10 Force things, for example file overwriting or removing .IP "\fB-z, \-\-zope-version=ZVERSIONS\fP" 10 limit actions to a comma separated list of zope versions; default behaviour is to act on all zope versions available .IP "\fB-u, \-\-user=USER[:GROUP]\fP" 10 User/Group ownership for new and copied files .IP "\fB-c, \-\-config-file=FILE\fP" 10 Configuration file; default is /etc/dzhandle.conf .IP "\fB-v, \-\-verbose\fP" 10 Enable verbose mode (not yet implemented) .IP "\fB-n, \-\-dry-run\fP" 10 Do not execute commands, print only them (not yet implemented) .SH "ACTIONS (instances handling)" .IP "\fBmake-instance\fP \-m AMODE []" 10 Create a new instance running Zope version specific mkzopeinstance. .RS .IP "\-m AMODE, \-\-addon-mode=AMODE" 10 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 dzhandle. This option is mandatory. .IP "\-t ATECHNIQUE, \-\-addon-install-technique=ATECHNIQUE" 10 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. .IP "" 10 Default: tree-linked. .IP "\-r RESTART, \-\-restart=RESTART" 10 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. .IP "" 10 Default: end .IP "\-u USER, \-\-user=USER" 10 user and password for the initial user (in the form `user:password'); these settigs can be modified later using zpasswd.py utility from Zope. .IP "" 10 You'll be prompted for an username and password if the options is omitted. .IP "\-\-service-user=SRVUSER" 10 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. .IP "" 10 Default: zope:zope .IP "\-\-service-port=SRVPORT" 10 HTTP port used to run this instance; this setting can be modified later editing the zope.conf file of the instance. .IP "" 10 Default: 9673 .IP "\-\-skelsrc=SKEL" 10 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'. .IP "" 10 Default: /usr/lib/zopeVER/skel .RE .IP "\fBremove-instance\fP " 10 Remove an instance (except data files) and mark it as removed. .IP "\fBpurge-instance\fP " 10 Purge files for an instance (including data files). .IP "\fBshow-instance\fP " 10 Print a short summary about an instance. .IP "\fBlist-instances\fP" 10 Print the list of available instances. .IP "\fBinstance-addon-mode\fP []" 10 Get or set an addon-mode for an instance. .IP "\fBinstance-addon-technique\fP []" 10 Get or set an addon-install-technique for an instance. .IP "\fBinstance-restart-policy\fP []" 10 Get or set a policy on addon-installation for an instance. .IP "\fBzopectl\fP []" 10 Call a zopectl action (e.g. `start', `stop' or `restart') for a given instance. .IP "\fBrestart-pending-instances\fP" 10 Restart instances with `restart-pending' markers. .SH "ACTIONS (ZEO instances handling)" .IP "\fBmake-zeoinstance\fP " 10 Create a new instance running Zope version specific mkzeoinstance. .IP "\fBpurge-zeoinstance\fP " 10 Purge files for a ZEO instance (including data files). .IP "\fBlist-zeoinstances\fP" 10 Print the list of available ZEO instances. .IP "\fBzeoctl\fP []" 10 Call a zeoctl action (e.g. `start', `stop' or `restart') for a given ZEO instance. .SH "ACTIONS (products and extensions handling)" .IP "\fBlist-products\fP, \fBlist-extensions\fP" 10 show all products or extensions managed by dzhandle .IP "\fBadd-product\fP, \fBadd-extension\fP" 10 add a product or extension to an instance .RS .IP "\-l, \-\-lazy" 10 Add missing addons only (error on manually installed addons). .IP "\-t ATECHNIQUE, \-\-addon-install-technique=ATECHNIQUE" 10 How to install the specified addons. .RE .IP "\fBremove-product\fP, \fBremove-extension\fP" 10 remove a product or extension from an instance .RS .IP "\-l, \-\-lazy" 10 Do not complain about already removed addons. .IP "\-f, \-\-force" 10 Force removal of the addons. .RE .SH "ACTIONS (for Zope products maintainers)" .PP 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 \fBdh_installzope\fP, these actions will be automatically included. .IP "\fBdinstall-extension, dinstall-product\fP" 10 install a packaged extension/product .IP "\fBdremove-extension, dremove-product\fP" 10 remove a packaged extension/product .IP "\fBpostinst-extension, postinst-product\fP" 10 handle postinst of a packaged extension/product .IP "\fBpostrm-extension, postrm-product\fP" 10 handle postrm of a packaged extension/product .IP "\fBpreinst-extension, preinst-product\fP" 10 handle preinst of a packaged extension/product .IP "\fBprerm-extension, prerm-product\fP" 10 handle prerm of a packaged extension/product .IP "\fBshow-package-info\fP" 10 show various information about zope packages .SH "SEE ALSO" .PP dh_installzope(1), dh_installzopeinstance(1) .SH "AUTHOR" .PP This manual page was written by Fabio Tranchitella for the \fBDebian GNU/Linux\fP and \fBUbuntu Linux\fP systems (but may be used by others). .PP Permission is granted to copy, distribute and/or modify this document under the terms of the GNU 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 \fB/usr/share/common-licenses/FDL\fP. .\" created by instant / docbook-to-man, Mon 14 Jul 2014, 18:25