dzhandle

dzhandle 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.

"-h, Print usage information and exit

"-f, Force things, for example file overwriting or removing

"-z, limit actions to a comma separated list of zope versions; default behaviour is to act on all zope versions available

"-u, User/Group ownership for new and copied files

"-c, Configuration file; default is /etc/dzhandle.conf

"-v, Enable verbose mode (not yet implemented)

"-n, Do not execute commands, print only them (not yet implemented)

"make-instance Create a new instance running Zope version specific mkzopeinstance.

"-m 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.

"-t 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.

"-r 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.

"-u user and password for the initial user (in the form `user:password'); these settigs can be modified later using zpasswd.py utility from Zope.

"--service-user=SRVUSER" 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.

"--service-port=SRVPORT" HTTP port used to run this instance (default 9673); this setting can be modified later editing the zope.conf file of the instance.

"--skelsrc=SKEL" 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'.

"remove-instance Remove an instance (except data files) and mark it as removed.

"purge-instance Purge files for an instance (including data files).

"show-instance Print a short summary about an instance.

"list-instances" Print the list of available instances.

"instance-addon-mode Get or set an addon-mode for an instance.

"instance-addon-technique Get or set an addon-install-technique for an instance.

"instance-restart-policy Get or set a policy on addon-installation for an instance.

"zopectl Call a zopectl action (e.g. `start', `stop' or `restart') for a given instance.

"restart-pending-instances" Restart instances with `restart-pending' markers.

"make-zeoinstance Create a new instance running Zope version specific mkzeoinstance.

"purge-zeoinstance Purge files for a ZEO instance (including data files).

"list-zeoinstances" Print the list of available ZEO instances.

"zeoctl Call a zeoctl action (e.g. `start', `stop' or `restart') for a given ZEO instance.

"list-products, show all products or extensions managed by dzhandle

"add-product, add a product or extension to an instance

"-l, Add missing addons only (error on manually installed addons).

"-t How to install the specified addons.

"remove-product, remove a product or extension from an instance

"-l, Do not complain about already removed addons.

"-f, Force removal of the addons.

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 dh_installzope, these actions will be automatically included.

"dinstall-extension, install a packaged extension/product

"dremove-extension, remove a packaged extension/product

"postinst-extension, handle postinst of a packaged extension/product

"postrm-extension, handle postrm of a packaged extension/product

"preinst-extension, handle preinst of a packaged extension/product

"prerm-extension, handle prerm of a packaged extension/product

"show-package-info" show various informations about zope packages

dh_installzope(1), dh_installzopeinstance(1)

This manual page was written by Fabio Tranchitella <kobold@debian.org> for the Debian GNU/Linux and Ubuntu Linux systems (but may be used by others).

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 /usr/share/common-licenses/FDL.