Commit 775dcd0d authored by Matthias Clasen's avatar Matthias Clasen
Browse files

Update man page generation

Use xsltproc directly, rather than the docbook2man wrapper.
Turn the man page source into xml, and modernize it a bit.
Also, document the available commandline options.
parent b91256f0
......@@ -80,10 +80,10 @@ AC_ARG_ENABLE(man,
[generate man pages [default=auto]])],,
enable_man=maybe)
AS_IF([test "$enable_man" != no], [
AC_PATH_PROG(DOCBOOK2MAN, docbook2man)
AS_IF([test -z "$DOCBOOK2MAN"], [
AC_PATH_PROG([XSLTPROC], [xsltproc])
AS_IF([test -z "$XSLTPROC"], [
AS_IF([test "$enable_man" = yes], [
AC_MSG_ERROR([docbook2man is required for --enable-man])
AC_MSG_ERROR([xsltproc is required for --enable-man])
])
enable_man=no
])
......
......@@ -119,8 +119,16 @@ if ENABLE_MAN
man_MANS += gnome-software.1
endif
gnome-software.1: gnome-software.sgml
docbook2man $? > /dev/null
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
gnome-software.1: gnome-software.xml
$(AM_V_GEN) $(XSLTPROC) $(XSLTPROC_FLAGS) http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl $<
clean-local:
rm -f *~
......
<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
<!-- Please adjust the date whenever revising the manpage. -->
<!ENTITY package "gnome-software">
<!ENTITY gnu "<acronym>GNU</acronym>">
<!ENTITY gpl "&gnu; <acronym>GPL</acronym>">
]>
<?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">
<refentry id="gnome-software">
<refentry>
<refentryinfo>
<address>
<email>richard@hughsie.com</email>;
</address>
<title>gnome-software</title>
<productname>GNOME</productname>
<author>
<contrib>Maintainer</contrib>
<firstname>Richard</firstname>
<surname>Hughes</surname>
<email>richard@hughsie.com</email>
</author>
<copyright>
<year>2013</year>
<holder>Richard Hughes</holder>
</copyright>
&date;
</refentryinfo>
<refmeta>
<refentrytitle>gnome-software</refentrytitle>
<manvolnum>1</manvolnum>
<refmiscinfo class="manual">User Commands</refmiscinfo>
</refmeta>
<refnamediv>
<refname>&package;</refname>
<refpurpose>GNOME PackageKit Software Log Viewer</refpurpose>
<refname>gnome-software</refname>
<refpurpose>Install applications</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>&package;</command>
<arg><option>--verbose</option></arg>
<command>gnome-software</command>
<arg choice="opt" rep="repeat">OPTION</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>DESCRIPTION</title>
<title>Description</title>
<para>
This manual page documents briefly the <command>&package;</command> command.
This manual page documents briefly the <command>gnome-software</command> command.
</para>
<para>
<command>&package;</command> allows you to add and remove applications and
update your system.
<command>gnome-software</command> allows you to add and remove
applications and update your system.
</para>
</refsect1>
<refsect1>
<title>SEE ALSO</title>
<para>gnome-software (1).</para>
<title>Options</title>
<variablelist>
<varlistentry>
<term><option>-?</option>, <option>--help</option></term>
<listitem><para>Prints a short help text and exits.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--version</option></term>
<listitem><para>Prints the program version and exits.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--mode</option> <replaceable>MODE</replaceable></term>
<listitem><para>Starts gnome-software in the given mode. <replaceable>MODE</replaceable> can be 'updates', 'installed' or 'overview'.</para></listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>AUTHOR</title>
<title>Author</title>
<para>This manual page was written by Richard Hughes <email>richard@hughsie.com</email>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:2
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:nil
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
-->
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment