summaryrefslogtreecommitdiff
path: root/man
diff options
context:
space:
mode:
authorMatthias Clasen <mclasen@redhat.com>2013-06-24 17:58:24 -0400
committerMatthias Clasen <mclasen@redhat.com>2013-06-26 00:00:24 -0400
commita2ba7b937e585b59983d4b8e3a9793aca918d4a4 (patch)
treee1fc0e8aaa7ea6a765edaffaa074b7e228d50153 /man
parente29c947a60d149102e80237377607d3971ab22b6 (diff)
downloadglade-a2ba7b937e585b59983d4b8e3a9793aca918d4a4.tar.gz
Add man pages
https://bugzilla.gnome.org/show_bug.cgi?id=703013
Diffstat (limited to 'man')
-rw-r--r--man/Makefile.am22
-rw-r--r--man/glade-previewer.xml105
-rw-r--r--man/glade.xml114
3 files changed, 241 insertions, 0 deletions
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>