udev.8.in

   1 .TH UDEV 8 "October 2003" "" "Linux Administrator's Manual"
   2 .SH NAME
   3 udev \- Linux configurable dynamic device naming support
   4 .SH SYNOPSIS
   5 .BI udev " hotplug-subsystem"
   6 .SH "DESCRIPTION"
   7 .B udev
   8 provides a dynamic device directory containing only the files for actually
   9 present devices. It creates or removes device node files usually located in
  10 the /dev directory, or it renames network interfaces.
  11 .br
  12 .P
  13 As part of the
  14 .B hotplug
  15 subsystem,
  16 .B udev
  17 is executed if a kernel device is added or removed from the system.
  18 On device creation,
  19 .B udev
  20 reads the sysfs directory of the given device to collect device attributes
  21 like label, serial number or bus device number.
  22 These attributes may be used as keys to determine a
  23 unique name for the device.
  24 .B udev
  25 maintains a database for devices present on the system.
  26 .br
  27 On device removal,
  28 .B udev
  29 queries its database for the name of the device file to be deleted.
  30 .SH "CONFIGURATION"
  31 All
  32 .B udev
  33 configuration files consist of a set of lines of text. All empty
  34 lines or lines beginning with '#' will be ignored.
  35 .P
  36 .B udev
  37 expects its main configuration file at
  38 .IR /etc/udev/udev.conf .
  39 The file consists of a set of variables and values allowing the user to
  40 override default udev values. The following variables can be overridden
  41 in this file:
  42 .TP
  43 .B udev_root
  44 Indicates where to place the device nodes in the filesystem. The default
  45 value is
  46 .IR @udevdir@/ .
  47 .TP
  48 .B udev_db
  49 The name and location of the udev database. The default value is
  50 .IR @udevdir@/.udevdb .
  51 .TP
  52 .B udev_rules
  53 The name of the udev rules file or directory to look for files with the suffix
  54 .IR .rules .
  55 All rule files are read in lexical order. The default value is
  56 .IR /etc/udev/rules.d/ .
  57 .TP
  58 .B udev_log
  59 The switch to enable/disable logging of udev information
  60 The default value is
  61 .IR yes .
  62 .P
  63 .RI "A sample " udev.conf " file might look like this:
  64 .sp
  65 .nf
  66 # udev_root - where to place the device nodes in the filesystem
  67 udev_root="/udev"
  68
  69 # udev_db - The name and location of the udev database
  70 udev_db="/udev/.udevdb"
  71
  72 # udev_rules - The name of the udev rules file or directory to look
  73                for files with the suffix .rules
  74 udev_rules="/etc/udev/rules.d/"
  75
  76 # udev_log - set to "yes" if you want logging, else "no"
  77 udev_log="yes"
  78 .fi
  79 .P
  80 The rules for device naming are read from the files located in the
  81 .I /etc/udev/rules.d/
  82 directory, or at the location specified by the
  83 .I udev_rules
  84 value in the
  85 .I /etc/udev/udev.conf
  86 file.
  87 .br
  88 Every line in the rules file defines the mapping between device attributes
  89 and the device name. One or more keys are specified to match a rule with
  90 the current device. If all keys are matching, the rule will be applied and
  91 the name is used to name the device file or the network interface.
  92 .br
  93 If no matching rule is found, the default kernel device name is used.
  94 .P
  95 Every rule consists of a list of comma separated fields:
  96 .sp
  97 .IR "key " ,[ "key " ,...] " name " [, " symlink" ]
  98 .sp
  99 where fields are:
 100 .TP
 101 .B BUS
 102 Match the bus type of the device.
 103 (The sysfs device bus must be able to be determined by a "device" symlink.)
 104 .TP
 105 .B KERNEL
 106 Match the kernel device name.
 107 .TP
 108 .B SUBSYSTEM
 109 Match the kernel subsystem name.
 110 .TP
 111 .B DRIVER
 112 Match the kernel driver name.
 113 .TP
 114 .B ID
 115 Match the device number on the bus, like PCI bus id.
 116 .TP
 117 .B PLACE
 118 Match the topological position on bus, like physical port of USB device
 119 .TP
 120 .BI SYSFS{ filename }
 121 Match sysfs device attribute like label, vendor, USB serial number, SCSI UUID
 122 or file system label. Up to 5 different sysfs files can be checked, with
 123 all of the values being required to match the rule.
 124 .br
 125 Trailing whitespace characters in the sysfs attribute value are ignored, if
 126 the key doesn't have any trailing whitespace characters by itself.
 127 .TP
 128 .B PROGRAM
 129 Call external program. This key is valid if the program returns successful.
 130 The environment variables of
 131 .B udev
 132 are also available for the program.
 133 .br
 134 The string returned by the program may be additionally matched with the
 135 .B RESULT
 136 key.
 137 .TP
 138 .B RESULT
 139 Match the returned string of the last
 140 .B PROGRAM
 141 call. This key may be used in any following rule after a
 142 .B PROGRAM
 143 call.
 144 .TP
 145 .B NAME
 146 The name of the node to be created, or the name, the network interface
 147 should be renamed to.
 148 .br
 149 If given with the attribute
 150 .BR NAME{ all_partitions }
 151 .B udev
 152 will create device nodes for all 15 partitions of a blockdevice.
 153 This may be useful for removable media devices.
 154 .br
 155 If given with the attribute
 156 .BR NAME{ ignore_remove }
 157 .B udev
 158 will ignore any later remove event for this device.
 159 This may be useful as a workaround for broken device drivers.
 160 .sp
 161 Multiple attributes may be separated by comma.
 162 .TP
 163 .B SYMLINK
 164 The name of a symlink targeting the node. Multiple symlinks may be
 165 specified by separating the names by the space character.
 166 .br
 167 If both the name and the symlink fields are omitted or its
 168 values are empty, the device will be ignored and no node will be created.
 169 .br
 170 If only the symlink field is given and the name field is omitted,
 171 the rule will not be applied immediately, but the symlink field is added
 172 to the symlink list of the rule which will create the node.
 173 This makes it possible to specify additional symlinks in a possibly
 174 separate rules file, while the device nodes are maintained by the
 175 distribution provided rules file.
 176 .TP
 177 .B OWNER, GROUP, MODE
 178 The permissions for the device node. Every specified value overwrites the
 179 compiled-in default value.
 180 .P
 181 .RB "The " NAME ", " SYMLINK ", " PROGRAM ", " OWNER " and " GROUP
 182 fields support simple printf-like string substitutions:
 183 .TP
 184 .B %n
 185 The "kernel number" of the device.
 186 For example, 'sda3' has a "kernel number" of '3'.
 187 .TP
 188 .B %k
 189 The "kernel name" for the device.
 190 .TP
 191 .B %p
 192 The devpath for the device.
 193 .TP
 194 .B %M
 195 The kernel major number for the device.
 196 .TP
 197 .B %m
 198 The kernel minor number for the device.
 199 .TP
 200 .B %b
 201 The bus id for the device.
 202 .TP
 203 .B %c
 204 The string returned by the external program, specified in
 205 .B PROGRAM
 206 (This does not work within the
 207 .B PROGRAM
 208 field for the obvious reason.)
 209 .br
 210 A single part of the string, separated by a space character
 211 may be selected by specifying the part number as an attribute:
 212 .BI %c{ N }
 213 If the number is followed by the + char this part plus
 214 all remaining parts of the result string are substituted:
 215 .BI %c{ N+ }
 216 .TP
 217 .B %N
 218 The name of a created temporary device node to provide access to the
 219 device from a external program.
 220 .TP
 221 .B %P
 222 The node name of the parent device.
 223 .TP
 224 .BI %s{ filename }
 225 The content of a sysfs attribute.
 226 .TP
 227 .B %e
 228 If a device node already exists with the name, the smallest positive
 229 decimal integer N is substituted such that the resulting name doesn't
 230 match an existing device node. Otherwise nothing is substituted. This
 231 can be used to create compatibility symlinks and enumerate devices of
 232 the same type originating from different kernel subsystems.
 233 .TP
 234 .B %%
 235 The '%' character itself.
 236 .P
 237 The count of charcters to insert may be limited by specifying
 238 the format length value. For example, '%3s{file}' will only insert
 239 the first three characters of the sysfs attribute.
 240 .P
 241 .RI "A sample " udev.rules " file might look like this:"
 242 .sp
 243 .nf
 244 # if /sbin/scsi_id returns "OEM 0815", the device will be called disk1
 245 BUS="scsi", PROGRAM="/sbin/scsi_id", RESULT="OEM 0815", NAME="disk1"
 246
 247 # USB printer to be called lp_color
 248 BUS="usb", SYSFS{serial}="W09090207101241330", NAME="lp_color"
 249
 250 # SCSI disk with a specific vendor and model number will be called boot
 251 BUS="scsi", SYSFS{vendor}="IBM", SYSFS{model}="ST336", NAME="boot%n"
 252
 253 # sound card with PCI bus id 00:0b.0 to be called dsp
 254 BUS="pci", ID="00:0b.0", NAME="dsp"
 255
 256 # USB mouse at third port of the second hub to be called mouse1
 257 BUS="usb", PLACE="2.3", NAME="mouse1"
 258
 259 # ttyUSB1 should always be called pda with two additional symlinks
 260 KERNEL="ttyUSB1", NAME="pda", SYMLINK="palmtop handheld"
 261
 262 # multiple USB webcams with symlinks to be called webcam0, webcam1, ...
 263 BUS="usb", SYSFS{model}="XV3", NAME="video%n", SYMLINK="webcam%n"
 264
 265 # grouping of optical drives from multiple kernel subsystems
 266 KERNEL="sr*", NAME="%k", SYMLINK="cdrom%e"
 267 KERNEL="scd*", NAME="%k", SYMLINK="cdrom%e"
 268 KERNEL="pcd*", NAME="%k", SYMLINK="cdrom%e"
 269 KERNEL="hd[a-z]", PROGRAM="/bin/cat /proc/ide/%k/media", RESULT="cdrom",
 270   NAME="%k", SYMLINK="cdrom%e"
 271 .fi
 272 .P
 273 A number of different fields in the above configuration files support a simple
 274 form of shell style pattern matching. It supports the following pattern characters:
 275 .TP
 276 .B *
 277 Matches zero, one, or more characters.
 278 .TP
 279 .B ?
 280 Matches any single character, but does not match zero characters.
 281 .TP
 282 .B [ ]
 283 Matches any single character specified within the brackets. For example, the
 284 pattern string "tty[SR]" would match either "ttyS" or "ttyR". Ranges are also
 285 supported within this match with the '\-' character. For example, to match on
 286 the range of all digits, the pattern [0\-9] would be used. If the first character
 287 following the '[' is a '!', any characters not enclosed are matched.
 288 .P
 289 After device node creation, removal, or network device renaming,
 290 .B udev
 291 executes the programs located in the directory tree under
 292 .IR /etc/dev.d/ .
 293 The name of a program must have the suffix
 294 .I .dev
 295 to be recognized.
 296 .br
 297 In addition to the hotplug environment variables,
 298 .B UDEV_LOG
 299 is set if udev is configured to use the syslog facility. Executed programs may
 300 want to follow that setting.
 301 .B DEVNAME
 302 is exported to make the name of the created node, or the name the network
 303 device is renamed to, available to the executed program. The programs in every
 304 directory are sorted in lexical order, while the directories are searched in
 305 the following order:
 306 .sp
 307 .nf
 308 /etc/dev.d/$(DEVNAME)/*.dev
 309 /etc/dev.d/$(SUBSYSTEM)/*.dev
 310 /etc/dev.d/default/*.dev
 311 .fi
 312 .SH "ENVIRONMENT"
 313 .P
 314 The following variables are read from the environment:
 315 .TP
 316 .B ACTION
 317 .IR add " or " remove
 318 signifies the addition or the removal of a device.
 319 .TP
 320 .B DEVPATH
 321 The sysfs devpath of the device without the mountpoint but a leading slash.
 322 .TP
 323 .B SUBSYSTEM
 324 The subsystem the device belongs to. Alternatively the subsystem may
 325 be passed as the first argument.
 326 .TP
 327 .B UDEV_CONFIG_FILE
 328 Overrides the default location of the
 329 .B udev
 330 config file.
 331 .TP
 332 .B UDEV_NO_DEVD
 333 The default behavior of
 334 .B udev
 335 is to execute programs in the
 336 .I /etc/dev.d/
 337 directory after device handling. If set,
 338 .B udev
 339 will skip this step.
 340 .SH "FILES"
 341 .nf
 342 /sbin/udev                           udev program
 343 /etc/udev/*                          udev config files
 344 /etc/hotplug.d/default/udev.hotplug  hotplug symlink to udev program
 345 /etc/dev.d/*                         programs invoked by udev
 346 .fi
 347 .SH "SEE ALSO"
 348 .BR udevinfo (8),
 349 .BR udevd (8),
 350 .BR hotplug (8)
 351 .PP
 352 .B Web resources:
 353 .nf
 354 .I http://linux\-hotplug.sourceforge.net/
 355 .I http://www.kernel.org/pub/linux/utils/kernel/hotplug/udev.html
 356 .fi
 357 .SH AUTHORS
 358 .B udev
 359 was developed by Greg Kroah-Hartman <greg@kroah.com> with much help from
 360 Dan Stekloff <dsteklof@us.ibm.com>, Kay Sievers <kay.sievers@vrfy.org>, and
 361 many others.