summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorDavid Zeuthen <davidz@redhat.com>2010-09-28 12:53:15 -0400
committerDavid Zeuthen <davidz@redhat.com>2010-09-28 12:53:15 -0400
commit82b56eba87ff5797d5589f9e4448502f32ea0eed (patch)
tree632036d23baa4d86329caae3e3e78a5cf71befe7 /doc
Initial commit
Signed-off-by: David Zeuthen <davidz@redhat.com>
Diffstat (limited to 'doc')
-rw-r--r--doc/Makefile.am86
-rw-r--r--doc/stc-docs.xml38
-rw-r--r--doc/stc-sections.txt48
-rw-r--r--doc/stc.types2
-rw-r--r--doc/stc.xml43
5 files changed, 217 insertions, 0 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am
new file mode 100644
index 0000000..8ebf073
--- /dev/null
+++ b/doc/Makefile.am
@@ -0,0 +1,86 @@
+NULL =
+
+# The name of the module.
+DOC_MODULE=stc
+
+# The top-level SGML file.
+DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.xml
+
+# Extra options to supply to gtkdoc-scan
+SCAN_OPTIONS=
+
+# The directory containing the source code. Relative to $(srcdir)
+DOC_SOURCE_DIR=$(top_srcdir)/stc
+
+HFILE_GLOB=$(top_srcdir)/stc/*.h
+CFILE_GLOB=$(top_srcdir)/stc/*.c
+
+# Headers to ignore
+IGNORE_HFILES= \
+ $(NULL)
+
+# CFLAGS and LDFLAGS for compiling scan program. Only needed
+# if $(DOC_MODULE).types is non-empty.
+INCLUDES = \
+ -I$(srcdir) \
+ -I$(top_srcdir) \
+ -I$(top_srcdir)/stc \
+ -I$(top_builddir) \
+ -I$(top_builddir)/stc \
+ $(GLIB_CFLAGS) \
+ $(NULL)
+
+GTKDOC_LIBS = \
+ $(GLIB_LIBS) \
+ $(top_builddir)/stc/libstc-1.la \
+ $(NULL)
+
+# Extra options to supply to gtkdoc-mkdb
+MKDB_OPTIONS = --output-format=xml --sgml-mode --name-space=stc
+
+# Images to copy into HTML directory
+HTML_IMAGES = \
+ $(NULL)
+
+content_files = \
+ $(NULL)
+
+expand_content_files = \
+ $(NULL)
+
+extra_files = \
+ $(NULL)
+
+include $(top_srcdir)/gtk-doc.make
+
+EXTRA_DIST += \
+ version.xml.in
+
+man_MANS = \
+ stc.1 \
+ $(NULL)
+
+.xml.1:
+ xsltproc -nonet http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl $<
+
+MAINTAINERCLEANFILES = $(man_MANS) $(BUILT_SOURCES)
+
+EXTRA_DIST += $(man_MANS)
+
+CLEANFILES += \
+ $(DOC_MODULE)-decl-list.txt \
+ $(DOC_MODULE)-decl.txt \
+ $(DOC_MODULE)-overrides.txt \
+ $(DOC_MODULE)-undeclared.txt \
+ $(DOC_MODULE)-undocumented.txt \
+ $(DOC_MODULE)-unused.txt \
+ $(DOC_MODULE).args \
+ $(DOC_MODULE).hierarchy \
+ $(DOC_MODULE).interfaces \
+ $(DOC_MODULE).prerequisites \
+ $(DOC_MODULE).signals \
+ *.stamp \
+ -rf xml html tmpl \
+ stc.1 \
+ $(NULL)
+
diff --git a/doc/stc-docs.xml b/doc/stc-docs.xml
new file mode 100644
index 0000000..3c26e36
--- /dev/null
+++ b/doc/stc-docs.xml
@@ -0,0 +1,38 @@
+<?xml version="1.0"?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
+ "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
+<!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'">
+<!ENTITY version SYSTEM "version.xml">
+]>
+<book lang="en" id="gio" xmlns:xi="http://www.w3.org/2003/XInclude">
+<title>stc Reference Manual</title>
+ <bookinfo>
+ <title>stc Reference Manual</title>
+ </bookinfo>
+
+ <part>
+ <title>Introduction</title>
+ </part>
+
+ <part>
+ <title>Library Reference</title>
+ <xi:include href="xml/stcerror.xml"/>
+ <xi:include href="xml/stcitem.xml"/>
+ <xi:include href="xml/stcmonitor.xml"/>
+ </part>
+
+ <part>
+ <title>Tools Reference</title>
+ <xi:include href="stc.xml"/>
+ </part>
+
+ <index>
+ <title>Index</title>
+ </index>
+
+ <chapter id="object-hierarchy">
+ <title>Object Hierarchy</title>
+ <xi:include href="xml/tree_index.sgml"/>
+ </chapter>
+
+</book>
diff --git a/doc/stc-sections.txt b/doc/stc-sections.txt
new file mode 100644
index 0000000..dd9dc48
--- /dev/null
+++ b/doc/stc-sections.txt
@@ -0,0 +1,48 @@
+<SECTION>
+<FILE>stcmonitor</FILE>
+<TITLE>StcMonitor</TITLE>
+StcMonitor
+stc_monitor_new
+stc_monitor_new_for_config_dir
+stc_monitor_get_config_dir
+stc_monitor_get_items
+<SUBSECTION Standard>
+STC_TYPE_MONITOR
+STC_MONITOR
+STC_IS_MONITOR
+<SUBSECTION Private>
+stc_monitor_get_type
+</SECTION>
+
+<SECTION>
+<FILE>stcitem</FILE>
+<TITLE>StcItem</TITLE>
+StcItem
+StcItemType
+stc_item_get_applied
+stc_item_get_can_apply
+stc_item_get_dependencies
+stc_item_get_id
+stc_item_get_item_type
+stc_item_get_nick_name
+stc_item_get_target
+stc_item_type_get_type
+<SUBSECTION Standard>
+STC_TYPE_ITEM
+STC_ITEM
+STC_IS_ITEM
+<SUBSECTION Private>
+stc_item_get_type
+STC_TYPE_ITEM_TYPE
+</SECTION>
+
+<SECTION>
+<FILE>stcerror</FILE>
+<TITLE>StcError</TITLE>
+STC_ERROR
+StcError
+<SUBSECTION Private>
+stc_error_quark
+stc_error_get_type
+STC_TYPE_ERROR
+</SECTION>
diff --git a/doc/stc.types b/doc/stc.types
new file mode 100644
index 0000000..c8825e2
--- /dev/null
+++ b/doc/stc.types
@@ -0,0 +1,2 @@
+stc_item_get_type
+stc_monitor_get_type
diff --git a/doc/stc.xml b/doc/stc.xml
new file mode 100644
index 0000000..84ee572
--- /dev/null
+++ b/doc/stc.xml
@@ -0,0 +1,43 @@
+<refentry id="stc" lang="en">
+<refmeta>
+ <refentrytitle>stc</refentrytitle>
+ <manvolnum>1</manvolnum>
+ <refmiscinfo class="manual">User Commands</refmiscinfo>
+</refmeta>
+
+<refnamediv>
+ <refname>stc</refname>
+ <refpurpose>Storage Configuration Tool</refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+ <cmdsynopsis>
+ <command>stc</command>
+ </cmdsynopsis>
+</refsynopsisdiv>
+
+<refsect1>
+ <title>Description</title>
+ <para>
+ <command>stc</command> is TODO.
+ </para>
+</refsect1>
+
+<refsect1>
+ <title>Author</title>
+ <para>
+ Written by David Zeuthen <email>zeuthen@gmail.com</email> with
+ a lot of help from many others.
+ </para>
+</refsect1>
+
+<refsect1>
+ <title>See also</title>
+ <para>
+ <citerefentry>
+ <refentrytitle>udisks</refentrytitle><manvolnum>1</manvolnum>
+ </citerefentry>
+ </para>
+</refsect1>
+
+</refentry>