Bug 8568 - Fix some errors in docs for scripts provided by the Debian packages

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 <f.demians@tamil.fr>

Works as described. I was able to produce the 3 man files, load them with man
command, and see the added information properly formated.

Signed-off-by: Paul Poulain <paul.poulain@biblibre.com>
Signed-off-by: Chris Cormack <chrisc@catalyst.net.nz>
This commit is contained in:
Magnus Enger 2012-09-30 09:57:37 +02:00 committed by Chris Cormack
parent 1f877328dc
commit b24fdbcdd6
3 changed files with 84 additions and 1 deletions

View File

@ -31,6 +31,13 @@
<refsect2><title>Administer instances</title>
<variablelist>
<varlistentry>
<term><option>koha-create</option></term>
<listitem>
<para>Create new Koha instances.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>koha-disable</option></term>
<listitem>
@ -59,6 +66,13 @@
</listitem>
</varlistentry>
<varlistentry>
<term><option>koha-run-backups</option></term>
<listitem>
<para>Performs backups of the koha installations on the system, except an instance called 'demo'.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>koha-remove</option></term>
<listitem>

View File

@ -23,7 +23,7 @@
<refsynopsisdiv>
<cmdsynopsis>
<command>koha-list</command> <arg><option>--enabled</option></arg> <arg><option>--email</option>|<option>--noemail</option></arg> <arg><option>command</option></arg>
<command>koha-foreach</command> <arg><option>--enabled</option></arg> <arg><option>--email</option>|<option>--noemail</option></arg> <arg><option>command</option></arg>
</cmdsynopsis>
</refsynopsisdiv>

69
debian/docs/koha-run-backups.xml vendored Normal file
View File

@ -0,0 +1,69 @@
<article xmlns='http://docbook.org/ns/docbook'>
<title>koha-run-backups</title>
<info>
<productname>Koha</productname> is the first free software library automation package.
<author>
<orgname>The Koha Communnity</orgname>
<uri>http://koha-community.org/</uri>
</author>
</info>
<refentry xml:id="koha-run-backups">
<refmeta>
<refentrytitle>koha-run-backups</refentrytitle>
<manvolnum>8</manvolnum>
</refmeta>
<refnamediv>
<refname>koha-run-backups</refname>
<refpurpose>Performs backups of the koha installations on the system, except an instance called 'demo'.</refpurpose>
<refclass>UNIX/Linux</refclass>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>koha-run-backups</command>
<arg><option>--output</option> /some/path</arg>
<arg><option>--days</option> 2</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1><title>Options</title>
<variablelist>
<varlistentry>
<term><option>--output</option></term>
<listitem>
<para>The directory that the resulting files will be placed into (default: /var/spool/koha).</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--days</option></term>
<listitem>
<para>The number of days to keep backups around for (default: 2).</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1><title>Description</title>
<para><command>koha-run-backups</command> 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 <command>koha-dump</command> to do the actual backup.</para>
<para>If there is an instance called 'demo', it will be skipped by this script.</para>
<para>Note: backups produced using this tool can be restored using <command>koha-restore</command>.</para>
</refsect1>
<refsect1><title>See also</title>
<simplelist type="inline">
<member><command>koha-dump(8)</command></member>
<member><command>koha-restore(8)</command></member>
</simplelist>
</refsect1>
</refentry>
</article>