Add a p11-kit tool manual page

5 files changed, 130 insertions, 35 deletions

diff --git a/.gitignore b/.gitignore
index 79ed605..b69b334 100644
--- a/.gitignore
+++ b/.gitignore
@@ -71,6 +71,7 @@ temp.txt
 /doc/tmpl/
 /doc/version.xml
 /doc/xml/
+/doc/*.8
 
 /p11-kit/p11-kit.pc
 /p11-kit/p11-kit-1.pc
diff --git a/configure.ac b/configure.ac
index 1c93729..426be4f 100644
--- a/configure.ac
+++ b/configure.ac
@@ -127,6 +127,7 @@ AC_PATH_PROG([GTKDOC_CHECK],[gtkdoc-check])
 AC_PATH_PROGS([GTKDOC_REBASE],[gtkdoc-rebase],[true])
 AC_PATH_PROG([GTKDOC_MKPDF],[gtkdoc-mkpdf])
 AC_PATH_PROG([GTKDOC_SCAN],[gtkdoc-scan])
+AC_PATH_PROG([XSLTPROC], [xsltproc])
 
 dnl for overriding the documentation installation directory
 AC_ARG_WITH([html-dir],
@@ -145,6 +146,9 @@ if test x$enable_doc = xyes; then
 	if test -z "$GTKDOC_SCAN"; then
 		AC_MSG_ERROR([gtk-doc not installed and --enable-doc requested])
 	fi
+	if test -z "$XSLTPROC"; then
+		AC_MSG_ERROR([the xsltproc command was not found and --enable-doc requested])
+	fi
 	doc_status="yes (manual, gtk-doc reference)"
 else
 	enable_doc=no
diff --git a/doc/Makefile.am b/doc/Makefile.am
index 999b4b3..6b2f31c 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -1,5 +1,7 @@
 abs_top_builddir = @abs_top_builddir@
 
+NULL =
+
 # We require automake 1.6 at least.
 AUTOMAKE_OPTIONS = 1.6
 
@@ -80,6 +82,35 @@ GTKDOC_LIBS=
 # This includes the standard gtk-doc make rules, copied by gtkdocize.
 include $(top_srcdir)/gtk-doc.make
 
+if ENABLE_GTK_DOC
+man8_MANS = \
+	p11-kit.8
+
+XSLTPROC_FLAGS = \
+        --nonet \
+        --stringparam man.output.quietly 1 \
+        --stringparam funcsynopsis.style ansi \
+        --stringparam man.th.extra1.suppress 1 \
+        --stringparam man.authors.section.enabled 0 \
+        --stringparam man.copyright.section.enabled 0
+
+.xml.8:
+	$(AM_V_GEN) $(XSLTPROC) $(XSLTPROC_FLAGS) http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl $<
+
+else # ENABLE_GTK_DOC
+
+man8_MANS =
+
+endif # ENABLE_GTK_DOC
+
+MAN_IN_FILES = $(man8_MANS:.8=.xml)
+
+CLEANFILES += \
+	$(man8_MANS) \
+	$(NULL)
+
 EXTRA_DIST += \
 	version.xml.in \
-	version.xml
+	version.xml \
+	$(MAN_IN_FILES) \
+	$(NULL)
diff --git a/doc/p11-kit-docs.sgml b/doc/p11-kit-docs.sgml
index 8e8c933..e8b694c 100644
--- a/doc/p11-kit-docs.sgml
+++ b/doc/p11-kit-docs.sgml
@@ -15,6 +15,11 @@
 	<xi:include href="p11-kit-sharing.xml"/>
 	<xi:include href="p11-kit-notes.xml"/>
 
+	<chapter xml:id="tools">
+		<title>Command Line Tools</title>
+		<xi:include href="p11-kit.xml"/>
+	</chapter>
+
 	<chapter xml:id="reference">
 		<title>Reference</title>
 		<xi:include href="xml/p11-kit.xml"/>
diff --git a/doc/p11-kit.xml b/doc/p11-kit.xml
index 3c8a318..3bc9d9f 100644
--- a/doc/p11-kit.xml
+++ b/doc/p11-kit.xml
@@ -1,40 +1,94 @@
-<?xml version="1.0"?>
-<article xml:id="index" xmlns="http://docbook.org/ns/docbook" version="5.0">
+<?xml version='1.0'?>
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
+        "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
 
-	<articleinfo>
-		<title>P11 Kit</title>
-		<releaseinfo>
-			Work in Progress
-		</releaseinfo>
+<refentry id="p11-kit">
 
-		<authorgroup>
+<refentryinfo>
+	<title>p11-kit</title>
+	<productname>p11-kit</productname>
+	<authorgroup>
 		<author>
+			<contrib>Maintainer</contrib>
 			<firstname>Stef</firstname>
 			<surname>Walter</surname>
-			<affiliation>
-				<orgname>Collabora Ltd.</orgname>
-				<address>
-					<email>stefw@collabora.co.uk</email>
-				</address>
-			</affiliation>
+			<email>stef@thewalter.net</email>
 		</author>
-		</authorgroup>
-
-		<copyright>
-			<year>2011</year>
-			<holder>Collabora Ltd.</holder>
-		</copyright>
-
-	</articleinfo>
-
-	<xi:include href="p11-kit-multiple-problem.xml" xmlns:xi="http://www.w3.org/2001/XInclude">
-		<xi:fallback/>
-	</xi:include>
-	<xi:include href="p11-kit-config.xml" xmlns:xi="http://www.w3.org/2001/XInclude">
-		<xi:fallback/>
-	</xi:include>
-	<xi:include href="p11-kit-notes.xml" xmlns:xi="http://www.w3.org/2001/XInclude">
-		<xi:fallback/>
-	</xi:include>
-
-</article>
+	</authorgroup>
+</refentryinfo>
+
+<refmeta>
+	<refentrytitle>p11-kit</refentrytitle>
+	<manvolnum>8</manvolnum>
+	<refmiscinfo class="manual">System Commands</refmiscinfo>
+</refmeta>
+
+<refnamediv>
+	<refname>p11-kit</refname>
+	<refpurpose>Tool for operating on configured PKCS#11 modules</refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+	<cmdsynopsis>
+		<command>p11-kit list-modules</command>
+	</cmdsynopsis>
+</refsynopsisdiv>
+
+<refsect1>
+	<title>Description</title>
+	<para><command>p11-kit</command> is a command line tool that
+	can be used to perform operations on PKCS#11 modules configured on the
+	system.</para>
+
+	<para>See the various sub commands below. The following global options
+	can be used:</para>
+
+	<variablelist>
+		<varlistentry>
+			<term><option>-v, --verbose</option></term>
+			<listitem><para>Run in verbose mode with debug
+			output.</para></listitem>
+		</varlistentry>
+		<varlistentry>
+			<term><option>-q, --quiet</option></term>
+			<listitem><para>Run in quiet mode without warning or
+			failure messages.</para></listitem>
+		</varlistentry>
+	</variablelist>
+
+</refsect1>
+
+<refsect1>
+	<title>List Modules</title>
+
+	<para>List system configured PKCS#11 modules.</para>
+
+	<informalexample>
+<programlisting>
+$ p11-kit list-modules
+</programlisting>
+	</informalexample>
+
+	<para>The modules, information about them and the tokens present in
+	the PKCS#11 modules will be displayed.</para>
+
+</refsect1>
+
+<refsect1>
+  <title>Bugs</title>
+  <para>
+    Please send bug reports to either the distribution bug tracker
+    or the upstream bug tracker at
+    <ulink url="https://bugs.freedesktop.org/enter_bug.cgi?product=p11-glue&amp;component=p11-kit">https://bugs.freedesktop.org/enter_bug.cgi?product=p11-glue&amp;component=p11-kit</ulink>.
+  </para>
+</refsect1>
+
+<refsect1>
+  <title>See also</title>
+  <para>
+    Further details available in the p11-kit online documentation at
+    <ulink url="http://p11-glue.freedesktop.org/doc/p11-kit/">http://p11-glue.freedesktop.org/doc/p11-kit/</ulink>.
+  </para>
+</refsect1>
+
+</refentry>