summaryrefslogtreecommitdiff
path: root/udev/udevadm.xml
blob: 5996c013838d65f4facca6ba95f3fb2bdc72da5e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
<?xml version='1.0'?>
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
  "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">

<article>
  <section>
    <title>udevadm</title>
    <refentry>
      <refentryinfo>
        <title>udevd</title>
        <date>November 2007</date>
        <productname>udev</productname>
      </refentryinfo>

      <refmeta>
        <refentrytitle>udevadm</refentrytitle>
        <manvolnum>8</manvolnum>
        <refmiscinfo class="version"></refmiscinfo>
      </refmeta>

      <refnamediv>
        <refname>udevadm</refname><refpurpose>udev management tool</refpurpose>
      </refnamediv>

      <refsynopsisdiv>
        <cmdsynopsis>
          <command>udevadm</command>
            <arg><option>--debug</option></arg>
            <arg><option>--version</option></arg>
            <arg><option>--help</option></arg>
        </cmdsynopsis>
        <cmdsynopsis>
          <command>udevadm info <replaceable>options</replaceable></command>
        </cmdsynopsis>
        <cmdsynopsis>
          <command>udevadm trigger <optional>options</optional></command>
        </cmdsynopsis>
        <cmdsynopsis>
          <command>udevadm settle <optional>options</optional></command>
        </cmdsynopsis>
        <cmdsynopsis>
          <command>udevadm control <replaceable>command</replaceable></command>
        </cmdsynopsis>
        <cmdsynopsis>
          <command>udevadm monitor <optional>options</optional></command>
        </cmdsynopsis>
        <cmdsynopsis>
          <command>udevadm test <optional>options</optional> <replaceable>devpath</replaceable></command>
        </cmdsynopsis>
      </refsynopsisdiv>

      <refsect1><title>DESCRIPTION</title>
        <para>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.</para>
      </refsect1>

      <refsect1><title>OPTIONS</title>
        <variablelist>
          <varlistentry>
            <term><option>--debug</option></term>
            <listitem>
              <para>Print debug messages to stderr.</para>
            </listitem>
          </varlistentry>
          <varlistentry>
            <term><option>--version</option></term>
            <listitem>
              <para>Print version number.</para>
            </listitem>
          </varlistentry>
          <varlistentry>
            <term><option>--help</option></term>
            <listitem>
              <para>Print help text.</para>
            </listitem>
          </varlistentry>
        </variablelist>

        <refsect2><title>udevadm info <replaceable>options</replaceable></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>
              <listitem>
                <para>Query the database for specified type of device data. It needs the
                <option>--path</option> or <option>--name</option> to identify the specified
                device. Valid queries are:
                <command>name</command>, <command>symlink</command>, <command>path</command>,
                <command>env</command>, <command>all</command>.</para>
              </listitem>
            </varlistentry>
            <varlistentry>
              <term><option>--path=<replaceable>devpath</replaceable></option></term>
              <listitem>
                <para>The devpath of the device to query.</para>
              </listitem>
            </varlistentry>
            <varlistentry>
              <term><option>--name=<replaceable>file</replaceable></option></term>
              <listitem>
                <para>The name of the device node or a symlink to query</para>
              </listitem>
            </varlistentry>
            <varlistentry>
              <term><option>--root</option></term>
              <listitem>
                <para>The udev root directory: <filename>/dev</filename>. If used in conjunction
                with a <command>name</command> or <command>symlink</command> query, the
                query returns the absolute path including the root directory.</para>
              </listitem>
            </varlistentry>
            <varlistentry>
              <term><option>--attribute-walk</option></term>
              <listitem>
                <para>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.</para>
              </listitem>
            </varlistentry>
            <varlistentry>
              <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>--export-db</option></term>
              <listitem>
                <para>Export the content of the udev database.</para>
              </listitem>
            </varlistentry>
            <varlistentry>
              <term><option>--version</option></term>
              <listitem>
                <para>Print version.</para>
              </listitem>
            </varlistentry>
            <varlistentry>
              <term><option>--help</option></term>
              <listitem>
                <para>Print help text.</para>
              </listitem>
            </varlistentry>
          </variablelist>
        </refsect2>

        <refsect2><title>udevadm trigger <optional>options</optional></title>
          <para>Request device events from the kernel. Usually used to replay events at system coldplug time.</para>
          <variablelist>
            <varlistentry>
              <term><option>--verbose</option></term>
              <listitem>
                <para>Print the list of devices which will be triggered.</para>
              </listitem>
            </varlistentry>
            <varlistentry>
              <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>
              <listitem>
                <para>Trigger a specific type of devices. Valid types are:
                <command>devices</command>, <command>subsystems</command>, <command>failed</command>.
                The default value is <command>devices</command>.</para>
              </listitem>
            </varlistentry>
            <varlistentry>
              <term><option>--action=<replaceable>action</replaceable></option></term>
              <listitem>
                <para>Type of event to be triggered. The default value is <command>add</command>.</para>
              </listitem>
            </varlistentry>
            <varlistentry>
              <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>
              </listitem>
            </varlistentry>
            <varlistentry>
              <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>
              <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>
              </listitem>
            </varlistentry>
            <varlistentry>
              <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>
              </listitem>
            </varlistentry>
          </variablelist>
        </refsect2>

        <refsect2><title>udevadm settle <optional>options</optional></title>
          <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>
              <listitem>
                <para>Maximum number of seconds to wait for the event queue to become empty.
                The default value is 180 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>
              <listitem>
                <para>Wait only for events after the given sequence number.</para>
              </listitem>
            </varlistentry>
            <varlistentry>
              <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>--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>--help</option></term>
              <listitem>
                <para>Print help text.</para>
              </listitem>
            </varlistentry>
          </variablelist>
        </refsect2>

        <refsect2><title>udevadm control <replaceable>command</replaceable></title>
          <para>Modify the internal state of the running udev daemon.</para>
          <variablelist>
            <varlistentry>
              <term><option>--log-priority=<replaceable>value</replaceable></option></term>
              <listitem>
                <para>Set the internal log level of udevd. Valid values are the numerical
                syslog priorities or their textual representations: <option>err</option>,
                <option>info</option> and <option>debug</option>.</para>
              </listitem>
            </varlistentry>
            <varlistentry>
              <term><option>--stop-exec-queue</option></term>
              <listitem>
                <para>Signal udevd to stop executing new events. Incoming events
                will be queued.</para>
              </listitem>
            </varlistentry>
            <varlistentry>
              <term><option>--start-exec-queue</option></term>
              <listitem>
                <para>Signal udevd to enable the execution of events.</para>
              </listitem>
            </varlistentry>
            <varlistentry>
              <term><option>--reload-rules</option></term>
              <listitem>
                <para>Signal udevd to reload the rules files.
                Usually the udev daemon detects changes automatically, this may
                only be needed on systems without inotify support. Reloading rules
                does not apply any changes to already existing devices.</para>
              </listitem>
            </varlistentry>
            <varlistentry>
              <term><option>--env=<replaceable>KEY</replaceable>=<replaceable>value</replaceable></option></term>
              <listitem>
                <para>Set global variable.</para>
              </listitem>
            </varlistentry>
            <varlistentry>
              <term><option>--max-childs=</option><replaceable>value</replaceable></term>
              <listitem>
                <para>Set the maximum number of events, udevd will handle at the
                same time.</para>
              </listitem>
            </varlistentry>
            <varlistentry>
              <term><option>--help</option></term>
              <listitem>
                <para>Print help text.</para>
              </listitem>
            </varlistentry>
          </variablelist>
        </refsect2>

        <refsect2><title>udevadm monitor <optional>options</optional></title>
          <para>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.
          </para>
          <variablelist>
            <varlistentry>
              <term><option>--environment</option></term>
              <listitem>
                <para>Print the complete environment for all events. Can be used to compare the
                kernel supplied and the udev added environment values.</para>
              </listitem>
            </varlistentry>
            <varlistentry>
              <term><option>--kernel</option></term>
              <listitem>
                <para>Print the kernel uevents.</para>
              </listitem>
            </varlistentry>
            <varlistentry>
              <term><option>--udev</option></term>
              <listitem>
                <para>Print the udev event after the rule processing.</para>
              </listitem>
            </varlistentry>
            <varlistentry>
              <term><option>--help</option></term>
              <listitem>
                <para>Print help text.</para>
              </listitem>
            </varlistentry>
          </variablelist>
        </refsect2>

        <refsect2><title>udevadm test <optional>options</optional> <replaceable>devpath</replaceable></title>
          <para>Simulate a udev event run for the given device, and print debug output.</para>
          <variablelist>
            <varlistentry>
              <term><option>--action=<replaceable>string</replaceable></option></term>
              <listitem>
                <para>The action string.</para>
              </listitem>
            </varlistentry>
            <varlistentry>
              <term><option>--subsystem=<replaceable>string</replaceable></option></term>
              <listitem>
                <para>The subsystem string.</para>
              </listitem>
            </varlistentry>
            <varlistentry>
              <term><option>--help</option></term>
              <listitem>
                <para>Print help text.</para>
              </listitem>
            </varlistentry>
          </variablelist>
        </refsect2>
      </refsect1>

      <refsect1><title>AUTHOR</title>
        <para>Written by Kay Sievers <email>kay.sievers@vrfy.org</email>.</para>
      </refsect1>

      <refsect1>
        <title>SEE ALSO</title>
        <para><citerefentry>
            <refentrytitle>udev</refentrytitle><manvolnum>7</manvolnum>
        </citerefentry>
        <citerefentry>
            <refentrytitle>udevd</refentrytitle><manvolnum>8</manvolnum>
        </citerefentry></para>
      </refsect1>
    </refentry>
  </section>
</article>