summaryrefslogtreecommitdiff
path: root/doc/upower-docs.xml
blob: 9b01704a9cbcdd371cb8d903137301b9e3dc81a5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
<?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 version SYSTEM "version.xml">
]>
<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
  <bookinfo>
    <title>UPower Reference Manual</title>
    <releaseinfo>Version &version;</releaseinfo>
    <authorgroup>
      <author>
        <firstname>Richard</firstname>
        <surname>Hughes</surname>
        <affiliation>
          <address>
            <email>richard@hughsie.com</email>
          </address>
        </affiliation>
      </author>
    </authorgroup>

    <copyright>
      <year>2010</year>
      <holder>The UPower Authors</holder>
    </copyright>

    <legalnotice>
      <para>
	Permission is granted to copy, distribute and/or modify this
	document under the terms of the <citetitle>GNU Free
	Documentation License</citetitle>, Version 1.1 or any later
	version published by the Free Software Foundation with no
	Invariant Sections, no Front-Cover Texts, and no Back-Cover
	Texts. You may obtain a copy of the <citetitle>GNU Free
	Documentation License</citetitle> from the Free Software
	Foundation by visiting <ulink type="http"
	url="http://www.fsf.org">their Web site</ulink> or by writing
	to:

	<address>
	  The Free Software Foundation, Inc.,
	  <street>59 Temple Place</street> - Suite 330,
	  <city>Boston</city>, <state>MA</state> <postcode>02111-1307</postcode>,
	  <country>USA</country>
	</address>
      </para>

      <para>
	Many of the names used by companies to distinguish their
	products and services are claimed as trademarks. Where those
	names appear in any freedesktop.org documentation, and those
	trademarks are made aware to the members of the
	freedesktop.org Project, the names have been printed in caps
	or initial caps.
      </para>
    </legalnotice>
  </bookinfo>

  <reference id="ref-dbus">
    <title>D-Bus API Reference</title>
    <partintro>
      <para>
	This part documents the D-Bus interface used to access the
	UPower daemon.
      </para>
    </partintro>
    <xi:include href="dbus/org.freedesktop.UPower.ref.xml"/>
    <xi:include href="dbus/org.freedesktop.UPower.Device.ref.xml"/>
    <xi:include href="dbus/org.freedesktop.UPower.QoS.ref.xml"/>
  </reference>

  <reference id="libupower-glib">
    <title>libpackagekit GObjects</title>
    <partintro>
      <para>
        This part documents GObjects used in libupower-glib.
      </para>
    </partintro>
    <xi:include href="xml/up-client.xml"/>
    <xi:include href="xml/up-device.xml"/>
  </reference>

  <reference id="libupower-glib-helpers">
    <title>libupower-glib helpers</title>
    <partintro>
      <para>
        This part documents helper funtions in libupower-glib.
      </para>
    </partintro>
    <xi:include href="xml/up-types.xml"/>
  </reference>

  <reference id="tools-fileformats">
    <title>Manual Pages</title>
    <partintro>
      <para>
	This part contains the manual pages distributed with UPower.
      </para>
    </partintro>
    <xi:include href="man/UPower.xml"/>
    <xi:include href="man/upowerd.xml"/>
    <xi:include href="man/upower.xml"/>
  </reference>

  <index>
    <title>Index</title>
  </index>

  <!-- License -->

  <appendix id="license">
    <title>License</title>
    <para>
<programlisting><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../COPYING" parse="text"><xi:fallback>FIXME: MISSING XINCLUDE CONTENT</xi:fallback></xi:include></programlisting>
    </para>
  </appendix>
</book>