Bug 17379: Add a man page for koha-passwd
authorLucio Moraes <lmoraes@catalyst.net.nz>
Mon, 24 Oct 2016 08:23:20 +0000 (08:23 +0000)
committerTomas Cohen Arazi <tomascohen@theke.io>
Tue, 11 Oct 2022 13:10:04 +0000 (10:10 -0300)
Adding a manpage for the koha-passwd utility.

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

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

Signed-off-by: Mika Smith <mikasmith@catalyst.net.nz>
Signed-off-by: Katrin Fischer <katrin.fischer.83@web.de>
Signed-off-by: Tomas Cohen Arazi <tomascohen@theke.io>
debian/docs/koha-passwd.xml [new file with mode: 0644]

diff --git a/debian/docs/koha-passwd.xml b/debian/docs/koha-passwd.xml
new file mode 100644 (file)
index 0000000..a40dfb2
--- /dev/null
@@ -0,0 +1,50 @@
+<article xmlns='http://docbook.org/ns/docbook'>
+<title>koha-passwd</title>
+<info>
+    <productname>Koha</productname> is the first free software library automation package.
+    <author>
+        <personname>
+            <firstname>Mason</firstname>
+            <surname>James</surname>
+        </personname>
+        <affiliation>
+            <orgname>The Koha Community</orgname>
+            <uri>http://koha-community.org</uri>
+        </affiliation>
+        <contrib>Author</contrib>
+    </author>
+</info>
+
+<refentry xml:id="koha-passwd">
+
+    <refmeta>
+        <refentrytitle>koha-passwd</refentrytitle>
+        <manvolnum>8</manvolnum>
+    </refmeta>
+
+    <refnamediv>
+        <refname>koha-passwd</refname>
+        <refpurpose>Display a Koha instance's password.</refpurpose>
+        <refclass>UNIX/Linux</refclass>
+    </refnamediv>
+
+    <refsynopsisdiv>
+        <cmdsynopsis>
+            <command>koha-passwd</command>
+            <arg choice="req" rep="repeat"><replaceable>instancename</replaceable></arg>
+        </cmdsynopsis>
+    </refsynopsisdiv>
+
+    <refsect1><title>Description</title>
+        <para>Display a password for one or more Koha instances.</para>
+    </refsect1>
+
+  <refsect1><title>See also</title>
+  <simplelist type="inline">
+    <member><command>Full documentation: https://koha-community.org/documentation/</command></member>
+  </simplelist>
+  </refsect1>
+
+</refentry>
+
+</article>