| 1 |
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> |
| 2 |
<html> |
| 3 |
<head> |
| 4 |
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| 5 |
<title>udisksctl: UDisks Reference Manual</title> |
| 6 |
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"> |
| 7 |
<link rel="home" href="index.html" title="UDisks Reference Manual"> |
| 8 |
<link rel="up" href="overview.html" title="Part I. Manual pages and Overview"> |
| 9 |
<link rel="prev" href="overview.html" title="Part I. Manual pages and Overview"> |
| 10 |
<link rel="next" href="udiskd.8.html" title="udisksd"> |
| 11 |
<meta name="generator" content="GTK-Doc V1.35.1 (XML mode)"> |
| 12 |
<link rel="stylesheet" href="style.css" type="text/css"> |
| 13 |
</head> |
| 14 |
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> |
| 15 |
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle"> |
| 16 |
<td width="100%" align="left" class="shortcuts"></td> |
| 17 |
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> |
| 18 |
<td><a accesskey="u" href="overview.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> |
| 19 |
<td><a accesskey="p" href="overview.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> |
| 20 |
<td><a accesskey="n" href="udiskd.8.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> |
| 21 |
</tr></table> |
| 22 |
<div class="refentry"> |
| 23 |
<a name="udisksctl.1"></a><div class="titlepage"></div> |
| 24 |
<div class="refnamediv"><table width="100%"><tr> |
| 25 |
<td valign="top"> |
| 26 |
<h2><span class="refentrytitle">udisksctl</span></h2> |
| 27 |
<p>udisksctl — The udisks command line tool</p> |
| 28 |
</td> |
| 29 |
<td class="gallery_image" valign="top" align="right"></td> |
| 30 |
</tr></table></div> |
| 31 |
<div class="refsynopsisdiv"> |
| 32 |
<h2>SYNOPSIS</h2> |
| 33 |
<div class="cmdsynopsis"><p><code class="command">udisksctl</code> status </p></div> |
| 34 |
<div class="cmdsynopsis"><p><code class="command">udisksctl</code> info { --object-path <em class="replaceable"><code>OBJECT</code></em> | --block-device <em class="replaceable"><code>DEVICE</code></em> | --drive <em class="replaceable"><code>DRIVE</code></em> }</p></div> |
| 35 |
<div class="cmdsynopsis"><p><code class="command">udisksctl</code> mount { --object-path <em class="replaceable"><code>OBJECT</code></em> | --block-device <em class="replaceable"><code>DEVICE</code></em> } [ --filesystem-type <em class="replaceable"><code>TYPE</code></em> ] [--options <em class="replaceable"><code>OPTIONS</code></em>...] [--no-user-interaction]</p></div> |
| 36 |
<div class="cmdsynopsis"><p><code class="command">udisksctl</code> unmount { --object-path <em class="replaceable"><code>OBJECT</code></em> | --block-device <em class="replaceable"><code>DEVICE</code></em> } [--force] [--no-user-interaction]</p></div> |
| 37 |
<div class="cmdsynopsis"><p><code class="command">udisksctl</code> unlock { --object-path <em class="replaceable"><code>OBJECT</code></em> | --block-device <em class="replaceable"><code>DEVICE</code></em> } [--no-user-interaction] [--key-file <em class="replaceable"><code>PATH</code></em>] [--read-only]</p></div> |
| 38 |
<div class="cmdsynopsis"><p><code class="command">udisksctl</code> lock { --object-path <em class="replaceable"><code>OBJECT</code></em> | --block-device <em class="replaceable"><code>DEVICE</code></em> } [--no-user-interaction]</p></div> |
| 39 |
<div class="cmdsynopsis"><p><code class="command">udisksctl</code> loop-setup --file <em class="replaceable"><code>PATH</code></em> [--read-only] [--offset <em class="replaceable"><code>OFFSET</code></em>] [--size <em class="replaceable"><code>SIZE</code></em>] [--no-user-interaction]</p></div> |
| 40 |
<div class="cmdsynopsis"><p><code class="command">udisksctl</code> loop-delete { --object-path <em class="replaceable"><code>OBJECT</code></em> | --block-device <em class="replaceable"><code>DEVICE</code></em> } [--no-user-interaction]</p></div> |
| 41 |
<div class="cmdsynopsis"><p><code class="command">udisksctl</code> power-off { --object-path <em class="replaceable"><code>OBJECT</code></em> | --block-device <em class="replaceable"><code>DEVICE</code></em> } [--no-user-interaction]</p></div> |
| 42 |
<div class="cmdsynopsis"><p><code class="command">udisksctl</code> smart-simulate --file <em class="replaceable"><code>PATH</code></em> { --object-path <em class="replaceable"><code>OBJECT</code></em> | --block-device <em class="replaceable"><code>DEVICE</code></em> } [--no-user-interaction]</p></div> |
| 43 |
<div class="cmdsynopsis"><p><code class="command">udisksctl</code> monitor </p></div> |
| 44 |
<div class="cmdsynopsis"><p><code class="command">udisksctl</code> dump </p></div> |
| 45 |
<div class="cmdsynopsis"><p><code class="command">udisksctl</code> help </p></div> |
| 46 |
</div> |
| 47 |
<div class="refsect1"> |
| 48 |
<a name="id-1.2.2.5"></a><h2>DESCRIPTION</h2> |
| 49 |
<p> |
| 50 |
<span class="command"><strong>udisksctl</strong></span> is a command-line program used |
| 51 |
to interact with the |
| 52 |
<span class="citerefentry"><span class="refentrytitle">udisksd</span>(8)</span> |
| 53 |
daemon process. |
| 54 |
</p> |
| 55 |
</div> |
| 56 |
<div class="refsect1"> |
| 57 |
<a name="id-1.2.2.6"></a><h2>COMMANDS</h2> |
| 58 |
<div class="variablelist"><table border="0" class="variablelist"> |
| 59 |
<colgroup> |
| 60 |
<col align="left" valign="top"> |
| 61 |
<col> |
| 62 |
</colgroup> |
| 63 |
<tbody> |
| 64 |
<tr> |
| 65 |
<td><p><span class="term"><code class="option">status</code></span></p></td> |
| 66 |
<td><p> |
| 67 |
Shows high-level information about disk drives and block |
| 68 |
devices. |
| 69 |
</p></td> |
| 70 |
</tr> |
| 71 |
<tr> |
| 72 |
<td><p><span class="term"><code class="option">info</code></span></p></td> |
| 73 |
<td><p> |
| 74 |
Shows detailed information about |
| 75 |
<em class="replaceable"><code>OBJECT</code></em>, |
| 76 |
<em class="replaceable"><code>DEVICE</code></em> or |
| 77 |
<em class="replaceable"><code>DRIVE</code></em>. |
| 78 |
</p></td> |
| 79 |
</tr> |
| 80 |
<tr> |
| 81 |
<td><p><span class="term"><code class="option">mount</code></span></p></td> |
| 82 |
<td><p> |
| 83 |
Mounts a device. The device will be mounted in a |
| 84 |
subdirectory in the <code class="filename">/run/media</code> hierarchy |
| 85 |
- upon successful completion, the mount point will be |
| 86 |
printed to standard output. |
| 87 |
</p></td> |
| 88 |
</tr> |
| 89 |
<tr> |
| 90 |
<td><p><span class="term"><code class="option">unmount</code></span></p></td> |
| 91 |
<td><p> |
| 92 |
Unmounts a device. This only works if the device is |
| 93 |
mounted. The option <code class="option">--force</code> can be used |
| 94 |
to request that the device is unmounted even if active |
| 95 |
references exists. |
| 96 |
</p></td> |
| 97 |
</tr> |
| 98 |
<tr> |
| 99 |
<td><p><span class="term"><code class="option">unlock</code></span></p></td> |
| 100 |
<td><p> |
| 101 |
Unlocks an encrypted device. The passphrase will be |
| 102 |
requested from the controlling terminal and upon |
| 103 |
successful completion, the cleartext device will be |
| 104 |
printed to standard output. |
| 105 |
</p></td> |
| 106 |
</tr> |
| 107 |
<tr> |
| 108 |
<td><p><span class="term"><code class="option">lock</code></span></p></td> |
| 109 |
<td><p> |
| 110 |
Locks a device. This only works if the device is a |
| 111 |
cleartext device backed by a cryptotext device. |
| 112 |
</p></td> |
| 113 |
</tr> |
| 114 |
<tr> |
| 115 |
<td><p><span class="term"><code class="option">loop-setup</code></span></p></td> |
| 116 |
<td><p> |
| 117 |
Sets up a loop device backed by <em class="replaceable"><code>FILE</code></em>. |
| 118 |
</p></td> |
| 119 |
</tr> |
| 120 |
<tr> |
| 121 |
<td><p><span class="term"><code class="option">loop-delete</code></span></p></td> |
| 122 |
<td><p> |
| 123 |
Tears down a loop device. |
| 124 |
</p></td> |
| 125 |
</tr> |
| 126 |
<tr> |
| 127 |
<td><p><span class="term"><code class="option">power-off</code></span></p></td> |
| 128 |
<td> |
| 129 |
<p> |
| 130 |
Arranges for the drive to be safely removed and powered |
| 131 |
off. On the OS side this includes ensuring that no process |
| 132 |
is using the drive, then requesting that in-flight buffers |
| 133 |
and caches are committed to stable storage. The exact |
| 134 |
steps for powering off the drive depends on the drive |
| 135 |
itself and the interconnect used. For drives connected |
| 136 |
through USB, the effect is that the USB device will be |
| 137 |
deconfigured followed by disabling the upstream hub port |
| 138 |
it is connected to. |
| 139 |
</p> |
| 140 |
<p> |
| 141 |
Note that as some physical devices contain multiple drives |
| 142 |
(for example 4-in-1 flash card reader USB devices) |
| 143 |
powering off one drive may affect other drives. As such |
| 144 |
there are not a lot of guarantees associated with |
| 145 |
performing this action. Usually the effect is that the |
| 146 |
drive disappears as if it was unplugged. |
| 147 |
</p> |
| 148 |
</td> |
| 149 |
</tr> |
| 150 |
<tr> |
| 151 |
<td><p><span class="term"><code class="option">smart-simulate</code></span></p></td> |
| 152 |
<td><p> |
| 153 |
Sets SMART data from the libatasmart blob given by |
| 154 |
<em class="replaceable"><code>FILE</code></em> - see |
| 155 |
<code class="filename">/usr/share/doc/libatasmart-devel-VERSION/</code> |
| 156 |
for blobs shipped with libatasmart. This is a debugging |
| 157 |
feature used to check that applications act correctly when |
| 158 |
a disk is failing. |
| 159 |
</p></td> |
| 160 |
</tr> |
| 161 |
<tr> |
| 162 |
<td><p><span class="term"><code class="option">monitor</code></span></p></td> |
| 163 |
<td><p> |
| 164 |
Monitors the daemon for events. |
| 165 |
</p></td> |
| 166 |
</tr> |
| 167 |
<tr> |
| 168 |
<td><p><span class="term"><code class="option">dump</code></span></p></td> |
| 169 |
<td><p> |
| 170 |
Prints the current state of the daemon. |
| 171 |
</p></td> |
| 172 |
</tr> |
| 173 |
<tr> |
| 174 |
<td><p><span class="term"><code class="option">help</code></span></p></td> |
| 175 |
<td><p> |
| 176 |
Prints help and exit. |
| 177 |
</p></td> |
| 178 |
</tr> |
| 179 |
</tbody> |
| 180 |
</table></div> |
| 181 |
</div> |
| 182 |
<div class="refsect1"> |
| 183 |
<a name="id-1.2.2.7"></a><h2>DEVICE SPECIFICATION</h2> |
| 184 |
<p> |
| 185 |
For commands that require a device as an argument following options |
| 186 |
can be used to specify it. |
| 187 |
</p> |
| 188 |
<div class="variablelist"><table border="0" class="variablelist"> |
| 189 |
<colgroup> |
| 190 |
<col align="left" valign="top"> |
| 191 |
<col> |
| 192 |
</colgroup> |
| 193 |
<tbody> |
| 194 |
<tr> |
| 195 |
<td><p><span class="term"><code class="option">-b</code>, </span><span class="term"><code class="option">--block-device=<em class="replaceable"><code>DEVICE</code></em></code></span></p></td> |
| 196 |
<td><p> |
| 197 |
Specify a device by its device file path. For example |
| 198 |
<span class="emphasis"><em>/dev/sda</em></span>. |
| 199 |
</p></td> |
| 200 |
</tr> |
| 201 |
<tr> |
| 202 |
<td><p><span class="term"><code class="option">-p</code>, </span><span class="term"><code class="option">--object-path=<em class="replaceable"><code>OBJECT</code></em></code></span></p></td> |
| 203 |
<td><p> |
| 204 |
Specify a device by the UDisks internal object path without the |
| 205 |
/org/freedesktop/UDisks2 prefix. For example |
| 206 |
<span class="emphasis"><em>block_devices/sda</em></span> |
| 207 |
for the <code class="filename">/dev/sda</code> disk. |
| 208 |
</p></td> |
| 209 |
</tr> |
| 210 |
<tr> |
| 211 |
<td><p><span class="term"><code class="option">-d</code>, </span><span class="term"><code class="option">--drive=<em class="replaceable"><code>DRIVE</code></em></code></span></p></td> |
| 212 |
<td><p> |
| 213 |
Specify a drive by name, for example <span class="emphasis"><em>VirtIO_Disk</em></span>. |
| 214 |
This can be currently used only together with the |
| 215 |
<code class="option">info</code> command. |
| 216 |
</p></td> |
| 217 |
</tr> |
| 218 |
</tbody> |
| 219 |
</table></div> |
| 220 |
</div> |
| 221 |
<div class="refsect1"> |
| 222 |
<a name="id-1.2.2.8"></a><h2>COMMON OPTIONS</h2> |
| 223 |
<p> |
| 224 |
The option <code class="option">--no-user-interaction</code> can be used |
| 225 |
to request that no interaction (such as the user being |
| 226 |
presented with an authentication dialog) must occur when |
| 227 |
checking with |
| 228 |
<span class="citerefentry"><span class="refentrytitle">polkit</span>(8)</span> |
| 229 |
whether the caller is authorized to perform the requested |
| 230 |
action. |
| 231 |
</p> |
| 232 |
</div> |
| 233 |
<div class="refsect1"> |
| 234 |
<a name="id-1.2.2.9"></a><h2>AUDIENCE</h2> |
| 235 |
<p> |
| 236 |
This program does not assume that the caller is the super user - |
| 237 |
it is intended to be used by unprivileged users and |
| 238 |
authorizations are checked by the udisks daemon using |
| 239 |
<span class="citerefentry"><span class="refentrytitle">polkit</span>(8)</span>. |
| 240 |
Additionally, this program is not intended to be used by scripts |
| 241 |
or other programs - options/commands may change in incompatible |
| 242 |
ways in the future even in maintenance releases. See the |
| 243 |
<span class="quote">“<span class="quote">API STABILITY</span>”</span> section of |
| 244 |
<a class="link" href="udisks.8.html" title="udisks"><span class="citerefentry"><span class="refentrytitle">udisks</span>(8)</span></a> |
| 245 |
for more information. |
| 246 |
</p> |
| 247 |
</div> |
| 248 |
<div class="refsect1"> |
| 249 |
<a name="id-1.2.2.10"></a><h2>BASH COMPLETION</h2> |
| 250 |
<p> |
| 251 |
<span class="command"><strong>udisksctl</strong></span> ships with a bash completion script to |
| 252 |
complete commands, objects, block devices and some options. |
| 253 |
</p> |
| 254 |
</div> |
| 255 |
<div class="refsect1"> |
| 256 |
<a name="id-1.2.2.11"></a><h2>AUTHOR</h2> |
| 257 |
<p> |
| 258 |
This man page was originally written for UDisks2 by David Zeuthen |
| 259 |
<code class="email"><<a class="email" href="mailto:[email protected]">[email protected]</a>></code> with a lot of help |
| 260 |
from many others. |
| 261 |
</p> |
| 262 |
</div> |
| 263 |
<div class="refsect1"> |
| 264 |
<a name="id-1.2.2.12"></a><h2>BUGS</h2> |
| 265 |
<p> |
| 266 |
Please send bug reports to either the distribution bug tracker |
| 267 |
or the upstream bug tracker at |
| 268 |
<a class="ulink" href="https://github.com/storaged-project/udisks/issues" target="_top">https://github.com/storaged-project/udisks/issues</a>. |
| 269 |
</p> |
| 270 |
</div> |
| 271 |
<div class="refsect1"> |
| 272 |
<a name="id-1.2.2.13"></a><h2>SEE ALSO</h2> |
| 273 |
<p> |
| 274 |
<a class="link" href="udisks.8.html" title="udisks"><span class="citerefentry"><span class="refentrytitle">udisks</span>(8)</span></a>, |
| 275 |
<span class="citerefentry"><span class="refentrytitle">udisksd</span>(8)</span>, |
| 276 |
<a class="link" href="umount.udisks2.8.html" title="umount.udisks2"><span class="citerefentry"><span class="refentrytitle">umount.udisks2</span>(8)</span></a>, |
| 277 |
<span class="citerefentry"><span class="refentrytitle">polkit</span>(8)</span> |
| 278 |
</p> |
| 279 |
</div> |
| 280 |
</div> |
| 281 |
<div class="footer"> |
| 282 |
<hr>Generated by GTK-Doc V1.35.1</div> |
| 283 |
</body> |
| 284 |
</html> |