udev.8

   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 .P
   7 The environment must provide the following variables:
   8 .TP
   9 .B ACTION
  10 .IR add " or " remove
  11 signifies the connection or disconnection of a device.
  12 .TP
  13 .B DEVPATH
  14 The sysfs devpath of the device without the mountpoint but a leading slash.
  15 .P
  16 Additional optional environment variables are:
  17 .TP
  18 .B UDEV_CONFIG_FILE
  19 Overrides the default location of the
  20 .B udev
  21 config file.
  22 .TP
  23 .B UDEV_NO_SLEEP
  24 The default behavior of
  25 .B udev
  26 is to wait until all the sysfs files of the device chain are populated. If set
  27 .B udev
  28 will continue, regardless of the state of the device representation.
  29 .SH "DESCRIPTION"
  30 .B udev
  31 creates or removes device node files usually located in the /dev directory.
  32 It provides a dynamic device directory that contains only the files for
  33 devices that are actually present.
  34 .P
  35 As part of the
  36 .B hotplug
  37 subsystem,
  38 .B udev
  39 is executed if a kernel device is added or removed from the system.
  40 On device creation,
  41 .B udev
  42 reads the sysfs directory of the given device to collect device attributes
  43 like label, serial number or bus device number.
  44 These attributes may used as keys to determine a
  45 unique name for device file creation.
  46 .B udev
  47 maintains a database for devices present on the system.
  48 .br
  49 On device removal,
  50 .B udev
  51 queries its database for the name of the device file to be deleted.
  52 .SH "CONFIGURATION"
  53 All
  54 .B udev
  55 configuration files consist of a set of lines of text.  All empty
  56 lines, and lines beginning with a '#' will be ignored.
  57 .P
  58
  59 .B udev
  60 expects its main configuration file at
  61 .IR /etc/udev/udev.conf .
  62 The file consists of a set of variables and values that allow the user to
  63 override default udev values.  The current set of variables that can be
  64 overridden in this file is:
  65 .TP
  66 .B udev_root
  67 This is the where in the filesystem to place the device nodes.  The default
  68 value for this is
  69 .IR /udev/ .
  70 .TP
  71 .B udev_db
  72 The name and location of the udev database.  The default value for this is
  73 .IR /udev/.udev.tdb .
  74 .TP
  75 .B udev_rules
  76 This is the location of the udev rules file.  The default value for this is
  77 .IR /etc/udev/udev.rules .
  78 If a directory is specified, the whole directory is
  79 scanned for files ending with
  80 .I .rules
  81 and all rule files are read in lexical order.
  82 .TP
  83 .B udev_permissions
  84 This is the location of the udev permission file. The default value for this is
  85 .IR /etc/udev/udev.permissions .
  86 If a directory is specified, the whole directory is scanned for files ending with
  87 .I .permissions
  88 and all permission files are read in lexical order.
  89 .TP
  90 .B udev_log
  91 If you want udev to log some information to the syslog for every node created or
  92 removed. The default value for this is
  93 .IR yes .
  94 .TP
  95 .B default_mode
  96 This is the default mode for all nodes that have no explicit match in the
  97 permissions file.  The default value for this is
  98 .IR 0666 .
  99 .TP
 100 .B default_owner
 101 This is the default owner for all nodes that have no explicit match in the
 102 permissions file.  The default value for this is
 103 .IR root .
 104 .TP
 105 .B default_group
 106 This is the default group for all nodes that have no explicit match in the
 107 permissions file.  The default value for this is
 108 .IR root .
 109 .br
 110 .P
 111 .RI "A sample " udev.conf " might look like this:
 112 .sp
 113 .nf
 114 # udev_root - where in the filesystem to place the device nodes
 115 udev_root="/udev/"
 116
 117 # udev_db - The name and location of the udev database.
 118 udev_db="/udev/.udev.tdb"
 119
 120 # udev_rules - The location of the directory where to look for files
 121                which names ending with .rules
 122 udev_rules="/etc/udev/"
 123
 124 # udev_permissions - The name and location of the udev permission file
 125 udev_permissions="/etc/udev/udev.permissions"
 126
 127 # udev_log - set to "yes" if you want logging, else "no"
 128 udev_log="yes"
 129
 130 # default_mode - set the default mode for all nodes that have no
 131 #                explicit match in the permissions file
 132 default_mode="0666"
 133
 134 # default_owner - set the default owner for all nodes that have no
 135 #                 explicit match in the permissions file
 136 default_owner="root"
 137
 138 # default_group - set the default group for all nodes that have no
 139 #                 explicit match in the permissions file
 140 default_group="root"
 141 .fi
 142 .P
 143 The rules for udev to use when naming devices may specified at
 144 .I /etc/udev/udev.rules
 145 or specified by the
 146 .I udev_rules
 147 value in the
 148 .I /etc/udev/udev.conf
 149 file.
 150 .P
 151 Every line in the rules file defines the mapping between device attributes
 152 and the device file name. One ore more keys are specified to match a rule
 153 with the current device. If all keys are matching, the rule will be applied
 154 and the name is used for the device node.
 155 .br
 156 If no matching rule is found, the default kernel device name is used.
 157 .P
 158 Every rule consists of a list a comma separated fields:
 159 .sp
 160 .IR "key " ,[ "key " ,...] " name " [, " symlink" ]
 161 .sp
 162 where possible fields are:
 163 .TP
 164 .B BUS
 165 Match the bus type of the device.
 166 (The sysfs device bus must be able to be determined by a "device" symlink.)
 167 .TP
 168 .B KERNEL
 169 Match the kernel device name.
 170 .TP
 171 .B ID
 172 Match the device number on the bus, like PCI bus id.
 173 .TP
 174 .B PLACE
 175 Match the topological position on bus, like physical port of USB device
 176 .TP
 177 .BI SYSFS{ filename }
 178 Match sysfs device attribute like label, vendor, USB serial number, SCSI UUID
 179 or file system label.  Up to 5 different sysfs files can be checked, with
 180 all of the values being required in order to match the rule.
 181 .br
 182 Trailing whitespace characters in the sysfs attribute value are ignored, if
 183 the key doesn't have any trailing whitespace characters by itself.
 184 .TP
 185 .B PROGRAM
 186 Call external program. This key is valid if the program returns successful.
 187 The environment variables of
 188 .B udev
 189 are also available for the program.
 190 .br
 191 The string returned by the program may additionally matched with the
 192 .B RESULT
 193 key.
 194 .TP
 195 .B RESULT
 196 Match the returned string of the last
 197 .B PROGRAM
 198 call. This key may used in any following rule after a
 199 .B PROGRAM
 200 call.
 201 .TP
 202 .B NAME
 203 The name of the node to be created. If the name field is omitted or its
 204 value is empty, the device will be ignored and no node will be created.
 205 .br
 206 If given with the attribute
 207 .BR NAME{ all_partitions }
 208 it will  create all 15 partitions of a blockdevice.
 209 This may be useful for removable media devices.
 210 .TP
 211 .B SYMLINK
 212 The name of a symlink targeting the node. Multiple symlinks may be
 213 specified by separating the names by the space character.
 214 .P
 215 .RB "The " NAME " ," SYMLINK " and " PROGRAM
 216 fields support simple printf-like string substitution:
 217 .TP
 218 .B %n
 219 The "kernel number" of the device.
 220 For example, 'sda3' has a "kernel number" of '3'.
 221 .TP
 222 .B %k
 223 The "kernel name" for the device.
 224 .TP
 225 .B %M
 226 The kernel major number for the device.
 227 .TP
 228 .B %m
 229 The kernel minor number for the device.
 230 .TP
 231 .B %b
 232 The bus id for the device.
 233 .TP
 234 .B %c
 235 The
 236 .B PROGRAM
 237 returned string.
 238 (This does not work within the
 239 .B PROGRAM
 240 field for the obvious reason.)
 241 .br
 242 A single part of the string, separated by the space character
 243 my be selected by specifying the part number as a attribute:
 244 .BI %c{ part }
 245 .TP
 246 .BI %s{ filename }
 247 The content of a sysfs attribute.
 248 .TP
 249 .B %%
 250 The '%' character itself.
 251 .P
 252 The count of charcters to insert may be limited by specifying
 253 the format length value. For example, '%3s{file}' will only insert
 254 the first three characters of the sysfs attribute.
 255 .P
 256 .RI "A sample " udev.rules " might look like this:"
 257 .sp
 258 .nf
 259 # if /sbin/scsi_id returns "OEM 0815" device will be called disk1
 260 BUS="scsi", PROGRAM="/sbin/scsi_id", RESULT="OEM 0815", NAME="disk1"
 261
 262 # USB printer to be called lp_color
 263 BUS="usb", SYSFS{serial}="W09090207101241330", NAME="lp_color"
 264
 265 # SCSI disk with a specific vendor and model number is to be called boot
 266 BUS="scsi", SYSFS{vendor}="IBM", SYSFS{model}="ST336", NAME="boot%n"
 267
 268 # sound card with PCI bus id 00:0b.0 to be called dsp
 269 BUS="pci", ID="00:0b.0", NAME="dsp"
 270
 271 # USB mouse at third port of the second hub to be called mouse1
 272 BUS="usb", PLACE="2.3", NAME="mouse1"
 273
 274 # ttyUSB1 should always be called pda with two additional symlinks
 275 KERNEL="ttyUSB1", NAME="pda", SYMLINK="palmtop handheld"
 276
 277 # multiple USB webcams with symlinks to be called webcam0, webcam1, ...
 278 BUS="usb", SYSFS{model}="XV3", NAME="video%n", SYMLINK="webcam%n"
 279 .fi
 280 .P
 281 Permissions and ownership for the created device files may specified at
 282 .I /etc/udev/udev.permissions
 283 or specified by the
 284 .I udev_permission
 285 value in the
 286 .I /etc/udev/udev.conf
 287 file.
 288 .br
 289 Every line lists a device name followed by owner, group and permission
 290 mode. All values are separated by colons. The name field may contain a
 291 pattern to apply the values to a whole class of devices.
 292 .sp
 293 .RI "A sample " udev.permissions " might look like this:"
 294 .sp
 295 .nf
 296 #name:user:group:mode
 297 input/*:root:root:644
 298 ttyUSB1:0:8:0660
 299 video*:root:video:0660
 300 dsp1:::0666
 301 .fi
 302 .P
 303 The value
 304 .I $local
 305 can be substituted for a specific username.  In that case, udev will determine
 306 the current local user at the time of device node creation and substitute
 307 that username as the owner of the new device node.  This is useful, for
 308 example, to let hot-plugged devices, such as cameras, be owned by the user at
 309 the current console.  Note that if no user is currently logged in, or if udev
 310 otherwise fails to determine a current user, the
 311 .I default_owner
 312 value is used in lieu.
 313 .P
 314 A number of different fields in the above configuration files support a simple
 315 form of shell style pattern matching. It supports the following pattern characters:
 316 .TP
 317 .B *
 318 Matches zero, one, or more characters.
 319 .TP
 320 .B ?
 321 Matches any single character, but does not match zero characters.
 322 .TP
 323 .B [ ]
 324 Matches any single character specified within the brackets. For example, the
 325 pattern string "tty[SR]" would match either "ttyS" or "ttyR".  Ranges are also
 326 supported within this match with the '\-' character.  For example, to match on
 327 the range of all digits, the pattern [0\-9] would be used. If the first character
 328 following the '[' is a '!' then any character not enclosed is matched.
 329 .SH "FILES"
 330 .nf
 331 /sbin/udev                           udev program
 332 /etc/udev/*                          udev config files
 333 /etc/hotplug.d/default/udev.hotplug  hotplug symlink to udev program
 334 .fi
 335 .LP
 336 .SH "SEE ALSO"
 337 .BR udevinfo (8),
 338 .BR udevd (8),
 339 .BR hotplug (8)
 340 .PP
 341 The
 342 .I http://linux\-hotplug.sourceforge.net/
 343 web site.
 344 .SH AUTHORS
 345 .B udev
 346 was developed by Greg Kroah-Hartman <greg@kroah.com> with much help from
 347 Dan Stekloff <dsteklof@us.ibm.com>, Kay Sievers <kay.sievers@vrfy.org>, and
 348 many others.