From 143eb2b482a9fb95f6911f4ea314eec37558d976 Mon Sep 17 00:00:00 2001 From: Magnus Enger Date: Sun, 30 Sep 2012 09:57:37 +0200 Subject: [PATCH] Bug 8568 - Fix some errors in docs for scripts provided by the Debian packages MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 1. Create a page for koha-run-backups 2. Fix the synopsis for koha-foreach 3. Add koha-create and koha-run-backups to koha-common To test - Convert the changed xml files to man pages with $ xsltproc /usr/share/xml/docbook/stylesheet/docbook-xsl/manpages/docbook.xsl koha-x.xml - View generated pages with e.g. $ man -l koha-x.8" (Replace x with the names of the changed files) - Check that the changes make sense Signed-off-by: Frédéric Demians Works as described. I was able to produce the 3 man files, load them with man command, and see the added information properly formated. --- debian/docs/koha-common.xml | 14 ++++++++ debian/docs/koha-foreach.xml | 2 +- debian/docs/koha-run-backups.xml | 69 ++++++++++++++++++++++++++++++++++++++++ 3 files changed, 84 insertions(+), 1 deletion(-) create mode 100644 debian/docs/koha-run-backups.xml diff --git a/debian/docs/koha-common.xml b/debian/docs/koha-common.xml index 0e70595..bbef4f2 100644 --- a/debian/docs/koha-common.xml +++ b/debian/docs/koha-common.xml @@ -32,6 +32,13 @@ + + + Create new Koha instances. + + + + Disable a Koha instance. @@ -60,6 +67,13 @@ + + + Performs backups of the koha installations on the system, except an instance called 'demo'. + + + + Remove a Koha instance. diff --git a/debian/docs/koha-foreach.xml b/debian/docs/koha-foreach.xml index 869e9c7..733ddd9 100644 --- a/debian/docs/koha-foreach.xml +++ b/debian/docs/koha-foreach.xml @@ -23,7 +23,7 @@ - koha-list | + koha-foreach | diff --git a/debian/docs/koha-run-backups.xml b/debian/docs/koha-run-backups.xml new file mode 100644 index 0000000..ba00d54 --- /dev/null +++ b/debian/docs/koha-run-backups.xml @@ -0,0 +1,69 @@ +
+koha-run-backups + +Koha is the first free software library automation package. + + The Koha Communnity + http://koha-community.org/ + + + + + + + koha-run-backups + 8 + + + + koha-run-backups + Performs backups of the koha installations on the system, except an instance called 'demo'. + UNIX/Linux + + + + + koha-run-backups + /some/path + 2 + + + + Options + + + + + + The directory that the resulting files will be placed into (default: /var/spool/koha). + + + + + + + The number of days to keep backups around for (default: 2). + + + + + + + Description + koha-run-backups allows automation of backing up the koha data and configuration to the filesystem. It will keep the past so many backups, discarding older ones. This script uses koha-dump to do the actual backup. + If there is an instance called 'demo', it will be skipped by this script. + Note: backups produced using this tool can be restored using koha-restore. + + + See also + + + koha-dump(8) + koha-restore(8) + + + + + + +
-- 1.7.11.1