chiark / gitweb /
move syslog wrapper to libudev
[elogind.git] / udev / udevadm.xml
1 <?xml version='1.0'?>
2 <!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
3   "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
4
5 <article>
6   <section>
7     <title>udevadm</title>
8     <refentry>
9       <refentryinfo>
10         <title>udevd</title>
11         <date>November 2007</date>
12         <productname>udev</productname>
13       </refentryinfo>
14
15       <refmeta>
16         <refentrytitle>udevadm</refentrytitle>
17         <manvolnum>8</manvolnum>
18         <refmiscinfo class="version"></refmiscinfo>
19       </refmeta>
20
21       <refnamediv>
22         <refname>udevadm</refname><refpurpose>udev management tool</refpurpose>
23       </refnamediv>
24
25       <refsynopsisdiv>
26         <cmdsynopsis>
27           <command>udevadm</command>
28             <arg><option>--debug</option></arg>
29             <arg><option>--version</option></arg>
30             <arg><option>--help</option></arg>
31         </cmdsynopsis>
32         <cmdsynopsis>
33           <command>udevadm info <replaceable>options</replaceable></command>
34         </cmdsynopsis>
35         <cmdsynopsis>
36           <command>udevadm trigger <optional>options</optional></command>
37         </cmdsynopsis>
38         <cmdsynopsis>
39           <command>udevadm settle <optional>options</optional></command>
40         </cmdsynopsis>
41         <cmdsynopsis>
42           <command>udevadm control <replaceable>command</replaceable></command>
43         </cmdsynopsis>
44         <cmdsynopsis>
45           <command>udevadm monitor <optional>options</optional></command>
46         </cmdsynopsis>
47         <cmdsynopsis>
48           <command>udevadm test <optional>options</optional> <replaceable>devpath</replaceable></command>
49         </cmdsynopsis>
50       </refsynopsisdiv>
51
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>
56       </refsect1>
57
58       <refsect1><title>OPTIONS</title>
59         <variablelist>
60           <varlistentry>
61             <term><option>--debug</option></term>
62             <listitem>
63               <para>Print debug messages to stderr.</para>
64             </listitem>
65           </varlistentry>
66           <varlistentry>
67             <term><option>--version</option></term>
68             <listitem>
69               <para>Print version number.</para>
70             </listitem>
71           </varlistentry>
72           <varlistentry>
73             <term><option>--help</option></term>
74             <listitem>
75               <para>Print help text.</para>
76             </listitem>
77           </varlistentry>
78         </variablelist>
79
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>
85           <variablelist>
86             <varlistentry>
87               <term><option>--query=<replaceable>type</replaceable></option></term>
88               <listitem>
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>property</command>, <command>all</command>.</para>
94               </listitem>
95             </varlistentry>
96             <varlistentry>
97               <term><option>--path=<replaceable>devpath</replaceable></option></term>
98               <listitem>
99                 <para>The devpath of the device to query.</para>
100               </listitem>
101             </varlistentry>
102             <varlistentry>
103               <term><option>--name=<replaceable>file</replaceable></option></term>
104               <listitem>
105                 <para>The name of the device node or a symlink to query</para>
106               </listitem>
107             </varlistentry>
108             <varlistentry>
109               <term><option>--root</option></term>
110               <listitem>
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>
114               </listitem>
115             </varlistentry>
116             <varlistentry>
117               <term><option>--attribute-walk</option></term>
118               <listitem>
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>
122               </listitem>
123             </varlistentry>
124             <varlistentry>
125               <term><option>--device-id-of-file=<replaceable>file</replaceable></option></term>
126               <listitem>
127                 <para>Print major/minor numbers of the underlying device, where the file
128                 lives on.</para>
129               </listitem>
130             </varlistentry>
131             <varlistentry>
132               <term><option>--export-db</option></term>
133               <listitem>
134                 <para>Export the content of the udev database.</para>
135               </listitem>
136             </varlistentry>
137             <varlistentry>
138               <term><option>--version</option></term>
139               <listitem>
140                 <para>Print version.</para>
141               </listitem>
142             </varlistentry>
143             <varlistentry>
144               <term><option>--help</option></term>
145               <listitem>
146                 <para>Print help text.</para>
147               </listitem>
148             </varlistentry>
149           </variablelist>
150         </refsect2>
151
152         <refsect2><title>udevadm trigger <optional>options</optional></title>
153           <para>Request device events from the kernel. Usually used to replay events at system coldplug time.</para>
154           <variablelist>
155             <varlistentry>
156               <term><option>--verbose</option></term>
157               <listitem>
158                 <para>Print the list of devices which will be triggered.</para>
159               </listitem>
160             </varlistentry>
161             <varlistentry>
162               <term><option>--dry-run</option></term>
163               <listitem>
164                 <para>Do not actually trigger the event.</para>
165               </listitem>
166             </varlistentry>
167             <varlistentry>
168               <term><option>--type=<replaceable>type</replaceable></option></term>
169               <listitem>
170                 <para>Trigger a specific type of devices. Valid types are:
171                 <command>devices</command>, <command>subsystems</command>, <command>failed</command>.
172                 The default value is <command>devices</command>.</para>
173               </listitem>
174             </varlistentry>
175             <varlistentry>
176               <term><option>--action=<replaceable>action</replaceable></option></term>
177               <listitem>
178                 <para>Type of event to be triggered. The default value is <command>add</command>.</para>
179               </listitem>
180             </varlistentry>
181             <varlistentry>
182               <term><option>--subsystem-match=<replaceable>subsystem</replaceable></option></term>
183               <listitem>
184                 <para>Trigger events for devices which belong to a matching subsystem. This option
185                 can be specified multiple times and supports shell style pattern matching.</para>
186               </listitem>
187             </varlistentry>
188             <varlistentry>
189               <term><option>--subsystem-nomatch=<replaceable>subsystem</replaceable></option></term>
190               <listitem>
191                 <para>Do not trigger events for devices which belong to a matching subsystem. This option
192                 can be specified multiple times and supports shell style pattern matching.</para>
193               </listitem>
194             </varlistentry>
195             <varlistentry>
196               <term><option>--attr-match=<replaceable>attribute</replaceable>=<replaceable>value</replaceable></option></term>
197               <listitem>
198                 <para>Trigger events for devices with a matching sysfs attribute. If a value is specified
199                 along with the attribute name, the content of the attribute is matched against the given
200                 value using shell style pattern matching. If no value is specified, the existence of the
201                 sysfs attribute is checked. This option can be specified multiple times.</para>
202               </listitem>
203             </varlistentry>
204             <varlistentry>
205               <term><option>--attr-nomatch=<replaceable>attribute</replaceable>=<replaceable>value</replaceable></option></term>
206               <listitem>
207                 <para>Do not trigger events for devices with a matching sysfs attribute. If a value is
208                 specified along with the attribute name, the content of the attribute is matched against
209                 the given value using shell style pattern matching. If no value is specified, the existence
210                 of the sysfs attribute is checked. This option can be specified multiple times.</para>
211               </listitem>
212             </varlistentry>
213             <varlistentry>
214               <term><option>--property-match=<replaceable>property</replaceable>=<replaceable>value</replaceable></option></term>
215               <listitem>
216                 <para>Trigger events for devices with a matching property value. This option can be
217                 specified multiple times and supports shell style pattern matching.</para>
218               </listitem>
219             </varlistentry>
220           </variablelist>
221         </refsect2>
222
223         <refsect2><title>udevadm settle <optional>options</optional></title>
224           <para>Watches the udev event queue, and exits if all current events are handled.</para>
225           <variablelist>
226             <varlistentry>
227               <term><option>--timeout=<replaceable>seconds</replaceable></option></term>
228               <listitem>
229                 <para>Maximum number of seconds to wait for the event queue to become empty.
230                 The default value is 180 seconds. A value of 0 will check if the queue is empty
231                 and always return immediately.</para>
232               </listitem>
233             </varlistentry>
234             <varlistentry>
235               <term><option>--seq-start=<replaceable>seqnum</replaceable></option></term>
236               <listitem>
237                 <para>Wait only for events after the given sequence number.</para>
238               </listitem>
239             </varlistentry>
240             <varlistentry>
241               <term><option>--seq-end=<replaceable>seqnum</replaceable></option></term>
242               <listitem>
243                 <para>Wait only for events before the given sequence number.</para>
244               </listitem>
245             </varlistentry>
246             <varlistentry>
247               <term><option>--exit-if-exists=<replaceable>file</replaceable></option></term>
248               <listitem>
249                 <para>Stop waiting if file exists.</para>
250               </listitem>
251             </varlistentry>
252             <varlistentry>
253               <term><option>--quiet</option></term>
254               <listitem>
255                 <para>Do not print any output, like the remaining queue entries when reaching the timeout.</para>
256               </listitem>
257             </varlistentry>
258             <varlistentry>
259               <term><option>--help</option></term>
260               <listitem>
261                 <para>Print help text.</para>
262               </listitem>
263             </varlistentry>
264           </variablelist>
265         </refsect2>
266
267         <refsect2><title>udevadm control <replaceable>command</replaceable></title>
268           <para>Modify the internal state of the running udev daemon.</para>
269           <variablelist>
270             <varlistentry>
271               <term><option>--log-priority=<replaceable>value</replaceable></option></term>
272               <listitem>
273                 <para>Set the internal log level of udevd. Valid values are the numerical
274                 syslog priorities or their textual representations: <option>err</option>,
275                 <option>info</option> and <option>debug</option>.</para>
276               </listitem>
277             </varlistentry>
278             <varlistentry>
279               <term><option>--stop-exec-queue</option></term>
280               <listitem>
281                 <para>Signal udevd to stop executing new events. Incoming events
282                 will be queued.</para>
283               </listitem>
284             </varlistentry>
285             <varlistentry>
286               <term><option>--start-exec-queue</option></term>
287               <listitem>
288                 <para>Signal udevd to enable the execution of events.</para>
289               </listitem>
290             </varlistentry>
291             <varlistentry>
292               <term><option>--reload-rules</option></term>
293               <listitem>
294                 <para>Signal udevd to reload the rules files.
295                 The udev daemon detects changes automatically, this option is
296                 usually not needed. Reloading rules does not apply any changes
297                 to already existing devices.</para>
298               </listitem>
299             </varlistentry>
300             <varlistentry>
301               <term><option>--property=<replaceable>KEY</replaceable>=<replaceable>value</replaceable></option></term>
302               <listitem>
303                 <para>Set a global property for all events.</para>
304               </listitem>
305             </varlistentry>
306             <varlistentry>
307               <term><option>--max-childs=</option><replaceable>value</replaceable></term>
308               <listitem>
309                 <para>Set the maximum number of events, udevd will handle at the
310                 same time.</para>
311               </listitem>
312             </varlistentry>
313             <varlistentry>
314               <term><option>--help</option></term>
315               <listitem>
316                 <para>Print help text.</para>
317               </listitem>
318             </varlistentry>
319           </variablelist>
320         </refsect2>
321
322         <refsect2><title>udevadm monitor <optional>options</optional></title>
323           <para>Listens to the kernel uevents and events sent out by a udev rule
324           and prints the devpath of the event to the console. It can be used to analyze the
325           event timing, by comparing the timestamps of the kernel uevent and the udev event.
326           </para>
327           <variablelist>
328             <varlistentry>
329               <term><option>--kernel</option></term>
330               <listitem>
331                 <para>Print the kernel uevents.</para>
332               </listitem>
333             </varlistentry>
334             <varlistentry>
335               <term><option>--udev</option></term>
336               <listitem>
337                 <para>Print the udev event after the rule processing.</para>
338               </listitem>
339             </varlistentry>
340             <varlistentry>
341               <term><option>--property</option></term>
342               <listitem>
343                 <para>Also print the properties of the event.</para>
344               </listitem>
345             </varlistentry>
346             <varlistentry>
347               <term><option>--help</option></term>
348               <listitem>
349                 <para>Print help text.</para>
350               </listitem>
351             </varlistentry>
352           </variablelist>
353         </refsect2>
354
355         <refsect2><title>udevadm test <optional>options</optional> <replaceable>devpath</replaceable></title>
356           <para>Simulate a udev event run for the given device, and print debug output.</para>
357           <variablelist>
358             <varlistentry>
359               <term><option>--action=<replaceable>string</replaceable></option></term>
360               <listitem>
361                 <para>The action string.</para>
362               </listitem>
363             </varlistentry>
364             <varlistentry>
365               <term><option>--subsystem=<replaceable>string</replaceable></option></term>
366               <listitem>
367                 <para>The subsystem string.</para>
368               </listitem>
369             </varlistentry>
370             <varlistentry>
371               <term><option>--help</option></term>
372               <listitem>
373                 <para>Print help text.</para>
374               </listitem>
375             </varlistentry>
376           </variablelist>
377         </refsect2>
378       </refsect1>
379
380       <refsect1><title>AUTHOR</title>
381         <para>Written by Kay Sievers <email>kay.sievers@vrfy.org</email>.</para>
382       </refsect1>
383
384       <refsect1>
385         <title>SEE ALSO</title>
386         <para><citerefentry>
387             <refentrytitle>udev</refentrytitle><manvolnum>7</manvolnum>
388         </citerefentry>
389         <citerefentry>
390             <refentrytitle>udevd</refentrytitle><manvolnum>8</manvolnum>
391         </citerefentry></para>
392       </refsect1>
393     </refentry>
394   </section>
395 </article>