summaryrefslogtreecommitdiff
path: root/docs/reference/tumbler/tumbler-docs.xml
diff options
context:
space:
mode:
Diffstat (limited to 'docs/reference/tumbler/tumbler-docs.xml')
-rw-r--r--docs/reference/tumbler/tumbler-docs.xml99
1 files changed, 99 insertions, 0 deletions
diff --git a/docs/reference/tumbler/tumbler-docs.xml b/docs/reference/tumbler/tumbler-docs.xml
new file mode 100644
index 0000000..7dda9ab
--- /dev/null
+++ b/docs/reference/tumbler/tumbler-docs.xml
@@ -0,0 +1,99 @@
+<?xml version="1.0"?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+ "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
+[
+ <!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'">
+]>
+
+<book id="index" lang="en">
+ <bookinfo>
+ <title>tumbler Reference Manual</title>
+ <releaseinfo>Version <xi:include href="version.xml" parse="text"/></releaseinfo>
+ <copyright>
+ <year>2009</year>
+ <holder>Jannis Pohlmann</holder>
+ </copyright>
+ <legalnotice id="legalnotice">
+ <para>
+ Permission is granted to copy, distribute and/or modify this document
+ under the terms of the GNU Free Documentation License, Version 1.1 or
+ any later version published by the Free Software Foundation; with no
+ Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
+ Texts. The complete license text is available from the <ulink
+ type="http" url="http://www.gnu.org/">Free Software Foundation</ulink>.
+ </para>
+ </legalnotice>
+ <authorgroup>
+ <author>
+ <firstname>Jannis</firstname>
+ <surname>Pohlmann</surname>
+ <affiliation>
+ <address><email>jannis@xfce.org</email></address>
+ </affiliation>
+ </author>
+ </authorgroup>
+ </bookinfo>
+
+ <part>
+ <title>Overview</title>
+ <para>
+ The <application>tumbler</application> library depends on the following libraries:
+ <variablelist>
+ <varlistentry>
+ <term>D-Bus</term>
+ <listitem>
+ <para>
+ TODO
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>D-Bus GLib Bindings</term>
+ <listitem>
+ <para>
+ TODO
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>GLib</term>
+ <listitem>
+ <para>
+ A general-purpose utility library, not specific to graphical user interfaces.
+ GLib provides many useful data types, macros, type conversions,
+ string utilities, file utilities, a main loop abstraction, and so on.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </part>
+
+ <part id="tumbler-utils">
+ <title>Utility Functions</title>
+ <xi:include href="xml/tumbler-error.xml"/>
+ <xi:include href="xml/tumbler-thumbnail.xml"/>
+ <xi:include href="xml/tumbler-enum-types.xml"/>
+ </part>
+
+ <part id="tumbler-miscellaneous">
+ <title>Miscellaneous</title>
+ <xi:include href="xml/tumbler-config.xml"/>
+ </part>
+
+ <part id="object-tree">
+ <title>Object Hierarchy</title>
+ <xi:include href="xml/tree_index.sgml"/>
+ </part>
+
+ <index id="api-index-full">
+ <title>API Index</title>
+ <xi:include href="xml/api-index-full.xml">
+ <xi:fallback />
+ </xi:include>
+ </index>
+
+ <xi:include href="xml/annotation-glossary.xml">
+ <xi:fallback />
+ </xi:include>
+</book>