chiark / gitweb /
remove debug output during rules parsing
[elogind.git] / udev / udev.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>udev</title>
8     <refentry>
9       <refentryinfo>
10         <title>udev</title>
11         <productname>udev</productname>
12       </refentryinfo>
13
14       <refmeta>
15         <refentrytitle>udev</refentrytitle>
16         <manvolnum>7</manvolnum>
17       </refmeta>
18
19       <refnamediv>
20         <refname>udev</refname>
21         <refpurpose>dynamic device management</refpurpose>
22       </refnamediv>
23
24       <refsect1><title>DESCRIPTION</title>
25         <para>udev provides a dynamic device directory containing only the files for
26         actually present devices. It creates or removes device node files in the
27         <filename>/dev</filename> directory, or it renames network interfaces.</para>
28
29         <para>Usually udev runs as <citerefentry><refentrytitle>udevd</refentrytitle>
30         <manvolnum>8</manvolnum></citerefentry> and receives uevents directly from the
31         kernel if a device is added or removed from the system.</para>
32
33         <para>If udev receives a device event, it matches its configured rules
34         against the available device attributes provided in sysfs to identify the device.
35         Rules that match may provide additional device information or specify a device
36         node name and multiple symlink names and instruct udev to run additional programs
37         as part of the device event handling.</para>
38       </refsect1>
39
40       <refsect1><title>CONFIGURATION</title>
41         <para>udev configuration files are placed in <filename>/etc/udev/</filename>
42         and <filename>/lib/udev/</filename>. All empty lines, or lines beginning with
43         '#' will be ignored.</para>
44
45         <refsect2><title>Configuration file</title>
46           <para>udev expects its main configuration file at <filename>/etc/udev/udev.conf</filename>.
47           It consists of a set of variables allowing the user to override default udev values.
48           The following variables can be set:</para>
49           <variablelist>
50             <varlistentry>
51               <term><option>udev_root</option></term>
52               <listitem>
53                 <para>Specifies where to place the device nodes in the filesystem.
54                 The default value is <filename>/dev</filename>.</para>
55               </listitem>
56             </varlistentry>
57
58             <varlistentry>
59               <term><option>udev_log</option></term>
60               <listitem>
61                 <para>The logging priority. Valid values are the numerical syslog priorities
62                 or their textual representations: <option>err</option>, <option>info</option>
63                 and <option>debug</option>.</para>
64               </listitem>
65             </varlistentry>
66           </variablelist>
67         </refsect2>
68
69         <refsect2><title>Rules files</title>
70           <para>The udev rules are read from the files located in the
71           default rules directory <filename>/lib/udev/rules.d/</filename>,
72           the custom rules directory <filename>/etc/udev/rules.d/</filename>
73           and the temporary rules directory <filename>/dev/.udev/rules.d/</filename>.
74           All rule files are sorted and processed in lexical order, regardless
75           in which of these directories they live.</para>
76
77           <para>Rule files are required to have a unique name, duplicate file names
78           are ignored. Files in <filename>/etc/udev/rules.d/</filename> have precedence
79           over files with the same name in <filename>/lib/udev/rules.d/</filename>. This
80           can be used to ignore a default rules file if needed.</para>
81
82           <para>Every line in the rules file contains at least one key value pair.
83           There are two kind of keys, match and assignment keys.
84           If all match keys are matching against its value, the rule gets applied and the
85           assign keys get the specified value assigned.</para>
86
87           <para>A matching rule may specify the name of the device node, add a symlink
88           pointing to the node, or run a specified program as part of the event handling.
89           If no matching rule is found, the default device node name is used.</para>
90
91           <para>A rule consists of a list of one or more key value pairs separated by
92           a comma. Each key has a distinct operation, depending on the used operator. Valid
93           operators are:</para>
94           <variablelist>
95             <varlistentry>
96               <term><option>==</option></term>
97               <listitem>
98                 <para>Compare for equality.</para>
99               </listitem>
100             </varlistentry>
101
102             <varlistentry>
103               <term><option>!=</option></term>
104               <listitem>
105                 <para>Compare for inequality.</para>
106               </listitem>
107             </varlistentry>
108
109             <varlistentry>
110               <term><option>=</option></term>
111               <listitem>
112                 <para>Assign a value to a key. Keys that represent a list, are reset
113                 and only this single value is assigned.</para>
114               </listitem>
115             </varlistentry>
116
117             <varlistentry>
118               <term><option>+=</option></term>
119               <listitem>
120                 <para>Add the value to a key that holds a list of entries.</para>
121               </listitem>
122             </varlistentry>
123
124             <varlistentry>
125               <term><option>:=</option></term>
126               <listitem>
127                 <para>Assign  a  value  to  a key finally; disallow any later changes,
128                 which may be used to prevent changes by any later rules.</para>
129               </listitem>
130             </varlistentry>
131           </variablelist>
132
133           <para>The following key names can be used to match against device properties.
134           Some of the keys also match against properties of the parent devices in sysfs,
135           not only the device that has generated the event. If multiple keys that match
136           a parent device are specified in a single rule, all these keys must match at
137           one and the same parent device.</para>
138           <variablelist>
139             <varlistentry>
140               <term><option>ACTION</option></term>
141               <listitem>
142                 <para>Match the name of the event action.</para>
143               </listitem>
144             </varlistentry>
145
146             <varlistentry>
147               <term><option>DEVPATH</option></term>
148               <listitem>
149                 <para>Match the devpath of the event device.</para>
150               </listitem>
151             </varlistentry>
152
153             <varlistentry>
154               <term><option>KERNEL</option></term>
155               <listitem>
156                 <para>Match the name of the event device.</para>
157               </listitem>
158             </varlistentry>
159
160             <varlistentry>
161               <term><option>NAME</option></term>
162               <listitem>
163                 <para>Match the name of the node or network interface. It can
164                 be used once the NAME key has been set in one of the preceding
165                 rules.</para>
166               </listitem>
167             </varlistentry>
168
169             <varlistentry>
170               <term><option>SYMLINK</option></term>
171               <listitem>
172                 <para>Match the name of a symlink targeting the node. It can
173                 be used once a SYMLINK key has been set in one of the preceding
174                 rules. There may be multiple symlinks; only one needs to match.
175                 </para>
176               </listitem>
177             </varlistentry>
178
179             <varlistentry>
180               <term><option>SUBSYSTEM</option></term>
181               <listitem>
182                 <para>Match the subsystem of the event device.</para>
183               </listitem>
184             </varlistentry>
185             <varlistentry>
186               <term><option>DRIVER</option></term>
187               <listitem>
188                 <para>Match the driver name of the event device. Only set for devices
189                 which are bound to a driver at the time the event is generated.</para>
190               </listitem>
191             </varlistentry>
192             <varlistentry>
193               <term><option>ATTR{<replaceable>filename</replaceable>}</option></term>
194               <listitem>
195                 <para>Match sysfs attribute values of the event device. Trailing
196                 whitespace in the attribute values is ignored, if the specified match
197                 value does not contain trailing whitespace itself.
198                 </para>
199               </listitem>
200             </varlistentry>
201
202             <varlistentry>
203               <term><option>KERNELS</option></term>
204               <listitem>
205                 <para>Search the devpath upwards for a matching device name.</para>
206               </listitem>
207             </varlistentry>
208
209             <varlistentry>
210               <term><option>SUBSYSTEMS</option></term>
211               <listitem>
212                 <para>Search the devpath upwards for a matching device subsystem name.</para>
213               </listitem>
214             </varlistentry>
215
216             <varlistentry>
217               <term><option>DRIVERS</option></term>
218               <listitem>
219                 <para>Search the devpath upwards for a matching device driver name.</para>
220               </listitem>
221             </varlistentry>
222
223             <varlistentry>
224               <term><option>ATTRS{<replaceable>filename</replaceable>}</option></term>
225               <listitem>
226                 <para>Search the devpath upwards for a device with matching sysfs attribute values.
227                 If multiple <option>ATTRS</option> matches are specified, all of them
228                 must match on the same device. Trailing whitespace in the attribute values is ignored,
229                 if the specified match value does not contain trailing whitespace itself.</para>
230               </listitem>
231             </varlistentry>
232
233             <varlistentry>
234               <term><option>ENV{<replaceable>key</replaceable>}</option></term>
235               <listitem>
236                 <para>Match against a device property value.</para>
237               </listitem>
238             </varlistentry>
239
240             <varlistentry>
241               <term><option>TAG</option></term>
242               <listitem>
243                 <para>Match against a device tag.</para>
244               </listitem>
245             </varlistentry>
246
247             <varlistentry>
248               <term><option>TEST{<replaceable>octal mode mask</replaceable>}</option></term>
249               <listitem>
250                 <para>Test the existence of a file. An octal mode mask can be specified
251                 if needed.</para>
252               </listitem>
253             </varlistentry>
254
255             <varlistentry>
256               <term><option>PROGRAM</option></term>
257               <listitem>
258                 <para>Execute a program. The key is true, if the program returns
259                 successfully. The device properties are made available to the
260                 executed program in the environment. The program's output printed to
261                 stdout, is available in the RESULT key.</para>
262               </listitem>
263             </varlistentry>
264
265             <varlistentry>
266               <term><option>RESULT</option></term>
267               <listitem>
268                 <para>Match the returned string of the last PROGRAM call. This key can
269                 be used in the same or in any later rule after a PROGRAM call.</para>
270               </listitem>
271             </varlistentry>
272           </variablelist>
273
274           <para>Most of the fields support a shell style pattern matching. The following
275           pattern characters are supported:</para>
276           <variablelist>
277             <varlistentry>
278               <term><option>*</option></term>
279               <listitem>
280                 <para>Matches zero, or any number of characters.</para>
281               </listitem>
282             </varlistentry>
283             <varlistentry>
284               <term><option>?</option></term>
285               <listitem>
286                 <para>Matches any single character.</para>
287               </listitem>
288             </varlistentry>
289             <varlistentry>
290               <term><option>[]</option></term>
291               <listitem>
292                 <para>Matches any single character specified within the brackets. For
293                 example, the pattern string 'tty[SR]' would match either 'ttyS' or 'ttyR'.
294                 Ranges are also supported within this match with the '-' character.
295                 For example, to match on the range of all digits, the pattern [0-9] would
296                 be used. If the first character following the '[' is a '!', any characters
297                 not enclosed are matched.</para>
298               </listitem>
299             </varlistentry>
300           </variablelist>
301
302           <para>The following keys can get values assigned:</para>
303           <variablelist>
304             <varlistentry>
305               <term><option>NAME</option></term>
306               <listitem>
307                 <para>The name, a network interface should be renamed to, or the name
308                 a device node should be named. Usually the kernel provides the defined
309                 node name, or even creates and removes the node before udev receives
310                 any event. Changing the node name from the kernel's default may result
311                 in unexpected behavior and is not supported. Udev is only expected to
312                 handle device node permissions and to create additional symlinks, which
313                 do not conflict with the kernel device node names.</para>
314               </listitem>
315             </varlistentry>
316
317             <varlistentry>
318               <term><option>SYMLINK</option></term>
319               <listitem>
320                 <para>The name of a symlink targeting the node. Every matching rule will add
321                 this value to the list of symlinks to be created along with the device node.
322                 Multiple symlinks may be specified by separating the names by the space
323                 character. In case multiple devices claim the same name, the link will
324                 always point to the device with the highest link_priority. If the current device
325                 goes away, the links will be re-evaluated and the device with the next highest
326                 link_priority will own the link. If no link_priority is specified, the order
327                 of the devices, and which of them will own the link, is undefined. Claiming
328                 the same name for a node and links may result in unexpected behavior and is
329                 not supported.
330                 </para>
331               </listitem>
332             </varlistentry>
333
334             <varlistentry>
335               <term><option>OWNER, GROUP, MODE</option></term>
336               <listitem>
337                 <para>The permissions for the device node. Every specified value overwrites
338                 the compiled-in default value.</para>
339               </listitem>
340             </varlistentry>
341
342             <varlistentry>
343               <term><option>ATTR{<replaceable>key</replaceable>}</option></term>
344               <listitem>
345                 <para>The value that should be written to a sysfs attribute of the
346                 event device.</para>
347               </listitem>
348             </varlistentry>
349
350             <varlistentry>
351               <term><option>ENV{<replaceable>key</replaceable>}</option></term>
352               <listitem>
353                 <para>Set a device property value. Property names with a leading '.'
354                 are not stored in the database or exported to external tool or events.</para>
355               </listitem>
356             </varlistentry>
357
358             <varlistentry>
359               <term><option>TAG</option></term>
360               <listitem>
361                 <para>Attach a tag to a device. This is used to filter events for users
362                 of libudev's monitor functionality, or to enumerate a group of tagged
363                 devices. The implementation can only work efficiently if only a few
364                 tags are attached to a device. It is only meant to be used in
365                 contexts with specific device filter requirements, and not as a
366                 general-purpose flag. Excessive use might result in inefficient event
367                 handling.</para>
368               </listitem>
369             </varlistentry>
370
371             <varlistentry>
372               <term><option>RUN</option></term>
373               <listitem>
374                 <para>Add a program to the list of programs to be executed for a specific
375                 device. This can only be used for very short running tasks. Running an
376                 event process for a long period of time may block all further events for
377                 this or a dependent device. Long running tasks need to be immediately
378                 detached from the event process itself. If the option
379                 <option>RUN{<replaceable>fail_event_on_error</replaceable>}</option> is
380                 specified, and the executed program returns non-zero, the event will be
381                 marked as failed for a possible later handling.</para>
382                 <para>If no path is given, the program must be in 
383                 <filename>/lib/udev</filename>, otherwise the full path must be
384                 specified.</para>
385                 <para>If the specified string starts with
386                 <option>socket:<replaceable>path</replaceable></option>, all current event
387                 values will be passed to the specified socket, as a message in the same
388                 format the kernel sends an uevent. If the first character of the specified path
389                 is an @ character, an abstract namespace socket is used, instead of an existing
390                 socket file.</para>
391                 <para>Program name and arguments are separated with spaces. To
392                 include spaces in an argument, use single quotes. Please note
393                 that this does not run through a shell.</para>
394               </listitem>
395             </varlistentry>
396
397             <varlistentry>
398               <term><option>LABEL</option></term>
399               <listitem>
400                 <para>Named label where a GOTO can jump to.</para>
401               </listitem>
402             </varlistentry>
403
404             <varlistentry>
405               <term><option>GOTO</option></term>
406               <listitem>
407                 <para>Jumps to the next LABEL with a matching name</para>
408               </listitem>
409             </varlistentry>
410
411             <varlistentry>
412               <term><option>IMPORT{<replaceable>type</replaceable>}</option></term>
413               <listitem>
414                 <para>Import a set of variables as device properties,
415                 depending on <replaceable>type</replaceable>:</para>
416                 <variablelist>
417                   <varlistentry>
418                     <term><option>program</option></term>
419                     <listitem>
420                       <para>Execute an external program specified as the assigned value and
421                       import its output, which must be in environment key
422                       format. Path specification, command/argument separation,
423                       and quoting work like in <option>RUN</option>.</para>
424                     </listitem>
425                   </varlistentry>
426                   <varlistentry>
427                     <term><option>file</option></term>
428                     <listitem>
429                       <para>Import a text file specified as the assigned value, which must be in
430                       environment key format.</para>
431                     </listitem>
432                   </varlistentry>
433                   <varlistentry>
434                     <term><option>db</option></term>
435                     <listitem>
436                       <para>Import a single property specified as the assigned value from the
437                       current device database. This works only if the database is already populated
438                       by an earlier event.</para>
439                     </listitem>
440                   </varlistentry>
441                   <varlistentry>
442                     <term><option>parent</option></term>
443                     <listitem>
444                       <para>Import the stored keys from the parent device by reading
445                       the database entry of the parent device. The value assigned to
446                       <option>IMPORT{parent}</option> is used as a filter of key names
447                       to import (with the same shell-style pattern matching used for
448                       comparisons).</para>
449                     </listitem>
450                   </varlistentry>
451                 </variablelist>
452                 <para>If no option is given, udev will choose between <option>program</option>
453                 and <option>file</option> based on the executable bit of the file
454                 permissions.</para>
455               </listitem>
456             </varlistentry>
457
458             <varlistentry>
459               <term><option>WAIT_FOR</option></term>
460               <listitem>
461                 <para>Wait for a file to become available or until a 10
462                 seconds timeout expires.</para>
463               </listitem>
464             </varlistentry>
465
466             <varlistentry>
467               <term><option>OPTIONS</option></term>
468               <listitem>
469                 <para>Rule and device options:</para>
470                 <variablelist>
471                   <varlistentry>
472                     <term><option>link_priority=<replaceable>value</replaceable></option></term>
473                     <listitem>
474                       <para>Specify the priority of the created symlinks. Devices with higher
475                       priorities overwrite existing symlinks of other devices. The default is 0.</para>
476                     </listitem>
477                   </varlistentry>
478                   <varlistentry>
479                     <term><option>event_timeout=</option></term>
480                     <listitem>
481                       <para>Number of seconds an event will wait for operations to finish, before it
482                       will terminate itself.</para>
483                     </listitem>
484                   </varlistentry>
485                   <varlistentry>
486                     <term><option>string_escape=<replaceable>none|replace</replaceable></option></term>
487                     <listitem>
488                       <para>Usually control and other possibly unsafe characters are replaced
489                       in strings used for device naming. The mode of replacement can be specified
490                       with this option.</para>
491                     </listitem>
492                   </varlistentry>
493                   <varlistentry>
494                     <term><option>watch</option></term>
495                     <listitem>
496                       <para>Watch the device node with inotify, when closed after being opened for
497                       writing, a change uevent will be synthesised.</para>
498                     </listitem>
499                   </varlistentry>
500                 </variablelist>
501               </listitem>
502             </varlistentry>
503           </variablelist>
504
505           <para>The <option>NAME</option>, <option>SYMLINK</option>, <option>PROGRAM</option>,
506           <option>OWNER</option>, <option>GROUP</option>, <option>MODE</option>  and  <option>RUN</option>
507           fields support simple printf-like string substitutions. The <option>RUN</option>
508           format chars gets applied after all rules have been processed, right before the program
509           is executed. It allows the use of device properties set by earlier matching
510           rules. For all other fields, substitutions are applied while the individual rule is
511           being processed. The available substitutions are:</para>
512           <variablelist>
513             <varlistentry>
514               <term><option>$kernel</option>, <option>%k</option></term>
515               <listitem>
516                 <para>The kernel name for this device.</para>
517               </listitem>
518             </varlistentry>
519
520             <varlistentry>
521               <term><option>$number</option>, <option>%n</option></term>
522               <listitem>
523                 <para>The kernel number for this device. For example, 'sda3' has
524                 kernel number of '3'</para>
525               </listitem>
526             </varlistentry>
527
528             <varlistentry>
529               <term><option>$devpath</option>, <option>%p</option></term>
530               <listitem>
531                 <para>The devpath of the device.</para>
532               </listitem>
533             </varlistentry>
534
535             <varlistentry>
536               <term><option>$id</option>, <option>%b</option></term>
537               <listitem>
538                 <para>The name of the device matched while searching the devpath upwards for
539                   <option>SUBSYSTEMS</option>, <option>KERNELS</option>, <option>DRIVERS</option> and <option>ATTRS</option>.
540                 </para>
541               </listitem>
542             </varlistentry>
543
544             <varlistentry>
545               <term><option>$driver</option></term>
546               <listitem>
547                 <para>The driver name of the device matched while searching the devpath upwards for
548                   <option>SUBSYSTEMS</option>, <option>KERNELS</option>, <option>DRIVERS</option> and <option>ATTRS</option>.
549                 </para>
550               </listitem>
551             </varlistentry>
552
553             <varlistentry>
554               <term><option>$attr{<replaceable>file</replaceable>}</option>, <option>%s{<replaceable>file</replaceable>}</option></term>
555               <listitem>
556                 <para>The value of a sysfs attribute found at the device, where
557                 all keys of the rule have matched. If the matching device does not have
558                 such an attribute, follow the chain of parent devices and use the value
559                 of the first attribute that matches.
560                 If the attribute is a symlink, the last element of the symlink target is
561                 returned as the value.</para>
562               </listitem>
563             </varlistentry>
564
565             <varlistentry>
566               <term><option>$env{<replaceable>key</replaceable>}</option>, <option>%E{<replaceable>key</replaceable>}</option></term>
567               <listitem>
568                 <para>A device property value.</para>
569               </listitem>
570             </varlistentry>
571
572             <varlistentry>
573               <term><option>$major</option>, <option>%M</option></term>
574               <listitem>
575                 <para>The kernel major number for the device.</para>
576               </listitem>
577             </varlistentry>
578
579             <varlistentry>
580               <term><option>$minor</option>, <option>%m</option></term>
581               <listitem>
582                 <para>The kernel minor number for the device.</para>
583               </listitem>
584             </varlistentry>
585
586             <varlistentry>
587               <term><option>$result</option>, <option>%c</option></term>
588               <listitem>
589                 <para>The string returned by the external program requested with PROGRAM.
590                 A single part of the string, separated by a space character may be selected
591                 by specifying the part number as an attribute: <option>%c{N}</option>.
592                 If the number is followed by the '+' char this part plus all remaining parts
593                 of the result string are substituted: <option>%c{N+}</option></para>
594               </listitem>
595             </varlistentry>
596
597             <varlistentry>
598               <term><option>$parent</option>, <option>%P</option></term>
599               <listitem>
600                 <para>The node name of the parent device.</para>
601               </listitem>
602             </varlistentry>
603
604             <varlistentry>
605               <term><option>$name</option></term>
606               <listitem>
607                 <para>The current name of the device node. If not changed by a rule, it is the
608                 name of the kernel device.</para>
609               </listitem>
610             </varlistentry>
611
612             <varlistentry>
613               <term><option>$links</option></term>
614               <listitem>
615                 <para>The current list of symlinks, separated by a space character. The value is
616                 only set if an earlier rule assigned a value, or during a remove events.</para>
617               </listitem>
618             </varlistentry>
619
620             <varlistentry>
621               <term><option>$root</option>, <option>%r</option></term>
622               <listitem>
623                 <para>The udev_root value.</para>
624               </listitem>
625             </varlistentry>
626
627             <varlistentry>
628               <term><option>$sys</option>, <option>%S</option></term>
629               <listitem>
630                 <para>The sysfs mount point.</para>
631               </listitem>
632             </varlistentry>
633
634             <varlistentry>
635               <term><option>$tempnode</option>, <option>%N</option></term>
636               <listitem>
637                 <para>The name of a created temporary device node to provide access to
638                 the device from a external program before the real node is created.</para>
639               </listitem>
640             </varlistentry>
641
642             <varlistentry>
643               <term><option>%%</option></term>
644               <listitem>
645               <para>The '%' character itself.</para>
646               </listitem>
647             </varlistentry>
648
649             <varlistentry>
650               <term><option>$$</option></term>
651               <listitem>
652               <para>The '$' character itself.</para>
653               </listitem>
654             </varlistentry>
655           </variablelist>
656         </refsect2>
657       </refsect1>
658
659       <refsect1><title>AUTHOR</title>
660         <para>Written by Greg Kroah-Hartman <email>greg@kroah.com</email> and
661         Kay Sievers <email>kay.sievers@vrfy.org</email>. With much help from
662         Dan Stekloff and many others.</para>
663       </refsect1>
664
665       <refsect1>
666         <title>SEE ALSO</title>
667         <para><citerefentry>
668             <refentrytitle>udevd</refentrytitle><manvolnum>8</manvolnum>
669           </citerefentry>, 
670           <citerefentry>
671             <refentrytitle>udevadm</refentrytitle><manvolnum>8</manvolnum>
672         </citerefentry></para>
673       </refsect1>
674     </refentry>
675   </section>
676 </article>