libbeagle/docs/reference/beagle-docs.sgml

   1 <?xml version="1.0"?>
   2 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
   3                "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
   4 <book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
   5   <bookinfo>
   6     <title>Libbeagle Reference Manual</title>
   7   </bookinfo>
   8
   9   <chapter>
  10     <title>Fundamental classes</title>
  11     <xi:include href="xml/beagle-client.xml"/>
  12     <xi:include href="xml/beagle-error-response.xml"/>
  13     <xi:include href="xml/beagle-empty-response.xml"/>
  14     <xi:include href="xml/beagle-timestamp.xml"/>
  15   </chapter>
  16   <chapter>
  17     <title>Query API</title>
  18     <para>
  19       This API is used to execute live queries against the beagle daemon.
  20     </para>
  21     <xi:include href="xml/beagle-query.xml"/>
  22     <xi:include href="xml/beagle-query-part.xml"/>
  23     <xi:include href="xml/beagle-hits-added-response.xml"/>
  24     <xi:include href="xml/beagle-hits-subtracted-response.xml"/>
  25     <xi:include href="xml/beagle-cancelled-response.xml"/>
  26     <xi:include href="xml/beagle-finished-response.xml"/>
  27     <xi:include href="xml/beagle-hit.xml"/>
  28     <xi:include href="xml/beagle-property.xml"/>
  29     <xi:include href="xml/beagle-snippet-request.xml"/>
  30     <xi:include href="xml/beagle-snippet-response.xml"/>
  31   </chapter>
  32   <chapter>
  33     <title>Indexing API</title>
  34     <para>
  35       This API is used when requesting indexing actions to the beagle daemon.
  36     </para>
  37     <xi:include href="xml/beagle-indexing-service-request.xml"/>
  38     <xi:include href="xml/beagle-indexable.xml"/>
  39   </chapter>
  40   <chapter>
  41     <title>Extra API</title>
  42     <para>
  43       API used to request extra information from the beagle daemon.
  44     </para>
  45     <xi:include href="xml/beagle-daemon-information-response.xml"/>
  46     <xi:include href="xml/beagle-daemon-information-request.xml"/>
  47     <xi:include href="xml/beagle-shutdown-request.xml"/>
  48   </chapter>
  49   <chapter>
  50     <title>Abstract base classes</title>
  51     <para>
  52       These are the abstract base classes of any request and response.
  53     </para>
  54     <xi:include href="xml/beagle-request.xml"/>
  55     <xi:include href="xml/beagle-response.xml"/>
  56   </chapter>
  57 </book>