]>
Commit | Line | Data |
---|---|---|
514094f9 | 1 | <?xml version='1.0'?> |
3a54a157 | 2 | <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" |
12b42c76 | 3 | "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> |
db9ecf05 | 4 | <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> |
f48f7543 | 5 | |
c94c581c YW |
6 | <refentry id="udevadm" |
7 | xmlns:xi="http://www.w3.org/2001/XInclude"> | |
8 | ||
63749b1a | 9 | <refentryinfo> |
225cb03b | 10 | <title>udevadm</title> |
d3a2386d | 11 | <productname>systemd</productname> |
63749b1a | 12 | </refentryinfo> |
225cb03b | 13 | |
63749b1a KS |
14 | <refmeta> |
15 | <refentrytitle>udevadm</refentrytitle> | |
16 | <manvolnum>8</manvolnum> | |
63749b1a | 17 | </refmeta> |
225cb03b | 18 | |
63749b1a KS |
19 | <refnamediv> |
20 | <refname>udevadm</refname><refpurpose>udev management tool</refpurpose> | |
21 | </refnamediv> | |
225cb03b | 22 | |
63749b1a KS |
23 | <refsynopsisdiv> |
24 | <cmdsynopsis> | |
25 | <command>udevadm</command> | |
26 | <arg><option>--debug</option></arg> | |
27 | <arg><option>--version</option></arg> | |
28 | <arg><option>--help</option></arg> | |
29 | </cmdsynopsis> | |
30 | <cmdsynopsis> | |
c94c581c | 31 | <command>udevadm info <optional>options</optional> <optional>devpath</optional></command> |
63749b1a KS |
32 | </cmdsynopsis> |
33 | <cmdsynopsis> | |
c94c581c | 34 | <command>udevadm trigger <optional>options</optional> <optional>devpath</optional></command> |
63749b1a KS |
35 | </cmdsynopsis> |
36 | <cmdsynopsis> | |
37 | <command>udevadm settle <optional>options</optional></command> | |
38 | </cmdsynopsis> | |
39 | <cmdsynopsis> | |
c94c581c | 40 | <command>udevadm control <replaceable>option</replaceable></command> |
63749b1a KS |
41 | </cmdsynopsis> |
42 | <cmdsynopsis> | |
43 | <command>udevadm monitor <optional>options</optional></command> | |
44 | </cmdsynopsis> | |
45 | <cmdsynopsis> | |
46 | <command>udevadm test <optional>options</optional> <replaceable>devpath</replaceable></command> | |
47 | </cmdsynopsis> | |
d7867b31 KS |
48 | <cmdsynopsis> |
49 | <command>udevadm test-builtin <optional>options</optional> <replaceable>command</replaceable> <replaceable>devpath</replaceable></command> | |
50 | </cmdsynopsis> | |
63749b1a | 51 | </refsynopsisdiv> |
225cb03b | 52 | |
63749b1a | 53 | <refsect1><title>Description</title> |
124b48b0 ZJS |
54 | <para><command>udevadm</command> expects a command and command |
55 | specific options. It controls the runtime behavior of | |
56 | <command>systemd-udevd</command>, requests kernel events, manages | |
57 | the event queue, and provides simple debugging mechanisms.</para> | |
63749b1a | 58 | </refsect1> |
225cb03b | 59 | |
80877656 | 60 | <refsect1><title>Options</title> |
63749b1a KS |
61 | <variablelist> |
62 | <varlistentry> | |
c94c581c | 63 | <term><option>-d</option></term> |
63749b1a KS |
64 | <term><option>--debug</option></term> |
65 | <listitem> | |
35a44646 YW |
66 | <para>Print debug messages to standard error. This option is implied in <command>udevadm test</command> and |
67 | <command>udevadm test-builtin</command> commands.</para> | |
63749b1a KS |
68 | </listitem> |
69 | </varlistentry> | |
c94c581c | 70 | |
c94c581c | 71 | <xi:include href="standard-options.xml" xpointer="help" /> |
63749b1a | 72 | </variablelist> |
225cb03b | 73 | |
80877656 ZJS |
74 | <refsect2><title>udevadm info |
75 | <arg choice="opt"><replaceable>options</replaceable></arg> | |
3c79311a | 76 | <arg choice="opt" rep="repeat"><replaceable>devpath</replaceable>|<replaceable>file</replaceable>|<replaceable>unit</replaceable></arg> |
80877656 ZJS |
77 | </title> |
78 | ||
b6854081 ZJS |
79 | <para>Query the udev database for device information.</para> |
80 | ||
3c79311a ZJS |
81 | <para>Positional arguments should be used to specify one or more devices. Each one may be a device name |
82 | (in which case it must start with <filename>/dev/</filename>), a sys path (in which case it must start | |
83 | with <filename>/sys/</filename>), or a systemd device unit name (in which case it must end with | |
b6854081 ZJS |
84 | <literal>.device</literal>, see |
85 | <citerefentry><refentrytitle>systemd.device</refentrytitle><manvolnum>5</manvolnum></citerefentry>). | |
86 | </para> | |
87 | ||
63749b1a KS |
88 | <variablelist> |
89 | <varlistentry> | |
7643ac9a ZJS |
90 | <term><option>-q</option></term> |
91 | <term><option>--query=<replaceable>TYPE</replaceable></option></term> | |
63749b1a | 92 | <listitem> |
b6854081 | 93 | <para>Query the database for the specified type of device data. |
7643ac9a ZJS |
94 | Valid <replaceable>TYPE</replaceable>s are: |
95 | <constant>name</constant>, <constant>symlink</constant>, | |
96 | <constant>path</constant>, <constant>property</constant>, | |
124b48b0 | 97 | <constant>all</constant>.</para> |
63749b1a KS |
98 | </listitem> |
99 | </varlistentry> | |
b6854081 | 100 | |
63749b1a | 101 | <varlistentry> |
7643ac9a ZJS |
102 | <term><option>-p</option></term> |
103 | <term><option>--path=<replaceable>DEVPATH</replaceable></option></term> | |
63749b1a | 104 | <listitem> |
3b121157 ZJS |
105 | <para>The <filename>/sys/</filename> path of the device to query, e.g. |
106 | <filename><optional>/sys/</optional>/class/block/sda</filename>. This option is an alternative to | |
b6854081 ZJS |
107 | the positional argument with a <filename>/sys/</filename> prefix. <command>udevadm info |
108 | --path=/class/block/sda</command> is equivalent to <command>udevadm info | |
109 | /sys/class/block/sda</command>.</para> | |
63749b1a KS |
110 | </listitem> |
111 | </varlistentry> | |
112 | <varlistentry> | |
7643ac9a ZJS |
113 | <term><option>-n</option></term> |
114 | <term><option>--name=<replaceable>FILE</replaceable></option></term> | |
63749b1a | 115 | <listitem> |
124b48b0 | 116 | <para>The name of the device node or a symlink to query, |
3b121157 | 117 | e.g. <filename><optional>/dev/</optional>/sda</filename>. This option is an alternative to the |
b6854081 ZJS |
118 | positional argument with a <filename>/dev/</filename> prefix. <command>udevadm info |
119 | --name=sda</command> is equivalent to <command>udevadm info /dev/sda</command>.</para> | |
63749b1a KS |
120 | </listitem> |
121 | </varlistentry> | |
122 | <varlistentry> | |
7643ac9a | 123 | <term><option>-r</option></term> |
63749b1a KS |
124 | <term><option>--root</option></term> |
125 | <listitem> | |
4f5d327a KS |
126 | <para>Print absolute paths in <command>name</command> or <command>symlink</command> |
127 | query.</para> | |
4ec9c3e7 KS |
128 | </listitem> |
129 | </varlistentry> | |
63749b1a | 130 | <varlistentry> |
7643ac9a | 131 | <term><option>-a</option></term> |
63749b1a KS |
132 | <term><option>--attribute-walk</option></term> |
133 | <listitem> | |
134 | <para>Print all sysfs properties of the specified device that can be used | |
135 | in udev rules to match the specified device. It prints all devices | |
136 | along the chain, up to the root of sysfs that can be used in udev rules.</para> | |
137 | </listitem> | |
138 | </varlistentry> | |
dc1791a9 | 139 | <varlistentry> |
7643ac9a | 140 | <term><option>-x</option></term> |
dc1791a9 KS |
141 | <term><option>--export</option></term> |
142 | <listitem> | |
f0c29bbf YW |
143 | <para>Print output as key/value pairs. Values are enclosed in single quotes. |
144 | This takes effects only when <option>--query=property</option> or | |
145 | <option>--device-id-of-file=<replaceable>FILE</replaceable></option> is specified.</para> | |
dc1791a9 KS |
146 | </listitem> |
147 | </varlistentry> | |
148 | <varlistentry> | |
7643ac9a ZJS |
149 | <term><option>-P</option></term> |
150 | <term><option>--export-prefix=<replaceable>NAME</replaceable></option></term> | |
dc1791a9 | 151 | <listitem> |
f0c29bbf YW |
152 | <para>Add a prefix to the key name of exported values. |
153 | This implies <option>--export</option>.</para> | |
dc1791a9 KS |
154 | </listitem> |
155 | </varlistentry> | |
63749b1a | 156 | <varlistentry> |
7643ac9a ZJS |
157 | <term><option>-d</option></term> |
158 | <term><option>--device-id-of-file=<replaceable>FILE</replaceable></option></term> | |
63749b1a | 159 | <listitem> |
f0c29bbf YW |
160 | <para>Print major/minor numbers of the underlying device, where the file lives on. |
161 | If this is specified, all positional arguments are ignored.</para> | |
63749b1a KS |
162 | </listitem> |
163 | </varlistentry> | |
164 | <varlistentry> | |
7643ac9a | 165 | <term><option>-e</option></term> |
63749b1a KS |
166 | <term><option>--export-db</option></term> |
167 | <listitem> | |
168 | <para>Export the content of the udev database.</para> | |
169 | </listitem> | |
170 | </varlistentry> | |
9ead6627 | 171 | <varlistentry> |
7643ac9a | 172 | <term><option>-c</option></term> |
9ead6627 KS |
173 | <term><option>--cleanup-db</option></term> |
174 | <listitem> | |
175 | <para>Cleanup the udev database.</para> | |
176 | </listitem> | |
177 | </varlistentry> | |
ae760f4b YW |
178 | <varlistentry> |
179 | <term><option>-w<optional>SECONDS</optional></option></term> | |
180 | <term><option>--wait-for-initialization<optional>=SECONDS</optional></option></term> | |
181 | <listitem> | |
182 | <para>Wait for device to be initialized. If argument <replaceable>SECONDS</replaceable> | |
183 | is not specified, the default is to wait forever.</para> | |
184 | </listitem> | |
185 | </varlistentry> | |
c94c581c | 186 | |
c94c581c | 187 | <xi:include href="standard-options.xml" xpointer="help" /> |
63749b1a KS |
188 | </variablelist> |
189 | </refsect2> | |
225cb03b | 190 | |
80877656 ZJS |
191 | <refsect2><title>udevadm trigger |
192 | <arg choice="opt"><replaceable>options</replaceable></arg> | |
a9bc94e5 | 193 | <arg choice="opt"><replaceable>devpath</replaceable>|<replaceable>file</replaceable>|<replaceable>unit</replaceable></arg> |
b6854081 | 194 | </title> |
63749b1a | 195 | <para>Request device events from the kernel. Primarily used to replay events at system coldplug time.</para> |
b6854081 | 196 | |
5b3b0733 | 197 | <para>Takes device specifications as positional arguments. See the description of <command>info</command> |
b6854081 ZJS |
198 | above.</para> |
199 | ||
63749b1a KS |
200 | <variablelist> |
201 | <varlistentry> | |
7643ac9a | 202 | <term><option>-v</option></term> |
63749b1a KS |
203 | <term><option>--verbose</option></term> |
204 | <listitem> | |
205 | <para>Print the list of devices which will be triggered.</para> | |
206 | </listitem> | |
207 | </varlistentry> | |
208 | <varlistentry> | |
7643ac9a | 209 | <term><option>-n</option></term> |
63749b1a KS |
210 | <term><option>--dry-run</option></term> |
211 | <listitem> | |
212 | <para>Do not actually trigger the event.</para> | |
213 | </listitem> | |
214 | </varlistentry> | |
6c99c265 YW |
215 | <varlistentry> |
216 | <term><option>-q</option></term> | |
217 | <term><option>--quiet</option></term> | |
218 | <listitem> | |
219 | <para>Suppress error logging in triggering events.</para> | |
220 | </listitem> | |
221 | </varlistentry> | |
63749b1a | 222 | <varlistentry> |
7643ac9a ZJS |
223 | <term><option>-t</option></term> |
224 | <term><option>--type=<replaceable>TYPE</replaceable></option></term> | |
63749b1a KS |
225 | <listitem> |
226 | <para>Trigger a specific type of devices. Valid types are: | |
864fde8a | 227 | <command>devices</command>, <command>subsystems</command>. |
63749b1a KS |
228 | The default value is <command>devices</command>.</para> |
229 | </listitem> | |
230 | </varlistentry> | |
231 | <varlistentry> | |
7643ac9a ZJS |
232 | <term><option>-c</option></term> |
233 | <term><option>--action=<replaceable>ACTION</replaceable></option></term> | |
63749b1a | 234 | <listitem> |
cd648ae1 YW |
235 | <para>Type of event to be triggered. Possible actions are <literal>add</literal>, |
236 | <literal>remove</literal>, <literal>change</literal>, <literal>move</literal>, | |
237 | <literal>online</literal>, <literal>offline</literal>, <literal>bind</literal>, | |
6d22bd87 YW |
238 | and <literal>unbind</literal>. Also, the special value <literal>help</literal> can be used |
239 | to list the possible actions. The default value is <literal>change</literal>. | |
240 | </para> | |
63749b1a KS |
241 | </listitem> |
242 | </varlistentry> | |
243 | <varlistentry> | |
7643ac9a ZJS |
244 | <term><option>-s</option></term> |
245 | <term><option>--subsystem-match=<replaceable>SUBSYSTEM</replaceable></option></term> | |
63749b1a | 246 | <listitem> |
7643ac9a | 247 | <para>Trigger events for devices which belong to a |
a9bc94e5 YW |
248 | matching subsystem. This option supports shell style pattern matching. |
249 | When this option is specified more than once, then each matching result is ORed, that is, | |
250 | all the devices in each subsystem are triggered.</para> | |
63749b1a KS |
251 | </listitem> |
252 | </varlistentry> | |
253 | <varlistentry> | |
7643ac9a ZJS |
254 | <term><option>-S</option></term> |
255 | <term><option>--subsystem-nomatch=<replaceable>SUBSYSTEM</replaceable></option></term> | |
63749b1a KS |
256 | <listitem> |
257 | <para>Do not trigger events for devices which belong to a matching subsystem. This option | |
a9bc94e5 YW |
258 | supports shell style pattern matching. When this option is specified more than once, |
259 | then each matching result is ANDed, that is, devices which do not match all specified | |
260 | subsystems are triggered.</para> | |
63749b1a KS |
261 | </listitem> |
262 | </varlistentry> | |
263 | <varlistentry> | |
7643ac9a ZJS |
264 | <term><option>-a</option></term> |
265 | <term><option>--attr-match=<replaceable>ATTRIBUTE</replaceable>=<replaceable>VALUE</replaceable></option></term> | |
63749b1a | 266 | <listitem> |
a9bc94e5 YW |
267 | <para>Trigger events for devices with a matching sysfs attribute. If a value is specified along |
268 | with the attribute name, the content of the attribute is matched against the given value using | |
269 | shell style pattern matching. If no value is specified, the existence of the sysfs attribute is | |
270 | checked. When this option is specified multiple times, then each matching result is ANDed, | |
271 | that is, only devices which have all specified attributes are triggered.</para> | |
63749b1a KS |
272 | </listitem> |
273 | </varlistentry> | |
274 | <varlistentry> | |
7643ac9a ZJS |
275 | <term><option>-A</option></term> |
276 | <term><option>--attr-nomatch=<replaceable>ATTRIBUTE</replaceable>=<replaceable>VALUE</replaceable></option></term> | |
63749b1a | 277 | <listitem> |
a9bc94e5 YW |
278 | <para>Do not trigger events for devices with a matching sysfs attribute. If a value is specified |
279 | along with the attribute name, the content of the attribute is matched against the given value | |
280 | using shell style pattern matching. If no value is specified, the existence of the sysfs attribute | |
281 | is checked. When this option is specified multiple times, then each matching result is ANDed, | |
282 | that is, only devices which have none of the specified attributes are triggered.</para> | |
63749b1a KS |
283 | </listitem> |
284 | </varlistentry> | |
285 | <varlistentry> | |
7643ac9a ZJS |
286 | <term><option>-p</option></term> |
287 | <term><option>--property-match=<replaceable>PROPERTY</replaceable>=<replaceable>VALUE</replaceable></option></term> | |
63749b1a | 288 | <listitem> |
a9bc94e5 YW |
289 | <para>Trigger events for devices with a matching property value. This option supports shell style |
290 | pattern matching. When this option is specified more than once, then each matching result is ORed, | |
291 | that is, devices which have one of the specified properties are triggered.</para> | |
63749b1a KS |
292 | </listitem> |
293 | </varlistentry> | |
294 | <varlistentry> | |
7643ac9a ZJS |
295 | <term><option>-g</option></term> |
296 | <term><option>--tag-match=<replaceable>PROPERTY</replaceable></option></term> | |
63749b1a | 297 | <listitem> |
a9bc94e5 YW |
298 | <para>Trigger events for devices with a matching tag. When this option is specified multiple times, |
299 | then each matching result is ANDed, that is, devices which have all specified tags are triggered.</para> | |
63749b1a KS |
300 | </listitem> |
301 | </varlistentry> | |
302 | <varlistentry> | |
7643ac9a | 303 | <term><option>-y</option></term> |
a9bc94e5 | 304 | <term><option>--sysname-match=<replaceable>NAME</replaceable></option></term> |
63749b1a | 305 | <listitem> |
a9bc94e5 | 306 | <para>Trigger events for devices for which the last component (i.e. the filename) of the |
3b121157 | 307 | <filename>/sys/</filename> path matches the specified <replaceable>PATH</replaceable>. This option |
a9bc94e5 YW |
308 | supports shell style pattern matching. When this option is specified more than once, then each |
309 | matching result is ORed, that is, all devices which have any of the specified | |
310 | <replaceable>NAME</replaceable> are triggered.</para> | |
63749b1a KS |
311 | </listitem> |
312 | </varlistentry> | |
80877656 ZJS |
313 | <varlistentry> |
314 | <term><option>--name-match=<replaceable>NAME</replaceable></option></term> | |
315 | <listitem> | |
a9bc94e5 | 316 | <para>Trigger events for devices with a matching device path. When this option is specified more than once, |
5b3b0733 | 317 | then each matching result is ORed, that is, all specified devices are triggered.</para> |
80877656 ZJS |
318 | </listitem> |
319 | </varlistentry> | |
b05211fa | 320 | <varlistentry> |
7643ac9a ZJS |
321 | <term><option>-b</option></term> |
322 | <term><option>--parent-match=<replaceable>SYSPATH</replaceable></option></term> | |
b05211fa | 323 | <listitem> |
a9bc94e5 | 324 | <para>Trigger events for all children of a given device. When this option is specified more than once, |
5b3b0733 | 325 | then each matching result is ORed, that is, all children of each specified device are triggered.</para> |
7643ac9a | 326 | </listitem> |
792cc203 MH |
327 | </varlistentry> |
328 | <varlistentry> | |
329 | <term><option>-w</option></term> | |
330 | <term><option>--settle</option></term> | |
331 | <listitem> | |
332 | <para>Apart from triggering events, also waits for those events to | |
333 | finish. Note that this is different from calling <command>udevadm | |
334 | settle</command>. <command>udevadm settle</command> waits for all | |
335 | events to finish. This option only waits for events triggered by | |
336 | the same command to finish.</para> | |
337 | </listitem> | |
7643ac9a | 338 | </varlistentry> |
2001622c YW |
339 | <varlistentry> |
340 | <term><option>--wait-daemon[=<replaceable>SECONDS</replaceable>]</option></term> | |
341 | <listitem> | |
342 | <para>Before triggering uevents, wait for systemd-udevd daemon to be initialized. | |
343 | Optionally takes timeout value. Default timeout is 5 seconds. This is equivalent to invoke | |
344 | invoking <command>udevadm control --ping</command> before <command>udevadm trigger</command>.</para> | |
345 | </listitem> | |
346 | </varlistentry> | |
c94c581c | 347 | |
c94c581c | 348 | <xi:include href="standard-options.xml" xpointer="help" /> |
63749b1a | 349 | </variablelist> |
80877656 | 350 | |
5b3b0733 YW |
351 | <para>In addition, optional positional arguments can be used |
352 | to specify device names or sys paths. They must start with | |
3b121157 | 353 | <filename>/dev/</filename> or <filename>/sys/</filename> |
80877656 | 354 | respectively.</para> |
63749b1a | 355 | </refsect2> |
225cb03b | 356 | |
80877656 ZJS |
357 | <refsect2><title>udevadm settle |
358 | <arg choice="opt"><replaceable>options</replaceable></arg> | |
359 | </title> | |
63749b1a KS |
360 | <para>Watches the udev event queue, and exits if all current events are handled.</para> |
361 | <variablelist> | |
362 | <varlistentry> | |
7643ac9a ZJS |
363 | <term><option>-t</option></term> |
364 | <term><option>--timeout=<replaceable>SECONDS</replaceable></option></term> | |
63749b1a | 365 | <listitem> |
7643ac9a ZJS |
366 | <para>Maximum number of seconds to wait for the event |
367 | queue to become empty. The default value is 120 seconds. A | |
368 | value of 0 will check if the queue is empty and always | |
2233c270 YK |
369 | return immediately. A non-zero value will return an exit |
370 | code of 0 if queue became empty before timeout was reached, | |
371 | non-zero otherwise.</para> | |
63749b1a KS |
372 | </listitem> |
373 | </varlistentry> | |
63749b1a | 374 | <varlistentry> |
7643ac9a ZJS |
375 | <term><option>-E</option></term> |
376 | <term><option>--exit-if-exists=<replaceable>FILE</replaceable></option></term> | |
63749b1a KS |
377 | <listitem> |
378 | <para>Stop waiting if file exists.</para> | |
379 | </listitem> | |
380 | </varlistentry> | |
c94c581c | 381 | |
c94c581c | 382 | <xi:include href="standard-options.xml" xpointer="help" /> |
63749b1a | 383 | </variablelist> |
18a38822 ZJS |
384 | |
385 | <para>See | |
386 | <citerefentry><refentrytitle>systemd-udev-settle.service</refentrytitle><manvolnum>8</manvolnum></citerefentry> | |
387 | for more information.</para> | |
63749b1a | 388 | </refsect2> |
225cb03b | 389 | |
c94c581c | 390 | <refsect2><title>udevadm control <replaceable>option</replaceable></title> |
63749b1a KS |
391 | <para>Modify the internal state of the running udev daemon.</para> |
392 | <variablelist> | |
ff2c503d | 393 | <varlistentry> |
bd8420c5 | 394 | <term><option>-e</option></term> |
ff2c503d KS |
395 | <term><option>--exit</option></term> |
396 | <listitem> | |
6371db93 YW |
397 | <para>Signal and wait for systemd-udevd to exit. No option except for |
398 | <option>--timeout</option> can be specified after this option. | |
399 | Note that <filename>systemd-udevd.service</filename> contains | |
400 | <option>Restart=always</option> and so as a result, this option restarts systemd-udevd. | |
d0d7e102 YW |
401 | If you want to stop <filename>systemd-udevd.service</filename>, please use the following: |
402 | <programlisting>systemctl stop systemd-udevd-control.socket systemd-udevd-kernel.socket systemd-udevd.service</programlisting> | |
403 | </para> | |
ff2c503d KS |
404 | </listitem> |
405 | </varlistentry> | |
63749b1a | 406 | <varlistentry> |
7643ac9a | 407 | <term><option>-l</option></term> |
027f96c8 | 408 | <term><option>--log-level=<replaceable>value</replaceable></option></term> |
63749b1a | 409 | <listitem> |
e03234a1 ZJS |
410 | <para>Set the internal log level of |
411 | <filename>systemd-udevd</filename>. Valid values are the | |
412 | numerical syslog priorities or their textual | |
413 | representations: <option>emerg</option>, | |
414 | <option>alert</option>, <option>crit</option>, | |
415 | <option>err</option>, <option>warning</option>, | |
416 | <option>notice</option>, <option>info</option>, and | |
417 | <option>debug</option>.</para> | |
63749b1a KS |
418 | </listitem> |
419 | </varlistentry> | |
420 | <varlistentry> | |
7643ac9a | 421 | <term><option>-s</option></term> |
63749b1a KS |
422 | <term><option>--stop-exec-queue</option></term> |
423 | <listitem> | |
f13b388f | 424 | <para>Signal systemd-udevd to stop executing new events. Incoming events |
63749b1a KS |
425 | will be queued.</para> |
426 | </listitem> | |
427 | </varlistentry> | |
428 | <varlistentry> | |
7643ac9a | 429 | <term><option>-S</option></term> |
63749b1a KS |
430 | <term><option>--start-exec-queue</option></term> |
431 | <listitem> | |
f13b388f | 432 | <para>Signal systemd-udevd to enable the execution of events.</para> |
63749b1a KS |
433 | </listitem> |
434 | </varlistentry> | |
435 | <varlistentry> | |
7643ac9a | 436 | <term><option>-R</option></term> |
7c85d636 | 437 | <term><option>--reload</option></term> |
63749b1a | 438 | <listitem> |
f13b388f | 439 | <para>Signal systemd-udevd to reload the rules files and other databases like the kernel |
7c85d636 KS |
440 | module index. Reloading rules and databases does not apply any changes to already |
441 | existing devices; the new configuration will only be applied to new events.</para> | |
63749b1a KS |
442 | </listitem> |
443 | </varlistentry> | |
444 | <varlistentry> | |
7643ac9a | 445 | <term><option>-p</option></term> |
63749b1a KS |
446 | <term><option>--property=<replaceable>KEY</replaceable>=<replaceable>value</replaceable></option></term> |
447 | <listitem> | |
448 | <para>Set a global property for all events.</para> | |
449 | </listitem> | |
450 | </varlistentry> | |
451 | <varlistentry> | |
7643ac9a | 452 | <term><option>-m</option></term> |
87d55ff6 | 453 | <term><option>--children-max=</option><replaceable>value</replaceable></term> |
63749b1a | 454 | <listitem> |
f13b388f | 455 | <para>Set the maximum number of events, systemd-udevd will handle at the |
63749b1a KS |
456 | same time.</para> |
457 | </listitem> | |
458 | </varlistentry> | |
a82340cc YW |
459 | <varlistentry> |
460 | <term><option>--ping</option></term> | |
461 | <listitem> | |
462 | <para>Send a ping message to systemd-udevd and wait for the reply. This may be useful to check that | |
463 | systemd-udevd daemon is running.</para> | |
464 | </listitem> | |
465 | </varlistentry> | |
ff2c503d | 466 | <varlistentry> |
c94c581c | 467 | <term><option>-t</option></term> |
ff2c503d KS |
468 | <term><option>--timeout=</option><replaceable>seconds</replaceable></term> |
469 | <listitem> | |
7e505069 | 470 | <para>The maximum number of seconds to wait for a reply from systemd-udevd.</para> |
ff2c503d KS |
471 | </listitem> |
472 | </varlistentry> | |
c94c581c | 473 | |
c94c581c | 474 | <xi:include href="standard-options.xml" xpointer="help" /> |
63749b1a KS |
475 | </variablelist> |
476 | </refsect2> | |
225cb03b | 477 | |
80877656 ZJS |
478 | <refsect2><title>udevadm monitor |
479 | <arg choice="opt"><replaceable>options</replaceable></arg> | |
480 | </title> | |
63749b1a KS |
481 | <para>Listens to the kernel uevents and events sent out by a udev rule |
482 | and prints the devpath of the event to the console. It can be used to analyze the | |
483 | event timing, by comparing the timestamps of the kernel uevent and the udev event. | |
484 | </para> | |
485 | <variablelist> | |
486 | <varlistentry> | |
7643ac9a | 487 | <term><option>-k</option></term> |
63749b1a KS |
488 | <term><option>--kernel</option></term> |
489 | <listitem> | |
490 | <para>Print the kernel uevents.</para> | |
491 | </listitem> | |
492 | </varlistentry> | |
493 | <varlistentry> | |
7643ac9a | 494 | <term><option>-u</option></term> |
63749b1a KS |
495 | <term><option>--udev</option></term> |
496 | <listitem> | |
497 | <para>Print the udev event after the rule processing.</para> | |
498 | </listitem> | |
499 | </varlistentry> | |
500 | <varlistentry> | |
7643ac9a | 501 | <term><option>-p</option></term> |
63749b1a KS |
502 | <term><option>--property</option></term> |
503 | <listitem> | |
504 | <para>Also print the properties of the event.</para> | |
505 | </listitem> | |
506 | </varlistentry> | |
507 | <varlistentry> | |
7643ac9a | 508 | <term><option>-s</option></term> |
63749b1a KS |
509 | <term><option>--subsystem-match=<replaceable>string[/string]</replaceable></option></term> |
510 | <listitem> | |
a9bc94e5 YW |
511 | <para>Filter kernel uevents and udev events by subsystem[/devtype]. Only events with a matching subsystem value will pass. |
512 | When this option is specified more than once, then each matching result is ORed, that is, all devices in the specified | |
513 | subsystems are monitored.</para> | |
63749b1a KS |
514 | </listitem> |
515 | </varlistentry> | |
516 | <varlistentry> | |
7643ac9a | 517 | <term><option>-t</option></term> |
63749b1a KS |
518 | <term><option>--tag-match=<replaceable>string</replaceable></option></term> |
519 | <listitem> | |
a9bc94e5 YW |
520 | <para>Filter udev events by tag. Only udev events with a given tag attached will pass. |
521 | When this option is specified more than once, then each matching result is ORed, that is, devices which have one of the | |
522 | specified tags are monitored.</para> | |
63749b1a KS |
523 | </listitem> |
524 | </varlistentry> | |
c94c581c | 525 | |
c94c581c | 526 | <xi:include href="standard-options.xml" xpointer="help" /> |
63749b1a KS |
527 | </variablelist> |
528 | </refsect2> | |
225cb03b | 529 | |
80877656 ZJS |
530 | <refsect2><title>udevadm test |
531 | <arg choice="opt"><replaceable>options</replaceable></arg> | |
532 | <arg><replaceable>devpath</replaceable></arg> | |
533 | </title> | |
63749b1a KS |
534 | <para>Simulate a udev event run for the given device, and print debug output.</para> |
535 | <variablelist> | |
536 | <varlistentry> | |
7643ac9a | 537 | <term><option>-a</option></term> |
6d22bd87 | 538 | <term><option>--action=<replaceable>ACTION</replaceable></option></term> |
63749b1a | 539 | <listitem> |
e148cbc5 YW |
540 | <para>Type of event to be simulated. Possible actions are <literal>add</literal>, |
541 | <literal>remove</literal>, <literal>change</literal>, <literal>move</literal>, | |
542 | <literal>online</literal>, <literal>offline</literal>, <literal>bind</literal>, | |
543 | and <literal>unbind</literal>. Also, the special value <literal>help</literal> can be used | |
544 | to list the possible actions. The default value is <literal>add</literal>.</para> | |
63749b1a KS |
545 | </listitem> |
546 | </varlistentry> | |
547 | <varlistentry> | |
7643ac9a | 548 | <term><option>-N</option></term> |
124b48b0 | 549 | <term><option>--resolve-names=<constant>early</constant>|<constant>late</constant>|<constant>never</constant></option></term> |
63749b1a | 550 | <listitem> |
124b48b0 ZJS |
551 | <para>Specify when udevadm should resolve names of users |
552 | and groups. When set to <constant>early</constant> (the | |
72f4d966 JE |
553 | default), names will be resolved when the rules are |
554 | parsed. When set to <constant>late</constant>, names will | |
124b48b0 | 555 | be resolved for every event. When set to |
72f4d966 | 556 | <constant>never</constant>, names will never be resolved |
124b48b0 | 557 | and all devices will be owned by root.</para> |
63749b1a KS |
558 | </listitem> |
559 | </varlistentry> | |
c94c581c | 560 | |
c94c581c | 561 | <xi:include href="standard-options.xml" xpointer="help" /> |
63749b1a KS |
562 | </variablelist> |
563 | </refsect2> | |
d7867b31 | 564 | |
80877656 ZJS |
565 | <refsect2><title>udevadm test-builtin |
566 | <arg choice="opt"><replaceable>options</replaceable></arg> | |
567 | <arg><replaceable>command</replaceable></arg> | |
568 | <arg><replaceable>devpath</replaceable></arg> | |
569 | </title> | |
7643ac9a ZJS |
570 | <para>Run a built-in command <replaceable>COMMAND</replaceable> |
571 | for device <replaceable>DEVPATH</replaceable>, and print debug | |
572 | output.</para> | |
d7867b31 | 573 | <variablelist> |
c94c581c | 574 | <xi:include href="standard-options.xml" xpointer="help" /> |
d7867b31 KS |
575 | </variablelist> |
576 | </refsect2> | |
63749b1a | 577 | </refsect1> |
225cb03b | 578 | |
63749b1a KS |
579 | <refsect1> |
580 | <title>See Also</title> | |
581 | <para><citerefentry> | |
582 | <refentrytitle>udev</refentrytitle><manvolnum>7</manvolnum> | |
7d06ef0a | 583 | </citerefentry>, |
63749b1a | 584 | <citerefentry> |
b79f817b | 585 | <refentrytitle>systemd-udevd.service</refentrytitle><manvolnum>8</manvolnum> |
63749b1a KS |
586 | </citerefentry></para> |
587 | </refsect1> | |
588 | </refentry> |