[PATCH 9/9] Initial man page for nbd-trplay.
From: Manfred Spraul <manfred.spraul@de.bosch.com>
Just as a starting point, especially:
The command line parameters must be added to the man page.
Questions:
- Did I update the right files?
- Is the .in.sgml file written manually or are there tools that
should be used?
Signed-off-by: Manfred Spraul <manfred.spraul@de.bosch.com>
---
autogen.sh | 2 +-
configure.ac | 2 +
man/Makefile.am | 8 ++--
man/mans.mk | 8 ++++
man/nbd-trplay.1.in.sgml | 99 ++++++++++++++++++++++++++++++++++++++++
5 files changed, 114 insertions(+), 5 deletions(-)
create mode 100644 man/nbd-trplay.1.in.sgml
diff --git a/autogen.sh b/autogen.sh
index 49e5a27..a518857 100755
--- a/autogen.sh
+++ b/autogen.sh
@@ -1,5 +1,5 @@
#!/bin/sh
set -ex
-make -C man -f mans.mk nbd-server.1.sh.in nbd-server.5.sh.in nbd-client.8.sh.in nbd-trdump.1.sh.in nbdtab.5.sh.in
+make -C man -f mans.mk nbd-server.1.sh.in nbd-server.5.sh.in nbd-client.8.sh.in nbd-trdump.1.sh.in nbd-trplay.1.sh.in nbdtab.5.sh.in
make -C systemd -f Makefile.am nbd@.service.sh.in
exec autoreconf -f -i
diff --git a/configure.ac b/configure.ac
index 0c960b4..8f58fb6 100644
--- a/configure.ac
+++ b/configure.ac
@@ -354,6 +354,7 @@ AS_IF([test "x$enable_manpages" != "xno"], [
man/nbd-server.5.sh \
man/nbd-server.1.sh \
man/nbd-trdump.1.sh \
+ man/nbd-trplay.1.sh \
man/nbdtab.5.sh \
"])
])
@@ -381,6 +382,7 @@ AC_CONFIG_FILES([Makefile
man/nbd-server.5.sh
man/nbd-server.1.sh
man/nbd-trdump.1.sh
+ man/nbd-trplay.1.sh
man/nbdtab.5.sh
systemd/Makefile
systemd/nbd@.service.sh
diff --git a/man/Makefile.am b/man/Makefile.am
index c800bd1..1e543ae 100644
--- a/man/Makefile.am
+++ b/man/Makefile.am
@@ -1,9 +1,9 @@
if MANPAGES
-man_MANS = nbd-server.1 nbd-server.5 nbd-client.8 nbd-trdump.1 nbdtab.5
+man_MANS = nbd-server.1 nbd-server.5 nbd-client.8 nbd-trdump.1 nbd-trplay.1 nbdtab.5
CLEANFILES = manpage.links manpage.refs
-DISTCLEANFILES = nbd-server.1 nbd-client.8 nbd-server.5 nbd-trdump.1 nbdtab.5
-MAINTAINERCLEANFILES = nbd-server.1.sh.in nbd-client.8.sh.in nbd-server.5.sh.in nbd-trdump.1.sh.in nbdtab.5.sh.in
-EXTRA_DIST = nbd-server.1.in.sgml nbd-client.8.in.sgml nbd-server.5.in.sgml nbd-trdump.1.in.sgml nbdtab.5.in.sgml nbd-server.1.sh.in nbd-server.5.sh.in nbd-client.8.sh.in nbd-trdump.1.sh.in nbdtab.5.sh.in sh.tmpl
+DISTCLEANFILES = nbd-server.1 nbd-client.8 nbd-server.5 nbd-trdump.1 nbd-trplay.1 nbdtab.5
+MAINTAINERCLEANFILES = nbd-server.1.sh.in nbd-client.8.sh.in nbd-server.5.sh.in nbd-trdump.1.sh.in nbd-trplay.1.sh.in nbdtab.5.sh.in
+EXTRA_DIST = nbd-server.1.in.sgml nbd-client.8.in.sgml nbd-server.5.in.sgml nbd-trdump.1.in.sgml nbd-trplay.1.in.sgml nbdtab.5.in.sgml nbd-server.1.sh.in nbd-server.5.sh.in nbd-client.8.sh.in nbd-trdump.1.sh.in nbd-trdump.1.sh.in nbdtab.5.sh.in sh.tmpl
include $(srcdir)/mans.mk
endif
diff --git a/man/mans.mk b/man/mans.mk
index fdfc266..e22c9c1 100644
--- a/man/mans.mk
+++ b/man/mans.mk
@@ -6,6 +6,8 @@ nbd-client.8: nbd-client.8.sh
sh nbd-client.8.sh > nbd-client.8
nbd-trdump.1: nbd-trdump.1.sh
sh nbd-trdump.1.sh > nbd-trdump.1
+nbd-trplay.1: nbd-trplay.1.sh
+ sh nbd-trplay.1.sh > nbd-trplay.1
nbdtab.5: nbdtab.5.sh
sh nbdtab.5.sh > nbdtab.5
nbd-server.1.sh.in: nbd-server.1.in.sgml sh.tmpl
@@ -32,6 +34,12 @@ nbd-trdump.1.sh.in: nbd-trdump.1.in.sgml sh.tmpl
cat NBD-TRDUMP.1 >> nbd-trdump.1.sh.in
echo "EOF" >> nbd-trdump.1.sh.in
rm NBD-TRDUMP.1
+nbd-trplay.1.sh.in: nbd-trplay.1.in.sgml sh.tmpl
+ LC_ALL=C docbook2man nbd-trplay.1.in.sgml
+ cat sh.tmpl > nbd-trplay.1.sh.in
+ cat NBD-TRPLAY.1 >> nbd-trplay.1.sh.in
+ echo "EOF" >> nbd-trplay.1.sh.in
+ rm NBD-TRPLAY.1
nbdtab.5.sh.in: nbdtab.5.in.sgml sh.tmpl
LC_ALL=C docbook2man nbdtab.5.in.sgml
cat sh.tmpl > nbdtab.5.sh.in
diff --git a/man/nbd-trplay.1.in.sgml b/man/nbd-trplay.1.in.sgml
new file mode 100644
index 0000000..f713131
--- /dev/null
+++ b/man/nbd-trplay.1.in.sgml
@@ -0,0 +1,99 @@
+<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.5//EN" [
+
+<!-- Process this file with docbook-to-man to generate an nroff manual
+ page: `docbook-to-man manpage.sgml > manpage.1'. You may view
+ the manual page with: `docbook-to-man manpage.sgml | nroff -man |
+ less'. A typical entry in a Makefile or Makefile.am is:
+
+manpage.1: manpage.sgml
+ docbook-to-man $< > $@
+ -->
+
+ <!-- Fill in your name for FIRSTNAME and SURNAME. -->
+ <!ENTITY dhfirstname "<firstname>Manfred</firstname>">
+ <!ENTITY dhsurname "<surname>Spraul</surname>">
+ <!-- Please adjust the date whenever revising the manpage. -->
+ <!ENTITY dhdate "<date>$Date$</date>">
+ <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
+ allowed: see man(7), man(1). -->
+ <!ENTITY dhsection "<manvolnum>1</manvolnum>">
+ <!ENTITY dhemail "<email>manfred@de.bosch.com</email>">
+ <!ENTITY dhusername "Manfred Spraul">
+ <!ENTITY dhucpackage "<refentrytitle>NBD-TRPLAY</refentrytitle>">
+ <!ENTITY dhpackage "nbd-trplay">
+
+ <!ENTITY debian "<productname>Debian GNU/Linux</productname>">
+ <!ENTITY gnu "<acronym>GNU</acronym>">
+]>
+
+<refentry>
+ <refentryinfo>
+ <address>
+ &dhemail;
+ </address>
+ <author>
+ &dhfirstname;
+ &dhsurname;
+ </author>
+ <copyright>
+ <year>2001</year>
+ <holder>&dhusername;</holder>
+ </copyright>
+ &dhdate;
+ </refentryinfo>
+ <refmeta>
+ &dhucpackage;
+
+ &dhsection;
+ </refmeta>
+ <refnamediv>
+ <refname>&dhpackage;</refname>
+
+ <refpurpose>replay all or parts of an nbd transaction log</refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <cmdsynopsis>
+ <command>&dhpackage;</command>
+ </cmdsynopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>DESCRIPTION</title>
+
+ <para><command>&dhpackage;</command> replays all or parts of
+ a transaction log produced by <command>nbd-server</command>
+ (specifically by the <command>transactionlog</command>
+ configuration directive with the option <command>datalog
+ </command>).</para>
+
+ <para>See nbd-trplay --help for the command line parameters.
+ </para>
+ </refsect1>
+ <refsect1>
+ <title>OUTPUT</title>
+
+ <para>The file updates the image provided via -i.</para>
+
+ </refsect1>
+ <refsect1>
+ <title>SEE ALSO</title>
+
+ <para>nbd-server (1).</para>
+
+ </refsect1>
+ <refsect1>
+ <title>AUTHOR</title>
+ <para>The NBD kernel module and the NBD tools have been written by
+ Pavel Macheck (pavel@ucw.cz).</para>
+
+ <para>The kernel module is now maintained by Paul Clements
+ (Paul.Clements@steeleye.com), while the userland tools are maintained by
+ Wouter Verhelst (wouter@debian.org)</para>
+
+ <para>This manual page was written by &dhusername; (&dhemail;) for
+ the &debian; system (but may be used by others). Permission is
+ granted to copy, distribute and/or modify this document under the
+ terms of the <acronym>GNU</acronym> General Public License,
+ version 2, as published by the Free Software Foundation.</para>
+
+ </refsect1>
+</refentry>
--
2.34.1
Reply to: