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 .TP
 149 .B SYMLINK
 150 The name of a symlink targeting the node. Multiple symlinks may be
 151 specified by separating the names by the space character.
 152 .br
 153 If both the name and the symlink fields are omitted or its
 154 values are empty, the device will be ignored and no node will be created.
 155 .br
 156 If only the symlink field is given and the name field is omitted,
 157 the rule will not be applied immediately, but the symlink field is added
 158 to the symlink list of the rule which will create the node.
 159 This makes it possible to specify additional symlinks in a possibly
 160 separate rules file, while the device nodes are maintained by the
 161 distribution provided rules file.
 162 .TP
 163 .B OWNER, GROUP, MODE
 164 The permissions for the device node. Every specified value overwrites the
 165 compiled-in default value.
 166 .TP
 167 .B OPTIONS
 168 .B ignore_device
 169 will ignore this device. No node will be created.
 170 .sp
 171 .B ignore_remove
 172 will ignore any later remove event for this device.
 173 This may be useful as a workaround for broken device drivers.
 174 .sp
 175 .B all_partitions
 176 will create device nodes for all available partitions of a blockdevice.
 177 This may be useful for removable media devices which do not detect a media
 178 change.
 179 .sp
 180 Multiple attributes may be separated by comma.
 181 .P
 182 .RB "The " NAME ", " SYMLINK ", " PROGRAM ", " OWNER " and " GROUP
 183 fields support simple printf-like string substitutions:
 184 .TP
 185 .B %n
 186 The "kernel number" of the device.
 187 For example, 'sda3' has a "kernel number" of '3'.
 188 .TP
 189 .B %k
 190 The "kernel name" for the device.
 191 .TP
 192 .B %p
 193 The devpath for the device.
 194 .TP
 195 .B %M
 196 The kernel major number for the device.
 197 .TP
 198 .B %m
 199 The kernel minor number for the device.
 200 .TP
 201 .B %b
 202 The bus id for the device.
 203 .TP
 204 .B %c
 205 The string returned by the external program, specified in
 206 .B PROGRAM
 207 (This does not work within the
 208 .B PROGRAM
 209 field for the obvious reason.)
 210 .br
 211 A single part of the string, separated by a space character
 212 may be selected by specifying the part number as an attribute:
 213 .BI %c{ N }
 214 If the number is followed by the + char this part plus
 215 all remaining parts of the result string are substituted:
 216 .BI %c{ N+ }
 217 .TP
 218 .B %N
 219 The name of a created temporary device node to provide access to the
 220 device from a external program.
 221 .TP
 222 .B %P
 223 The node name of the parent device.
 224 .TP
 225 .BI %s{ filename }
 226 The content of a sysfs attribute.
 227 .TP
 228 .B %e
 229 If a device node already exists with the name, the smallest positive
 230 decimal integer N is substituted such that the resulting name doesn't
 231 match an existing device node. Otherwise nothing is substituted. This
 232 can be used to create compatibility symlinks and enumerate devices of
 233 the same type originating from different kernel subsystems.
 234 .TP
 235 .B %%
 236 The '%' character itself.
 237 .P
 238 The count of charcters to insert may be limited by specifying
 239 the format length value. For example, '%3s{file}' will only insert
 240 the first three characters of the sysfs attribute.
 241 .P
 242 .RI "A sample " udev.rules " file might look like this:"
 243 .sp
 244 .nf
 245 # if /sbin/scsi_id returns "OEM 0815", the device will be called disk1
 246 BUS="scsi", PROGRAM="/sbin/scsi_id", RESULT="OEM 0815", NAME="disk1"
 247
 248 # USB printer to be called lp_color
 249 BUS="usb", SYSFS{serial}="W09090207101241330", NAME="lp_color"
 250
 251 # SCSI disk with a specific vendor and model number will be called boot
 252 BUS="scsi", SYSFS{vendor}="IBM", SYSFS{model}="ST336", NAME="boot%n"
 253
 254 # sound card with PCI bus id 00:0b.0 to be called dsp
 255 BUS="pci", ID="00:0b.0", NAME="dsp"
 256
 257 # USB mouse at third port of the second hub to be called mouse1
 258 BUS="usb", PLACE="2.3", NAME="mouse1"
 259
 260 # ttyUSB1 should always be called pda with two additional symlinks
 261 KERNEL="ttyUSB1", NAME="pda", SYMLINK="palmtop handheld"
 262
 263 # multiple USB webcams with symlinks to be called webcam0, webcam1, ...
 264 BUS="usb", SYSFS{model}="XV3", NAME="video%n", SYMLINK="webcam%n"
 265
 266 # grouping of optical drives from multiple kernel subsystems
 267 KERNEL="sr*", NAME="%k", SYMLINK="cdrom%e"
 268 KERNEL="scd*", NAME="%k", SYMLINK="cdrom%e"
 269 KERNEL="pcd*", NAME="%k", SYMLINK="cdrom%e"
 270 KERNEL="hd[a-z]", PROGRAM="/bin/cat /proc/ide/%k/media", RESULT="cdrom",
 271   NAME="%k", SYMLINK="cdrom%e"
 272 .fi
 273 .P
 274 A number of different fields in the above configuration files support a simple
 275 form of shell style pattern matching. It supports the following pattern characters:
 276 .TP
 277 .B *
 278 Matches zero, one, or more characters.
 279 .TP
 280 .B ?
 281 Matches any single character, but does not match zero characters.
 282 .TP
 283 .B [ ]
 284 Matches any single character specified within the brackets. For example, the
 285 pattern string "tty[SR]" would match either "ttyS" or "ttyR". Ranges are also
 286 supported within this match with the '\-' character. For example, to match on
 287 the range of all digits, the pattern [0\-9] would be used. If the first character
 288 following the '[' is a '!', any characters not enclosed are matched.
 289 .P
 290 After device node creation, removal, or network device renaming,
 291 .B udev
 292 executes the programs located in the directory tree under
 293 .IR /etc/dev.d/ .
 294 The name of a program must have the suffix
 295 .I .dev
 296 to be recognized.
 297 .br
 298 In addition to the hotplug environment variables,
 299 .B UDEV_LOG
 300 is set if udev is configured to use the syslog facility. Executed programs may
 301 want to follow that setting.
 302 .B DEVNAME
 303 is exported to make the name of the created node, or the name the network
 304 device is renamed to, available to the executed program. The programs in every
 305 directory are sorted in lexical order, while the directories are searched in
 306 the following order:
 307 .sp
 308 .nf
 309 /etc/dev.d/$(DEVNAME)/*.dev
 310 /etc/dev.d/$(SUBSYSTEM)/*.dev
 311 /etc/dev.d/default/*.dev
 312 .fi
 313 .SH "ENVIRONMENT"
 314 .P
 315 The following variables are read from the environment:
 316 .TP
 317 .B ACTION
 318 .IR add " or " remove
 319 signifies the addition or the removal of a device.
 320 .TP
 321 .B DEVPATH
 322 The sysfs devpath of the device without the mountpoint but a leading slash.
 323 .TP
 324 .B SUBSYSTEM
 325 The subsystem the device belongs to. Alternatively the subsystem may
 326 be passed as the first argument.
 327 .TP
 328 .B UDEV_CONFIG_FILE
 329 Overrides the default location of the
 330 .B udev
 331 config file.
 332 .TP
 333 .B UDEV_NO_DEVD
 334 The default behavior of
 335 .B udev
 336 is to execute programs in the
 337 .I /etc/dev.d/
 338 directory after device handling. If set,
 339 .B udev
 340 will skip this step.
 341 .SH "FILES"
 342 .nf
 343 /sbin/udev                           udev program
 344 /etc/udev/*                          udev config files
 345 /etc/hotplug.d/default/udev.hotplug  hotplug symlink to udev program
 346 /etc/dev.d/*                         programs invoked by udev
 347 .fi
 348 .SH "SEE ALSO"
 349 .BR udevinfo (8),
 350 .BR udevd (8),
 351 .BR hotplug (8)
 352 .PP
 353 .B Web resources:
 354 .nf
 355 .I http://linux\-hotplug.sourceforge.net/
 356 .I http://www.kernel.org/pub/linux/utils/kernel/hotplug/udev.html
 357 .fi
 358 .SH AUTHORS
 359 .B udev
 360 was developed by Greg Kroah-Hartman <greg@kroah.com> with much help from
 361 Dan Stekloff <dsteklof@us.ibm.com>, Kay Sievers <kay.sievers@vrfy.org>, and
 362 many others.