Koha/debian/docs/koha-mysql.xml
Magnus Enger 5b12159380 Bug 9247 - Add two more usage examples to the manpage for koha-mysql
It might not be immediately obvious that it is possible to send
SQL queries "directly" to the koha-mysql command, or that files
from mysqldump can be loaded with it. This patch adds these as
"example usage" to the man page for koha-mysql.

To test:

Run these commands and look at the formatted man page:
$ xsltproc /usr/share/xml/docbook/stylesheet/docbook-xsl/manpages/docbook.xsl \
  debian/docs/koha-mysql.xml
$ man -l koha-mysql.8

Make sure this test passes:
$ prove -v xt/verify-debian-docbook.t

This patch also corrects a couple places where "Koha" was written as "koha".

Signed-off-by: Mirko Tietgen <mirko@abunchofthings.net>
Signed-off-by: Katrin Fischer <Katrin.Fischer.83@web.de>
Test plan, all tests and QA script pass.

Signed-off-by: Galen Charlton <gmc@esilibrary.com>
2013-08-28 13:43:00 +00:00

61 lines
1.9 KiB
XML

<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 Community</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>Example usage</title>
<variablelist>
<varlistentry>
<term>Send an SQL query to MySQL</term>
<listitem>
<para>"Some SQL query" | <command>koha-mysql</command> <arg choice="req" rep="norepeat"><replaceable>instancename</replaceable></arg></para>
</listitem>
</varlistentry>
<varlistentry>
<term>Load a database dump (e.g. one produced by mysqldump) into the database of the given instance</term>
<listitem>
<para><command>koha-mysql</command> <arg choice="req" rep="norepeat"><replaceable>instancename</replaceable></arg> &lt; /path/to/mysqldump.sql</para>
</listitem>
</varlistentry>
</variablelist>
</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>