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
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
|
<refentry id="udisks.7">
<refentryinfo>
<title>udisks</title>
<date>March 2008</date>
<productname>udisks</productname>
</refentryinfo>
<refmeta>
<refentrytitle>udisks</refentrytitle>
<manvolnum>7</manvolnum>
<refmiscinfo class="version"></refmiscinfo>
</refmeta>
<refnamediv>
<refname>udisks</refname>
<refpurpose>Storage Management</refpurpose>
</refnamediv>
<refsect1><title>DESCRIPTION</title>
<para>
udisks provides an interface to enumerate storage
devices and perform operations on them. Any application
can access the <emphasis>org.freedesktop.UDisks</emphasis>
service on the system message bus. Some operations (such
as formatting disks etc.) is restricted using polkit.
</para>
</refsect1>
<refsect1><title>DEVICE INFORMATION</title>
<para>
On Linux, udisks relies on recent versions of
<citerefentry><refentrytitle>udev</refentrytitle><manvolnum>7</manvolnum></citerefentry>
and the kernel. Influential device properties in the udev
database include:
</para>
<variablelist>
<varlistentry>
<term><option>UDISKS_PRESENTATION_HIDE</option></term>
<listitem><para>If set to 1 this is a hint to presentation
level software that the device should not be shown to the
user.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>UDISKS_PRESENTATION_NOPOLICY</option></term>
<listitem><para>If set to 1 this is a hint to presentation
level software that the device should not be automounted
or autoassembled (for e.g. components of a multi-disk device).
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>UDISKS_DISABLE_POLLING</option></term>
<listitem><para>If set to 1 this will disable the polling of drives
for media changes, for devices which do not send out media
notifications by themselves (this mostly affects CD drives).
Some CD drives cause bad effects such as very high CPU usage when
being polled.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>UDISKS_PRESENTATION_NAME</option></term>
<listitem><para>The name to user for the device when
presenting it to the user.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>UDISKS_PRESENTATION_ICON_NAME</option></term>
<listitem><para>The icon to use when presenting the device to
the user. If set, the name must follow the freedesktop.org
icon theme specification.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>UDISKS_SYSTEM_INTERNAL</option></term>
<listitem><para>If set, this will override the usual bus type based
detection of whether a device is considered "system internal". "0"
means "removable" (i. e. eligible for automounting, and normal
users can mount), any other value means "system internal" (i.
e. no automounting, and only administrators can mount).
</para></listitem>
</varlistentry>
</variablelist>
<para>
The <option>ID_DRIVE_*</option> properties are used to describe what
kind of physical media can be used in a device. These are typically
set on the main block device (e.g. <literal>/dev/sdb</literal>) and
more than one these properties can be set if the device supports
multiple kinds of media.
</para>
<variablelist>
<varlistentry>
<term><option>ID_DRIVE_EJECTABLE</option></term>
<listitem><para>Whether the media in the drive is physically ejectable. Only
set this to 1 (or 0) if the drive truly uses (or doesn't) ejectable media.
In particular, it is not necessary to set this for e.g. iPod or Kindle
devices where it is necessary to send a command via
<citerefentry>
<refentrytitle>eject</refentrytitle><manvolnum>1</manvolnum>
</citerefentry>
since the desktop user session will offer this option for
removable devices regardless of whether they are
ejectable. If this property is not set, a heuristic will
be used to determine if the media is ejectable (drives
using optical, Zip or Jaz media are considered ejectable).
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>ID_DRIVE_DETACHABLE</option></term>
<listitem><para> Whether the device is detachable. It is only meaningful
to set this to 0 (to avoid marking a device as detachable) since the
code for detaching the device is part of udisks itself.
If this property is not set, a heuristic will be used to determine if the
drive is detachable (currently only devices connected through USB are
detachable).
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>ID_DRIVE_CAN_SPINDOWN</option></term>
<listitem><para> Whether the device can spin down. It is only meaningful
to set this to 0 (to avoid marking a device as being capable of spinning down)
since the code for spinning down the device is part of udisks itself.
If this property is not set, a heuristic will be used to determine if the
drive can spin down (currently only ATA devices, including those USB
devices with a SAT layer) can be spun down).
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>ID_DRIVE_FLASH</option></term>
<listitem><para>The device is compatible with flash.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>ID_DRIVE_FLASH_CF</option></term>
<listitem><para>The device is compatible with Compact Flash.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>ID_DRIVE_FLASH_MS</option></term>
<listitem><para>The device is compatible with Memory Stick.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>ID_DRIVE_FLASH_SM</option></term>
<listitem><para>The device is compatible with SmartMedia.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>ID_DRIVE_FLASH_SD</option></term>
<listitem><para>The device is compatible with SecureDigital.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>ID_DRIVE_FLASH_SDHC</option></term>
<listitem><para>The device is compatible with High-Capicity SecureDigital.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>ID_DRIVE_FLASH_MMC</option></term>
<listitem><para>The device is compatible with MultiMediaCard.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>ID_DRIVE_FLOPPY</option></term>
<listitem><para>The device is compatible with floppy disk.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>ID_DRIVE_FLOPPY_ZIP</option></term>
<listitem><para>The device is compatible with Zip.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>ID_DRIVE_FLOPPY_JAZ</option></term>
<listitem><para>The device is compatible with Jaz.
</para></listitem>
</varlistentry>
</variablelist>
<para>
The <option>ID_DRIVE_MEDIA_*</option> properties describe the
current media in a device. As with
the <option>ID_DRIVE_*</option> properties, these properties are
typically set on the main block device
(e.g. <literal>/dev/sdb</literal>). Typically only one of these
properties are set.
</para>
<variablelist>
<varlistentry>
<term><option>ID_DRIVE_MEDIA_FLASH</option></term>
<listitem><para>The physical media currently inserted into the device is flash.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>ID_DRIVE_MEDIA_FLASH_CF</option></term>
<listitem><para>The physical media currently inserted into the device is Compact Flash.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>ID_DRIVE_MEDIA_FLASH_MS</option></term>
<listitem><para>The physical media currently inserted into the device is Memory Stick.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>ID_DRIVE_MEDIA_FLASH_SM</option></term>
<listitem><para>The physical media currently inserted into the device is SmartMedia.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>ID_DRIVE_MEDIA_FLASH_SD</option></term>
<listitem><para>The physical media currently inserted into the device is SecureDigital.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>ID_DRIVE_MEDIA_FLASH_SDHC</option></term>
<listitem><para>The physical media currently inserted into the device is High-Capicity SecureDigital.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>ID_DRIVE_MEDIA_FLASH_MMC</option></term>
<listitem><para>The physical media currently inserted into the device is MultiMediaCard.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>ID_DRIVE_MEDIA_FLOPPY</option></term>
<listitem><para>The physical media currently inserted into the device is floppy disk.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>ID_DRIVE_MEDIA_FLOPPY_ZIP</option></term>
<listitem><para>The physical media currently inserted into the device is Zip.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>ID_DRIVE_MEDIA_FLOPPY_JAZ</option></term>
<listitem><para>The physical media currently inserted into the device is Jaz.
</para></listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1><title>REMOTE CLIENTS</title>
<para>
TODO: write me.
</para>
</refsect1>
<refsect1><title>AUTHOR</title>
<para>
Written by David Zeuthen <email>david@fubar.dk</email> with
a lot of help from many others.
</para>
</refsect1>
<refsect1>
<title>BUGS</title>
<para>
Please send bug reports to either the distribution bug tracker
or the upstream bug tracker at
<ulink url="http://bugs.freedesktop.org/enter_bug.cgi?product=udisks"/>.
</para>
</refsect1>
<refsect1>
<title>SEE ALSO</title>
<para>
<citerefentry>
<refentrytitle>udev</refentrytitle><manvolnum>7</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>polkit</refentrytitle><manvolnum>8</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>udisks-daemon</refentrytitle><manvolnum>8</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>udisks-tcp-bridge</refentrytitle><manvolnum>1</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>udisks</refentrytitle><manvolnum>1</manvolnum>
</citerefentry>
</para>
</refsect1>
</refentry>
|
