docs/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   <articleinfo>
   7     <title>xmlto</title>
   8     <author>
   9       <firstname>Kay</firstname>
  10       <surname>Sievers</surname>
  11       <email>kay.sievers@vrfy.org</email>
  12     </author>
  13     <copyright>
  14       <year>2005</year>
  15       <holder>Kay Sievers</holder>
  16     </copyright>
  17   </articleinfo>
  18
  19   <section>
  20     <title>udev</title>
  21     <refentry>
  22       <refentryinfo>
  23         <title>udev</title>
  24         <date>August 2005</date>
  25         <productname>udev</productname>
  26       </refentryinfo>
  27
  28       <refmeta>
  29         <refentrytitle>udev</refentrytitle>
  30         <manvolnum>8</manvolnum>
  31       </refmeta>
  32
  33       <refnamediv>
  34         <refname>udev</refname>
  35         <refpurpose>dynamic device management</refpurpose>
  36       </refnamediv>
  37
  38       <refsect1><title>DESCRIPTION</title>
  39         <para>udev provides a dynamic device directory containing only the files for
  40         actually present devices. It creates or removes device node files in the
  41         <filename>/dev</filename> directory, or it renames network interfaces.</para>
  42
  43         <para>Usually udev runs as <citerefentry><refentrytitle>udevd</refentrytitle>
  44         <manvolnum>8</manvolnum></citerefentry> and receives uevents directly from the
  45         kernel if a device is added or removed form the system.</para>
  46
  47         <para>If udev receives a device event, it matches its configured rules
  48         against the available device attributes provided in sysfs to identify the device.
  49         Rules that match, may provide additional device information or specify a device
  50         node name and multiple symlink names and instruct udev to run additional programs
  51         as part of the device event handling.</para>
  52       </refsect1>
  53
  54       <refsect1><title>CONFIGURATION</title>
  55         <para>All udev configuration files are placed in <filename>/etc/udev/*</filename>.
  56         Every file consist of a set of lines of text. All empty lines or lines beginning
  57         with '#' will be ignored.</para>
  58
  59         <refsect2><title>Configuration file</title>
  60           <para>udev expects its main configuration file at <filename>/etc/udev/udev.conf</filename>.
  61           It consists of a set of variables allowing the user to override default udev values.
  62           The following variables can be set:</para>
  63           <variablelist>
  64             <varlistentry>
  65               <term><option>udev_root</option></term>
  66               <listitem>
  67                 <para>Specifies where to place the device nodes in the filesystem.
  68                 The default value is <filename>/dev</filename>.</para>
  69               </listitem>
  70             </varlistentry>
  71
  72             <varlistentry>
  73               <term><option>udev_rules</option></term>
  74               <listitem>
  75                 <para>The name of the udev rules file or directory to look for files
  76                 with the suffix <filename>.rules</filename>. Multiple rule files are
  77                 read in lexical order. The default value is
  78                 <filename>/etc/udev/rules.d</filename>.</para>
  79               </listitem>
  80             </varlistentry>
  81
  82             <varlistentry>
  83               <term><option>udev_log</option></term>
  84               <listitem>
  85                 <para>The logging priority. Valid values are the numerical syslog priorities
  86                 or their textual representations: <option>err</option>, <option>info</option>
  87                 and <option>debug</option>.</para>
  88               </listitem>
  89             </varlistentry>
  90           </variablelist>
  91         </refsect2>
  92
  93         <refsect2><title>Rules files</title>
  94           <para>The udev rules are read from the files located in the
  95           <filename>/etc/udev/rules.d</filename> directory or at the location specified
  96           value in the configuraton file. Every line in the rules file contains at least
  97           one key value pair. There are two kind of keys, match and assignement keys.
  98           If all match keys are matching against its value, the rule gets applied and the
  99           assign keys get the specified value assigned. A matching rule may specify the
 100           name of the device node, add a symlink pointing to the node, or run a specified
 101           program as part of the event handling. If no matching rule is found, the default
 102           device node name is used.</para>
 103
 104           <para>A rule may consists of a list of one or more key value pairs separated by
 105           a comma. Each key has a distinct operation, depending on the used operator. Valid
 106           operators are:</para>
 107           <variablelist>
 108             <varlistentry>
 109               <term><option>==</option></term>
 110               <listitem>
 111                 <para>Compare for equality.</para>
 112               </listitem>
 113             </varlistentry>
 114
 115             <varlistentry>
 116               <term><option>!=</option></term>
 117               <listitem>
 118                 <para>Compare for non-equality.</para>
 119               </listitem>
 120             </varlistentry>
 121
 122             <varlistentry>
 123               <term><option>=</option></term>
 124               <listitem>
 125                 <para>Asign a value to a key. Keys that represent a list, are reset
 126                 and only this single value is assigned.</para>
 127               </listitem>
 128             </varlistentry>
 129
 130             <varlistentry>
 131               <term><option>+=</option></term>
 132               <listitem>
 133                 <para>Add the value to a key that holds a list of entries.</para>
 134               </listitem>
 135             </varlistentry>
 136
 137             <varlistentry>
 138               <term><option>:=</option></term>
 139               <listitem>
 140                 <para>Assign  a  value  to  a key finally; disallow any later changes,
 141                 which may be used to prevent changes by any later rules.</para>
 142               </listitem>
 143             </varlistentry>
 144           </variablelist>
 145
 146           <para>The following key names can be used to match against device properties:</para>
 147           <variablelist>
 148             <varlistentry>
 149               <term><option>ACTION</option></term>
 150               <listitem>
 151                 <para>Match the kernel action name.</para>
 152               </listitem>
 153             </varlistentry>
 154
 155             <varlistentry>
 156               <term><option>KERNEL</option></term>
 157               <listitem>
 158                 <para>Match the kernel device name</para>
 159               </listitem>
 160             </varlistentry>
 161
 162             <varlistentry>
 163               <term><option>DEVPATH</option></term>
 164               <listitem>
 165                 <para>Match the kernel devpath.</para>
 166               </listitem>
 167             </varlistentry>
 168
 169             <varlistentry>
 170               <term><option>SUBSYSTEM</option></term>
 171               <listitem>
 172                 <para>Match the kernel subsystem name</para>
 173               </listitem>
 174             </varlistentry>
 175
 176             <varlistentry>
 177               <term><option>BUS</option></term>
 178               <listitem>
 179                 <para>Match the type of bus the device is connected to.</para>
 180               </listitem>
 181             </varlistentry>
 182
 183             <varlistentry>
 184               <term><option>DRIVER</option></term>
 185               <listitem>
 186                 <para>Match the kernel driver name.</para>
 187               </listitem>
 188             </varlistentry>
 189
 190             <varlistentry>
 191               <term><option>ID</option></term>
 192               <listitem>
 193                 <para>Match the device number on the bus.</para>
 194               </listitem>
 195             </varlistentry>
 196
 197             <varlistentry>
 198               <term><option>ENV{<replaceable>key</replaceable>}</option></term>
 199               <listitem>
 200                 <para>Match against the value of an environment key. Depending on
 201                 the specified operation, this key is also used as a assignment.</para>
 202               </listitem>
 203             </varlistentry>
 204
 205             <varlistentry>
 206               <term><option>SYSFS{<replaceable>filename</replaceable>}</option></term>
 207               <listitem>
 208                 <para>Match the sysfs attribute value. Up to five values can be specified.
 209                 Trailing whitespace is ignored, if the specified match value does not contain
 210                 trailing whitespace itself.</para>
 211               </listitem>
 212             </varlistentry>
 213
 214             <varlistentry>
 215               <term><option>PROGRAM</option></term>
 216               <listitem>
 217                 <para>Execute external program. The key is true, if the program returns
 218                 without exit code zero. The whole event environment is available to the
 219                 executed program. The program's output printed to stdout is available for
 220                 the RESULT key.</para>
 221               </listitem>
 222             </varlistentry>
 223
 224             <varlistentry>
 225               <term><option>RESULT</option></term>
 226               <listitem>
 227                 <para>Match the returned string of the last PROGRAM call. This key can
 228                 be used in the same or in any later rule after a PROGRAM call.</para>
 229               </listitem>
 230             </varlistentry>
 231           </variablelist>
 232
 233           <para>Most of the fields support a shell style pattern matching. The following
 234           pattern characters are supported:</para>
 235           <variablelist>
 236             <varlistentry>
 237               <term><option>*</option></term>
 238               <listitem>
 239                 <para>Matches zero, or any number of characters.</para>
 240               </listitem>
 241             </varlistentry>
 242             <varlistentry>
 243               <term><option>?</option></term>
 244               <listitem>
 245                 <para>Matches any single character.</para>
 246               </listitem>
 247             </varlistentry>
 248             <varlistentry>
 249               <term><option>[]</option></term>
 250               <listitem>
 251                 <para>Matches any single character specified within the brackets.
 252                 example, the pattern string 'tty[SR]' would match either 'ttyS' or 'ttyR'.
 253                 Ranges are also supported within this match with the '-' character.
 254                 For example, to match on the range of all digits, the pattern [0-9] would
 255                 be used. If the first character following the '[' is a '!', any characters
 256                 not enclosed are matched.</para>
 257               </listitem>
 258             </varlistentry>
 259           </variablelist>
 260
 261           <para>The following keys can get values assigned:</para>
 262           <variablelist>
 263             <varlistentry>
 264               <term><option>NAME</option></term>
 265               <listitem>
 266                 <para>The name of the node to be created, or the name the network interface
 267                 should be renamed to. Only one rule can set the node name, all later rules with
 268                 a NAME key will be ignored.</para>
 269               </listitem>
 270             </varlistentry>
 271
 272             <varlistentry>
 273               <term><option>SYMLINK</option></term>
 274               <listitem>
 275                 <para>The name of a symlink targeting the node. Every matching rule can add
 276                 this value to the list of symlinks to be created along with the device  node.
 277                 Multiple symlinks may be specified by separating the names by the space
 278                 character.</para>
 279               </listitem>
 280             </varlistentry>
 281
 282             <varlistentry>
 283               <term><option>OWNER, GROUP, MODE</option></term>
 284               <listitem>
 285                 <para>The permissions for the device node. Every specified value overwrites
 286                 the compiled-in default value.</para>
 287               </listitem>
 288             </varlistentry>
 289
 290             <varlistentry>
 291               <term><option>ENV{<replaceable>key</replaceable>}</option></term>
 292               <listitem>
 293                 <para>Export the key to the environment. Depending on the specified
 294                 operation, this key is also used as a match.</para>
 295               </listitem>
 296             </varlistentry>
 297
 298             <varlistentry>
 299               <term><option>RUN</option></term>
 300               <listitem>
 301                 <para>Add a program to the list of programs to be executed for a specific
 302                 device.</para>
 303               </listitem>
 304             </varlistentry>
 305
 306             <varlistentry>
 307               <term><option>LABEL</option></term>
 308               <listitem>
 309                 <para>Named label where a GOTO can jump to.</para>
 310               </listitem>
 311             </varlistentry>
 312
 313             <varlistentry>
 314               <term><option>GOTO</option></term>
 315               <listitem>
 316                 <para>Jumps to the next LABEL with a matching gname</para>
 317               </listitem>
 318             </varlistentry>
 319
 320             <varlistentry>
 321               <term><option>IMPORT{<replaceable>type</replaceable>}</option></term>
 322               <listitem>
 323                 <para>Import the printed result or the content of a file in environment key
 324                 format into the event environment. <option>program</option> will execute an
 325                 external program and read its output. <option>file</option> will inport a
 326                 text file. If no option is given, udev will determine it from the  executable
 327                 bit of of the file permissions.</para>
 328               </listitem>
 329             </varlistentry>
 330
 331             <varlistentry>
 332               <term><option>WAIT_FOR_SYSFS</option></term>
 333               <listitem>
 334                 <para>Wait for the specified sysfs file of the device to be created. May be used
 335                 to fight agains timing issues wth the kernel.</para>
 336               </listitem>
 337             </varlistentry>
 338
 339             <varlistentry>
 340               <term><option>OPTIONS</option></term>
 341               <listitem>
 342                 <para><option>last_rule</option> stops further rules application. No later rules
 343                 will have any effect.
 344                 <option>ignore_device</option> will ignore this event completely.
 345                 <option>ignore_remove</option> will ignore  any  later  remove  event  for  this
 346                 device. This may be useful as a workaround for broken device drivers.
 347                 <option>all_partitions</option> will create device nodes for all available partitions of
 348                 a block device. This may be useful for removable media.</para>
 349               </listitem>
 350             </varlistentry>
 351           </variablelist>
 352
 353           <para>The <option>NAME</option>, <option>SYMLINK</option>, <option>PROGRAM</option>,
 354           <option>OWNER</option>  and  <option>GROUP</option>  fields  support  simple
 355           printf-like string substitutions:</para>
 356           <variablelist>
 357             <varlistentry>
 358               <term><option>%k</option>, <option>$kernel</option></term>
 359               <listitem>
 360                 <para>The kernel name for this device.</para>
 361               </listitem>
 362             </varlistentry>
 363
 364             <varlistentry>
 365               <term><option>%b</option>, <option>$id</option></term>
 366               <listitem>
 367                 <para>The kernel bus id for this device.</para>
 368               </listitem>
 369             </varlistentry>
 370
 371             <varlistentry>
 372               <term><option>%n</option>, <option>$number</option></term>
 373               <listitem>
 374                 <para>The kernel number for this device. For example, 'sda3' has
 375                 kernel number of '3'</para>
 376               </listitem>
 377             </varlistentry>
 378
 379             <varlistentry>
 380               <term><option>%p</option>, <option>$devpath</option></term>
 381               <listitem>
 382                 <para>The devpath of the device.</para>
 383               </listitem>
 384             </varlistentry>
 385
 386             <varlistentry>
 387               <term><option>%s{<replaceable>file</replaceable>}</option>, <option>$sysfs{<replaceable>file</replaceable>}</option></term>
 388               <listitem>
 389                 <para>The content of a sysfs attribute.</para>
 390               </listitem>
 391             </varlistentry>
 392
 393             <varlistentry>
 394               <term><option>%E{<replaceable>key</replaceable>}</option>, <option>$env{<replaceable>key</replaceable>}</option></term>
 395               <listitem>
 396                 <para>The value of an environment variable.</para>
 397               </listitem>
 398             </varlistentry>
 399
 400             <varlistentry>
 401               <term><option>%m</option>, <option>$major</option></term>
 402               <listitem>
 403                 <para>The kernel major number for the device.</para>
 404               </listitem>
 405             </varlistentry>
 406
 407             <varlistentry>
 408               <term><option>%M</option> <option>$minor</option></term>
 409               <listitem>
 410                 <para>The kernel minor number for the device.</para>
 411               </listitem>
 412             </varlistentry>
 413
 414             <varlistentry>
 415               <term><option>%c</option>, <option>$result</option></term>
 416               <listitem>
 417                 <para>The string returned by the external program requested with PROGRAM.
 418                 A single part of the string, separated by a space character may be selected
 419                 by specifying the part number as an attribute: <option>%c{N}</option>.
 420                 If the number is followed by the '+' char this part plus all remaining parts
 421                 of the result string are substituted: <option>%c{N+}</option></para>
 422               </listitem>
 423             </varlistentry>
 424
 425             <varlistentry>
 426               <term><option>%P</option>, <option>$parent</option></term>
 427               <listitem>
 428                 <para>The node name of the parent device.</para>
 429               </listitem>
 430             </varlistentry>
 431
 432             <varlistentry>
 433               <term><option>%r</option>, <option>$root</option></term>
 434               <listitem>
 435                 <para>The udev_root value.</para>
 436               </listitem>
 437             </varlistentry>
 438
 439             <varlistentry>
 440               <term><option>%N</option>, <option>$tempnode</option></term>
 441               <listitem>
 442                 <para>The name of a created temporary device node to provide access to
 443                 the device from a external program before the real node is created.</para>
 444               </listitem>
 445             </varlistentry>
 446
 447             <varlistentry>
 448               <term><option>%%</option></term>
 449               <listitem>
 450               <para>The '%' character itself.</para>
 451               </listitem>
 452             </varlistentry>
 453
 454             <varlistentry>
 455               <term><option>$$</option></term>
 456               <listitem>
 457               <para>The '$' character itself.</para>
 458               </listitem>
 459             </varlistentry>
 460           </variablelist>
 461           <para>The count of characters to be substituted may be limited by specifying
 462           the format length value. For example, '%3s{file}' will only
 463           insert the first three characters of the sysfs attribute</para>
 464         </refsect2>
 465       </refsect1>
 466
 467       <refsect1><title>ENVIRONMENT</title>
 468         <variablelist>
 469           <varlistentry>
 470             <term><option>ACTION</option></term>
 471             <listitem>
 472               <para><replaceable>add</replaceable> or <replaceable>remove</replaceable> signifies
 473               the addition or the removal of a device.</para>
 474             </listitem>
 475           </varlistentry>
 476
 477           <varlistentry>
 478             <term><option>DEVPATH</option></term>
 479             <listitem>
 480               <para>The sysfs devpath without the mountpoint but a leading slash.</para>
 481             </listitem>
 482           </varlistentry>
 483
 484           <varlistentry>
 485             <term><option>SUBSYSTEM</option></term>
 486             <listitem>
 487               <para>The kernel subsystem the device belongs to.</para>
 488             </listitem>
 489           </varlistentry>
 490
 491           <varlistentry>
 492             <term><option>UDEV_LOG</option></term>
 493             <listitem>
 494               <para>Overrides the syslog priority specified in the config file.</para>
 495             </listitem>
 496           </varlistentry>
 497         </variablelist>
 498      </refsect1>
 499
 500       <refsect1><title>AUTHOR</title>
 501         <para>Written by Greg Kroah-Hartman <email>greg@kroah.com</email> and
 502         Kay Sievers <email>kay.sievers@vrfy.org</email>. With much help from
 503         Dan  Stekloff <email>dsteklof@us.ibm.com</email> and many others.</para>
 504       </refsect1>
 505
 506       <refsect1>
 507         <title>SEE ALSO</title>
 508         <para><citerefentry>
 509             <refentrytitle>udev</refentrytitle><manvolnum>8</manvolnum>
 510           </citerefentry>,
 511           <citerefentry>
 512             <refentrytitle>udevinfo</refentrytitle><manvolnum>8</manvolnum>
 513           </citerefentry>,
 514           <citerefentry>
 515             <refentrytitle>udevd</refentrytitle><manvolnum>8</manvolnum>
 516           </citerefentry>,
 517           <citerefentry>
 518             <refentrytitle>udevmonitor</refentrytitle><manvolnum>8</manvolnum>
 519         </citerefentry></para>
 520       </refsect1>
 521     </refentry>
 522   </section>
 523 </article>