From 28777eeebf38c13a43d0118a86391d2a487ad15b Mon Sep 17 00:00:00 2001 From: Stef Walter Date: Tue, 5 Feb 2013 10:21:49 +0100 Subject: Add a p11-kit tool manual page --- .gitignore | 1 + configure.ac | 4 ++ doc/Makefile.am | 33 +++++++++++++- doc/p11-kit-docs.sgml | 5 +++ doc/p11-kit.xml | 122 ++++++++++++++++++++++++++++++++++++-------------- 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 @@ + + Command Line Tools + + + Reference 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 @@ - -
+ + - - P11 Kit - - Work in Progress - + - + + p11-kit + p11-kit + + Maintainer Stef Walter - - Collabora Ltd. -
- stefw@collabora.co.uk -
- + stef@thewalter.net - - - - 2011 - Collabora Ltd. - - - - - - - - - - - - - - -
+ + + + + p11-kit + 8 + System Commands + + + + p11-kit + Tool for operating on configured PKCS#11 modules + + + + + p11-kit list-modules + + + + + Description + p11-kit is a command line tool that + can be used to perform operations on PKCS#11 modules configured on the + system. + + See the various sub commands below. The following global options + can be used: + + + + + Run in verbose mode with debug + output. + + + + Run in quiet mode without warning or + failure messages. + + + + + + + List Modules + + List system configured PKCS#11 modules. + + + +$ p11-kit list-modules + + + + The modules, information about them and the tokens present in + the PKCS#11 modules will be displayed. + + + + + Bugs + + Please send bug reports to either the distribution bug tracker + or the upstream bug tracker at + https://bugs.freedesktop.org/enter_bug.cgi?product=p11-glue&component=p11-kit. + + + + + See also + + Further details available in the p11-kit online documentation at + http://p11-glue.freedesktop.org/doc/p11-kit/. + + + + -- cgit v1.2.1