Debian Codegraph @

doc/udisks2-docs.xml

raw
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 <!ENTITY version SYSTEM "version.xml">
5 ]>
6 <book id="udisks" xmlns:xi="http://www.w3.org/2003/XInclude">
7 <bookinfo>
8 <title>UDisks Reference Manual</title>
9 <releaseinfo>
10 For version &version; — the latest version of this
11 documentation can be found at <ulink role="online-location"
12 url="https://storaged.org/udisks/docs/">https://storaged.org/udisks/docs/</ulink>.
13 </releaseinfo>
14 </bookinfo>
15
16 <part id="overview">
17 <title>Manual pages and Overview</title>
18 <xi:include href="man/udisksctl.xml"/>
19 <xi:include href="man/udisksd.xml"/>
20 <xi:include href="man/udisks.xml"/>
21 <xi:include href="man/umount.udisks2.xml"/>
22 <xi:include href="man/udisks2.conf.5.xml"/>
23 <xi:include href="man/udisks2_lsm.conf.5.xml"/>
24 <xi:include href="configurable_mount_options.xml"/>
25 </part>
26
27 <part id="ref-dbus">
28 <title>D-Bus API Reference</title>
29 <chapter id="ref-dbus-overview">
30 <title>Overview</title>
31 <sect1 id="ref-dbus-well-known-name">
32 <title>The org.freedesktop.UDisks2 bus name</title>
33 <para>
34 The D-Bus name <literal>org.freedesktop.UDisks2</literal> on
35 the system bus is used by the UDisks Daemon, <link
36 linkend="udisksd.8">udisksd</link>. If this daemon isn't
37 running, it will be started if D-Bus messages are sent to
38 the name.
39 </para>
40 </sect1>
41 <sect1 id="ref-dbus-udisks2-well-known-object">
42 <title>The /org/freedesktop/UDisks2 object</title>
43 <para>
44 The process that owns the well-known D-Bus name <link
45 linkend="ref-dbus-well-known-name">org.freedesktop.UDisks2</link>
46 on the system bus (typically <link
47 linkend="udisksd.8">udisksd</link>) exports an object at the
48 well-known path <literal>/org/freedesktop/UDisks2</literal>.
49 This object implements the <ulink
50 url="http://dbus.freedesktop.org/doc/dbus-specification.html#standard-interfaces-objectmanager">org.freedesktop.DBus.ObjectManager</ulink>
51 interface and should be used by clients to discover other
52 objects.
53 </para>
54 </sect1>
55 <sect1 id="ref-dbus-manager-well-known-object">
56 <title>The /org/freedesktop/UDisks2/Manager object</title>
57 <para>
58 The object at the path
59 <literal>/org/freedesktop/UDisks2/Manager</literal>
60 implements the <link
61 linkend="gdbus-interface-org-freedesktop-UDisks2-Manager.top_of_page">org.freedesktop.UDisks2.Manager</link>
62 D-Bus interface. This object can be used to inspect and
63 manipulate global state.
64 </para>
65 </sect1>
66
67 <sect1 id="ref-dbus-block-devices">
68 <title>The /org/freedesktop/UDisks2/block_devices/* objects</title>
69 <para>
70 Objects with object paths starting with
71 <literal>/org/freedesktop/UDisks2/block_devices/</literal>
72 all represent <ulink url="http://en.wikipedia.org/wiki/Block_device#Block_devices">block devices</ulink>.
73 Such objects implement the
74 <link linkend="gdbus-interface-org-freedesktop-UDisks2-Block.top_of_page">org.freedesktop.UDisks2.Block</link>
75 D-Bus interface and may optionally implement other D-Bus interfaces such as
76 <link linkend="gdbus-interface-org-freedesktop-UDisks2-Filesystem.top_of_page">org.freedesktop.UDisks2.Filesystem</link>,
77 <link linkend="gdbus-interface-org-freedesktop-UDisks2-Partition.top_of_page">org.freedesktop.UDisks2.Partition</link> or
78 <link linkend="gdbus-interface-org-freedesktop-UDisks2-Loop.top_of_page">org.freedesktop.UDisks2.Loop</link> depending on the block device in question.
79 </para>
80 <para>
81 Note that interfaces may be added and removed at
82 run-time. For example, if a block device is full of zeroes
83 (or, at least, have zeroes in the known metadata areas), it
84 will not initially implement the <link
85 linkend="gdbus-interface-org-freedesktop-UDisks2-Filesystem.top_of_page">org.freedesktop.UDisks2.Filesystem</link>
86 interface; however, if a filesystem is later created on the device
87 (using, say, the
88 <citerefentry>
89 <refentrytitle>mkfs</refentrytitle><manvolnum>8</manvolnum>
90 </citerefentry>
91 command) and the filesystem is recognized by the OS (specifically, recognized by
92 <citerefentry>
93 <refentrytitle>udev</refentrytitle><manvolnum>7</manvolnum>
94 </citerefentry> and its device probers), the object will gain the interface. If the device is later zeroed or formatted for use as e.g. swap-space, it will lose the
95 <link linkend="gdbus-interface-org-freedesktop-UDisks2-Filesystem.top_of_page">org.freedesktop.UDisks2.Filesystem</link>
96 interface.
97 </para>
98 </sect1>
99
100 <sect1 id="ref-dbus-drives">
101 <title>The /org/freedesktop/UDisks2/drives/* objects</title>
102 <para>
103 Objects with object paths starting with
104 <literal>/org/freedesktop/UDisks2/drives/</literal>
105 all represent <ulink url="http://en.wikipedia.org/wiki/Disk_drive">disk drives</ulink>,
106 typically physical disk drives.
107 Such objects implement the
108 <link linkend="gdbus-interface-org-freedesktop-UDisks2-Drive.top_of_page">org.freedesktop.UDisks2.Drive</link>
109 D-Bus interface and may optionally implement other D-Bus interfaces such as
110 <link linkend="gdbus-interface-org-freedesktop-UDisks2-Drive-Ata.top_of_page">org.freedesktop.UDisks2.Drive.Ata</link> depending on the drive in question.
111 </para>
112 <para>
113 A drive object should not to be confused with
114 <link linkend="ref-dbus-block-devices">block device</link>
115 objects (which are used for low-level block devices the OS
116 knows about). For example, if <filename>/dev/sda</filename>
117 and <filename>/dev/sdb</filename> are block devices for two
118 paths to the same drive, there will be only drive object but
119 two block device objects.
120 </para>
121 </sect1>
122
123 <sect1 id="ref-dbus-md-raid">
124 <title>The /org/freedesktop/UDisks2/mdraid/* objects</title>
125 <para>
126 Objects with object paths starting with
127 <literal>/org/freedesktop/UDisks2/mdraid/</literal>
128 represent <ulink url="https://raid.wiki.kernel.org/index.php/Linux_Raid">Linux Software RAID arrays</ulink>.
129 Such objects implement the
130 <link linkend="gdbus-interface-org-freedesktop-UDisks2-MDRaid.top_of_page">org.freedesktop.UDisks2.MDRaid</link>
131 D-Bus interface.
132 </para>
133 <para>
134 These objects should not to be confused with
135 <link linkend="ref-dbus-block-devices">block device</link>
136 objects (which are used for low-level block devices the OS
137 knows about).
138 </para>
139 </sect1>
140
141 <sect1 id="ref-iscsi-session">
142 <title>The /org/freedesktop/UDisks2/iscsi/session[0-9]+ objects</title>
143 <para>
144 Objects with object paths starting with
145 <literal>/org/freedesktop/UDisks2/iscsi/session[0-9]+</literal>
146 represent iSCSI session parameters. Such objects implement the
147 <link linkend="gdbus-interface-org-freedesktop-UDisks2-ISCSI-Session.top_of_page">org.freedesktop.UDisks2.ISCSI.Session</link>
148 D-Bus interface.
149 </para>
150 </sect1>
151
152 <sect1 id="ref-dbus-jobs">
153 <title>The /org/freedesktop/UDisks2/jobs/* objects</title>
154 <para>
155 Objects with object paths starting with
156 <literal>/org/freedesktop/UDisks2/jobs/</literal> all
157 represent long-running tasks, typically initiated by the
158 user and are guaranteed to implement the
159 <link linkend="gdbus-interface-org-freedesktop-UDisks2-Job.top_of_page">org.freedesktop.UDisks2.Job</link>
160 D-Bus interface.
161 </para>
162 </sect1>
163
164 <sect1 id="udisks-polkit-actions">
165 <title>Authorization Checks</title>
166 <para>
167 Many methods and operations offered by udisks requires the
168 calling user to be sufficiently authorized. Whether the user
169 is authorized is checked using <ulink
170 url="http://www.freedesktop.org/software/polkit/docs/latest/polkit.8.html">polkit</ulink>
171 allowing the administrator to configure fine-grained permissions via
172 polkit authorization rules.
173 </para>
174 <para>
175 There is not necessarily a one-to-one relationship between
176 D-Bus methods and polkit actions - typically the
177 relationship is more complicated and depends on both the
178 context of the process invoking the method, the object the
179 method is acting on and possibly more factors. For example,
180 the <link
181 linkend="gdbus-method-org-freedesktop-UDisks2-Filesystem.Mount">Filesystem.Mount()</link>
182 method call may check that the caller is authorized for one
183 of the four actions
184 <emphasis>org.freedesktop.UDisks2.filesystem-mount</emphasis>,
185 <emphasis>org.freedesktop.UDisks2.filesystem-mount-system</emphasis>,
186 <emphasis>org.freedesktop.UDisks2.filesystem-mount-other-seat</emphasis>
187 or
188 <emphasis>org.freedesktop.UDisks2.filesystem-mount-fstab</emphasis>
189 depending on circumstances.
190 </para>
191 <para>
192 Often there will be two polkit actions for one operation -
193 one for so-called <quote>system devices</quote> and one for
194 non-system devices. In this context <quote>system
195 device</quote> refers to the value of the <link
196 linkend="gdbus-property-org-freedesktop-UDisks2-Block.HintSystem">Block:HintSystem</link>
197 D-Bus property and is normally only
198 <constant>TRUE</constant> for devices not considered
199 <quote>removable</quote> (devices considered removable
200 include USB attached storage, Flash media and optical
201 drives). See <xref linkend="udisks.8"/> for how to control
202 if a device is considered a system device.
203 </para>
204 <para>
205 The polkit actions are not considered stable and may change
206 from release to release so administrators should take notice
207 when upgrading from one version of udisks to another. For
208 example, polkit authorization rules may need to be updated
209 to match an updated policy.
210 </para>
211 <para>
212 See <xref linkend="udisks-polkit-details"/> for the
213 variables that can be used to assist in determining if the
214 caller is authorized (note that each variable may not be set
215 for request). For example, a polkit authorization rule for
216 any of the
217 <emphasis>org.freedesktop.UDisks2.filesystem-mount*</emphasis>
218 actions can use the <parameter>device</parameter> variable
219 to determine if the caller is authorized to mount a specific
220 block device.
221 </para>
222
223 <table frame="all" id="udisks-polkit-details">
224 <title>Known polkit variables</title>
225 <tgroup cols="2" align="left" colsep="1" rowsep="1">
226 <thead>
227 <row>
228 <entry>key</entry>
229 <entry>value</entry>
230 </row>
231 </thead>
232 <tbody>
233 <row>
234 <entry><parameter>device</parameter></entry>
235 <entry>If the object is a block device, this property is set to the value of the <link linkend="gdbus-property-org-freedesktop-UDisks2-Block.PreferredDevice">Block:PreferredDevice</link> property. If set, this is guaranteed to be a device file, for example <quote>/dev/vg_lucifer/lv_root</quote> or <quote>/dev/sda1</quote>. If the object is not a block device, this is not set.</entry>
236 </row>
237 <row>
238 <entry><parameter>drive</parameter></entry>
239 <entry>Like the <parameter>device</parameter> variable, but if the object is also a drive, this variable includes Vital Product Data about the drive such as the vendor and model identifiers (if available), for example <quote>INTEL SSDSA2MH080G1GC (/dev/sda1)</quote>. Otherwise is just set to the same value as <parameter>device</parameter>. If the object is not a block device, this is not set (it is however set if the object is a block device but not a drive).</entry>
240 </row>
241
242 <row>
243 <entry><parameter>drive.wwn</parameter></entry>
244 <entry>If the object is a drive (or a block device that is part of a drive), this is set to the value of the <link linkend="gdbus-property-org-freedesktop-UDisks2-Drive.WWN">Drive:WWN</link> property.</entry>
245 </row>
246 <row>
247 <entry><parameter>drive.serial</parameter></entry>
248 <entry>If the object is a drive (or a block device that is part of a drive), this is set to the value of the <link linkend="gdbus-property-org-freedesktop-UDisks2-Drive.Serial">Drive:Serial</link> property.</entry>
249 </row>
250 <row>
251 <entry><parameter>drive.vendor</parameter></entry>
252 <entry>If the object is a drive (or a block device that is part of a drive), this is set to the value of the <link linkend="gdbus-property-org-freedesktop-UDisks2-Drive.Vendor">Drive:Vendor</link> property.</entry>
253 </row>
254 <row>
255 <entry><parameter>drive.model</parameter></entry>
256 <entry>If the object is a drive (or a block device that is part of a drive), this is set to the value of the <link linkend="gdbus-property-org-freedesktop-UDisks2-Drive.Model">Drive:Model</link> property.</entry>
257 </row>
258 <row>
259 <entry><parameter>drive.revision</parameter></entry>
260 <entry>If the object is a drive (or a block device that is part of a drive), this is set to the value of the <link linkend="gdbus-property-org-freedesktop-UDisks2-Drive.Revision">Drive:Revision</link> property.</entry>
261 </row>
262 <row>
263 <entry><parameter>drive.removable</parameter></entry>
264 <entry>If the object is a drive (or a block device that is part of a drive), this is set to the string <quote>true</quote> only if the value of the <link linkend="gdbus-property-org-freedesktop-UDisks2-Drive.Removable">Drive:Removable</link> property is <constant>TRUE</constant>.</entry>
265 </row>
266 <row>
267 <entry><parameter>drive.removable.bus</parameter></entry>
268 <entry>If the object is a drive (or a block device that is part of a drive), this is set to the value of the <link linkend="gdbus-property-org-freedesktop-UDisks2-Drive.ConnectionBus">Drive:ConnectionBus</link> property. This variable is set only if the value of the <link linkend="gdbus-property-org-freedesktop-UDisks2-Drive.Removable">Drive:Removable</link> property is <constant>TRUE</constant>.</entry>
269 </row>
270 <row>
271 <entry><parameter>drive.removable.media</parameter></entry>
272 <entry>If the object is a drive (or a block device that is part of a drive), this is set to the value of the <link linkend="gdbus-property-org-freedesktop-UDisks2-Drive.MediaCompatibility">Drive:MediaCompatibility</link> property. This variable is set only if the value of the <link linkend="gdbus-property-org-freedesktop-UDisks2-Drive.Removable">Drive:Removable</link> property is <constant>TRUE</constant>.</entry>
273 </row>
274
275 <row>
276 <entry><parameter>id.type</parameter></entry>
277 <entry>If the object is a block device, this property is set to the value of the <link linkend="gdbus-property-org-freedesktop-UDisks2-Block.IdType">Block:IdType</link> property.</entry>
278 </row>
279 <row>
280 <entry><parameter>id.usage</parameter></entry>
281 <entry>If the object is a block device, this property is set to the value of the <link linkend="gdbus-property-org-freedesktop-UDisks2-Block.IdUsage">Block:IdUsage</link> property.</entry>
282 </row>
283 <row>
284 <entry><parameter>id.version</parameter></entry>
285 <entry>If the object is a block device, this property is set to the value of the <link linkend="gdbus-property-org-freedesktop-UDisks2-Block.IdVersion">Block:IdVersion</link> property.</entry>
286 </row>
287 <row>
288 <entry><parameter>id.label</parameter></entry>
289 <entry>If the object is a block device, this property is set to the value of the <link linkend="gdbus-property-org-freedesktop-UDisks2-Block.IdLabel">Block:IdLabel</link> property.</entry>
290 </row>
291 <row>
292 <entry><parameter>id.uuid</parameter></entry>
293 <entry>If the object is a block device, this property is set to the value of the <link linkend="gdbus-property-org-freedesktop-UDisks2-Block.IdUUID">Block:IdUUID</link> property.</entry>
294 </row>
295
296 <row>
297 <entry><parameter>partition.number</parameter></entry>
298 <entry>If the object is a partition, this property is set to the value of the <link linkend="gdbus-property-org-freedesktop-UDisks2-Partition.Number">Partition:Number</link> property.</entry>
299 </row>
300 <row>
301 <entry><parameter>partition.type</parameter></entry>
302 <entry>If the object is a partition, this property is set to the value of the <link linkend="gdbus-property-org-freedesktop-UDisks2-Partition.Type">Partition:Type</link> property.</entry>
303 </row>
304 <row>
305 <entry><parameter>partition.flags</parameter></entry>
306 <entry>If the object is a partition, this property is set to the value of the <link linkend="gdbus-property-org-freedesktop-UDisks2-Partition.Flags">Partition:Flags</link> property.</entry>
307 </row>
308 <row>
309 <entry><parameter>partition.name</parameter></entry>
310 <entry>If the object is a partition, this property is set to the value of the <link linkend="gdbus-property-org-freedesktop-UDisks2-Partition.Name">Partition:Name</link> property.</entry>
311 </row>
312 <row>
313 <entry><parameter>partition.uuid</parameter></entry>
314 <entry>If the object is a partition, this property is set to the value of the <link linkend="gdbus-property-org-freedesktop-UDisks2-Partition.UUID">Partition:UUID</link> property.</entry>
315 </row>
316
317 </tbody>
318 </tgroup>
319 </table>
320
321 <para>
322 For reference, the polkit actions defined by udisks &version;
323 are included here:
324 <informalexample id="udisks-polkit-actions-file"><programlisting><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" parse="text" href="../data/org.freedesktop.UDisks2.policy.in"><xi:fallback>FIXME: MISSING XINCLUDE CONTENT</xi:fallback></xi:include></programlisting></informalexample>
325 </para>
326 </sect1>
327
328 <sect1 id="udisks-std-options">
329 <title>The <parameter>options</parameter> parameter</title>
330 <para>
331 Many method calls take a parameter of type
332 <link linkend='G-VARIANT-TYPE-VARDICT:CAPS'>'a{sv}'</link>
333 that is normally called <parameter>options</parameter>.
334 The following table lists well-known options:
335 </para>
336 <table frame='all'>
337 <title>Well-known options</title>
338 <tgroup cols='3' align='left' colsep='1' rowsep='1'>
339 <thead>
340 <row>
341 <entry>Option name</entry>
342 <entry>Value type</entry>
343 <entry>Description</entry>
344 </row>
345 </thead>
346 <tbody>
347 <row>
348 <entry>auth.no_user_interaction</entry>
349 <entry><link linkend="G-VARIANT-TYPE-BOOLEAN:CAPS">'b'</link></entry>
350 <entry>
351 If set to <constant>TRUE</constant>, then no user
352 interaction will happen when checking if the method
353 call is authorized.
354 </entry>
355 </row>
356 </tbody>
357 </tgroup>
358 </table>
359 </sect1>
360
361 </chapter>
362
363 <chapter>
364 <title>D-Bus Interfaces</title>
365 <xi:include href="xml/udisks-generated-doc-org.freedesktop.UDisks2.Manager.xml"/>
366 <xi:include href="xml/udisks-generated-doc-org.freedesktop.UDisks2.Drive.xml"/>
367 <xi:include href="xml/udisks-generated-doc-org.freedesktop.UDisks2.Drive.Ata.xml"/>
368 <xi:include href="xml/udisks-generated-doc-org.freedesktop.UDisks2.MDRaid.xml"/>
369 <xi:include href="xml/udisks-generated-doc-org.freedesktop.UDisks2.Block.xml"/>
370 <xi:include href="xml/udisks-generated-doc-org.freedesktop.UDisks2.Partition.xml"/>
371 <xi:include href="xml/udisks-generated-doc-org.freedesktop.UDisks2.PartitionTable.xml"/>
372 <xi:include href="xml/udisks-generated-doc-org.freedesktop.UDisks2.Filesystem.xml"/>
373 <xi:include href="xml/udisks-generated-doc-org.freedesktop.UDisks2.Swapspace.xml"/>
374 <xi:include href="xml/udisks-generated-doc-org.freedesktop.UDisks2.Encrypted.xml"/>
375 <xi:include href="xml/udisks-generated-doc-org.freedesktop.UDisks2.Loop.xml"/>
376 <xi:include href="xml/udisks-generated-doc-org.freedesktop.UDisks2.Job.xml"/>
377 <xi:include href="xml/udisks-generated-doc-org.freedesktop.UDisks2.NVMe.Controller.xml"/>
378 <xi:include href="xml/udisks-generated-doc-org.freedesktop.UDisks2.NVMe.Namespace.xml"/>
379 <xi:include href="xml/udisks-generated-doc-org.freedesktop.UDisks2.Manager.NVMe.xml"/>
380 <xi:include href="xml/udisks-generated-doc-org.freedesktop.UDisks2.NVMe.Fabrics.xml"/>
381 <xi:include href="xml/udisks-generated-doc-org.freedesktop.UDisks2.Drive.LSM.xml"/>
382 <xi:include href="xml/udisks-generated-doc-org.freedesktop.UDisks2.Drive.LsmLocal.xml"/>
383 <xi:include href="xml/udisks-generated-doc-org.freedesktop.UDisks2.Block.LVM2.xml"/>
384 <xi:include href="xml/udisks-generated-doc-org.freedesktop.UDisks2.LogicalVolume.xml"/>
385 <xi:include href="xml/udisks-generated-doc-org.freedesktop.UDisks2.VDOVolume.xml"/>
386 <xi:include href="xml/udisks-generated-doc-org.freedesktop.UDisks2.Manager.LVM2.xml"/>
387 <xi:include href="xml/udisks-generated-doc-org.freedesktop.UDisks2.PhysicalVolume.xml"/>
388 <xi:include href="xml/udisks-generated-doc-org.freedesktop.UDisks2.VolumeGroup.xml"/>
389 <xi:include href="xml/udisks-generated-doc-org.freedesktop.UDisks2.ISCSI.Session.xml"/>
390 <xi:include href="xml/udisks-generated-doc-org.freedesktop.UDisks2.Manager.ISCSI.Initiator.xml"/>
391 <xi:include href="xml/udisks-generated-doc-org.freedesktop.UDisks2.Manager.BTRFS.xml"/>
392 <xi:include href="xml/udisks-generated-doc-org.freedesktop.UDisks2.Filesystem.BTRFS.xml"/>
393 </chapter>
394 </part>
395
396 <part id="ref-library">
397 <title>Library API Reference</title>
398 <xi:include href="xml/udisksclient.xml"/>
399 <xi:include href="xml/udisksobjectinfo.xml"/>
400 <xi:include href="xml/udiskserror.xml"/>
401 <chapter id="ref-library-generated">
402 <title>Generated Code</title>
403 <xi:include href="xml/UDisksObject.xml"/>
404 <xi:include href="xml/UDisksObjectManagerClient.xml"/>
405 <xi:include href="xml/UDisksManager.xml"/>
406 <xi:include href="xml/UDisksDrive.xml"/>
407 <xi:include href="xml/UDisksDriveAta.xml"/>
408 <xi:include href="xml/UDisksMDRaid.xml"/>
409 <xi:include href="xml/UDisksJob.xml"/>
410 <xi:include href="xml/UDisksBlock.xml"/>
411 <xi:include href="xml/UDisksPartition.xml"/>
412 <xi:include href="xml/UDisksPartitionTable.xml"/>
413 <xi:include href="xml/UDisksFilesystem.xml"/>
414 <xi:include href="xml/UDisksSwapspace.xml"/>
415 <xi:include href="xml/UDisksEncrypted.xml"/>
416 <xi:include href="xml/UDisksLoop.xml"/>
417 <xi:include href="xml/UDisksNVMeController.xml"/>
418 <xi:include href="xml/UDisksNVMeNamespace.xml"/>
419 <xi:include href="xml/UDisksManagerNVMe.xml"/>
420 <xi:include href="xml/UDisksNVMeFabrics.xml"/>
421 <xi:include href="../doc/xml/UDisksDriveLSM.xml"/>
422 <xi:include href="../doc/xml/UDisksDriveLsmLocal.xml"/>
423 <xi:include href="../doc/xml/UDisksManagerLVM2.xml"/>
424 <xi:include href="../doc/xml/UDisksBlockLVM2.xml"/>
425 <xi:include href="../doc/xml/UDisksPhysicalVolume.xml"/>
426 <xi:include href="../doc/xml/UDisksVolumeGroup.xml"/>
427 <xi:include href="../doc/xml/UDisksLogicalVolume.xml"/>
428 <xi:include href="../doc/xml/UDisksVDOVolume.xml"/>
429 <xi:include href="../doc/xml/UDisksISCSISession.xml"/>
430 <xi:include href="../doc/xml/UDisksManagerISCSIInitiator.xml"/>
431 <xi:include href="../doc/xml/UDisksManagerBTRFS.xml"/>
432 <xi:include href="../doc/xml/UDisksFilesystemBTRFS.xml"/>
433 </chapter>
434 </part>
435
436 <part id="ref-daemon">
437 <title>Daemon Implementation Details</title>
438 <chapter id="ref-daemon-core">
439 <title>Core</title>
440 <xi:include href="xml/udisksdaemonutil.xml"/>
441 <xi:include href="xml/udiskslogging.xml"/>
442 <xi:include href="xml/udisksdaemon.xml"/>
443 <xi:include href="xml/udisksprovider.xml"/>
444 <xi:include href="xml/udisksstate.xml"/>
445 <xi:include href="xml/udisksata.xml"/>
446 <xi:include href="xml/UDisksModuleManager.xml"/>
447 <xi:include href="xml/UDisksModule.xml"/>
448 </chapter>
449 <chapter id="ref-daemon-monitoring">
450 <title>State and Configuration</title>
451 <xi:include href="xml/udisksmountmonitor.xml"/>
452 <xi:include href="xml/udisksfstabentry.xml"/>
453 <xi:include href="xml/udiskscrypttabmonitor.xml"/>
454 <xi:include href="xml/udisksutabmonitor.xml"/>
455 </chapter>
456 <chapter id="ref-daemon-jobs">
457 <title>Jobs</title>
458 <xi:include href="xml/udisksbasejob.xml"/>
459 <xi:include href="xml/udiskssimplejob.xml"/>
460 <xi:include href="xml/udisksthreadedjob.xml"/>
461 <xi:include href="xml/udisksspawnedjob.xml"/>
462 </chapter>
463 <chapter id="ref-daemon-linux-types">
464 <title>Linux-specific types</title>
465 <xi:include href="xml/udiskslinuxmanager.xml"/>
466 <xi:include href="xml/udiskslinuxmanagernvme.xml"/>
467 <xi:include href="xml/udiskslinuxprovider.xml"/>
468 <xi:include href="xml/udiskslinuxdevice.xml"/>
469 </chapter>
470 <chapter id="ref-daemon-drives">
471 <title>Drives on Linux</title>
472 <xi:include href="xml/udiskslinuxdrive.xml"/>
473 <xi:include href="xml/udiskslinuxdriveata.xml"/>
474 <xi:include href="xml/udiskslinuxdriveobject.xml"/>
475 <xi:include href="xml/udiskslinuxnvmecontroller.xml"/>
476 <xi:include href="xml/udiskslinuxnvmefabrics.xml"/>
477 </chapter>
478 <chapter id="ref-daemon-mdraid">
479 <title>Linux RAID</title>
480 <xi:include href="xml/udiskslinuxmdraid.xml"/>
481 <xi:include href="xml/udiskslinuxmdraidobject.xml"/>
482 </chapter>
483 <chapter id="ref-daemon-block-devices">
484 <title>Block devices on Linux</title>
485 <xi:include href="xml/udiskslinuxblock.xml"/>
486 <xi:include href="xml/udiskslinuxpartition.xml"/>
487 <xi:include href="xml/udiskslinuxpartitiontable.xml"/>
488 <xi:include href="xml/udiskslinuxfilesystem.xml"/>
489 <xi:include href="xml/udiskslinuxencrypted.xml"/>
490 <xi:include href="xml/udiskslinuxswapspace.xml"/>
491 <xi:include href="xml/udiskslinuxloop.xml"/>
492 <xi:include href="xml/udiskslinuxblockobject.xml"/>
493 <xi:include href="xml/udiskslinuxnvmenamespace.xml"/>
494 </chapter>
495 </part>
496
497 <index id="api-index">
498 <title>Index</title>
499 </index>
500
501 <index id="api-index-deprecated" role="deprecated">
502 <title>Index of deprecated symbols</title>
503 <xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include>
504 </index>
505
506 <!-- TODO: version -->
507 <index id="api-index-2.11.1" role="2.11.1">
508 <title>Index of new symbols in 2.11.1</title>
509 <xi:include href="xml/api-index-2.11.1.xml"><xi:fallback /></xi:include>
510 </index>
511
512 <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
513
514 <chapter id="gio-hierarchy">
515 <title>Object Hierarchy</title>
516 <xi:include href="xml/tree_index.sgml"/>
517 </chapter>
518 </book>