gitea
/
Koha-clms
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

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>
(cherry picked from commit 5b12159380)
Signed-off-by: Tomas Cohen Arazi <tomascohen@gmail.com>
This commit is contained in:
Magnus Enger 2013-07-30 15:32:31 +02:00 committed by Tomas Cohen Arazi
parent e647d4e3ed
commit 45f9a4a038
1 changed files with 19 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
debian/docs/koha-mysql.xml vendored
View File

@ -17,7 +17,7 @@
<refnamediv>
<refname>koha-mysql</refname>
<refpurpose>Provide an interactive mysql shell set up for the specified koha instance.</refpurpose>
<refpurpose>Provide an interactive mysql shell set up for the specified Koha instance.</refpurpose>
<refclass>UNIX/Linux</refclass>
</refnamediv>
@ -28,7 +28,24 @@
</refsynopsisdiv>
<refsect1><title>Description</title>
<para>Provide an interactive mysql shell set up for the specified koha instance.</para>
<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>