Add man pages

https://bugzilla.gnome.org/show_bug.cgi?id=703013

5 files changed, 264 insertions, 1 deletions

diff --git a/Makefile.am b/Makefile.am
index 5ec4456c..1dba0484 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -1,6 +1,10 @@
 ACLOCAL_AMFLAGS = -I m4 ${ACLOCAL_FLAGS}
 
 SUBDIRS = po data gladeui src plugins tests doc help
+if BUILD_MAN_PAGES
+SUBDIRS += man
+endif
+DIST_SUBDIRS = po data gladeui src plugins tests doc help man
 
 EXTRA_DIST = \
 	autogen.sh \
@@ -14,7 +18,7 @@ DISTCLEANFILES = intltool-extract \
                  intltool-merge \
                  intltool-update
 
-DISTCHECK_CONFIGURE_FLAGS = --enable-gtk-doc --enable-introspection
+DISTCHECK_CONFIGURE_FLAGS = --enable-gtk-doc --enable-introspection --enable-man-pages
 
 dist-hook:
 	@if test -d "$(srcdir)/.git"; \
diff --git a/configure.ac b/configure.ac
index 37d93cfe..ae04c22c 100644
--- a/configure.ac
+++ b/configure.ac
@@ -214,6 +214,22 @@ AM_CONDITIONAL(BUILD_PYTHON, test x"$have_python" = "xyes")
 
 YELP_HELP_INIT
 
+# ==================================================================
+# Man pages (requires xsltproc)
+# ==================================================================
+
+AC_ARG_ENABLE(man-pages,
+              AC_HELP_STRING([--enable-man-pages],
+                             [build manual pages]),,
+              enable_man_pages=yes)
+if test x$enable_man_pages = xyes; then
+   AC_PATH_PROG([XSLTPROC], [xsltproc])
+   if test x$XSLTPROC = x; then
+      AC_MSG_ERROR([xsltproc is required to build manual pages])
+   fi
+fi
+AM_CONDITIONAL(BUILD_MAN_PAGES, test x$enable_man_pages = xyes)
+
 dnl ================================================================
 dnl Check for windows
 dnl ================================================================
@@ -325,6 +341,7 @@ po/Makefile.in
 doc/Makefile
 doc/version.xml
 help/Makefile
+man/Makefile
 tests/Makefile
 build/mingw-w64/glade.nsi
 ])
@@ -344,4 +361,5 @@ Configuration:
 	Introspection Data:      ${found_introspection}
 
 	Build Reference Manual:  ${enable_gtk_doc}
+	Build Manual Pages:      ${enable_man_pages}
 "
