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