From fab2d8b0abdb2a1af711d8b2ee6f287eef35d91d Mon Sep 17 00:00:00 2001 From: Magnus Enger Date: Mon, 17 Oct 2011 12:23:09 +0200 Subject: [PATCH] Bug 4877 - Add DocBook for missing manual pages Add DocBook manual pages for commands that do not have a manual page yet. Also add a page for koha-common itself, listing all the available commands. Signed-off-by: Robin Sheat Minor change: I fixed a typo I spotted --- debian/docs/koha-common.xml | 206 ++++++++++++++++++++++++++++ debian/docs/koha-create-dirs.xml | 43 ++++++ debian/docs/koha-disable.xml | 45 ++++++ debian/docs/koha-dump-defaults.xml | 44 ++++++ debian/docs/koha-dump.xml | 45 ++++++ debian/docs/koha-email-disable.xml | 42 ++++++ debian/docs/koha-email-enable.xml | 42 ++++++ debian/docs/koha-enable.xml | 45 ++++++ debian/docs/koha-foreach.xml | 43 ++++++ debian/docs/koha-list.xml | 73 ++++++++++ debian/docs/koha-mysql.xml | 44 ++++++ debian/docs/koha-rebuild-zebra.xml | 67 +++++++++ debian/docs/koha-remove.xml | 17 ++- debian/docs/koha-reset-passwd.xml | 44 ++++++ debian/docs/koha-restart-zebra.xml | 44 ++++++ debian/docs/koha-restore.xml | 45 ++++++ debian/docs/koha-start-zebra.xml | 44 ++++++ debian/docs/koha-stop-zebra.xml | 44 ++++++ debian/docs/koha-upgrade-schema.xml | 44 ++++++ debian/docs/koha-upgrade-to-3.4.xml | 41 ++++++ 20 files changed, 1058 insertions(+), 4 deletions(-) create mode 100644 debian/docs/koha-common.xml create mode 100644 debian/docs/koha-create-dirs.xml create mode 100644 debian/docs/koha-disable.xml create mode 100644 debian/docs/koha-dump-defaults.xml create mode 100644 debian/docs/koha-dump.xml create mode 100644 debian/docs/koha-email-disable.xml create mode 100644 debian/docs/koha-email-enable.xml create mode 100644 debian/docs/koha-enable.xml create mode 100644 debian/docs/koha-foreach.xml create mode 100644 debian/docs/koha-list.xml create mode 100644 debian/docs/koha-mysql.xml create mode 100644 debian/docs/koha-rebuild-zebra.xml create mode 100644 debian/docs/koha-reset-passwd.xml create mode 100644 debian/docs/koha-restart-zebra.xml create mode 100644 debian/docs/koha-restore.xml create mode 100644 debian/docs/koha-start-zebra.xml create mode 100644 debian/docs/koha-stop-zebra.xml create mode 100644 debian/docs/koha-upgrade-schema.xml create mode 100644 debian/docs/koha-upgrade-to-3.4.xml diff --git a/debian/docs/koha-common.xml b/debian/docs/koha-common.xml new file mode 100644 index 0000000000..0e70595599 --- /dev/null +++ b/debian/docs/koha-common.xml @@ -0,0 +1,206 @@ +
+koha-common + +Koha is the first free software library automation package. + + The Koha Communnity + http://koha-community.org/ + + + + + + + koha-common + 8 + + + + koha-common + Create and manage Koha instances. + UNIX/Linux + + + Description + koha-common provides a number of scripts for creating and administering Koha instances. It is meant for sites that provide Koha hosting, and serves several sites from the same host. + + + Commands + The following commands are available after when koha-common has been installed. See individual manual pages for each command for optios and other details related to their usage. + + Administer instances + + + + + + Disable a Koha instance. + + + + + + + Enable a Koha instance. New instances are enabled by default. You only need this command if you have previously disabled a site with koha-disable. + + + + + + + Restore a Koha site from a dump (from koha-dump). + + + + + + + Dump all contents and configs for a Koha site. + + + + + + + Remove a Koha instance. + + + + + + Database-related + + + + + + Create default contents from an existing Koha site. + + + + + + + Upgrade the DB schema for Koha instances. Done automatically on package upgrades. + + + + + + + Reset password for a user in a Koha instance. + + + + + + + Provide an interactive mysql shell set up for the specified koha instance. + + + + + + Zebra-related + + + + + + Start Zebra for named Koha instances. + + + + + + + Restart Zebra for named Koha instances. + + + + + + + Rebuild the Zebra database for a Koha instance. + + + + + + + Stop Zebra for named Koha instances. + + + + + + E-mail + + + + + + Turn on the email for a Koha instance. + + + + + + + Turn off the email for a Koha instance. + + + + + + Misc + + + + + + Performs the necessary changes to upgrade a Koha system from 3.2 to 3.4. If no instance names are provided, this will run it on all of them. + + + + + + Utilities + + + + + + Create dirs for a Koha instance. + + + + + + + Lists Koha instances, optionally only those that are enabled or have email turned on. + + + + + + + Run a command for each Koha instance. Takes the same arguments as koha-list. + + + + + + + Bugs + The scripts are a bit fragile. If something goes wrong, they do not clean up after themselves. + Bugs can be reported here: http://bugs.koha-community.org/bugzilla3/ + + + About Koha + Koha is the first free software library automation package. In use worldwide, its development is steered by a growing community of users collaborating to achieve their technology goals. Koha’s feature set continues to evolve and expand to meet the needs of its user base. + + + + +
diff --git a/debian/docs/koha-create-dirs.xml b/debian/docs/koha-create-dirs.xml new file mode 100644 index 0000000000..9f9ddead63 --- /dev/null +++ b/debian/docs/koha-create-dirs.xml @@ -0,0 +1,43 @@ +
+koha-create-dirs + +Koha is the first free software library automation package. + + The Koha Communnity + http://koha-community.org/ + + + + + + + koha-create-dirs + 8 + + + + koha-create-dirs + Create dirs for a Koha instance. + UNIX/Linux + + + + + koha-create-dirs instancename + + + + Description + Create dirs for a Koha instance. + + + See also + + koha-foreach(8) + koha-list(8) + + + + + +
diff --git a/debian/docs/koha-disable.xml b/debian/docs/koha-disable.xml new file mode 100644 index 0000000000..8b7f729808 --- /dev/null +++ b/debian/docs/koha-disable.xml @@ -0,0 +1,45 @@ +
+koha-disable + +Koha is the first free software library automation package. + + The Koha Communnity + http://koha-community.org/ + + + + + + + koha-disable + 8 + + + + koha-disable + Disable a Koha instance. + UNIX/Linux + + + + + koha-disable instancename + + + + Description + Disable a Koha instance. + + + See also + + koha-dump(8) + koha-enable(8) + koha-remove(8) + koha-restore(8) + + + + + +
diff --git a/debian/docs/koha-dump-defaults.xml b/debian/docs/koha-dump-defaults.xml new file mode 100644 index 0000000000..048c3e9277 --- /dev/null +++ b/debian/docs/koha-dump-defaults.xml @@ -0,0 +1,44 @@ +
+koha-dump-defaults + +Koha is the first free software library automation package. + + The Koha Communnity + http://koha-community.org/ + + + + + + + koha-dump-defaults + 8 + + + + koha-dump-defaults + Create default contents from an existing Koha site. + UNIX/Linux + + + + + koha-dump-defaults instancename + + + + Description + Create default contents from an existing Koha site. + + + See also + + koha-mysql(8) + koha-reset-passwd(8) + koha-upgrade-schema(8) + + + + + +
diff --git a/debian/docs/koha-dump.xml b/debian/docs/koha-dump.xml new file mode 100644 index 0000000000..ec79f6e393 --- /dev/null +++ b/debian/docs/koha-dump.xml @@ -0,0 +1,45 @@ +
+koha-dump + +Koha is the first free software library automation package. + + The Koha Communnity + http://koha-community.org/ + + + + + + + koha-dump + 8 + + + + koha-dump + Dump all contents and configs for a Koha site. + UNIX/Linux + + + + + koha-dump instancename + + + + Description + Dump all contents and configs for a Koha site. + + + See also + + koha-disable(8) + koha-enable(8) + koha-remove(8) + koha-restore(8) + + + + + +
diff --git a/debian/docs/koha-email-disable.xml b/debian/docs/koha-email-disable.xml new file mode 100644 index 0000000000..83bf8ef396 --- /dev/null +++ b/debian/docs/koha-email-disable.xml @@ -0,0 +1,42 @@ +
+koha-email-disable + +Koha is the first free software library automation package. + + The Koha Communnity + http://koha-community.org/ + + + + + + + koha-email-disable + 8 + + + + koha-email-disable + Turn off the email for a Koha instance. + UNIX/Linux + + + + + koha-email-disable instancename + + + + Description + Turn off the email for a Koha instance. + + + See also + + koha-email-enable(8) + + + + + +
diff --git a/debian/docs/koha-email-enable.xml b/debian/docs/koha-email-enable.xml new file mode 100644 index 0000000000..5274f753f4 --- /dev/null +++ b/debian/docs/koha-email-enable.xml @@ -0,0 +1,42 @@ +
+koha-email-enable + +Koha is the first free software library automation package. + + The Koha Communnity + http://koha-community.org/ + + + + + + + koha-email-enable + 8 + + + + koha-email-enable + Turn on the email for a Koha instance. + UNIX/Linux + + + + + koha-email-enable instancename + + + + Description + Turn on the email for a Koha instance. + + + See also + + koha-email-disable(8) + + + + + +
diff --git a/debian/docs/koha-enable.xml b/debian/docs/koha-enable.xml new file mode 100644 index 0000000000..a2f8cc3569 --- /dev/null +++ b/debian/docs/koha-enable.xml @@ -0,0 +1,45 @@ +
+koha-enable + +Koha is the first free software library automation package. + + The Koha Communnity + http://koha-community.org/ + + + + + + + koha-enable + 8 + + + + koha-enable + Enable a Koha instance. New instances are enabled by default. You only need this command if you have previously disabled a site with koha-disable. + UNIX/Linux + + + + + koha-enable instancename + + + + Description + Enable a Koha instance. New instances are enabled by default. You only need this command if you have previously disabled a site with koha-disable. + + + See also + + koha-disable(8) + koha-dump(8) + koha-remove(8) + koha-restore(8) + + + + + +
diff --git a/debian/docs/koha-foreach.xml b/debian/docs/koha-foreach.xml new file mode 100644 index 0000000000..869e9c7a9d --- /dev/null +++ b/debian/docs/koha-foreach.xml @@ -0,0 +1,43 @@ +
+koha-foreach + +Koha is the first free software library automation package. + + The Koha Communnity + http://koha-community.org/ + + + + + + + koha-foreach + 8 + + + + koha-foreach + Run a command for each Koha instance. Takes the same arguments as koha-list. + UNIX/Linux + + + + + koha-list | + + + + Description + Run a command for each Koha instance. Takes the same arguments as koha-list. + + + See also + + koha-create-dirs(8) + koha-list(8) + + + + + +
diff --git a/debian/docs/koha-list.xml b/debian/docs/koha-list.xml new file mode 100644 index 0000000000..9d0acf9d58 --- /dev/null +++ b/debian/docs/koha-list.xml @@ -0,0 +1,73 @@ +
+koha-list + +Koha is the first free software library automation package. + + The Koha Communnity + http://koha-community.org/ + + + + + + + koha-list + 8 + + + + koha-list + Lists Koha instances, optionally only those that are enabled or have email turned on. + UNIX/Linux + + + + + koha-list + + + + Options + The filtering options can be combined, and you probably want to do this (except --email and --noemail, that's just silly.) + + + + + Only show instances that are enabled. + + + + + + Only show instances that have email enabled. + + + + + + Only show instances that do not have email enabled. + + + + + + This help. + + + + + + Description + Lists Koha instances, optionally only those that are enabled or have email turned on. + + + See also + + koha-create-dirs(8) + koha-foreach(8) + + + + + +
diff --git a/debian/docs/koha-mysql.xml b/debian/docs/koha-mysql.xml new file mode 100644 index 0000000000..b8079ced70 --- /dev/null +++ b/debian/docs/koha-mysql.xml @@ -0,0 +1,44 @@ +
+koha-mysql + +Koha is the first free software library automation package. + + The Koha Communnity + http://koha-community.org/ + + + + + + + koha-mysql + 8 + + + + koha-mysql + Provide an interactive mysql shell set up for the specified koha instance. + UNIX/Linux + + + + + koha-mysql instancename + + + + Description + Provide an interactive mysql shell set up for the specified koha instance. + + + See also + + koha-dump-defaults(8) + koha-reset-passwd(8) + koha-upgrade-schema(8) + + + + + +
diff --git a/debian/docs/koha-rebuild-zebra.xml b/debian/docs/koha-rebuild-zebra.xml new file mode 100644 index 0000000000..e5b319c507 --- /dev/null +++ b/debian/docs/koha-rebuild-zebra.xml @@ -0,0 +1,67 @@ +
+koha-rebuild-zebra + +Koha is the first free software library automation package. + + The Koha Communnity + http://koha-community.org/ + + + + + + + koha-rebuild-zebra + 8 + + + + koha-rebuild-zebra + Rebuild the Zebra database for a Koha instance. + UNIX/Linux + + + + + koha-rebuild-zebra | | instancename + + + + Options + + + + + Runs the process as USMARC rather than the default of MARCXML. + + + + + + Does a reindex of the whole collection. + + + + + + Anything else is passed directly to rebuild_zebra. This is useful in particular for -v. + + + + + + Description + Rebuild the Zebra database for a Koha instance. + + + See also + + koha-restart-zebra(8) + koha-start-zebra(8) + koha-stop-zebra(8) + + + + + +
diff --git a/debian/docs/koha-remove.xml b/debian/docs/koha-remove.xml index 5d5767fd8c..ee2b26673b 100644 --- a/debian/docs/koha-remove.xml +++ b/debian/docs/koha-remove.xml @@ -17,20 +17,29 @@ koha-remove - Remove one or more Koha instance(s). + Remove a Koha instance. UNIX/Linux - koha-remove - instancename + koha-remove instancename Description - Remove one or more Koha instance(s). This removes all files associated with a Koha instance. + Remove a Koha instance. + + See also + + koha-disable(8) + koha-dump(8) + koha-enable(8) + koha-restore(8) + + + diff --git a/debian/docs/koha-reset-passwd.xml b/debian/docs/koha-reset-passwd.xml new file mode 100644 index 0000000000..85e84436fd --- /dev/null +++ b/debian/docs/koha-reset-passwd.xml @@ -0,0 +1,44 @@ +
+koha-reset-passwd + +Koha is the first free software library automation package. + + The Koha Communnity + http://koha-community.org/ + + + + + + + koha-reset-passwd + 8 + + + + koha-reset-passwd + Reset password for a user in a Koha instance. + UNIX/Linux + + + + + koha-reset-passwd instancename username + + + + Description + Reset password for a user in a Koha instance. + + + See also + + koha-dump-defaults(8) + koha-mysql(8) + koha-upgrade-schema(8) + + + + + +
diff --git a/debian/docs/koha-restart-zebra.xml b/debian/docs/koha-restart-zebra.xml new file mode 100644 index 0000000000..649df1e6ac --- /dev/null +++ b/debian/docs/koha-restart-zebra.xml @@ -0,0 +1,44 @@ +
+koha-restart-zebra + +Koha is the first free software library automation package. + + The Koha Communnity + http://koha-community.org/ + + + + + + + koha-restart-zebra + 8 + + + + koha-restart-zebra + Restart Zebra for named Koha instances. + UNIX/Linux + + + + + koha-restart-zebra instancename + + + + Description + Restart Zebra for named Koha instances. + + + See also + + koha-rebuild-zebra(8) + koha-start-zebra(8) + koha-stop-zebra(8) + + + + + +
diff --git a/debian/docs/koha-restore.xml b/debian/docs/koha-restore.xml new file mode 100644 index 0000000000..6acb0e825b --- /dev/null +++ b/debian/docs/koha-restore.xml @@ -0,0 +1,45 @@ +
+koha-restore + +Koha is the first free software library automation package. + + The Koha Communnity + http://koha-community.org/ + + + + + + + koha-restore + 8 + + + + koha-restore + Restore a Koha site from a dump (from koha-dump). + UNIX/Linux + + + + + koha-restore + + + + Description + Restore a Koha site from a dump (from koha-dump). + + + See also + + koha-disable(8) + koha-dump(8) + koha-enable(8) + koha-remove(8) + + + + + +
diff --git a/debian/docs/koha-start-zebra.xml b/debian/docs/koha-start-zebra.xml new file mode 100644 index 0000000000..eb3c2abf34 --- /dev/null +++ b/debian/docs/koha-start-zebra.xml @@ -0,0 +1,44 @@ +
+koha-start-zebra + +Koha is the first free software library automation package. + + The Koha Communnity + http://koha-community.org/ + + + + + + + koha-start-zebra + 8 + + + + koha-start-zebra + Start Zebra for named Koha instances. + UNIX/Linux + + + + + koha-start-zebra instancename + + + + Description + Start Zebra for named Koha instances. + + + See also + + koha-rebuild-zebra(8) + koha-restart-zebra(8) + koha-stop-zebra(8) + + + + + +
diff --git a/debian/docs/koha-stop-zebra.xml b/debian/docs/koha-stop-zebra.xml new file mode 100644 index 0000000000..050ddd7cb0 --- /dev/null +++ b/debian/docs/koha-stop-zebra.xml @@ -0,0 +1,44 @@ +
+koha-stop-zebra + +Koha is the first free software library automation package. + + The Koha Communnity + http://koha-community.org/ + + + + + + + koha-stop-zebra + 8 + + + + koha-stop-zebra + Stop Zebra for named Koha instances. + UNIX/Linux + + + + + koha-stop-zebra instancename + + + + Description + Stop Zebra for named Koha instances. + + + See also + + koha-rebuild-zebra(8) + koha-restart-zebra(8) + koha-start-zebra(8) + + + + + +
diff --git a/debian/docs/koha-upgrade-schema.xml b/debian/docs/koha-upgrade-schema.xml new file mode 100644 index 0000000000..8b5a4c4b60 --- /dev/null +++ b/debian/docs/koha-upgrade-schema.xml @@ -0,0 +1,44 @@ +
+koha-upgrade-schema + +Koha is the first free software library automation package. + + The Koha Communnity + http://koha-community.org/ + + + + + + + koha-upgrade-schema + 8 + + + + koha-upgrade-schema + Upgrade the DB schema for Koha instances. Done automatically on package upgrades. + UNIX/Linux + + + + + koha-upgrade-schema instancename + + + + Description + Upgrade the DB schema for Koha instances. Done automatically on package upgrades. + + + See also + + koha-dump-defaults(8) + koha-mysql(8) + koha-reset-passwd(8) + + + + + +
diff --git a/debian/docs/koha-upgrade-to-3.4.xml b/debian/docs/koha-upgrade-to-3.4.xml new file mode 100644 index 0000000000..c528377169 --- /dev/null +++ b/debian/docs/koha-upgrade-to-3.4.xml @@ -0,0 +1,41 @@ +
+koha-upgrade-to-3.4 + +Koha is the first free software library automation package. + + The Koha Communnity + http://koha-community.org/ + + + + + + + koha-upgrade-to-3.4 + 8 + + + + koha-upgrade-to-3.4 + Performs the necessary changes to upgrade a Koha system from 3.2 to 3.4. If no instance names are provided, this will run it on all of them. + UNIX/Linux + + + + + koha-upgrade-to-3.4 instancename + + + + Description + Performs the necessary changes to upgrade a Koha system from 3.2 to 3.4. If no instance names are provided, this will run it on all of them. + + + See also + + + + + + +