|
 |
eb981d |
From ae41997ebc01621c40e74a7fd29cd93b8f7fc790 Mon Sep 17 00:00:00 2001
|
|
|
eb981d |
From: Vojtech Trefny <vtrefny@redhat.com>
|
|
|
eb981d |
Date: Mon, 10 Dec 2018 10:43:44 +0100
|
|
|
eb981d |
Subject: [PATCH] man: Describe command options in the udisksctl man page
|
|
|
eb981d |
|
|
|
eb981d |
Added short description for the "device" options (--object-path
|
|
|
eb981d |
and --block-device) and for options for specific commands.
|
|
|
eb981d |
|
|
|
eb981d |
Resolves: rhbz#1568269
|
|
|
eb981d |
---
|
|
|
eb981d |
doc/man/udisksctl.xml.in | 157 +++++++++++++++++++++++++++++++++++++--
|
|
|
eb981d |
1 file changed, 149 insertions(+), 8 deletions(-)
|
|
|
eb981d |
|
|
|
eb981d |
diff --git a/doc/man/udisksctl.xml.in b/doc/man/udisksctl.xml.in
|
|
|
eb981d |
index 41a1410d3..3ecbafe99 100644
|
|
|
eb981d |
--- a/doc/man/udisksctl.xml.in
|
|
|
eb981d |
+++ b/doc/man/udisksctl.xml.in
|
|
|
eb981d |
@@ -34,6 +34,7 @@
|
|
|
eb981d |
<group choice="req">
|
|
|
eb981d |
<arg choice="plain">--object-path <replaceable>OBJECT</replaceable></arg>
|
|
|
eb981d |
<arg choice="plain">--block-device <replaceable>DEVICE</replaceable></arg>
|
|
|
eb981d |
+ <arg choice="plain">--drive <replaceable>DRIVE</replaceable></arg>
|
|
|
eb981d |
</group>
|
|
|
eb981d |
</cmdsynopsis>
|
|
|
eb981d |
|
|
|
eb981d |
@@ -168,8 +169,9 @@
|
|
|
eb981d |
<listitem>
|
|
|
eb981d |
<para>
|
|
|
eb981d |
Shows detailed information about
|
|
|
eb981d |
- <replaceable>OBJECT</replaceable> or
|
|
|
eb981d |
- <replaceable>DEVICE</replaceable>.
|
|
|
eb981d |
+ <replaceable>OBJECT</replaceable>,
|
|
|
eb981d |
+ <replaceable>DEVICE</replaceable> or
|
|
|
eb981d |
+ <replaceable>DRIVE</replaceable>.
|
|
|
eb981d |
</para>
|
|
|
eb981d |
</listitem>
|
|
|
eb981d |
</varlistentry>
|
|
|
eb981d |
@@ -179,21 +181,40 @@
|
|
|
eb981d |
<listitem>
|
|
|
eb981d |
<para>
|
|
|
eb981d |
Mounts a device. The device will be mounted in a
|
|
|
eb981d |
- subdirectory in the <filename>/media</filename> hierarchy
|
|
|
eb981d |
+ subdirectory in the <filename>/run/media</filename> hierarchy
|
|
|
eb981d |
- upon successful completion, the mount point will be
|
|
|
eb981d |
printed to standard output.
|
|
|
eb981d |
</para>
|
|
|
eb981d |
- <para>
|
|
|
eb981d |
+ </listitem>
|
|
|
eb981d |
+
|
|
|
eb981d |
+ <varlistentry>
|
|
|
eb981d |
+ <term><option>-t</option></term>
|
|
|
eb981d |
+ <term><option>--filesystem-type</option></term>
|
|
|
eb981d |
+ <listitem>
|
|
|
eb981d |
+ <para>
|
|
|
eb981d |
+ Filesystem type to use. If not specified, autodetected filesystem
|
|
|
eb981d |
+ type will be used.
|
|
|
eb981d |
+ </para>
|
|
|
eb981d |
+ </listitem>
|
|
|
eb981d |
+ </varlistentry>
|
|
|
eb981d |
+
|
|
|
eb981d |
+ <varlistentry>
|
|
|
eb981d |
+ <term><option>-o</option></term>
|
|
|
eb981d |
+ <term><option>--options</option></term>
|
|
|
eb981d |
+ <listitem>
|
|
|
eb981d |
+ <para>
|
|
|
eb981d |
The device will be mounted with a safe set of default
|
|
|
eb981d |
options. You can influence the options passed to the
|
|
|
eb981d |
<citerefentry><refentrytitle>mount</refentrytitle><manvolnum>8</manvolnum></citerefentry>
|
|
|
eb981d |
- command with <option>--options</option>. Note that only
|
|
|
eb981d |
+ command using this option. Note that only
|
|
|
eb981d |
safe options are allowed - requests with inherently unsafe
|
|
|
eb981d |
options such as <parameter>suid</parameter> or
|
|
|
eb981d |
<parameter>dev</parameter> that would allow the caller to
|
|
|
eb981d |
gain additional privileges, are rejected.
|
|
|
eb981d |
- </para>
|
|
|
eb981d |
- </listitem>
|
|
|
eb981d |
+ </para>
|
|
|
eb981d |
+ </listitem>
|
|
|
eb981d |
+ </varlistentry>
|
|
|
eb981d |
+
|
|
|
eb981d |
</varlistentry>
|
|
|
eb981d |
|
|
|
eb981d |
<varlistentry>
|
|
|
eb981d |
@@ -206,6 +227,18 @@
|
|
|
eb981d |
references exists.
|
|
|
eb981d |
</para>
|
|
|
eb981d |
</listitem>
|
|
|
eb981d |
+
|
|
|
eb981d |
+ <varlistentry>
|
|
|
eb981d |
+ <term><option>-f</option></term>
|
|
|
eb981d |
+ <term><option>--force</option></term>
|
|
|
eb981d |
+ <listitem>
|
|
|
eb981d |
+ <para>
|
|
|
eb981d |
+ Lazy unmount. Detach the filesystem from the file hierarchy
|
|
|
eb981d |
+ now, and clean up all references to this filesystem as soon
|
|
|
eb981d |
+ as it is not busy anymore.
|
|
|
eb981d |
+ </para>
|
|
|
eb981d |
+ </listitem>
|
|
|
eb981d |
+ </varlistentry>
|
|
|
eb981d |
</varlistentry>
|
|
|
eb981d |
|
|
|
eb981d |
<varlistentry>
|
|
|
eb981d |
@@ -218,6 +251,15 @@
|
|
|
eb981d |
printed to standard output.
|
|
|
eb981d |
</para>
|
|
|
eb981d |
</listitem>
|
|
|
eb981d |
+
|
|
|
eb981d |
+ <varlistentry>
|
|
|
eb981d |
+ <term><option>--key-file=<replaceable>PATH</replaceable></option></term>
|
|
|
eb981d |
+ <listitem>
|
|
|
eb981d |
+ <para>
|
|
|
eb981d |
+ Read passphrase from the given file.
|
|
|
eb981d |
+ </para>
|
|
|
eb981d |
+ </listitem>
|
|
|
eb981d |
+ </varlistentry>
|
|
|
eb981d |
</varlistentry>
|
|
|
eb981d |
|
|
|
eb981d |
<varlistentry>
|
|
|
eb981d |
@@ -237,6 +279,48 @@
|
|
|
eb981d |
Sets up a loop device backed by <replaceable>FILE</replaceable>.
|
|
|
eb981d |
</para>
|
|
|
eb981d |
</listitem>
|
|
|
eb981d |
+
|
|
|
eb981d |
+ <varlistentry>
|
|
|
eb981d |
+ <term><option>-f</option></term>
|
|
|
eb981d |
+ <term><option>--file=<replaceable>FILE</replaceable></option></term>
|
|
|
eb981d |
+ <listitem>
|
|
|
eb981d |
+ <para>
|
|
|
eb981d |
+ File to set up a loop device for.
|
|
|
eb981d |
+ </para>
|
|
|
eb981d |
+ </listitem>
|
|
|
eb981d |
+ </varlistentry>
|
|
|
eb981d |
+
|
|
|
eb981d |
+ <varlistentry>
|
|
|
eb981d |
+ <term><option>-r</option></term>
|
|
|
eb981d |
+ <term><option>--read-only</option></term>
|
|
|
eb981d |
+ <listitem>
|
|
|
eb981d |
+ <para>
|
|
|
eb981d |
+ Set up a read-only loop device.
|
|
|
eb981d |
+ </para>
|
|
|
eb981d |
+ </listitem>
|
|
|
eb981d |
+ </varlistentry>
|
|
|
eb981d |
+
|
|
|
eb981d |
+ <varlistentry>
|
|
|
eb981d |
+ <term><option>-o</option></term>
|
|
|
eb981d |
+ <term><option>--offset=<replaceable>OFFSET</replaceable></option></term>
|
|
|
eb981d |
+ <listitem>
|
|
|
eb981d |
+ <para>
|
|
|
eb981d |
+ The data start is moved <replaceable>OFFSET</replaceable> bytes
|
|
|
eb981d |
+ into the specified file.
|
|
|
eb981d |
+ </para>
|
|
|
eb981d |
+ </listitem>
|
|
|
eb981d |
+ </varlistentry>
|
|
|
eb981d |
+
|
|
|
eb981d |
+ <varlistentry>
|
|
|
eb981d |
+ <term><option>-s</option></term>
|
|
|
eb981d |
+ <term><option>--size=<replaceable>SIZE</replaceable></option></term>
|
|
|
eb981d |
+ <listitem>
|
|
|
eb981d |
+ <para>
|
|
|
eb981d |
+ The data end is set to no more than <replaceable>SIZE</replaceable>
|
|
|
eb981d |
+ bytes after the data start.
|
|
|
eb981d |
+ </para>
|
|
|
eb981d |
+ </listitem>
|
|
|
eb981d |
+ </varlistentry>
|
|
|
eb981d |
</varlistentry>
|
|
|
eb981d |
|
|
|
eb981d |
<varlistentry>
|
|
|
eb981d |
@@ -285,6 +369,16 @@
|
|
|
eb981d |
a disk is failing.
|
|
|
eb981d |
</para>
|
|
|
eb981d |
</listitem>
|
|
|
eb981d |
+
|
|
|
eb981d |
+ <varlistentry>
|
|
|
eb981d |
+ <term><option>-f</option></term>
|
|
|
eb981d |
+ <term><option>--file=<replaceable>FILE</replaceable></option></term>
|
|
|
eb981d |
+ <listitem>
|
|
|
eb981d |
+ <para>
|
|
|
eb981d |
+ File with the libatasmart blob.
|
|
|
eb981d |
+ </para>
|
|
|
eb981d |
+ </listitem>
|
|
|
eb981d |
+ </varlistentry>
|
|
|
eb981d |
</varlistentry>
|
|
|
eb981d |
|
|
|
eb981d |
<varlistentry>
|
|
|
eb981d |
@@ -311,10 +405,57 @@
|
|
|
eb981d |
</variablelist>
|
|
|
eb981d |
</refsect1>
|
|
|
eb981d |
|
|
|
eb981d |
+ <refsect1>
|
|
|
eb981d |
+ <title>DEVICE SPECIFICATION</title>
|
|
|
eb981d |
+ <para>
|
|
|
eb981d |
+ For commands that require a device as an argument following options
|
|
|
eb981d |
+ can be used to specify it.
|
|
|
eb981d |
+ </para>
|
|
|
eb981d |
+ <variablelist>
|
|
|
eb981d |
+
|
|
|
eb981d |
+ <varlistentry>
|
|
|
eb981d |
+ <term><option>-b</option></term>
|
|
|
eb981d |
+ <term><option>--block-device=<replaceable>DEVICE</replaceable></option></term>
|
|
|
eb981d |
+ <listitem>
|
|
|
eb981d |
+ <para>
|
|
|
eb981d |
+ Specify a device by its device file path. For example
|
|
|
eb981d |
+ <emphasis>/dev/sda</emphasis>.
|
|
|
eb981d |
+ </para>
|
|
|
eb981d |
+ </listitem>
|
|
|
eb981d |
+ </varlistentry>
|
|
|
eb981d |
+
|
|
|
eb981d |
+ <varlistentry>
|
|
|
eb981d |
+ <term><option>-p</option></term>
|
|
|
eb981d |
+ <term><option>--object-path=<replaceable>OBJECT</replaceable></option></term>
|
|
|
eb981d |
+ <listitem>
|
|
|
eb981d |
+ <para>
|
|
|
eb981d |
+ Specify a device by the UDisks internal object path without the
|
|
|
eb981d |
+ /org/freedesktop/UDisks2 prefix. For example
|
|
|
eb981d |
+ <emphasis>block_devices/sda</emphasis>
|
|
|
eb981d |
+ for the <filename class="devicefile">/dev/sda</filename> disk.
|
|
|
eb981d |
+ </para>
|
|
|
eb981d |
+ </listitem>
|
|
|
eb981d |
+ </varlistentry>
|
|
|
eb981d |
+
|
|
|
eb981d |
+ <varlistentry>
|
|
|
eb981d |
+ <term><option>-d</option></term>
|
|
|
eb981d |
+ <term><option>--drive=<replaceable>DRIVE</replaceable></option></term>
|
|
|
eb981d |
+ <listitem>
|
|
|
eb981d |
+ <para>
|
|
|
eb981d |
+ Specify a drive by name, for example <emphasis>VirtIO_Disk</emphasis>.
|
|
|
eb981d |
+ This can be currently used only together with the
|
|
|
eb981d |
+ <option>info</option> command.
|
|
|
eb981d |
+ </para>
|
|
|
eb981d |
+ </listitem>
|
|
|
eb981d |
+ </varlistentry>
|
|
|
eb981d |
+
|
|
|
eb981d |
+ </variablelist>
|
|
|
eb981d |
+ </refsect1>
|
|
|
eb981d |
+
|
|
|
eb981d |
<refsect1>
|
|
|
eb981d |
<title>COMMON OPTIONS</title>
|
|
|
eb981d |
<para>
|
|
|
eb981d |
- The option <option >--no-user-interaction</option> can be used
|
|
|
eb981d |
+ The option <option>--no-user-interaction</option> can be used
|
|
|
eb981d |
to request that no interaction (such as the user being
|
|
|
eb981d |
presented with an authentication dialog) must occur when
|
|
|
eb981d |
checking with
|