[gdk-pixbuf] Improve man pages



commit d81310c42a51379f8898d73adcdb753554916980
Author: Matthias Clasen <mclasen redhat com>
Date:   Mon Aug 6 12:26:13 2012 -0400

    Improve man pages
    
    Copy various tweaks that I've done to man pages in other
    modules, to improve consistency.

 docs/reference/gdk-pixbuf/Makefile.am              |   10 ++++-
 docs/reference/gdk-pixbuf/gdk-pixbuf-csource.xml   |   42 ++++++++++----------
 .../gdk-pixbuf/gdk-pixbuf-query-loaders.xml        |   25 +++++++-----
 3 files changed, 45 insertions(+), 32 deletions(-)
---
diff --git a/docs/reference/gdk-pixbuf/Makefile.am b/docs/reference/gdk-pixbuf/Makefile.am
index edbf334..c28e34f 100644
--- a/docs/reference/gdk-pixbuf/Makefile.am
+++ b/docs/reference/gdk-pixbuf/Makefile.am
@@ -88,8 +88,16 @@ man_MANS = 				\
 
 if ENABLE_MAN
 
+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.1:
-	@XSLTPROC@ -nonet http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl $<
+	$(AM_V_GEN) $(XSLTPROC) $(XSLTPROC_FLAGS) http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl $<
 
 dist-local-check-mans-enabled:
 	if grep "Man generation disabled" $(man_MANS) >/dev/null; then $(RM) $(man_MANS); fi
diff --git a/docs/reference/gdk-pixbuf/gdk-pixbuf-csource.xml b/docs/reference/gdk-pixbuf/gdk-pixbuf-csource.xml
index a88d506..d9d8487 100644
--- a/docs/reference/gdk-pixbuf/gdk-pixbuf-csource.xml
+++ b/docs/reference/gdk-pixbuf/gdk-pixbuf-csource.xml
@@ -4,9 +4,22 @@
 ]>
 <refentry id="gdk-pixbuf-csource">
 
+<refentryinfo>
+<title>gdk-pixbuf-csource</title>
+<productname>gdk-pixbuf</productname>
+<authorgroup>
+<author>
+<contrib>Developer</contrib>
+<firstname>Tim</firstname>
+<surname>Janik</surname>
+</author>
+</authorgroup>
+</refentryinfo>
+
 <refmeta>
 <refentrytitle>gdk-pixbuf-csource</refentrytitle>
 <manvolnum>1</manvolnum>
+<refmiscinfo class="manual">User Commands</refmiscinfo>
 </refmeta>
 
 <refnamediv>
@@ -17,16 +30,16 @@
 <refsynopsisdiv>
 <cmdsynopsis>
 <command>gdk-pixbuf-csource</command>
-<arg choice="opt">options</arg>
-<arg choice="opt">image</arg>
+<arg choice="opt" rep="repeat">OPTION</arg>
+<arg choice="opt">IMAGE</arg>
 </cmdsynopsis>
 <cmdsynopsis>
 <command>gdk-pixbuf-csource</command>
-<arg choice="opt">options</arg>
+<arg choice="opt" rep="repeat">OPTION</arg>
 <arg choice="plain">--build-list</arg>
 <arg rep="repeat">
-  <arg>name</arg>
-  <arg>image</arg>
+  <arg>NAME</arg>
+  <arg>IMAGE</arg>
 </arg>
 </cmdsynopsis>
 </refsynopsisdiv>
@@ -36,16 +49,15 @@
 <command>gdk-pixbuf-csource</command> is a small utility that generates
 C code containing images, useful for compiling images directly into programs.
 </para>
-</refsect1>
-
-<refsect1><title>Invocation</title>
 <para>
 <command>gdk-pixbuf-csource</command> either takes as input one image file
 name to generate code for, or, using the <option>--build-list</option> option,
 a list of (<replaceable>name</replaceable>, <replaceable>image</replaceable>)
 pairs to generate code for a list of images into named variables.
 </para>
-<refsect2><title>Options</title>
+</refsect1>
+
+<refsect1><title>Options</title>
 <variablelist>
 
 <varlistentry>
@@ -146,7 +158,6 @@ Make warnings fatal (causes the program to abort).
 </varlistentry>
 
 </variablelist>
-</refsect2>
 </refsect1>
 
 <refsect1><title>See also</title>
@@ -163,15 +174,4 @@ it includes the rowstride padding in the encoded stream. Furthermore, it
 generates pixbufs with suboptimal rowstride in some cases.
 </para>
 </refsect1>
-
-<refsect1><title>Author</title>
-<para>
-<command>gdk-pixbuf-csource</command> was written by Tim Janik
-<email>timj gtk org</email>.
-</para>
-<para>
-This manual page was provided by Tim Janik <email>timj gtk org</email>.
-</para>
-</refsect1>
 </refentry>
-
diff --git a/docs/reference/gdk-pixbuf/gdk-pixbuf-query-loaders.xml b/docs/reference/gdk-pixbuf/gdk-pixbuf-query-loaders.xml
index 4f51a04..bc9523e 100644
--- a/docs/reference/gdk-pixbuf/gdk-pixbuf-query-loaders.xml
+++ b/docs/reference/gdk-pixbuf/gdk-pixbuf-query-loaders.xml
@@ -4,9 +4,22 @@
 ]>
 <refentry id="gdk-pixbuf-query-loaders">
 
+<refentryinfo>
+<title>gdk-pixbuf-query-loaders</title>
+<productname>gdk-pixbuf</productname>
+<authorgroup>
+<author>
+<contrib>Developer</contrib>
+<firstname>Owen</firstname>
+<surname>Taylor</surname>
+</author>
+</authorgroup>
+</refentryinfo>
+
 <refmeta>
 <refentrytitle>gdk-pixbuf-query-loaders</refentrytitle>
 <manvolnum>1</manvolnum>
+<refmiscinfo class="manual">User Commands</refmiscinfo>
 </refmeta>
 
 <refnamediv>
@@ -18,7 +31,7 @@
 <cmdsynopsis>
 <command>gdk-pixbuf-query-loaders</command>
 <arg choice="opt">--update-cache</arg>
-<arg choice="opt" rep="repeat">module</arg>
+<arg choice="opt" rep="repeat">MODULE</arg>
 </cmdsynopsis>
 </refsynopsisdiv>
 
@@ -38,7 +51,7 @@ may be absolute or relative paths.
 </para>
 <para>
 Normally, the output of <command>gdk-pixbuf-queryloaders</command> is written
-to <filename><replaceable>libdir</replaceable>gdk-pixbuf-2.0/2.10.0/loaders.cache</filename>, where <application>gdk-pixbuf</application> looks for it by default. If it is written to some other
+to <filename><replaceable>libdir</replaceable>/gdk-pixbuf-2.0/2.10.0/loaders.cache</filename>, where <application>gdk-pixbuf</application> looks for it by default. If it is written to some other
 location, the environment variable <link linkend="GDK_PIXBUF_MODULE_FILE"><envar>GDK_PIXBUF_MODULE_FILE</envar></link>
 can be set to point <application>gdk-pixbuf</application> at the file.
 </para>
@@ -63,12 +76,4 @@ directory is <filename><replaceable>libdir</replaceable>/gdk-pixbuf-2.0/<replace
 </para>
 </refsect1>
 
-<refsect1><title>Bugs</title>
-<para>
-None known yet.
-</para>
-</refsect1>
-
 </refentry>
-
-



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]