[Koha-patches] [PATCH] Bug 4877 - Add DocBook for missing manual pages
Magnus Enger
magnus at enger.priv.no
Mon Oct 17 12:25:19 CEST 2011
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.
---
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 0000000..0e70595
--- /dev/null
+++ b/debian/docs/koha-common.xml
@@ -0,0 +1,206 @@
+<article xmlns='http://docbook.org/ns/docbook'>
+<title>koha-common</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-common">
+
+ <refmeta>
+ <refentrytitle>koha-common</refentrytitle>
+ <manvolnum>8</manvolnum>
+ </refmeta>
+
+ <refnamediv>
+ <refname>koha-common</refname>
+ <refpurpose>Create and manage Koha instances.</refpurpose>
+ <refclass>UNIX/Linux</refclass>
+ </refnamediv>
+
+ <refsect1><title>Description</title>
+ <para>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.</para>
+ </refsect1>
+
+ <refsect1><title>Commands</title>
+ <para>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.</para>
+
+ <refsect2><title>Administer instances</title>
+ <variablelist>
+
+ <varlistentry>
+ <term><option>koha-disable</option></term>
+ <listitem>
+ <para>Disable a Koha instance.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>koha-enable</option></term>
+ <listitem>
+ <para>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.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>koha-restore</option></term>
+ <listitem>
+ <para>Restore a Koha site from a dump (from koha-dump).</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>koha-dump</option></term>
+ <listitem>
+ <para>Dump all contents and configs for a Koha site.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>koha-remove</option></term>
+ <listitem>
+ <para>Remove a Koha instance.</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect2>
+
+ <refsect2><title>Database-related</title>
+ <variablelist>
+
+ <varlistentry>
+ <term><option>koha-dump-defaults</option></term>
+ <listitem>
+ <para>Create default contents from an existing Koha site.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>koha-upgrade-schema</option></term>
+ <listitem>
+ <para>Upgrade the DB schema for Koha instances. Done automatically on package upgrades.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>koha-reset-passwd</option></term>
+ <listitem>
+ <para>Reset password for a user in a Koha instance.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>koha-mysql</option></term>
+ <listitem>
+ <para>Provide an interactive mysql shell set up for the specified koha instance.</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect2>
+
+ <refsect2><title>Zebra-related</title>
+ <variablelist>
+
+ <varlistentry>
+ <term><option>koha-start-zebra</option></term>
+ <listitem>
+ <para>Start Zebra for named Koha instances.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>koha-restart-zebra</option></term>
+ <listitem>
+ <para>Restart Zebra for named Koha instances.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>koha-rebuild-zebra</option></term>
+ <listitem>
+ <para>Rebuild the Zebra database for a Koha instance.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>koha-stop-zebra</option></term>
+ <listitem>
+ <para>Stop Zebra for named Koha instances.</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect2>
+
+ <refsect2><title>E-mail</title>
+ <variablelist>
+
+ <varlistentry>
+ <term><option>koha-email-enable</option></term>
+ <listitem>
+ <para>Turn on the email for a Koha instance.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>koha-email-disable</option></term>
+ <listitem>
+ <para>Turn off the email for a Koha instance.</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect2>
+
+ <refsect2><title>Misc</title>
+ <variablelist>
+
+ <varlistentry>
+ <term><option>koha-upgrade-to-3.4</option></term>
+ <listitem>
+ <para>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.</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect2>
+
+ <refsect2><title>Utilities</title>
+ <variablelist>
+
+ <varlistentry>
+ <term><option>koha-create-dirs</option></term>
+ <listitem>
+ <para>Create dirs for a Koha instance.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>koha-list</option></term>
+ <listitem>
+ <para>Lists Koha instances, optionally only those that are enabled or have email turned on.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>koha-foreach</option></term>
+ <listitem>
+ <para>Run a command for each Koha instance. Takes the same arguments as koha-list.</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect2>
+ </refsect1>
+
+ <refsect1><title>Bugs</title>
+ <para>The scripts are a bit fragile. If something goes wrong, they do not clean up after themselves.</para>
+ <para>Bugs can be reported here: <uri>http://bugs.koha-community.org/bugzilla3/</uri></para>
+ </refsect1>
+
+ <refsect1><title>About Koha</title>
+ <para>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.</para>
+ </refsect1>
+
+</refentry>
+
+</article>
diff --git a/debian/docs/koha-create-dirs.xml b/debian/docs/koha-create-dirs.xml
new file mode 100644
index 0000000..9f9ddea
--- /dev/null
+++ b/debian/docs/koha-create-dirs.xml
@@ -0,0 +1,43 @@
+<article xmlns='http://docbook.org/ns/docbook'>
+<title>koha-create-dirs</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-create-dirs">
+
+ <refmeta>
+ <refentrytitle>koha-create-dirs</refentrytitle>
+ <manvolnum>8</manvolnum>
+ </refmeta>
+
+ <refnamediv>
+ <refname>koha-create-dirs</refname>
+ <refpurpose>Create dirs for a Koha instance.</refpurpose>
+ <refclass>UNIX/Linux</refclass>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <cmdsynopsis>
+ <command>koha-create-dirs</command> <arg choice="req" rep="repeat"><replaceable>instancename</replaceable></arg>
+ </cmdsynopsis>
+ </refsynopsisdiv>
+
+ <refsect1><title>Description</title>
+ <para>Create dirs for a Koha instance.</para>
+ </refsect1>
+
+ <refsect1><title>See also</title>
+ <simplelist type="inline">
+ <member><command>koha-foreach(8)</command></member>
+ <member><command>koha-list(8)</command></member>
+ </simplelist>
+ </refsect1>
+
+</refentry>
+
+</article>
diff --git a/debian/docs/koha-disable.xml b/debian/docs/koha-disable.xml
new file mode 100644
index 0000000..8b7f729
--- /dev/null
+++ b/debian/docs/koha-disable.xml
@@ -0,0 +1,45 @@
+<article xmlns='http://docbook.org/ns/docbook'>
+<title>koha-disable</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-disable">
+
+ <refmeta>
+ <refentrytitle>koha-disable</refentrytitle>
+ <manvolnum>8</manvolnum>
+ </refmeta>
+
+ <refnamediv>
+ <refname>koha-disable</refname>
+ <refpurpose>Disable a Koha instance.</refpurpose>
+ <refclass>UNIX/Linux</refclass>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <cmdsynopsis>
+ <command>koha-disable</command> <arg choice="req" rep="norepeat"><replaceable>instancename</replaceable></arg>
+ </cmdsynopsis>
+ </refsynopsisdiv>
+
+ <refsect1><title>Description</title>
+ <para>Disable a Koha instance.</para>
+ </refsect1>
+
+ <refsect1><title>See also</title>
+ <simplelist type="inline">
+ <member><command>koha-dump(8)</command></member>
+ <member><command>koha-enable(8)</command></member>
+ <member><command>koha-remove(8)</command></member>
+ <member><command>koha-restore(8)</command></member>
+ </simplelist>
+ </refsect1>
+
+</refentry>
+
+</article>
diff --git a/debian/docs/koha-dump-defaults.xml b/debian/docs/koha-dump-defaults.xml
new file mode 100644
index 0000000..048c3e9
--- /dev/null
+++ b/debian/docs/koha-dump-defaults.xml
@@ -0,0 +1,44 @@
+<article xmlns='http://docbook.org/ns/docbook'>
+<title>koha-dump-defaults</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-dump-defaults">
+
+ <refmeta>
+ <refentrytitle>koha-dump-defaults</refentrytitle>
+ <manvolnum>8</manvolnum>
+ </refmeta>
+
+ <refnamediv>
+ <refname>koha-dump-defaults</refname>
+ <refpurpose>Create default contents from an existing Koha site.</refpurpose>
+ <refclass>UNIX/Linux</refclass>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <cmdsynopsis>
+ <command>koha-dump-defaults</command> <arg choice="req" rep="norepeat"><replaceable>instancename</replaceable></arg>
+ </cmdsynopsis>
+ </refsynopsisdiv>
+
+ <refsect1><title>Description</title>
+ <para>Create default contents from an existing Koha site.</para>
+ </refsect1>
+
+ <refsect1><title>See also</title>
+ <simplelist type="inline">
+ <member><command>koha-mysql(8)</command></member>
+ <member><command>koha-reset-passwd(8)</command></member>
+ <member><command>koha-upgrade-schema(8)</command></member>
+ </simplelist>
+ </refsect1>
+
+</refentry>
+
+</article>
diff --git a/debian/docs/koha-dump.xml b/debian/docs/koha-dump.xml
new file mode 100644
index 0000000..ec79f6e
--- /dev/null
+++ b/debian/docs/koha-dump.xml
@@ -0,0 +1,45 @@
+<article xmlns='http://docbook.org/ns/docbook'>
+<title>koha-dump</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-dump">
+
+ <refmeta>
+ <refentrytitle>koha-dump</refentrytitle>
+ <manvolnum>8</manvolnum>
+ </refmeta>
+
+ <refnamediv>
+ <refname>koha-dump</refname>
+ <refpurpose>Dump all contents and configs for a Koha site.</refpurpose>
+ <refclass>UNIX/Linux</refclass>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <cmdsynopsis>
+ <command>koha-dump</command> <arg choice="req" rep="norepeat"><replaceable>instancename</replaceable></arg>
+ </cmdsynopsis>
+ </refsynopsisdiv>
+
+ <refsect1><title>Description</title>
+ <para>Dump all contents and configs for a Koha site.</para>
+ </refsect1>
+
+ <refsect1><title>See also</title>
+ <simplelist type="inline">
+ <member><command>koha-disable(8)</command></member>
+ <member><command>koha-enable(8)</command></member>
+ <member><command>koha-remove(8)</command></member>
+ <member><command>koha-restore(8)</command></member>
+ </simplelist>
+ </refsect1>
+
+</refentry>
+
+</article>
diff --git a/debian/docs/koha-email-disable.xml b/debian/docs/koha-email-disable.xml
new file mode 100644
index 0000000..83bf8ef
--- /dev/null
+++ b/debian/docs/koha-email-disable.xml
@@ -0,0 +1,42 @@
+<article xmlns='http://docbook.org/ns/docbook'>
+<title>koha-email-disable</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-email-disable">
+
+ <refmeta>
+ <refentrytitle>koha-email-disable</refentrytitle>
+ <manvolnum>8</manvolnum>
+ </refmeta>
+
+ <refnamediv>
+ <refname>koha-email-disable</refname>
+ <refpurpose>Turn off the email for a Koha instance.</refpurpose>
+ <refclass>UNIX/Linux</refclass>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <cmdsynopsis>
+ <command>koha-email-disable</command> <arg choice="req" rep="repeat"><replaceable>instancename</replaceable></arg>
+ </cmdsynopsis>
+ </refsynopsisdiv>
+
+ <refsect1><title>Description</title>
+ <para>Turn off the email for a Koha instance.</para>
+ </refsect1>
+
+ <refsect1><title>See also</title>
+ <simplelist type="inline">
+ <member><command>koha-email-enable(8)</command></member>
+ </simplelist>
+ </refsect1>
+
+</refentry>
+
+</article>
diff --git a/debian/docs/koha-email-enable.xml b/debian/docs/koha-email-enable.xml
new file mode 100644
index 0000000..5274f75
--- /dev/null
+++ b/debian/docs/koha-email-enable.xml
@@ -0,0 +1,42 @@
+<article xmlns='http://docbook.org/ns/docbook'>
+<title>koha-email-enable</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-email-enable">
+
+ <refmeta>
+ <refentrytitle>koha-email-enable</refentrytitle>
+ <manvolnum>8</manvolnum>
+ </refmeta>
+
+ <refnamediv>
+ <refname>koha-email-enable</refname>
+ <refpurpose>Turn on the email for a Koha instance.</refpurpose>
+ <refclass>UNIX/Linux</refclass>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <cmdsynopsis>
+ <command>koha-email-enable</command> <arg choice="req" rep="repeat"><replaceable>instancename</replaceable></arg>
+ </cmdsynopsis>
+ </refsynopsisdiv>
+
+ <refsect1><title>Description</title>
+ <para>Turn on the email for a Koha instance.</para>
+ </refsect1>
+
+ <refsect1><title>See also</title>
+ <simplelist type="inline">
+ <member><command>koha-email-disable(8)</command></member>
+ </simplelist>
+ </refsect1>
+
+</refentry>
+
+</article>
diff --git a/debian/docs/koha-enable.xml b/debian/docs/koha-enable.xml
new file mode 100644
index 0000000..a2f8cc3
--- /dev/null
+++ b/debian/docs/koha-enable.xml
@@ -0,0 +1,45 @@
+<article xmlns='http://docbook.org/ns/docbook'>
+<title>koha-enable</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-enable">
+
+ <refmeta>
+ <refentrytitle>koha-enable</refentrytitle>
+ <manvolnum>8</manvolnum>
+ </refmeta>
+
+ <refnamediv>
+ <refname>koha-enable</refname>
+ <refpurpose>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.</refpurpose>
+ <refclass>UNIX/Linux</refclass>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <cmdsynopsis>
+ <command>koha-enable</command> <arg choice="req" rep="norepeat"><replaceable>instancename</replaceable></arg>
+ </cmdsynopsis>
+ </refsynopsisdiv>
+
+ <refsect1><title>Description</title>
+ <para>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.</para>
+ </refsect1>
+
+ <refsect1><title>See also</title>
+ <simplelist type="inline">
+ <member><command>koha-disable(8)</command></member>
+ <member><command>koha-dump(8)</command></member>
+ <member><command>koha-remove(8)</command></member>
+ <member><command>koha-restore(8)</command></member>
+ </simplelist>
+ </refsect1>
+
+</refentry>
+
+</article>
diff --git a/debian/docs/koha-foreach.xml b/debian/docs/koha-foreach.xml
new file mode 100644
index 0000000..869e9c7
--- /dev/null
+++ b/debian/docs/koha-foreach.xml
@@ -0,0 +1,43 @@
+<article xmlns='http://docbook.org/ns/docbook'>
+<title>koha-foreach</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-foreach">
+
+ <refmeta>
+ <refentrytitle>koha-foreach</refentrytitle>
+ <manvolnum>8</manvolnum>
+ </refmeta>
+
+ <refnamediv>
+ <refname>koha-foreach</refname>
+ <refpurpose>Run a command for each Koha instance. Takes the same arguments as koha-list.</refpurpose>
+ <refclass>UNIX/Linux</refclass>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <cmdsynopsis>
+ <command>koha-list</command> <arg><option>--enabled</option></arg> <arg><option>--email</option>|<option>--noemail</option></arg> <arg><option>command</option></arg>
+ </cmdsynopsis>
+ </refsynopsisdiv>
+
+ <refsect1><title>Description</title>
+ <para>Run a command for each Koha instance. Takes the same arguments as koha-list.</para>
+ </refsect1>
+
+ <refsect1><title>See also</title>
+ <simplelist type="inline">
+ <member><command>koha-create-dirs(8)</command></member>
+ <member><command>koha-list(8)</command></member>
+ </simplelist>
+ </refsect1>
+
+</refentry>
+
+</article>
diff --git a/debian/docs/koha-list.xml b/debian/docs/koha-list.xml
new file mode 100644
index 0000000..9d0acf9
--- /dev/null
+++ b/debian/docs/koha-list.xml
@@ -0,0 +1,73 @@
+<article xmlns='http://docbook.org/ns/docbook'>
+<title>koha-list</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-list">
+
+ <refmeta>
+ <refentrytitle>koha-list</refentrytitle>
+ <manvolnum>8</manvolnum>
+ </refmeta>
+
+ <refnamediv>
+ <refname>koha-list</refname>
+ <refpurpose>Lists Koha instances, optionally only those that are enabled or have email turned on.</refpurpose>
+ <refclass>UNIX/Linux</refclass>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <cmdsynopsis>
+ <command>koha-list</command> <arg><option>--enabled</option></arg> <arg><option>--email</option></arg> <arg><option>-h</option></arg>
+ </cmdsynopsis>
+ </refsynopsisdiv>
+
+ <refsect1><title>Options</title>
+ <para>The filtering options can be combined, and you probably want to do this (except --email and --noemail, that's just silly.)</para>
+ <variablelist>
+ <varlistentry>
+ <term><option>--enabled</option></term>
+ <listitem>
+ <para>Only show instances that are enabled.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--email</option></term>
+ <listitem>
+ <para>Only show instances that have email enabled.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--noemail</option></term>
+ <listitem>
+ <para>Only show instances that do not have email enabled.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>-h</option></term>
+ <listitem>
+ <para>This help.</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect1>
+
+ <refsect1><title>Description</title>
+ <para>Lists Koha instances, optionally only those that are enabled or have email turned on.</para>
+ </refsect1>
+
+ <refsect1><title>See also</title>
+ <simplelist type="inline">
+ <member><command>koha-create-dirs(8)</command></member>
+ <member><command>koha-foreach(8)</command></member>
+ </simplelist>
+ </refsect1>
+
+</refentry>
+
+</article>
diff --git a/debian/docs/koha-mysql.xml b/debian/docs/koha-mysql.xml
new file mode 100644
index 0000000..b8079ce
--- /dev/null
+++ b/debian/docs/koha-mysql.xml
@@ -0,0 +1,44 @@
+<article xmlns='http://docbook.org/ns/docbook'>
+<title>koha-mysql</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-mysql">
+
+ <refmeta>
+ <refentrytitle>koha-mysql</refentrytitle>
+ <manvolnum>8</manvolnum>
+ </refmeta>
+
+ <refnamediv>
+ <refname>koha-mysql</refname>
+ <refpurpose>Provide an interactive mysql shell set up for the specified koha instance.</refpurpose>
+ <refclass>UNIX/Linux</refclass>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <cmdsynopsis>
+ <command>koha-mysql</command> <arg choice="req" rep="norepeat"><replaceable>instancename</replaceable></arg>
+ </cmdsynopsis>
+ </refsynopsisdiv>
+
+ <refsect1><title>Description</title>
+ <para>Provide an interactive mysql shell set up for the specified koha instance.</para>
+ </refsect1>
+
+ <refsect1><title>See also</title>
+ <simplelist type="inline">
+ <member><command>koha-dump-defaults(8)</command></member>
+ <member><command>koha-reset-passwd(8)</command></member>
+ <member><command>koha-upgrade-schema(8)</command></member>
+ </simplelist>
+ </refsect1>
+
+</refentry>
+
+</article>
diff --git a/debian/docs/koha-rebuild-zebra.xml b/debian/docs/koha-rebuild-zebra.xml
new file mode 100644
index 0000000..e5b319c
--- /dev/null
+++ b/debian/docs/koha-rebuild-zebra.xml
@@ -0,0 +1,67 @@
+<article xmlns='http://docbook.org/ns/docbook'>
+<title>koha-rebuild-zebra</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-rebuild-zebra">
+
+ <refmeta>
+ <refentrytitle>koha-rebuild-zebra</refentrytitle>
+ <manvolnum>8</manvolnum>
+ </refmeta>
+
+ <refnamediv>
+ <refname>koha-rebuild-zebra</refname>
+ <refpurpose>Rebuild the Zebra database for a Koha instance.</refpurpose>
+ <refclass>UNIX/Linux</refclass>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <cmdsynopsis>
+ <command>koha-rebuild-zebra</command> <arg><option>-u</option>|<option>--usmarc</option></arg> <arg><option>-f</option>|<option>--full</option></arg> <arg><option>...</option></arg> <arg choice="req" rep="repeat"><replaceable>instancename</replaceable></arg>
+ </cmdsynopsis>
+ </refsynopsisdiv>
+
+ <refsect1><title>Options</title>
+ <variablelist>
+ <varlistentry>
+ <term><option>-u, --usmarc</option></term>
+ <listitem>
+ <para>Runs the process as USMARC rather than the default of MARCXML.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>-f, --full</option></term>
+ <listitem>
+ <para>Does a reindex of the whole collection.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>-...</option></term>
+ <listitem>
+ <para>Anything else is passed directly to rebuild_zebra. This is useful in particular for -v.</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect1>
+
+ <refsect1><title>Description</title>
+ <para>Rebuild the Zebra database for a Koha instance.</para>
+ </refsect1>
+
+ <refsect1><title>See also</title>
+ <simplelist type="inline">
+ <member><command>koha-restart-zebra(8)</command></member>
+ <member><command>koha-start-zebra(8)</command></member>
+ <member><command>koha-stop-zebra(8)</command></member>
+ </simplelist>
+ </refsect1>
+
+</refentry>
+
+</article>
diff --git a/debian/docs/koha-remove.xml b/debian/docs/koha-remove.xml
index 5d5767f..ee2b266 100644
--- a/debian/docs/koha-remove.xml
+++ b/debian/docs/koha-remove.xml
@@ -17,20 +17,29 @@
<refnamediv>
<refname>koha-remove</refname>
- <refpurpose>Remove one or more Koha instance(s).</refpurpose>
+ <refpurpose>Remove a Koha instance.</refpurpose>
<refclass>UNIX/Linux</refclass>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
- <command>koha-remove</command>
- <arg choice="req" rep="repeat">instancename</arg>
+ <command>koha-remove</command> <arg choice="req" rep="repeat"><replaceable>instancename</replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1><title>Description</title>
- <para>Remove one or more Koha instance(s). This removes all files associated with a Koha instance.</para>
+ <para>Remove a Koha instance.</para>
</refsect1>
+
+ <refsect1><title>See also</title>
+ <simplelist type="inline">
+ <member><command>koha-disable(8)</command></member>
+ <member><command>koha-dump(8)</command></member>
+ <member><command>koha-enable(8)</command></member>
+ <member><command>koha-restore(8)</command></member>
+ </simplelist>
+ </refsect1>
+
</refentry>
</article>
diff --git a/debian/docs/koha-reset-passwd.xml b/debian/docs/koha-reset-passwd.xml
new file mode 100644
index 0000000..85e8443
--- /dev/null
+++ b/debian/docs/koha-reset-passwd.xml
@@ -0,0 +1,44 @@
+<article xmlns='http://docbook.org/ns/docbook'>
+<title>koha-reset-passwd</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-reset-passwd">
+
+ <refmeta>
+ <refentrytitle>koha-reset-passwd</refentrytitle>
+ <manvolnum>8</manvolnum>
+ </refmeta>
+
+ <refnamediv>
+ <refname>koha-reset-passwd</refname>
+ <refpurpose>Reset password for a user in a Koha instance.</refpurpose>
+ <refclass>UNIX/Linux</refclass>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <cmdsynopsis>
+ <command>koha-reset-passwd</command> <arg choice="req" rep="norepeat"><replaceable>instancename</replaceable></arg> <arg choice="req" rep="norepeat">username</arg>
+ </cmdsynopsis>
+ </refsynopsisdiv>
+
+ <refsect1><title>Description</title>
+ <para>Reset password for a user in a Koha instance.</para>
+ </refsect1>
+
+ <refsect1><title>See also</title>
+ <simplelist type="inline">
+ <member><command>koha-dump-defaults(8)</command></member>
+ <member><command>koha-mysql(8)</command></member>
+ <member><command>koha-upgrade-schema(8)</command></member>
+ </simplelist>
+ </refsect1>
+
+</refentry>
+
+</article>
diff --git a/debian/docs/koha-restart-zebra.xml b/debian/docs/koha-restart-zebra.xml
new file mode 100644
index 0000000..649df1e
--- /dev/null
+++ b/debian/docs/koha-restart-zebra.xml
@@ -0,0 +1,44 @@
+<article xmlns='http://docbook.org/ns/docbook'>
+<title>koha-restart-zebra</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-restart-zebra">
+
+ <refmeta>
+ <refentrytitle>koha-restart-zebra</refentrytitle>
+ <manvolnum>8</manvolnum>
+ </refmeta>
+
+ <refnamediv>
+ <refname>koha-restart-zebra</refname>
+ <refpurpose>Restart Zebra for named Koha instances.</refpurpose>
+ <refclass>UNIX/Linux</refclass>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <cmdsynopsis>
+ <command>koha-restart-zebra</command> <arg choice="req" rep="repeat"><replaceable>instancename</replaceable></arg>
+ </cmdsynopsis>
+ </refsynopsisdiv>
+
+ <refsect1><title>Description</title>
+ <para>Restart Zebra for named Koha instances.</para>
+ </refsect1>
+
+ <refsect1><title>See also</title>
+ <simplelist type="inline">
+ <member><command>koha-rebuild-zebra(8)</command></member>
+ <member><command>koha-start-zebra(8)</command></member>
+ <member><command>koha-stop-zebra(8)</command></member>
+ </simplelist>
+ </refsect1>
+
+</refentry>
+
+</article>
diff --git a/debian/docs/koha-restore.xml b/debian/docs/koha-restore.xml
new file mode 100644
index 0000000..6acb0e8
--- /dev/null
+++ b/debian/docs/koha-restore.xml
@@ -0,0 +1,45 @@
+<article xmlns='http://docbook.org/ns/docbook'>
+<title>koha-restore</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-restore">
+
+ <refmeta>
+ <refentrytitle>koha-restore</refentrytitle>
+ <manvolnum>8</manvolnum>
+ </refmeta>
+
+ <refnamediv>
+ <refname>koha-restore</refname>
+ <refpurpose>Restore a Koha site from a dump (from koha-dump).</refpurpose>
+ <refclass>UNIX/Linux</refclass>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <cmdsynopsis>
+ <command>koha-restore</command> <arg choice="req"><option>sqldump</option></arg> <arg choice="req"><option>configdump</option></arg>
+ </cmdsynopsis>
+ </refsynopsisdiv>
+
+ <refsect1><title>Description</title>
+ <para>Restore a Koha site from a dump (from koha-dump).</para>
+ </refsect1>
+
+ <refsect1><title>See also</title>
+ <simplelist type="inline">
+ <member><command>koha-disable(8)</command></member>
+ <member><command>koha-dump(8)</command></member>
+ <member><command>koha-enable(8)</command></member>
+ <member><command>koha-remove(8)</command></member>
+ </simplelist>
+ </refsect1>
+
+</refentry>
+
+</article>
diff --git a/debian/docs/koha-start-zebra.xml b/debian/docs/koha-start-zebra.xml
new file mode 100644
index 0000000..eb3c2ab
--- /dev/null
+++ b/debian/docs/koha-start-zebra.xml
@@ -0,0 +1,44 @@
+<article xmlns='http://docbook.org/ns/docbook'>
+<title>koha-start-zebra</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-start-zebra">
+
+ <refmeta>
+ <refentrytitle>koha-start-zebra</refentrytitle>
+ <manvolnum>8</manvolnum>
+ </refmeta>
+
+ <refnamediv>
+ <refname>koha-start-zebra</refname>
+ <refpurpose>Start Zebra for named Koha instances.</refpurpose>
+ <refclass>UNIX/Linux</refclass>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <cmdsynopsis>
+ <command>koha-start-zebra</command> <arg choice="req" rep="repeat"><replaceable>instancename</replaceable></arg>
+ </cmdsynopsis>
+ </refsynopsisdiv>
+
+ <refsect1><title>Description</title>
+ <para>Start Zebra for named Koha instances.</para>
+ </refsect1>
+
+ <refsect1><title>See also</title>
+ <simplelist type="inline">
+ <member><command>koha-rebuild-zebra(8)</command></member>
+ <member><command>koha-restart-zebra(8)</command></member>
+ <member><command>koha-stop-zebra(8)</command></member>
+ </simplelist>
+ </refsect1>
+
+</refentry>
+
+</article>
diff --git a/debian/docs/koha-stop-zebra.xml b/debian/docs/koha-stop-zebra.xml
new file mode 100644
index 0000000..050ddd7
--- /dev/null
+++ b/debian/docs/koha-stop-zebra.xml
@@ -0,0 +1,44 @@
+<article xmlns='http://docbook.org/ns/docbook'>
+<title>koha-stop-zebra</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-stop-zebra">
+
+ <refmeta>
+ <refentrytitle>koha-stop-zebra</refentrytitle>
+ <manvolnum>8</manvolnum>
+ </refmeta>
+
+ <refnamediv>
+ <refname>koha-stop-zebra</refname>
+ <refpurpose>Stop Zebra for named Koha instances.</refpurpose>
+ <refclass>UNIX/Linux</refclass>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <cmdsynopsis>
+ <command>koha-stop-zebra</command> <arg choice="req" rep="repeat"><replaceable>instancename</replaceable></arg>
+ </cmdsynopsis>
+ </refsynopsisdiv>
+
+ <refsect1><title>Description</title>
+ <para>Stop Zebra for named Koha instances.</para>
+ </refsect1>
+
+ <refsect1><title>See also</title>
+ <simplelist type="inline">
+ <member><command>koha-rebuild-zebra(8)</command></member>
+ <member><command>koha-restart-zebra(8)</command></member>
+ <member><command>koha-start-zebra(8)</command></member>
+ </simplelist>
+ </refsect1>
+
+</refentry>
+
+</article>
diff --git a/debian/docs/koha-upgrade-schema.xml b/debian/docs/koha-upgrade-schema.xml
new file mode 100644
index 0000000..8b5a4c4
--- /dev/null
+++ b/debian/docs/koha-upgrade-schema.xml
@@ -0,0 +1,44 @@
+<article xmlns='http://docbook.org/ns/docbook'>
+<title>koha-upgrade-schema</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-upgrade-schema">
+
+ <refmeta>
+ <refentrytitle>koha-upgrade-schema</refentrytitle>
+ <manvolnum>8</manvolnum>
+ </refmeta>
+
+ <refnamediv>
+ <refname>koha-upgrade-schema</refname>
+ <refpurpose>Upgrade the DB schema for Koha instances. Done automatically on package upgrades.</refpurpose>
+ <refclass>UNIX/Linux</refclass>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <cmdsynopsis>
+ <command>koha-upgrade-schema</command> <arg choice="req" rep="repeat"><replaceable>instancename</replaceable></arg>
+ </cmdsynopsis>
+ </refsynopsisdiv>
+
+ <refsect1><title>Description</title>
+ <para>Upgrade the DB schema for Koha instances. Done automatically on package upgrades.</para>
+ </refsect1>
+
+ <refsect1><title>See also</title>
+ <simplelist type="inline">
+ <member><command>koha-dump-defaults(8)</command></member>
+ <member><command>koha-mysql(8)</command></member>
+ <member><command>koha-reset-passwd(8)</command></member>
+ </simplelist>
+ </refsect1>
+
+</refentry>
+
+</article>
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 0000000..c528377
--- /dev/null
+++ b/debian/docs/koha-upgrade-to-3.4.xml
@@ -0,0 +1,41 @@
+<article xmlns='http://docbook.org/ns/docbook'>
+<title>koha-upgrade-to-3.4</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-upgrade-to-3.4">
+
+ <refmeta>
+ <refentrytitle>koha-upgrade-to-3.4</refentrytitle>
+ <manvolnum>8</manvolnum>
+ </refmeta>
+
+ <refnamediv>
+ <refname>koha-upgrade-to-3.4</refname>
+ <refpurpose>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.</refpurpose>
+ <refclass>UNIX/Linux</refclass>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <cmdsynopsis>
+ <command>koha-upgrade-to-3.4</command> <arg choice="req" rep="repeat"><replaceable>instancename</replaceable></arg>
+ </cmdsynopsis>
+ </refsynopsisdiv>
+
+ <refsect1><title>Description</title>
+ <para>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.</para>
+ </refsect1>
+
+ <refsect1><title>See also</title>
+ <simplelist type="inline">
+ </simplelist>
+ </refsect1>
+
+</refentry>
+
+</article>
--
1.7.5.4
More information about the Koha-patches
mailing list