2 <!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
3 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
11 <date>November 2007</date>
12 <productname>udev</productname>
16 <refentrytitle>udevadm</refentrytitle>
17 <manvolnum>8</manvolnum>
18 <refmiscinfo class="version"></refmiscinfo>
22 <refname>udevadm</refname><refpurpose>udev management tool</refpurpose>
27 <command>udevadm</command>
28 <arg><option>--debug</option></arg>
29 <arg><option>--version</option></arg>
30 <arg><option>--help</option></arg>
33 <command>udevadm info <replaceable>options</replaceable></command>
36 <command>udevadm trigger <optional>options</optional></command>
39 <command>udevadm settle <optional>options</optional></command>
42 <command>udevadm control <replaceable>command</replaceable></command>
45 <command>udevadm monitor <optional>options</optional></command>
48 <command>udevadm test <optional>options</optional> <replaceable>devpath</replaceable></command>
52 <refsect1><title>DESCRIPTION</title>
53 <para>udevadm expects a command and command specific options. It
54 controls the runtime behavior of udev, requests kernel events,
55 manages the event queue, and provides simple debugging mechanisms.</para>
58 <refsect1><title>OPTIONS</title>
61 <term><option>--debug</option></term>
63 <para>Print debug messages to stderr.</para>
67 <term><option>--version</option></term>
69 <para>Print version number.</para>
73 <term><option>--help</option></term>
75 <para>Print help text.</para>
80 <refsect2><title>udevadm info <replaceable>options</replaceable></title>
81 <para>Queries the udev database for device information
82 stored in the udev database. It can also query the properties
83 of a device from its sysfs representation to help creating udev
84 rules that match this device.</para>
87 <term><option>--query=<replaceable>type</replaceable></option></term>
89 <para>Query the database for specified type of device data. It needs the
90 <option>--path</option> or <option>--name</option> to identify the specified
91 device. Valid queries are:
92 <command>name</command>, <command>symlink</command>, <command>path</command>,
93 <command>env</command>, <command>all</command>.</para>
97 <term><option>--path=<replaceable>devpath</replaceable></option></term>
99 <para>The devpath of the device to query.</para>
103 <term><option>--name=<replaceable>file</replaceable></option></term>
105 <para>The name of the device node or a symlink to query</para>
109 <term><option>--root</option></term>
111 <para>The udev root directory: <filename>/dev</filename>. If used in conjunction
112 with a <command>name</command> or <command>symlink</command> query, the
113 query returns the absolute path including the root directory.</para>
117 <term><option>--attribute-walk</option></term>
119 <para>Print all sysfs properties of the specified device that can be used
120 in udev rules to match the specified device. It prints all devices
121 along the chain, up to the root of sysfs that can be used in udev rules.</para>
125 <term><option>--device-id-of-file=<replaceable>file</replaceable></option></term>
127 <para>Print major/minor numbers of the underlying device, where the file
132 <term><option>--export-db</option></term>
134 <para>Export the content of the udev database.</para>
138 <term><option>--version</option></term>
140 <para>Print version.</para>
144 <term><option>--help</option></term>
146 <para>Print help text.</para>
152 <refsect2><title>udevadm trigger <optional>options</optional></title>
153 <para>Request device uevents, usually used to replay events at system coldplug.</para>
156 <term><option>--verbose</option></term>
158 <para>Print the list of devices which will be triggered.</para>
162 <term><option>--dry-run</option></term>
164 <para>Do not actually trigger the event.</para>
168 <term><option>--retry-failed</option></term>
170 <para>Trigger only the events which are failed during a previous run.</para>
174 <term><option>--action=<replaceable>action</replaceable></option></term>
176 <para>Type of event to be triggered. The default value is "add".</para>
180 <term><option>--subsystem-match=<replaceable>subsystem</replaceable></option></term>
182 <para>Trigger events for devices which belong to a matching subsystem. This option
183 can be specified multiple times and supports shell style pattern matching.</para>
187 <term><option>--subsystem-nomatch=<replaceable>subsystem</replaceable></option></term>
189 <para>Do not trigger events for devices which belong to a matching subsystem. This option
190 can be specified multiple times and supports shell style pattern matching.</para>
194 <term><option>--attr-match=<replaceable>attribute</replaceable>=<replaceable>value</replaceable></option></term>
196 <para>Trigger events for devices with a matching sysfs attribute. If a value is specified
197 along with the attribute name, the content of the attribute is matched against the given
198 value using shell style pattern matching. If no value is specified, the existence of the
199 sysfs attribute is checked. This option can be specified multiple times.</para>
203 <term><option>--attr-nomatch=<replaceable>attribute</replaceable>=<replaceable>value</replaceable></option></term>
205 <para>Do not trigger events for devices with a matching sysfs attribute. If a value is
206 specified along with the attribute name, the content of the attribute is matched against
207 the given value using shell style pattern matching. If no value is specified, the existence
208 of the sysfs attribute is checked. This option can be specified multiple times.</para>
212 <term><option>--socket=<replaceable>path</replaceable></option></term>
214 <para>Pass the synthesized events to the specified socket, instead of triggering
215 a global kernel event. All available event values will be send in the same format
216 the kernel sends an uevent, or <option>RUN+="socket:<replaceable>path</replaceable>"</option>
217 sends a message. If the first character of the specified path is an @ character,
218 an abstract namespace socket is used, instead of an existing socket file.</para>
222 <term><option>--env=<replaceable>KEY</replaceable>=<replaceable>value</replaceable></option></term>
224 <para>Pass an additional environemt key to the event. This works only with the
225 --socket option.</para>
231 <refsect2><title>udevadm settle <optional>options</optional></title>
232 <para>Watches the udev event queue, and exits if all current events are handled.</para>
235 <term><option>--timeout=<replaceable>seconds</replaceable></option></term>
237 <para>Maximum number of seconds to wait for the event queue to become empty.
238 The default value is 180 seconds.</para>
242 <term><option>--help</option></term>
244 <para>Print help text.</para>
250 <refsect2><title>udevadm control <replaceable>command</replaceable></title>
251 <para>Modify the internal state of the running udev daemon.</para>
254 <term><option>--log-priority=<replaceable>value</replaceable></option></term>
256 <para>Set the internal log level of udevd. Valid values are the numerical
257 syslog priorities or their textual representations: <option>err</option>,
258 <option>info</option> and <option>debug</option>.</para>
262 <term><option>--stop-exec-queue</option></term>
264 <para>Signal udevd to stop executing new events. Incoming events
265 will be queued.</para>
269 <term><option>--start-exec-queue</option></term>
271 <para>Signal udevd to enable the execution of events.</para>
275 <term><option>--reload-rules</option></term>
277 <para>Signal udevd to reload the rules from the config.</para>
281 <term><option>--env=<replaceable>KEY</replaceable>=<replaceable>value</replaceable></option></term>
283 <para>Set global variable.</para>
287 <term><option>--max-childs=</option><replaceable>value</replaceable></term>
289 <para>Set the maximum number of events, udevd will handle at the
294 <term><option>--help</option></term>
296 <para>Print help text.</para>
302 <refsect2><title>udevadm monitor <optional>options</optional></title>
303 <para>Listens to the kernel uevents and events sent out by a udev rule
304 and prints the devpath of the event to the console. It can be used to analyze the
305 event timing, by comparing the timestamps of the kernel uevent and the udev event.
309 <term><option>--environment</option></term>
311 <para>Print the complete environment for all events. Can be used to compare the
312 kernel supplied and the udev added environment values.</para>
316 <term><option>--kernel</option></term>
318 <para>Print the kernel uevents.</para>
322 <term><option>--udev</option></term>
324 <para>Print the udev event after the rule processing.</para>
328 <term><option>--help</option></term>
330 <para>Print help text.</para>
336 <refsect2><title>udevadm test <optional>options</optional> <replaceable>devpath</replaceable></title>
337 <para>Simulate a udev event run for the given device, and print out debug
338 output. Unless forced to, no device node or symlink will be created.</para>
341 <term><option>--action=<replaceable>string</replaceable></option></term>
343 <para>The action string.</para>
347 <term><option>--subsystem=<replaceable>string</replaceable></option></term>
349 <para>The subsystem string.</para>
353 <term><option>--force</option></term>
355 <para>Force the creation of a device node or symlink. Usually the test run
356 prints only debug output.</para>
360 <term><option>--help</option></term>
362 <para>Print help text.</para>
369 <refsect1><title>AUTHOR</title>
370 <para>Written by Kay Sievers <email>kay.sievers@vrfy.org</email>.</para>
374 <title>SEE ALSO</title>
376 <refentrytitle>udev</refentrytitle><manvolnum>7</manvolnum>
379 <refentrytitle>udevd</refentrytitle><manvolnum>8</manvolnum>
380 </citerefentry></para>