summaryrefslogtreecommitdiff
path: root/doc/udisks2-docs.xml
blob: 9e4a0c9d796a5a1f37e7c64cb6f2d24c9402446a (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
<?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="udisks" xmlns:xi="http://www.w3.org/2003/XInclude">
  <bookinfo>
    <title>UDisks Reference Manual</title>
    <releaseinfo>Version &version;</releaseinfo>
    <authorgroup>
      <author>
	<firstname>David</firstname>
	<surname>Zeuthen</surname>
	<affiliation>
	  <address>
	    <email>zeuthen@gmail.com</email>
	  </address>
	</affiliation>
      </author>
    </authorgroup>

    <copyright>
      <year>2007</year>
      <year>2008</year>
      <year>2009</year>
      <year>2010</year>
      <year>2011</year>
      <holder>The UDisks 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>
          <street>51 Franklin Street</street>, Suite 500
          <city>Boston</city>, <state>MA</state> <postcode>02110-1335</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>

  <part id="overview">
    <title>UDisks Overview</title>
  </part>

  <part id="ref-library">
    <title>Library API Reference</title>
      <xi:include href="xml/udiskserror.xml"/>
  </part>

  <part id="ref-daemon">
    <title>Daemon Implementation Details</title>
    <xi:include href="xml/udisksdaemon.xml"/>
    <xi:include href="xml/udisksdaemonutil.xml"/>
    <xi:include href="xml/udiskslinuxblock.xml"/>
    <xi:include href="xml/udiskslinuxlun.xml"/>
    <xi:include href="xml/udisksmount.xml"/>
    <xi:include href="xml/udisksmountmonitor.xml"/>
    <xi:include href="xml/udiskspersistentstore.xml"/>
    <chapter id="ref-daemon-jobs">
      <title>Jobs</title>
      <xi:include href="xml/udisksbasejob.xml"/>
      <xi:include href="xml/udiskssimplejob.xml"/>
      <xi:include href="xml/udisksthreadedjob.xml"/>
      <xi:include href="xml/udisksspawnedjob.xml"/>
    </chapter>
    <chapter id="ref-daemon-providers">
      <title>Data Providers</title>
      <xi:include href="xml/udisksprovider.xml"/>
      <xi:include href="xml/udiskslinuxprovider.xml"/>
      <xi:include href="xml/udisksfstabprovider.xml"/>
    </chapter>
  </part>

  <part id="tools-fileformats">
    <title>Tools, File Formats and Manual Pages</title>
    <xi:include href="man/udisks.xml"/>
    <xi:include href="man/udisksd.xml"/>
    <xi:include href="man/udisksctl.xml"/>
  </part>

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

  <chapter id="gio-hierarchy">
    <title>Object Hierarchy</title>
      <xi:include href="xml/tree_index.sgml"/>
  </chapter>
</book>