diff --git a/man/Makefile.am b/man/Makefile.am
new file mode 100644
index 00000000..da459d90
--- /dev/null
+++ b/man/Makefile.am
@@ -0,0 +1,22 @@
+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:
+	$(AM_V_GEN) $(XSLTPROC) $(XSLTPROC_FLAGS) http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl $<
+
+man_MANS = \
+	glade.1 \
+	glade-previewer.1
+
+xml_files = $(man_MANS:.1=.xml)
+
+EXTRA_DIST = $(xml_files)
+
+DISTCLEANFILES = $(man_MANS)
+
+-include $(top_srcdir)/git.mk
diff --git a/man/glade-previewer.xml b/man/glade-previewer.xml
new file mode 100644
index 00000000..caf81ed3
--- /dev/null
+++ b/man/glade-previewer.xml
@@ -0,0 +1,105 @@
+<?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="glade-previewer">
+
+        <refentryinfo>
+                <title>glade-previewer</title>
+                <productname>GNOME</productname>
+
+                <authorgroup>
+                        <author>
+                                <contrib>Maintainer</contrib>
+                                <firstname>Tristan Van Berkom</firstname>
+                                <surname>Van Berkom</surname>
+                                <email>tristan.van.berkom@gmail.com</email>
+                        </author>
+                        <author>
+                                <contrib>Maintainer</contrib>
+                                <firstname>Juan Pablo</firstname>
+                                <surname>Ugarte</surname>
+                                <email>juanpablougarte@gmail.com</email>
+                        </author>
+                </authorgroup>
+
+        </refentryinfo>
+
+        <refmeta>
+                <refentrytitle>glade-previewer</refentrytitle>
+                <manvolnum>1</manvolnum>
+                <refmiscinfo class="manual">User Commands</refmiscinfo>
+        </refmeta>
+
+        <refnamediv>
+                <refname>glade-previewer</refname>
+                <refpurpose>Preview glade user interface definitions</refpurpose>
+        </refnamediv>
+
+        <refsynopsisdiv>
+                <cmdsynopsis>
+                        <command>glade-previewer <arg choice="opt" rep="repeat">OPTION</arg></command>
+                </cmdsynopsis>
+        </refsynopsisdiv>
+
+        <refsect1>
+                <title>Description</title>
+
+                <para><command>glade-previewer</command> is a tool that
+                can load and display a User Interface that has been defined
+                with glade. glade itself uses glade-previewer, but it
+                can also be used as a standalone utility.</para>
+        </refsect1>
+
+        <refsect1>
+                <title>Options</title>
+
+                <para>The following options can be specified:</para>
+
+                <variablelist>
+                        <varlistentry>
+                                <term><option>-f FILENAME</option>, <option>--filename=FILENAME</option></term>
+
+                                <listitem><para>Name of the file to preview.</para></listitem>
+
+                        </varlistentry>
+
+                        <varlistentry>
+                                <term><option>-t TOPLEVEL</option>, <option>--toplevel=TOPLEVEL</option></term>
+
+                                <listitem><para>Name of the toplevel to preview.</para></listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                                <term><option>-l</option>, <option>--listen</option></term>
+
+                                <listitem><para>Listen on standard input.</para></listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                                <term><option>-v</option>, <option>--version</option></term>
+
+                                <listitem><para>Output version information and exit.</para></listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                                <term><option>--display=DISPLAY</option></term>
+
+                                <listitem><para>X display to use.</para></listitem>
+                        </varlistentry>
+
+                </variablelist>
+
+                <para>One of the <option>--filename</option> or
+                <option>--listen</option> options has to be specified.</para>
+
+        </refsect1>
+
+        <refsect1>
+                <title>See Also</title>
+                <para>
+                        <citerefentry><refentrytitle>glade</refentrytitle><manvolnum>1</manvolnum></citerefentry>
+                </para>
+        </refsect1>
+
+</refentry>
diff --git a/man/glade.xml b/man/glade.xml
new file mode 100644
index 00000000..f58bdb5c
--- /dev/null
+++ b/man/glade.xml
@@ -0,0 +1,114 @@
+<?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="glade">
+
+        <refentryinfo>
+                <title>glade</title>
+                <productname>GNOME</productname>
+
+                <authorgroup>
+                        <author>
+                                <contrib>Maintainer</contrib>
+                                <firstname>Tristan Van Berkom</firstname>
+                                <surname>Van Berkom</surname>
+                                <email>tristan.van.berkom@gmail.com</email>
+                        </author>
+                        <author>
+                                <contrib>Maintainer</contrib>
+                                <firstname>Juan Pablo</firstname>
+                                <surname>Ugarte</surname>
+                                <email>juanpablougarte@gmail.com</email>
+                        </author>
+                </authorgroup>
+
+        </refentryinfo>
+
+        <refmeta>
+                <refentrytitle>glade</refentrytitle>
+                <manvolnum>1</manvolnum>
+                <refmiscinfo class="manual">User Commands</refmiscinfo>
+        </refmeta>
+
+        <refnamediv>
+                <refname>glade</refname>
+                <refpurpose>Create GTK+ user interfaces</refpurpose>
+        </refnamediv>
+
+        <refsynopsisdiv>
+                <cmdsynopsis>
+                        <command>glade <arg choice="opt" rep="repeat">OPTION</arg> <arg choice="opt" rep="repeat">FILE</arg></command>
+                </cmdsynopsis>
+        </refsynopsisdiv>
+
+        <refsect1>
+                <title>Description</title>
+
+                <para><command>glade</command> is a tool to create or edit
+                user interfaces for GTK+ or GNOME applications. It saves
+                the user interface descriptions in xml files which can be
+                read by the GtkBuilder API that is part of GTK+.</para>
+        </refsect1>
+
+        <refsect1>
+                <title>Options</title>
+
+                <para>The following options can be specified:</para>
+
+                <variablelist>
+                        <varlistentry>
+                                <term><option>-h</option>, <option>--help</option></term>
+
+                                <listitem><para>Show help options.</para></listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                                <term><option>--help-all</option></term>
+
+                                <listitem><para>Show all help options.</para></listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                                <term><option>--help-debug</option></term>
+
+                                <listitem><para>Show Glade debug options.</para></listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                                <term><option>--help-gtk</option></term>
+
+                                <listitem><para>Show GTK+ options.</para></listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                                <term><option>--version</option></term>
+
+                                <listitem><para>Output version information
+                                and exit.</para></listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                                <term><option>--without-devhelp</option></term>
+
+                                <listitem><para>Disable devhelp integration.</para></listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                                <term><option>--display=DISPLAY</option></term>
+
+                                <listitem><para>X display to use.</para></listitem>
+                        </varlistentry>
+
+                </variablelist>
+
+        </refsect1>
+
+        <refsect1>
+                <title>See Also</title>
+                <para>
+                        <citerefentry><refentrytitle>devhelp</refentrytitle><manvolnum>1</manvolnum></citerefentry>
+                </para>
+        </refsect1>
+
+</refentry>