[gnome-shell/gnome-3-6] Convert man page to Docbook



commit d046ba597ffa0808bd8dbc9ed2e29a3b59342e16
Author: Matthias Clasen <mclasen redhat com>
Date:   Wed Jul 25 04:00:55 2012 +0200

    Convert man page to Docbook
    
    This make it easier to update the content and to transform
    the man page into other output formats, like HTML.
    
    https://bugzilla.gnome.org/show_bug.cgi?id=680601

 configure.ac        |    2 +
 man/Makefile.am     |   12 ++++-
 man/gnome-shell.1   |   94 ------------------------------------
 man/gnome-shell.xml |  132 +++++++++++++++++++++++++++++++++++++++++++++++++++
 4 files changed, 145 insertions(+), 95 deletions(-)
---
diff --git a/configure.ac b/configure.ac
index 11de801..70c261e 100644
--- a/configure.ac
+++ b/configure.ac
@@ -36,6 +36,8 @@ AC_DEFINE_UNQUOTED(GETTEXT_PACKAGE, "$GETTEXT_PACKAGE",
 
 PKG_PROG_PKG_CONFIG([0.22])
 
+AC_PATH_PROG([XSLTPROC], [xsltproc])
+
 GLIB_GSETTINGS
 
 # Get a value to substitute into gnome-shell.in
diff --git a/man/Makefile.am b/man/Makefile.am
index c4f139f..510e9c6 100644
--- a/man/Makefile.am
+++ b/man/Makefile.am
@@ -1 +1,11 @@
-dist_man_MANS = gnome-shell.1
+.xml.1:
+	$(AM_V_GEN) $(XSLTPROC) -o $@ --nonet http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl $<
+
+man_MANS = \
+	gnome-shell.1
+
+xml_files = $(man_MANS:.1=.xml)
+
+EXTRA_DIST = $(xml_files)
+
+DISTCLEANFILES = $(man_MANS)
diff --git a/man/gnome-shell.xml b/man/gnome-shell.xml
new file mode 100644
index 0000000..7e43536
--- /dev/null
+++ b/man/gnome-shell.xml
@@ -0,0 +1,132 @@
+<?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-shell">
+
+        <refentryinfo>
+                <title>gnome-shell</title>
+                <productname>gnome-shell</productname>
+
+                <authorgroup>
+                        <author>
+                                <contrib>wrote the original gnome-shell man page</contrib>
+                                <firstname>Marcelo Jorge</firstname>
+                                <surname>Vieira</surname>
+                                <email>metal alucinados com</email>
+                        </author>
+                </authorgroup>
+
+        </refentryinfo>
+
+        <refmeta>
+                <refentrytitle>gnome-shell</refentrytitle>
+                <manvolnum>1</manvolnum>
+        </refmeta>
+
+        <refnamediv>
+                <refname>gnome-shell</refname>
+                <refpurpose>Graphical shell for the GNOME desktop</refpurpose>
+        </refnamediv>
+
+        <refsynopsisdiv>
+                <cmdsynopsis>
+                        <command>gnome-shell <arg choice="opt" rep="repeat">OPTION</arg></command>
+                </cmdsynopsis>
+        </refsynopsisdiv>
+
+        <refsect1>
+                <title>Description</title>
+
+                <para>GNOME shell provides core user
+                interface functions for the GNOME 3 desktop, like switching
+                to windows and launching applications. GNOME shell takes
+                advantage of the capabilities of modern graphics hardware
+                and introduces innovative user interface concepts to provide
+                a visually attractive and easy to use experience.</para>
+
+        </refsect1>
+
+        <refsect1>
+                <title>Options</title>
+
+                <variablelist>
+
+                        <varlistentry>
+                                <term><option>--replace</option></term>
+
+                                <listitem><para>Replace the running window manager</para></listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                                <term><option>--sm-disable</option></term>
+
+                                <listitem><para>Disable connection to the session manager</para></listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                                <term><option>--sm-client-id=<replaceable>ID</replaceable></option></term>
+
+                                <listitem><para>Specify session management <replaceable>ID</replaceable></para></listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                                <term><option>--sm-save-file=<replaceable>FILE</replaceable></option></term>
+
+                                <listitem><para>Initialize session from <replaceable>FILE</replaceable></para></listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                                <term><option>--screen=<replaceable>SCREEN</replaceable></option></term>
+
+                                <listitem><para>X screen to use</para></listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                                <term><option>-d</option>, <option>--display=<replaceable>DISPLAY</replaceable></option></term>
+
+                                <listitem><para>X Display to use</para></listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                                <term><option>--sync</option></term>
+
+                                <listitem><para>Make X calls synchronous</para></listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                                <term><option>--version</option></term>
+
+                                <listitem><para>Print version and exit</para></listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                                <term><option>--help</option></term>
+
+                                <listitem><para>Display help and exit</para></listitem>
+                        </varlistentry>
+
+                </variablelist>
+
+        </refsect1>
+
+        <refsect1>
+                <title>Bugs</title>
+
+                <para>The bug tracker can be reached by visiting the
+                website <ulink url="https://bugzilla.gnome.org/buglist.cgi?product=gnome-shell";>https://bugzilla.gnome.org/buglist.cgi?product=gnome-shell</ulink>.
+                Before sending a bug report, please verify that you have
+                the latest version of gnome-shell. Many bugs (major and
+                minor) are fixed at each release, and if yours is out of
+                date, the problem may already have been solved.</para>
+
+        </refsect1>
+
+        <refsect1>
+                <title>Additional Information</title>
+
+                <para>For further information, visit the website
+                <ulink url="http://live.gnome.org/GnomeShell";>http://live.gnome.org/GnomeShell</ulink>.</para>
+        </refsect1>
+
+</refentry>



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