chiark / gitweb /
doc: update "writing udev rules"
[elogind.git] / udevadm.8
index 23502215ecdca24d5f5e3cbd5062f1e00bc6f2ec..acad283bc329c86ac6054a6f174321a009620ef3 100644 (file)
--- a/udevadm.8
+++ b/udevadm.8
@@ -31,9 +31,9 @@ udevadm - udev management tool
 \fBudevadm help\fR
 .SH "DESCRIPTION"
 .PP
-udevadm expects a command and command specific options\. It controls the runtime behavior of udev, request kernel events, manages the event queue, and provides simple debugging mechanisms\.
+udevadm expects a command and command specific options\. It controls the runtime behavior of udev, requests kernel events, manages the event queue, and provides simple debugging mechanisms\.
 .SH "OPTIONS"
-.SS "udevadm info"
+.SS "udevadm info \fIoptions\fR"
 .PP
 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\.
 .PP
@@ -56,7 +56,7 @@ to identify the specified device\. Valid queries are:
 The devpath of the device to query\.
 .RE
 .PP
-\fB\-\-name=\fR\fB\fInode\fR\fR
+\fB\-\-name=\fR\fB\fIfile\fR\fR
 .RS 4
 The name of the device node or a symlink to query
 .RE
@@ -76,6 +76,11 @@ query, the query returns the absolute path including the root directory\.
 Print all sysfs properties of the specified device that can be used in udev rules to match the specified device\. It prints all devices along the chain, up to the root of sysfs that can be used in udev rules\.
 .RE
 .PP
+\fB\-\-device\-id\-of\-file=\fR\fB\fIfile\fR\fR
+.RS 4
+Print major/minor numbers of the underlying device, where the file lives on\.
+.RE
+.PP
 \fB\-\-export\-db\fR
 .RS 4
 Export the content of the udev database\.
@@ -90,7 +95,7 @@ Print version\.
 .RS 4
 Print help text\.
 .RE
-.SS "udevadm trigger"
+.SS "udevadm trigger [options]"
 .PP
 Request kernel device uevents, usually used to replay events at system coldplug\.
 .PP
@@ -133,24 +138,24 @@ Trigger events for devices with a matching sysfs attribute\. If a value is speci
 .RS 4
 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\.
 .RE
-.SS "udevadm settle"
+.SS "udevadm settle [options]"
 .PP
 Watches the udev event queue, and exits if all current events are handled\.
 .PP
 \fB\-\-timeout=\fR\fB\fIseconds\fR\fR
 .RS 4
-Maximum seconds to wait for the queue to become empty\.
+Maximum number of seconds to wait for the event queue to become empty\. The default value is 180 seconds\.
 .RE
 .PP
 \fB\-\-help\fR
 .RS 4
 Print help text\.
 .RE
-.SS "udevadm control \fIinstruction\fR"
+.SS "udevadm control \fIcommand\fR"
 .PP
 Modify the internal state of the running udev daemon\.
 .PP
-\fBlog_priority=\fR\fB\fIvalue\fR\fR
+\fB\-\-log_priority=\fR\fB\fIvalue\fR\fR
 .RS 4
 Set the internal log level of udevd\. Valid values are the numerical syslog priorities or their textual representations:
 \fBerr\fR,
@@ -159,41 +164,41 @@ and
 \fBdebug\fR\.
 .RE
 .PP
-\fBstop_exec_queue\fR
+\fB\-\-stop_exec_queue\fR
 .RS 4
 Signal udevd to stop executing new events\. Incoming events will be queued\.
 .RE
 .PP
-\fBstart_exec_queue\fR
+\fB\-\-start_exec_queue\fR
 .RS 4
 Signal udevd to enable the execution of events\.
 .RE
 .PP
-\fBreload_rules\fR
+\fB\-\-reload_rules\fR
 .RS 4
 Signal udevd to reload the rules from the config\.
 .RE
 .PP
-\fBenv \fR\fB\fIvar\fR\fR\fB=\fR\fB\fIvalue\fR\fR
+\fB\-\-env \fR\fB\fIvar\fR\fR\fB=\fR\fB\fIvalue\fR\fR
 .RS 4
 Set global variable\.
 .RE
 .PP
-\fBmax_childs\fR
+\fB\-\-max_childs\fR
 .RS 4
 Set the maximum number of events, udevd will handle at the same time\.
 .RE
 .PP
-\fBmax_childs_running\fR
+\fB\-\-max_childs_running\fR
 .RS 4
 Set the maximum number of events, which are allowed to run at the same time\.
 .RE
 .PP
-\fBhelp\fR
+\fB\-\-help\fR
 .RS 4
 Print help text\.
 .RE
-.SS "udevadm monitor"
+.SS "udevadm monitor [options]"
 .PP
 Listens to the kernel uevents and events sent out by a udev rule and prints the devpath of the event to the console\. It can be used to analyze the event timing, by comparing the timestamps of the kernel uevent and the udev event\.
 .PP
@@ -216,7 +221,7 @@ Print the udev event after the rule processing\.
 .RS 4
 Print help text\.
 .RE
-.SS "udevadm test"
+.SS "udevadm test [options] \fIdevpath\fR"
 .PP
 Simulate a udev event run for the given device, and print out debug output\. Unless forced to, no device node or symlink will be created\.
 .PP