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