summaryrefslogtreecommitdiff
path: root/man/udevadm.xml
diff options
context:
space:
mode:
authorZbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>2013-12-17 21:48:14 -0500
committerZbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>2013-12-18 23:58:23 -0500
commit7643ac9a8add1f07ffc237c054feb443b5612717 (patch)
tree7fb3f5ae619376e81754f3748a4efe23dde01d05 /man/udevadm.xml
parented142bdb68fdcd5ce591152ce0ec9d29898fbac4 (diff)
udevadm,scsi_id: add short options to help strings and to the man page
Also clean things up a bit here and there.
Diffstat (limited to 'man/udevadm.xml')
-rw-r--r--man/udevadm.xml176
1 files changed, 128 insertions, 48 deletions
diff --git a/man/udevadm.xml b/man/udevadm.xml
index 30a6ac423a..6fc4e8d50c 100644
--- a/man/udevadm.xml
+++ b/man/udevadm.xml
@@ -82,6 +82,7 @@
</listitem>
</varlistentry>
<varlistentry>
+ <term><option>-h</option></term>
<term><option>--help</option></term>
<listitem>
<para>Print help text.</para>
@@ -89,26 +90,28 @@
</varlistentry>
</variablelist>
- <refsect2><title>udevadm info <replaceable>options</replaceable></title>
+ <refsect2><title>udevadm info <optional><replaceable>OPTIONS</replaceable></optional> <optional><replaceable>DEVPATH</replaceable>|<replaceable>FILE</replaceable></optional></title>
<para>Queries the udev database for device information
stored in the udev database. It can also query the properties
of a device from its sysfs representation to help creating udev
rules that match this device.</para>
<variablelist>
<varlistentry>
- <term><option>--query=<replaceable>type</replaceable></option></term>
+ <term><option>-q</option></term>
+ <term><option>--query=<replaceable>TYPE</replaceable></option></term>
<listitem>
<para>Query the database for the specified type of device
data. It needs the <option>--path</option> or
- <option>--name</option> to identify the specified
- device. Valid queries are: <constant>name</constant>,
- <constant>symlink</constant>, <constant>path</constant>,
- <constant>property</constant>,
+ <option>--name</option> to identify the specified device.
+ Valid <replaceable>TYPE</replaceable>s are:
+ <constant>name</constant>, <constant>symlink</constant>,
+ <constant>path</constant>, <constant>property</constant>,
<constant>all</constant>.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>--path=<replaceable>devpath</replaceable></option></term>
+ <term><option>-p</option></term>
+ <term><option>--path=<replaceable>DEVPATH</replaceable></option></term>
<listitem>
<para>The <filename>/sys</filename> path of the device to
query, e.g.
@@ -121,7 +124,8 @@
</listitem>
</varlistentry>
<varlistentry>
- <term><option>--name=<replaceable>file</replaceable></option></term>
+ <term><option>-n</option></term>
+ <term><option>--name=<replaceable>FILE</replaceable></option></term>
<listitem>
<para>The name of the device node or a symlink to query,
e.g. <filename><optional>/dev</optional>/sda</filename>.
@@ -132,6 +136,7 @@
</listitem>
</varlistentry>
<varlistentry>
+ <term><option>-r</option></term>
<term><option>--root</option></term>
<listitem>
<para>Print absolute paths in <command>name</command> or <command>symlink</command>
@@ -139,6 +144,7 @@
</listitem>
</varlistentry>
<varlistentry>
+ <term><option>-a</option></term>
<term><option>--attribute-walk</option></term>
<listitem>
<para>Print all sysfs properties of the specified device that can be used
@@ -147,31 +153,36 @@
</listitem>
</varlistentry>
<varlistentry>
+ <term><option>-x</option></term>
<term><option>--export</option></term>
<listitem>
<para>Print output as key/value pairs. Values are enclosed in single quotes.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>--export-prefix=<replaceable>name</replaceable></option></term>
+ <term><option>-P</option></term>
+ <term><option>--export-prefix=<replaceable>NAME</replaceable></option></term>
<listitem>
<para>Add a prefix to the key name of exported values.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>--device-id-of-file=<replaceable>file</replaceable></option></term>
+ <term><option>-d</option></term>
+ <term><option>--device-id-of-file=<replaceable>FILE</replaceable></option></term>
<listitem>
<para>Print major/minor numbers of the underlying device, where the file
lives on.</para>
</listitem>
</varlistentry>
<varlistentry>
+ <term><option>-e</option></term>
<term><option>--export-db</option></term>
<listitem>
<para>Export the content of the udev database.</para>
</listitem>
</varlistentry>
<varlistentry>
+ <term><option>-c</option></term>
<term><option>--cleanup-db</option></term>
<listitem>
<para>Cleanup the udev database.</para>
@@ -184,6 +195,7 @@
</listitem>
</varlistentry>
<varlistentry>
+ <term><option>-h</option></term>
<term><option>--help</option></term>
<listitem>
<para>Print help text.</para>
@@ -196,19 +208,22 @@
<para>Request device events from the kernel. Primarily used to replay events at system coldplug time.</para>
<variablelist>
<varlistentry>
+ <term><option>-v</option></term>
<term><option>--verbose</option></term>
<listitem>
<para>Print the list of devices which will be triggered.</para>
</listitem>
</varlistentry>
<varlistentry>
+ <term><option>-n</option></term>
<term><option>--dry-run</option></term>
<listitem>
<para>Do not actually trigger the event.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>--type=<replaceable>type</replaceable></option></term>
+ <term><option>-t</option></term>
+ <term><option>--type=<replaceable>TYPE</replaceable></option></term>
<listitem>
<para>Trigger a specific type of devices. Valid types are:
<command>devices</command>, <command>subsystems</command>.
@@ -216,68 +231,95 @@
</listitem>
</varlistentry>
<varlistentry>
- <term><option>--action=<replaceable>action</replaceable></option></term>
+ <term><option>-c</option></term>
+ <term><option>--action=<replaceable>ACTION</replaceable></option></term>
<listitem>
- <para>Type of event to be triggered. The default value is <command>change</command>.</para>
+ <para>Type of event to be triggered. The default value is
+ <command>change</command>.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>--subsystem-match=<replaceable>subsystem</replaceable></option></term>
+ <term><option>-s</option></term>
+ <term><option>--subsystem-match=<replaceable>SUBSYSTEM</replaceable></option></term>
<listitem>
- <para>Trigger events for devices which belong to a matching subsystem. This option
- can be specified multiple times and supports shell style pattern matching.</para>
+ <para>Trigger events for devices which belong to a
+ matching subsystem. This option can be specified multiple
+ times and supports shell style pattern matching.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>--subsystem-nomatch=<replaceable>subsystem</replaceable></option></term>
+ <term><option>-S</option></term>
+ <term><option>--subsystem-nomatch=<replaceable>SUBSYSTEM</replaceable></option></term>
<listitem>
<para>Do not trigger events for devices which belong to a matching subsystem. This option
can be specified multiple times and supports shell style pattern matching.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>--attr-match=<replaceable>attribute</replaceable>=<replaceable>value</replaceable></option></term>
+ <term><option>-a</option></term>
+ <term><option>--attr-match=<replaceable>ATTRIBUTE</replaceable>=<replaceable>VALUE</replaceable></option></term>
<listitem>
- <para>Trigger events for devices with a matching sysfs attribute. If a value is specified
- along with the attribute name, the content of the attribute is matched against the given
- value using shell style pattern matching. If no value is specified, the existence of the
- sysfs attribute is checked. This option can be specified multiple times.</para>
+ <para>Trigger events for devices with a matching sysfs
+ attribute. If a value is specified along with the
+ attribute name, the content of the attribute is matched
+ against the given value using shell style pattern
+ matching. If no value is specified, the existence of the
+ sysfs attribute is checked. This option can be specified
+ multiple times.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>--attr-nomatch=<replaceable>attribute</replaceable>=<replaceable>value</replaceable></option></term>
+ <term><option>-A</option></term>
+ <term><option>--attr-nomatch=<replaceable>ATTRIBUTE</replaceable>=<replaceable>VALUE</replaceable></option></term>
<listitem>
- <para>Do not trigger events for devices with a matching sysfs attribute. If a value is
- specified along with the attribute name, the content of the attribute is matched against
- the given value using shell style pattern matching. If no value is specified, the existence
- of the sysfs attribute is checked. This option can be specified multiple times.</para>
+ <para>Do not trigger events for devices with a matching
+ sysfs attribute. If a value is specified along with the
+ attribute name, the content of the attribute is matched
+ against the given value using shell style pattern
+ matching. If no value is specified, the existence of the
+ sysfs attribute is checked. This option can be specified
+ multiple times.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>--property-match=<replaceable>property</replaceable>=<replaceable>value</replaceable></option></term>
+ <term><option>-p</option></term>
+ <term><option>--property-match=<replaceable>PROPERTY</replaceable>=<replaceable>VALUE</replaceable></option></term>
<listitem>
- <para>Trigger events for devices with a matching property value. This option can be
- specified multiple times and supports shell style pattern matching.</para>
+ <para>Trigger events for devices with a matching property
+ value. This option can be specified multiple times and
+ supports shell style pattern matching.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>--tag-match=<replaceable>property</replaceable></option></term>
+ <term><option>-g</option></term>
+ <term><option>--tag-match=<replaceable>PROPERTY</replaceable></option></term>
<listitem>
- <para>Trigger events for devices with a matching tag. This option can be
- specified multiple times.</para>
+ <para>Trigger events for devices with a matching tag. This
+ option can be specified multiple times.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>--sysname-match=<replaceable>name</replaceable></option></term>
+ <term><option>-y</option></term>
+ <term><option>--sysname-match=<replaceable>NAME</replaceable></option></term>
<listitem>
- <para>Trigger events for devices with a matching sys device name. This option can be
- specified multiple times and supports shell style pattern matching.</para>
+ <para>Trigger events for devices with a matching sys
+ device name. This option can be specified multiple times
+ and supports shell style pattern matching.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>--parent-match=<replaceable>syspath</replaceable></option></term>
+ <term><option>-b</option></term>
+ <term><option>--parent-match=<replaceable>SYSPATH</replaceable></option></term>
<listitem>
- <para>Trigger events for all children of a given device.</para>
+ <para>Trigger events for all children of a given
+ device.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>-h</option></term>
+ <term><option>--help</option></term>
+ <listitem>
+ <para>Print help text.</para>
</listitem>
</varlistentry>
</variablelist>
@@ -287,38 +329,46 @@
<para>Watches the udev event queue, and exits if all current events are handled.</para>
<variablelist>
<varlistentry>
- <term><option>--timeout=<replaceable>seconds</replaceable></option></term>
+ <term><option>-t</option></term>
+ <term><option>--timeout=<replaceable>SECONDS</replaceable></option></term>
<listitem>
- <para>Maximum number of seconds to wait for the event queue to become empty.
- The default value is 120 seconds. A value of 0 will check if the queue is empty
- and always return immediately.</para>
+ <para>Maximum number of seconds to wait for the event
+ queue to become empty. The default value is 120 seconds. A
+ value of 0 will check if the queue is empty and always
+ return immediately.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>--seq-start=<replaceable>seqnum</replaceable></option></term>
+ <term><option>-s</option></term>
+ <term><option>--seq-start=<replaceable>SEQNUM</replaceable></option></term>
<listitem>
- <para>Wait only for events after the given sequence number.</para>
+ <para>Wait only for events after the given sequence
+ number.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>--seq-end=<replaceable>seqnum</replaceable></option></term>
+ <term><option>-e</option></term>
+ <term><option>--seq-end=<replaceable>SEQNUM</replaceable></option></term>
<listitem>
<para>Wait only for events before the given sequence number.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>--exit-if-exists=<replaceable>file</replaceable></option></term>
+ <term><option>-E</option></term>
+ <term><option>--exit-if-exists=<replaceable>FILE</replaceable></option></term>
<listitem>
<para>Stop waiting if file exists.</para>
</listitem>
</varlistentry>
<varlistentry>
+ <term><option>-q</option></term>
<term><option>--quiet</option></term>
<listitem>
<para>Do not print any output, like the remaining queue entries when reaching the timeout.</para>
</listitem>
</varlistentry>
<varlistentry>
+ <term><option>-h</option></term>
<term><option>--help</option></term>
<listitem>
<para>Print help text.</para>
@@ -331,12 +381,14 @@
<para>Modify the internal state of the running udev daemon.</para>
<variablelist>
<varlistentry>
+ <term><option>-x</option></term>
<term><option>--exit</option></term>
<listitem>
<para>Signal and wait for systemd-udevd to exit.</para>
</listitem>
</varlistentry>
<varlistentry>
+ <term><option>-l</option></term>
<term><option>--log-priority=<replaceable>value</replaceable></option></term>
<listitem>
<para>Set the internal log level of systemd-udevd. Valid values are the numerical
@@ -345,6 +397,7 @@
</listitem>
</varlistentry>
<varlistentry>
+ <term><option>-s</option></term>
<term><option>--stop-exec-queue</option></term>
<listitem>
<para>Signal systemd-udevd to stop executing new events. Incoming events
@@ -352,12 +405,14 @@
</listitem>
</varlistentry>
<varlistentry>
+ <term><option>-S</option></term>
<term><option>--start-exec-queue</option></term>
<listitem>
<para>Signal systemd-udevd to enable the execution of events.</para>
</listitem>
</varlistentry>
<varlistentry>
+ <term><option>-R</option></term>
<term><option>--reload</option></term>
<listitem>
<para>Signal systemd-udevd to reload the rules files and other databases like the kernel
@@ -366,12 +421,14 @@
</listitem>
</varlistentry>
<varlistentry>
+ <term><option>-p</option></term>
<term><option>--property=<replaceable>KEY</replaceable>=<replaceable>value</replaceable></option></term>
<listitem>
<para>Set a global property for all events.</para>
</listitem>
</varlistentry>
<varlistentry>
+ <term><option>-m</option></term>
<term><option>--children-max=</option><replaceable>value</replaceable></term>
<listitem>
<para>Set the maximum number of events, systemd-udevd will handle at the
@@ -385,6 +442,7 @@
</listitem>
</varlistentry>
<varlistentry>
+ <term><option>-h</option></term>
<term><option>--help</option></term>
<listitem>
<para>Print help text.</para>
@@ -400,36 +458,42 @@
</para>
<variablelist>
<varlistentry>
+ <term><option>-k</option></term>
<term><option>--kernel</option></term>
<listitem>
<para>Print the kernel uevents.</para>
</listitem>
</varlistentry>
<varlistentry>
+ <term><option>-u</option></term>
<term><option>--udev</option></term>
<listitem>
<para>Print the udev event after the rule processing.</para>
</listitem>
</varlistentry>
<varlistentry>
+ <term><option>-p</option></term>
<term><option>--property</option></term>
<listitem>
<para>Also print the properties of the event.</para>
</listitem>
</varlistentry>
<varlistentry>
+ <term><option>-s</option></term>
<term><option>--subsystem-match=<replaceable>string[/string]</replaceable></option></term>
<listitem>
<para>Filter events by subsystem[/devtype]. Only udev events with a matching subsystem value will pass.</para>
</listitem>
</varlistentry>
<varlistentry>
+ <term><option>-t</option></term>
<term><option>--tag-match=<replaceable>string</replaceable></option></term>
<listitem>
<para>Filter events by property. Only udev events with a given tag attached will pass.</para>
</listitem>
</varlistentry>
<varlistentry>
+ <term><option>-h</option></term>
<term><option>--help</option></term>
<listitem>
<para>Print help text.</para>
@@ -442,6 +506,7 @@
<para>Maintain the hardware database index in <filename>/etc/udev/hwdb.bin</filename>.</para>
<variablelist>
<varlistentry>
+ <term><option>-u</option></term>
<term><option>--update</option></term>
<listitem>
<para>Compile the hardware database information located in /usr/lib/udev/hwdb.d/,
@@ -452,6 +517,7 @@
</listitem>
</varlistentry>
<varlistentry>
+ <term><option>-t</option></term>
<term><option>--test=<replaceable>string</replaceable></option></term>
<listitem>
<para>Query the database with a modalias string, and print the
@@ -459,11 +525,19 @@
</listitem>
</varlistentry>
<varlistentry>
+ <term><option>-r</option></term>
<term><option>--root=<replaceable>string</replaceable></option></term>
<listitem>
<para>Alternative root path in the filesystem for reading and writing files.</para>
</listitem>
</varlistentry>
+ <varlistentry>
+ <term><option>-h</option></term>
+ <term><option>--help</option></term>
+ <listitem>
+ <para>Print help text.</para>
+ </listitem>
+ </varlistentry>
</variablelist>
</refsect2>
@@ -471,12 +545,14 @@
<para>Simulate a udev event run for the given device, and print debug output.</para>
<variablelist>
<varlistentry>
+ <term><option>-a</option></term>
<term><option>--action=<replaceable>string</replaceable></option></term>
<listitem>
<para>The action string.</para>
</listitem>
</varlistentry>
<varlistentry>
+ <term><option>-N</option></term>
<term><option>--resolve-names=<constant>early</constant>|<constant>late</constant>|<constant>never</constant></option></term>
<listitem>
<para>Specify when udevadm should resolve names of users
@@ -489,6 +565,7 @@
</listitem>
</varlistentry>
<varlistentry>
+ <term><option>-h</option></term>
<term><option>--help</option></term>
<listitem>
<para>Print help text.</para>
@@ -497,10 +574,13 @@
</variablelist>
</refsect2>
- <refsect2><title>udevadm test-builtin <optional>options</optional> <replaceable>command</replaceable> <replaceable>devpath</replaceable></title>
- <para>Run a built-in command for the given device, and print debug output.</para>
+ <refsect2><title>udevadm test-builtin <optional>options</optional> <replaceable>COMMAND</replaceable> <replaceable>DEVPATH</replaceable></title>
+ <para>Run a built-in command <replaceable>COMMAND</replaceable>
+ for device <replaceable>DEVPATH</replaceable>, and print debug
+ output.</para>
<variablelist>
<varlistentry>
+ <term><option>-h</option></term>
<term><option>--help</option></term>
<listitem>
<para>Print help text.</para>