]> Pileus Git - grits/commitdiff
Add man page for gis-demo
authorAndy Spencer <andy753421@gmail.com>
Mon, 8 Feb 2010 11:28:53 +0000 (11:28 +0000)
committerAndy Spencer <andy753421@gmail.com>
Mon, 8 Feb 2010 11:28:53 +0000 (11:28 +0000)
docs/api/Makefile.am
docs/api/gis-demo.xml [new file with mode: 0644]
docs/api/libgis-docs.sgml

index 742a4956f89d083aec85173e95df259898c5dc5d..fce5ed98a3aa741f379ef7cae185b2e1431a52d8 100644 (file)
@@ -1,6 +1,10 @@
 AM_CPPFLAGS=$(SOUP_CFLAGS) $(GLIB_CFLAGS) $(GTK_CFLAGS)
 
-GTKDOC_LIBS        = $(SOUP_LIBS) $(GLIB_LIBS) $(GTK_LIBS) $(top_srcdir)/src/libgis.la $(top_srcdir)/src/plugins/*.la
+
+# Gtk docs
+GTKDOC_LIBS        = $(SOUP_LIBS) $(GLIB_LIBS) $(GTK_LIBS) \
+                    $(top_srcdir)/src/libgis.la \
+                    $(top_srcdir)/src/plugins/*.la
 DOC_MODULE         = libgis
 DOC_SOURCE_DIR     = $(top_srcdir)/src/
 DOC_MAIN_SGML_FILE = $(DOC_MODULE)-docs.sgml
@@ -9,5 +13,13 @@ include $(top_srcdir)/gtk-doc.make
 
 CLEANFILES += libgis-sections.txt
 
+
+# Man pages 
+man_MANS = gis-demo.1
+%.1 : %.xml 
+       xsltproc -nonet http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl $<
+BUILT_EXTRA_DIST = $(man_MANS)
+
+
 MAINTAINERCLEANFILES=\
        tmpl/* Makefile.in libgis-overrides.txt libgis.types libgis-scan.*
diff --git a/docs/api/gis-demo.xml b/docs/api/gis-demo.xml
new file mode 100644 (file)
index 0000000..4e06338
--- /dev/null
@@ -0,0 +1,48 @@
+<refentry id="gis-demo">
+<refmeta>
+       <refentrytitle>gis-demo</refentrytitle>
+       <manvolnum>1</manvolnum>
+</refmeta>
+
+<refnamediv>
+       <refname>gis-demo</refname>
+       <refpurpose>libgis demonstration program</refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+       <cmdsynopsis>
+               <command>gis-demo [GTK_OPTIONS]</command>
+       </cmdsynopsis>
+</refsynopsisdiv>
+
+<refsect1><title>Description</title>
+       <para><command>gis-demo</command> TODO (short description)</para>
+       <para>
+               TODO (long description)
+       </para>
+</refsect1>
+
+<refsect1><title>Environment</title>
+       <variablelist>
+               <varlistentry>
+                       <term>GIS_PLUGIN_PATH</term>
+                       <listitem><para>
+                               Secondary path to use when searching for
+                               plugins.
+                       </para></listitem>
+               </varlistentry>
+       </variablelist>
+</refsect1>
+
+<refsect1><title>Files</title>
+       <variablelist>
+               <varlistentry>
+                       <term>$HOME/.config/libgis/config.ini</term>
+                       <listitem><para>
+                               Configuration file used to store loaded
+                               plugins and a few other settings.
+                       </para></listitem>
+               </varlistentry>
+       </variablelist>
+</refsect1>
+</refentry>
index 0e5dc44e8e2ea7c913187cc8a15f147a39a0ae9c..fe5763e8e9395034ae32e4b9521d949f67bd4fe8 100644 (file)
@@ -46,8 +46,7 @@
 
        <chapter>
                <title>Miscellaneous</title>
-               <xi:include href="xml/gis-demo.xml"/>
-               <xi:include href="xml/tile-test.xml"/>
+               <xi:include href="gis-demo.xml"/>
        </chapter>
 
        <index>