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>TEST{<replaceable>octal mode mask</replaceable>}</option></term>
 242               <listitem>
 243                 <para>Test the existence of a file. An octal mode mask can be specified
 244                 if needed.</para>
 245               </listitem>
 246             </varlistentry>
 247
 248             <varlistentry>
 249               <term><option>PROGRAM</option></term>
 250               <listitem>
 251                 <para>Execute a program. The key is true, if the program returns
 252                 successfully. The device properties are made available to the
 253                 executed program in the environment. The program's output printed to
 254                 stdout, is available in the RESULT key.</para>
 255               </listitem>
 256             </varlistentry>
 257
 258             <varlistentry>
 259               <term><option>RESULT</option></term>
 260               <listitem>
 261                 <para>Match the returned string of the last PROGRAM call. This key can
 262                 be used in the same or in any later rule after a PROGRAM call.</para>
 263               </listitem>
 264             </varlistentry>
 265           </variablelist>
 266
 267           <para>Most of the fields support a shell style pattern matching. The following
 268           pattern characters are supported:</para>
 269           <variablelist>
 270             <varlistentry>
 271               <term><option>*</option></term>
 272               <listitem>
 273                 <para>Matches zero, or any number of characters.</para>
 274               </listitem>
 275             </varlistentry>
 276             <varlistentry>
 277               <term><option>?</option></term>
 278               <listitem>
 279                 <para>Matches any single character.</para>
 280               </listitem>
 281             </varlistentry>
 282             <varlistentry>
 283               <term><option>[]</option></term>
 284               <listitem>
 285                 <para>Matches any single character specified within the brackets. For
 286                 example, the pattern string 'tty[SR]' would match either 'ttyS' or 'ttyR'.
 287                 Ranges are also supported within this match with the '-' character.
 288                 For example, to match on the range of all digits, the pattern [0-9] would
 289                 be used. If the first character following the '[' is a '!', any characters
 290                 not enclosed are matched.</para>
 291               </listitem>
 292             </varlistentry>
 293           </variablelist>
 294
 295           <para>The following keys can get values assigned:</para>
 296           <variablelist>
 297             <varlistentry>
 298               <term><option>NAME</option></term>
 299               <listitem>
 300                 <para>The name of the node to be created, or the name the network interface
 301                 should be renamed to.</para>
 302               </listitem>
 303             </varlistentry>
 304
 305             <varlistentry>
 306               <term><option>SYMLINK</option></term>
 307               <listitem>
 308                 <para>The name of a symlink targeting the node. Every matching rule will add
 309                 this value to the list of symlinks to be created along with the device  node.
 310                 Multiple symlinks may be specified by separating the names by the space
 311                 character.</para>
 312               </listitem>
 313             </varlistentry>
 314
 315             <varlistentry>
 316               <term><option>OWNER, GROUP, MODE</option></term>
 317               <listitem>
 318                 <para>The permissions for the device node. Every specified value overwrites
 319                 the compiled-in default value.</para>
 320               </listitem>
 321             </varlistentry>
 322
 323             <varlistentry>
 324               <term><option>ATTR{<replaceable>key</replaceable>}</option></term>
 325               <listitem>
 326                 <para>The value that should be written to a sysfs attribute of the
 327                 event device.</para>
 328               </listitem>
 329             </varlistentry>
 330
 331             <varlistentry>
 332               <term><option>ENV{<replaceable>key</replaceable>}</option></term>
 333               <listitem>
 334                 <para>Set a device property value. Property names with a leading '.'
 335                 are not stored in the database or exported to external tool or events.</para>
 336               </listitem>
 337             </varlistentry>
 338
 339             <varlistentry>
 340               <term><option>RUN</option></term>
 341               <listitem>
 342                 <para>Add a program to the list of programs to be executed for a specific
 343                 device. This can only be used for very short running tasks. Running an
 344                 event process for a long period of time may block all further events for
 345                 this or a dependent device. Long running tasks need to be immediately
 346                 detached from the event process itself. If the option
 347                 <option>RUN{<replaceable>fail_event_on_error</replaceable>}</option> is
 348                 specified, and the executed program returns non-zero, the event will be
 349                 marked as failed for a possible later handling.</para>
 350                 <para>If no path is given, the program must be in
 351                 <filename>/lib/udev</filename>, otherwise the full path must be
 352                 specified.</para>
 353                 <para>If the specified string starts with
 354                 <option>socket:<replaceable>path</replaceable></option>, all current event
 355                 values will be passed to the specified socket, as a message in the same
 356                 format the kernel sends an uevent. If the first character of the specified path
 357                 is an @ character, an abstract namespace socket is used, instead of an existing
 358                 socket file.</para>
 359                 <para>Program name and arguments are separated with spaces. To
 360                 include spaces in an argument, use single quotes. Please note
 361                 that this does not run through a shell.</para>
 362               </listitem>
 363             </varlistentry>
 364
 365             <varlistentry>
 366               <term><option>LABEL</option></term>
 367               <listitem>
 368                 <para>Named label where a GOTO can jump to.</para>
 369               </listitem>
 370             </varlistentry>
 371
 372             <varlistentry>
 373               <term><option>GOTO</option></term>
 374               <listitem>
 375                 <para>Jumps to the next LABEL with a matching name</para>
 376               </listitem>
 377             </varlistentry>
 378
 379             <varlistentry>
 380               <term><option>IMPORT{<replaceable>type</replaceable>}</option></term>
 381               <listitem>
 382                 <para>Import a set of variables as device properties,
 383                 depending on <replaceable>type</replaceable>:</para>
 384                 <variablelist>
 385                   <varlistentry>
 386                     <term><option>program</option></term>
 387                     <listitem>
 388                       <para>Execute an external program specified as the assigned value and
 389                       import its output, which must be in environment key
 390                       format. Path specification, command/argument separation,
 391                       and quoting work like in <option>RUN</option>.</para>
 392                     </listitem>
 393                   </varlistentry>
 394                   <varlistentry>
 395                     <term><option>file</option></term>
 396                     <listitem>
 397                       <para>Import a text file specified as the assigned value, which must be in
 398                       environment key format.</para>
 399                     </listitem>
 400                   </varlistentry>
 401                   <varlistentry>
 402                     <term><option>db</option></term>
 403                     <listitem>
 404                       <para>Import a single property specified as the assigned value from the
 405                       current device database. This works only if the database is already populated
 406                       by an earlier event.</para>
 407                     </listitem>
 408                   </varlistentry>
 409                   <varlistentry>
 410                     <term><option>parent</option></term>
 411                     <listitem>
 412                       <para>Import the stored keys from the parent device by reading
 413                       the database entry of the parent device. The value assigned to
 414                       <option>IMPORT{parent}</option> is used as a filter of key names
 415                       to import (with the same shell-style pattern matching used for
 416                       comparisons).</para>
 417                     </listitem>
 418                   </varlistentry>
 419                 </variablelist>
 420                 <para>If no option is given, udev will choose between <option>program</option>
 421                 and <option>file</option> based on the executable bit of the file
 422                 permissions.</para>
 423               </listitem>
 424             </varlistentry>
 425
 426             <varlistentry>
 427               <term><option>WAIT_FOR</option></term>
 428               <listitem>
 429                 <para>Wait for a file to become available.</para>
 430               </listitem>
 431             </varlistentry>
 432
 433             <varlistentry>
 434               <term><option>OPTIONS</option></term>
 435               <listitem>
 436                 <para>Rule and device options:</para>
 437                 <variablelist>
 438                   <varlistentry>
 439                     <term><option>ignore_remove</option></term>
 440                     <listitem>
 441                       <para>Do not remove the device node when the device goes away. This may be
 442                       useful as a workaround for broken device drivers.</para>
 443                     </listitem>
 444                   </varlistentry>
 445                   <varlistentry>
 446                     <term><option>link_priority=<replaceable>value</replaceable></option></term>
 447                     <listitem>
 448                       <para>Specify the priority of the created symlinks. Devices with higher
 449                       priorities overwrite existing symlinks of other devices. The default is 0.</para>
 450                     </listitem>
 451                   </varlistentry>
 452                   <varlistentry>
 453                     <term><option>all_partitions</option></term>
 454                     <listitem>
 455                       <para>Create the device nodes for all available partitions of a block device.
 456                       This may be useful for removable media devices where media changes are not
 457                       detected.</para>
 458                     </listitem>
 459                   </varlistentry>
 460                   <varlistentry>
 461                     <term><option>event_timeout=</option></term>
 462                     <listitem>
 463                       <para>Number of seconds an event will wait for operations to finish, before it
 464                       will terminate itself.</para>
 465                     </listitem>
 466                   </varlistentry>
 467                   <varlistentry>
 468                     <term><option>string_escape=<replaceable>none|replace</replaceable></option></term>
 469                     <listitem>
 470                       <para>Usually control and other possibly unsafe characters are replaced
 471                       in strings used for device naming. The mode of replacement can be specified
 472                       with this option.</para>
 473                     </listitem>
 474                   </varlistentry>
 475                   <varlistentry>
 476                     <term><option>watch</option></term>
 477                     <listitem>
 478                       <para>Watch the device node with inotify, when closed after being opened for
 479                       writing, a change uevent will be synthesised.</para>
 480                     </listitem>
 481                   </varlistentry>
 482                 </variablelist>
 483               </listitem>
 484             </varlistentry>
 485           </variablelist>
 486
 487           <para>The <option>NAME</option>, <option>SYMLINK</option>, <option>PROGRAM</option>,
 488           <option>OWNER</option>, <option>GROUP</option>, <option>MODE</option>  and  <option>RUN</option>
 489           fields support simple printf-like string substitutions. The <option>RUN</option>
 490           format chars gets applied after all rules have been processed, right before the program
 491           is executed. It allows the use of device properties set by earlier matching
 492           rules. For all other fields, substitutions are applied while the individual rule is
 493           being processed. The available substitutions are:</para>
 494           <variablelist>
 495             <varlistentry>
 496               <term><option>$kernel</option>, <option>%k</option></term>
 497               <listitem>
 498                 <para>The kernel name for this device.</para>
 499               </listitem>
 500             </varlistentry>
 501
 502             <varlistentry>
 503               <term><option>$number</option>, <option>%n</option></term>
 504               <listitem>
 505                 <para>The kernel number for this device. For example, 'sda3' has
 506                 kernel number of '3'</para>
 507               </listitem>
 508             </varlistentry>
 509
 510             <varlistentry>
 511               <term><option>$devpath</option>, <option>%p</option></term>
 512               <listitem>
 513                 <para>The devpath of the device.</para>
 514               </listitem>
 515             </varlistentry>
 516
 517             <varlistentry>
 518               <term><option>$id</option>, <option>%b</option></term>
 519               <listitem>
 520                 <para>The name of the device matched while searching the devpath upwards for
 521                   <option>SUBSYSTEMS</option>, <option>KERNELS</option>, <option>DRIVERS</option> and <option>ATTRS</option>.
 522                 </para>
 523               </listitem>
 524             </varlistentry>
 525
 526             <varlistentry>
 527               <term><option>$driver</option></term>
 528               <listitem>
 529                 <para>The driver name of the device matched while searching the devpath upwards for
 530                   <option>SUBSYSTEMS</option>, <option>KERNELS</option>, <option>DRIVERS</option> and <option>ATTRS</option>.
 531                 </para>
 532               </listitem>
 533             </varlistentry>
 534
 535             <varlistentry>
 536               <term><option>$attr{<replaceable>file</replaceable>}</option>, <option>%s{<replaceable>file</replaceable>}</option></term>
 537               <listitem>
 538                 <para>The value of a sysfs attribute found at the device, where
 539                 all keys of the rule have matched. If the matching device does not have
 540                 such an attribute, follow the chain of parent devices and use the value
 541                 of the first attribute that matches.
 542                 If the attribute is a symlink, the last element of the symlink target is
 543                 returned as the value.</para>
 544               </listitem>
 545             </varlistentry>
 546
 547             <varlistentry>
 548               <term><option>$env{<replaceable>key</replaceable>}</option>, <option>%E{<replaceable>key</replaceable>}</option></term>
 549               <listitem>
 550                 <para>A device property value.</para>
 551               </listitem>
 552             </varlistentry>
 553
 554             <varlistentry>
 555               <term><option>$major</option>, <option>%M</option></term>
 556               <listitem>
 557                 <para>The kernel major number for the device.</para>
 558               </listitem>
 559             </varlistentry>
 560
 561             <varlistentry>
 562               <term><option>$minor</option>, <option>%m</option></term>
 563               <listitem>
 564                 <para>The kernel minor number for the device.</para>
 565               </listitem>
 566             </varlistentry>
 567
 568             <varlistentry>
 569               <term><option>$result</option>, <option>%c</option></term>
 570               <listitem>
 571                 <para>The string returned by the external program requested with PROGRAM.
 572                 A single part of the string, separated by a space character may be selected
 573                 by specifying the part number as an attribute: <option>%c{N}</option>.
 574                 If the number is followed by the '+' char this part plus all remaining parts
 575                 of the result string are substituted: <option>%c{N+}</option></para>
 576               </listitem>
 577             </varlistentry>
 578
 579             <varlistentry>
 580               <term><option>$parent</option>, <option>%P</option></term>
 581               <listitem>
 582                 <para>The node name of the parent device.</para>
 583               </listitem>
 584             </varlistentry>
 585
 586             <varlistentry>
 587               <term><option>$name</option></term>
 588               <listitem>
 589                 <para>The current name of the device node. If not changed by a rule, it is the
 590                 name of the kernel device.</para>
 591               </listitem>
 592             </varlistentry>
 593
 594             <varlistentry>
 595               <term><option>$links</option></term>
 596               <listitem>
 597                 <para>The current list of symlinks, separated by a space character. The value is
 598                 only set if an earlier rule assigned a value, or during a remove events.</para>
 599               </listitem>
 600             </varlistentry>
 601
 602             <varlistentry>
 603               <term><option>$root</option>, <option>%r</option></term>
 604               <listitem>
 605                 <para>The udev_root value.</para>
 606               </listitem>
 607             </varlistentry>
 608
 609             <varlistentry>
 610               <term><option>$sys</option>, <option>%S</option></term>
 611               <listitem>
 612                 <para>The sysfs mount point.</para>
 613               </listitem>
 614             </varlistentry>
 615
 616             <varlistentry>
 617               <term><option>$tempnode</option>, <option>%N</option></term>
 618               <listitem>
 619                 <para>The name of a created temporary device node to provide access to
 620                 the device from a external program before the real node is created.</para>
 621               </listitem>
 622             </varlistentry>
 623
 624             <varlistentry>
 625               <term><option>%%</option></term>
 626               <listitem>
 627               <para>The '%' character itself.</para>
 628               </listitem>
 629             </varlistentry>
 630
 631             <varlistentry>
 632               <term><option>$$</option></term>
 633               <listitem>
 634               <para>The '$' character itself.</para>
 635               </listitem>
 636             </varlistentry>
 637           </variablelist>
 638         </refsect2>
 639       </refsect1>
 640
 641       <refsect1><title>AUTHOR</title>
 642         <para>Written by Greg Kroah-Hartman <email>greg@kroah.com</email> and
 643         Kay Sievers <email>kay.sievers@vrfy.org</email>. With much help from
 644         Dan Stekloff and many others.</para>
 645       </refsect1>
 646
 647       <refsect1>
 648         <title>SEE ALSO</title>
 649         <para><citerefentry>
 650             <refentrytitle>udevd</refentrytitle><manvolnum>8</manvolnum>
 651           </citerefentry>,
 652           <citerefentry>
 653             <refentrytitle>udevadm</refentrytitle><manvolnum>8</manvolnum>
 654         </citerefentry></para>
 655       </refsect1>
 656     </refentry>
 657   </section>
 658 </article>