summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorHavoc Pennington <hp@redhat.com>2003-09-30 03:34:00 +0000
committerHavoc Pennington <hp@redhat.com>2003-09-30 03:34:00 +0000
commit78b69c683ea27514c0787b2d1e2244d7182bc72d (patch)
treede33636f51b016788b75390f87026fcf4d802338 /doc
parent9a4bd6bf72a8c06227eaf94a59ebf1645faa1e6d (diff)
2003-09-29 Havoc Pennington <hp@pobox.com>
* configure.in: split checks for Doxygen from XML docs, check for xmlto * doc/Makefile.am: XML-ify all the docs, and add a blank dbus-tutorial.xml
Diffstat (limited to 'doc')
-rw-r--r--doc/Makefile.am44
-rw-r--r--doc/dbus-specification.xml (renamed from doc/dbus-specification.sgml)94
-rw-r--r--doc/dbus-test-plan.xml (renamed from doc/dbus-test-plan.sgml)10
-rw-r--r--doc/dbus-tutorial.xml50
4 files changed, 124 insertions, 74 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am
index 5bd9fb1e..7bd392a6 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -1,38 +1,30 @@
EXTRA_DIST= \
dbus-specification.html \
- dbus-specification.sgml \
+ dbus-specification.xml \
dbus-test-plan.html \
- dbus-test-plan.sgml \
+ dbus-test-plan.xml \
+ dbus-tutorial.html \
+ dbus-tutorial.xml \
dcop-howto.txt \
file-boilerplate.c
-if DBUS_DOCS_ENABLED
-all-local: dbus-specification.html dbus-test-plan.html
+HTML_FILES= \
+ dbus-specification.html \
+ dbus-test-plan.html \
+ dbus-tutorial.html
+
+if DBUS_XML_DOCS_ENABLED
+all-local: $(HTML_FILES)
endif
-## Debian db2html outputs to stdout, so we collect stdout and use
-## it if we didn't get the proper output
+dbus-specification.html: dbus-specification.xml
+ $(XMLTO) html-nochunks $<
-dbus-specification.html: dbus-specification.sgml
- rm -f $@ && \
- $(DB2HTML) -o . --nochunks $< > $@.stdout && \
- (test -e $@ && rm -f $@.stdout || mv $@.stdout $@) && \
- rm -rf $(srcdir)/dbus-specification/stylesheet-images && \
- (if test -d $(srcdir)/dbus-specification ; then \
- rmdir $(srcdir)/dbus-specification ; fi)
+dbus-test-plan.html: dbus-test-plan.xml
+ $(XMLTO) html-nochunks $<
-dbus-test-plan.html: dbus-test-plan.sgml
- rm -f $@ && \
- $(DB2HTML) -o . --nochunks $< > $@.stdout && \
- (test -e $@ && rm -f $@.stdout || mv $@.stdout $@) && \
- rm -rf $(srcdir)/dbus-test-plan/stylesheet-images && \
- (if test -d $(srcdir)/dbus-test-plan ; then \
- rmdir $(srcdir)/dbus-test-plan ; fi)
+dbus-tutorial.html: dbus-tutorial.xml
+ $(XMLTO) html-nochunks $<
maintainer-clean-local:
- rm -f dbus-test-plan.html
- rm -rf dbus-test-plan/stylesheet-images
- test -d dbus-test-plan && rmdir dbus-test-plan
- rm -f dbus-specification.html
- rm -rf dbus-specification/stylesheet-images
- test -d dbus-specification && rmdir dbus-specification
+ rm -f $(HTML_FILES)
diff --git a/doc/dbus-specification.sgml b/doc/dbus-specification.xml
index 696c3f45..698e35a2 100644
--- a/doc/dbus-specification.sgml
+++ b/doc/dbus-specification.xml
@@ -1,7 +1,11 @@
-<!doctype article PUBLIC "-//OASIS//DTD DocBook V3.1//EN" [
+<?xml version="1.0" standalone="no"?>
+<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
+"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"
+[
]>
+
<article id="index">
- <artheader>
+ <articleinfo>
<title>D-BUS Specification</title>
<releaseinfo>Version 0.8</releaseinfo>
<date>06 September 2003</date>
@@ -10,7 +14,7 @@
<firstname>Havoc</firstname>
<surname>Pennington</surname>
<affiliation>
- <orgname>Red Hat, Inc</orgname>
+ <orgname>Red Hat, Inc.</orgname>
<address>
<email>hp@pobox.com</email>
</address>
@@ -30,14 +34,14 @@
<firstname>Alexander</firstname>
<surname>Larsson</surname>
<affiliation>
- <orgname>Red Hat, Inc</orgname>
+ <orgname>Red Hat, Inc.</orgname>
<address>
<email>alexl@redhat.com</email>
</address>
</affiliation>
</author>
</authorgroup>
- </artheader>
+ </articleinfo>
<sect1 id="introduction">
<title>Introduction</title>
@@ -75,10 +79,10 @@
</para>
<para>
The base D-BUS protocol is a peer-to-peer protocol, specified in <xref
- linkend="message-protocol">. That is, it is a system for one application
+ linkend="message-protocol"/>. That is, it is a system for one application
to talk to a single other application. However, the primary intended
application of D-BUS is the D-BUS <firstterm>message bus</firstterm>,
- specified in <xref linkend="message-bus">. The message bus is a special
+ specified in <xref linkend="message-bus"/>. The message bus is a special
application that accepts connections from multiple other applications, and
forwards messages among them.
</para>
@@ -111,7 +115,7 @@
<title>Header Encoding</title>
<para>
Following the mandatory fields, there are zero or more named fields (see
- <xref linkend="message-protocol-header-fields">), and then nul bytes
+ <xref linkend="message-protocol-header-fields"/>), and then nul bytes
padding the header such that its total length in bytes is a multiple of
8.
</para>
@@ -119,7 +123,7 @@
The header MUST begin with the following mandatory fields in the following
order:
<informaltable>
- <tgroup cols=2>
+ <tgroup cols="2">
<thead>
<row>
<entry>Size</entry>
@@ -185,7 +189,7 @@
<para>
Types that can appear in the second byte of the header:
<informaltable>
- <tgroup cols=3>
+ <tgroup cols="3">
<thead>
<row>
<entry>Conventional name</entry>
@@ -228,7 +232,7 @@
<para>
Flags that can appear in the third byte of the header:
<informaltable>
- <tgroup cols=3>
+ <tgroup cols="3">
<thead>
<row>
<entry>Conventional name</entry>
@@ -255,7 +259,7 @@
<title>Header Fields</title>
<para>
In addition to the required header information mentioned
- in <xref linkend="message-protocol-header-encoding">,
+ in <xref linkend="message-protocol-header-encoding"/>,
the header may contain zero or more named
header fields. Future versions of this protocol
specification may add new fields. Implementations must
@@ -269,7 +273,7 @@
of which are defined below. Following the name, the field MUST have
a type code represented as a single unsigned byte, and then a
properly-aligned value of that type. See <xref
- linkend="message-protocol-arguments"> for a description of how each
+ linkend="message-protocol-arguments"/> for a description of how each
type is encoded. If an implementation sees a header field name that
it does not understand, it MUST ignore that field.
</para>
@@ -277,7 +281,7 @@
<para>
Here are the currently-defined named header fields:
<informaltable>
- <tgroup cols=3>
+ <tgroup cols="3">
<thead>
<row>
<entry>Conventional Name</entry>
@@ -326,7 +330,7 @@
<entry>UINT32</entry>
<entry>The serial number of the message this message is a reply
to. (The serial number is one of the mandatory header fields,
- see <xref linkend="message-protocol-header-encoding">.)</entry>
+ see <xref linkend="message-protocol-header-encoding"/>.)</entry>
</row>
<row>
<entry>SERVICE</entry>
@@ -334,7 +338,7 @@
<entry>STRING</entry>
<entry>The name of the service this message should be routed to.
Only used in combination with the message bus, see
- <xref linkend="message-bus">.</entry>
+ <xref linkend="message-bus"/>.</entry>
</row>
<row>
<entry>SENDER_SERVICE</entry>
@@ -373,7 +377,7 @@
</para>
<para>
<informaltable>
- <tgroup cols=3>
+ <tgroup cols="3">
<thead>
<row>
<entry>Type name</entry>
@@ -442,7 +446,7 @@
<para>
The types are encoded as follows:
<informaltable>
- <tgroup cols=2>
+ <tgroup cols="2">
<thead>
<row>
<entry>Type name</entry>
@@ -771,10 +775,10 @@
<itemizedlist>
<listitem><para>AUTH [mechanism] [initial-response]</para></listitem>
- <listitem><para>CANCEL</para></listitem
- <listitem><para>BEGIN</para></listitem>
- <listitem><para>DATA &lt;data in base 64 encoding&gt;</para></listitem>
- <listitem><para>ERROR [human-readable error explanation]</para></listitem>
+ <listitem><para>CANCEL</para></listitem>
+ <listitem><para>BEGIN</para></listitem>
+ <listitem><para>DATA &lt;data in base 64 encoding&gt;</para></listitem>
+ <listitem><para>ERROR [human-readable error explanation]</para></listitem>
</itemizedlist>
From server to client are as follows:
@@ -1203,7 +1207,7 @@
<sect1 id="standard-messages">
<title>Standard Peer-to-Peer Messages</title>
<para>
- See <xref linkend="message-protocol-types-notation"> for details on
+ See <xref linkend="message-protocol-types-notation"/> for details on
the notation used in this section.
</para>
<sect2 id="standard-messages-ping">
@@ -1232,7 +1236,7 @@
</programlisting>
Message arguments:
<informaltable>
- <tgroup cols=3>
+ <tgroup cols="3">
<thead>
<row>
<entry>Argument</entry>
@@ -1283,7 +1287,7 @@
</para>
<para>
Messages may have a <literal>SERVICE</literal> field (see <xref
- linkend="message-protocol-header-fields">). When the message bus
+ linkend="message-protocol-header-fields"/>). When the message bus
receives a message, if the <literal>SERVICE</literal> field is absent, the
message is taken to be a standard peer-to-peer message and interpreted
by the message bus itself. For example, sending
@@ -1396,7 +1400,7 @@
daemon looks for <firstterm>service description files</firstterm>.
Service description files define a mapping from service names to
executables. Different kinds of message bus will look for these files
- in different places, see <xref linkend="message-bus-types">.
+ in different places, see <xref linkend="message-bus-types"/>.
</para>
<para>
[FIXME the file format should be much better specified than
@@ -1439,7 +1443,7 @@
<para>
The executable being launched may want to know whether the message bus
activating it is one of the well-known message buses (see <xref
- linkend="message-bus-types">). To facilitate this, the bus MUST also set
+ linkend="message-bus-types"/>). To facilitate this, the bus MUST also set
the <literal>DBUS_ACTIVATION_BUS_TYPE</literal> environment variable if it is one
of the well-known buses. The currently-defined values for this variable
are <literal>system</literal> for the systemwide message bus,
@@ -1530,7 +1534,7 @@
</programlisting>
Reply arguments:
<informaltable>
- <tgroup cols=3>
+ <tgroup cols="3">
<thead>
<row>
<entry>Argument</entry>
@@ -1573,7 +1577,7 @@
</programlisting>
Reply arguments:
<informaltable>
- <tgroup cols=3>
+ <tgroup cols="3">
<thead>
<row>
<entry>Argument</entry>
@@ -1604,7 +1608,7 @@
</programlisting>
Message arguments:
<informaltable>
- <tgroup cols=3>
+ <tgroup cols="3">
<thead>
<row>
<entry>Argument</entry>
@@ -1623,7 +1627,7 @@
</informaltable>
Reply arguments:
<informaltable>
- <tgroup cols=3>
+ <tgroup cols="3">
<thead>
<row>
<entry>Argument</entry>
@@ -1655,7 +1659,7 @@
</programlisting>
Message arguments:
<informaltable>
- <tgroup cols=3>
+ <tgroup cols="3">
<thead>
<row>
<entry>Argument</entry>
@@ -1679,7 +1683,7 @@
</informaltable>
Reply arguments:
<informaltable>
- <tgroup cols=3>
+ <tgroup cols="3">
<thead>
<row>
<entry>Argument</entry>
@@ -1702,7 +1706,7 @@
specified can be the following values logically ORed together:
<informaltable>
- <tgroup cols=3>
+ <tgroup cols="3">
<thead>
<row>
<entry>Identifier</entry>
@@ -1738,7 +1742,7 @@
The return value can be one of the following values:
<informaltable>
- <tgroup cols=3>
+ <tgroup cols="3">
<thead>
<row>
<entry>Identifier</entry>
@@ -1781,7 +1785,7 @@
</programlisting>
Message arguments:
<informaltable>
- <tgroup cols=3>
+ <tgroup cols="3">
<thead>
<row>
<entry>Argument</entry>
@@ -1818,7 +1822,7 @@
</programlisting>
Message arguments:
<informaltable>
- <tgroup cols=3>
+ <tgroup cols="3">
<thead>
<row>
<entry>Argument</entry>
@@ -1860,7 +1864,7 @@
</programlisting>
Message arguments:
<informaltable>
- <tgroup cols=3>
+ <tgroup cols="3">
<thead>
<row>
<entry>Argument</entry>
@@ -1898,7 +1902,7 @@
</programlisting>
Message arguments:
<informaltable>
- <tgroup cols=3>
+ <tgroup cols="3">
<thead>
<row>
<entry>Argument</entry>
@@ -1936,7 +1940,7 @@
</programlisting>
Message arguments:
<informaltable>
- <tgroup cols=3>
+ <tgroup cols="3">
<thead>
<row>
<entry>Argument</entry>
@@ -1960,7 +1964,7 @@
</informaltable>
Reply arguments:
<informaltable>
- <tgroup cols=3>
+ <tgroup cols="3">
<thead>
<row>
<entry>Argument</entry>
@@ -1977,7 +1981,7 @@
</tbody>
</tgroup>
</informaltable>
- Tries to launch the executable associated with a service. For more information, see <xref linkend="message-bus-activation">.
+ Tries to launch the executable associated with a service. For more information, see <xref linkend="message-bus-activation"/>.
[FIXME need semantics in much more detail here; for example,
if I activate a service then send it a message, is the message
@@ -1986,7 +1990,7 @@
<para>
The return value can be one of the following values:
<informaltable>
- <tgroup cols=3>
+ <tgroup cols="3">
<thead>
<row>
<entry>Identifier</entry>
@@ -2170,7 +2174,7 @@
An application is said to <firstterm>own</firstterm> a service if the
message bus has associated the application with the service name.
Services may also have <firstterm>secondary owners</firstterm> (see
- <xref linkend="term-secondary-owner">).
+ <xref linkend="term-secondary-owner"/>).
</para>
</glossdef>
</glossentry>
@@ -2187,7 +2191,7 @@
<glossdef>
<para>
".service files" tell the bus how to activate a particular service.
- See <xref linkend="term-activation">
+ See <xref linkend="term-activation"/>
</para>
</glossdef>
</glossentry>
diff --git a/doc/dbus-test-plan.sgml b/doc/dbus-test-plan.xml
index 755ed22a..bcb9b3e6 100644
--- a/doc/dbus-test-plan.sgml
+++ b/doc/dbus-test-plan.xml
@@ -1,7 +1,11 @@
-<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook V3.1//EN" [
+<?xml version="1.0" standalone="no"?>
+<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
+"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"
+[
]>
+
<article id="index">
- <artheader>
+ <articleinfo>
<title>D-BUS Test Plan</title>
<date>14 February 2003</date>
<authorgroup>
@@ -14,7 +18,7 @@
</affiliation>
</author>
</authorgroup>
- </artheader>
+ </articleinfo>
<sect1 id="introduction">
<title>Introduction</title>
<para>
diff --git a/doc/dbus-tutorial.xml b/doc/dbus-tutorial.xml
new file mode 100644
index 00000000..10cfc79f
--- /dev/null
+++ b/doc/dbus-tutorial.xml
@@ -0,0 +1,50 @@
+<?xml version="1.0" standalone="no"?>
+<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
+"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"
+[
+]>
+
+<article id="index">
+ <articleinfo>
+ <title>D-BUS Tutorial</title>
+ <releaseinfo>Version 0.1</releaseinfo>
+ <date>29 September 2003</date>
+ <authorgroup>
+ <author>
+ <firstname>Havoc</firstname>
+ <surname>Pennington</surname>
+ <affiliation>
+ <orgname>Red Hat, Inc.</orgname>
+ <address>
+ <email>hp@pobox.com</email>
+ </address>
+ </affiliation>
+ </author>
+ </authorgroup>
+ </articleinfo>
+
+ <sect1 id="introduction">
+ <title>Introduction</title>
+ <para>
+ D-BUS blah blah blah
+ <itemizedlist>
+ <listitem>
+ <para>
+ foo
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ bar
+ </para>
+ </listitem>
+ </itemizedlist>
+ </para>
+ <para>
+ blah blah blah
+ </para>
+ <para>
+ blah blah blah
+ </para>
+ </sect1>
+</article>