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 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. One or more optional symlinks
 155 targeting the node may be specified.
 156 .br
 157 If no matching rule is found, the default kernel device name is used.
 158 .P
 159 The line format is:
 160 .sp
 161 .I key,[key,...] name [, symlink]
 162 .sp
 163 where keys are:
 164 .TP
 165 .B BUS
 166 Match the bus type of the device.
 167 (The sysfs device bus must be able to be determined by a "device" symlink.)
 168 .TP
 169 .B KERNEL
 170 Match the kernel device name.
 171 .TP
 172 .B ID
 173 Match the device number on the bus, like PCI bus id.
 174 .TP
 175 .B PLACE
 176 Match the topological position on bus, like physical port of USB device
 177 .TP
 178 .BI SYSFS{ filename }
 179 Match sysfs device attribute like label, vendor, USB serial number, SCSI UUID
 180 or file system label.  Up to 5 different sysfs files can be checked, with
 181 all of the values being required in order to match the rule.
 182 .TP
 183 .B PROGRAM
 184 Call external program. This key is valid if the program returns successful.
 185 The environment variables of
 186 .B udev
 187 are also available for the program.
 188 .br
 189 The string returned by the program may additionally matched with the
 190 .B RESULT
 191 key.
 192 .TP
 193 .B RESULT
 194 Match the returned string of the last
 195 .B PROGRAM
 196 call. This key may used in any following rule after a
 197 .B PROGRAM
 198 call.
 199 .P
 200 The
 201 .B NAME
 202 field given with the attribute
 203 .BR NAME{ all_partitions }
 204 will  create all 15 partitions of a blockdevice.
 205 This may be useful for removable media devices.
 206 .P
 207 .RB "The " NAME " ," SYMLINK " and " PROGRAM
 208 fields support simple printf-like string substitution:
 209 .TP
 210 .B %n
 211 The "kernel number" of the device.
 212 For example, 'sda3' has a "kernel number" of '3'.
 213 .TP
 214 .B %k
 215 The "kernel name" for the device.
 216 .TP
 217 .B %M
 218 The kernel major number for the device.
 219 .TP
 220 .B %m
 221 The kernel minor number for the device.
 222 .TP
 223 .B %b
 224 The bus id for the device.
 225 .TP
 226 .B %c
 227 The
 228 .B PROGRAM
 229 returned string.
 230 (This does not work within the
 231 .B PROGRAM
 232 field for the obvious reason.)
 233 .br
 234 A single part of the string, separated by the space character
 235 my be selected by specifying the part number as a attribute:
 236 .BI %c{ part }
 237 .TP
 238 .BI %s{ filename }
 239 The content of a sysfs attribute.
 240 .TP
 241 .B %%
 242 The '%' character itself.
 243 .P
 244 The count of charcters to insert may be limited by specifying
 245 the format length value. For example, '%3s{file}' will only insert
 246 the first three characters of the sysfs attribute.
 247 .P
 248 .RI "A sample " udev.rules " might look like this:"
 249 .sp
 250 .nf
 251 # if /sbin/scsi_id returns "OEM 0815" device will be called disk1
 252 BUS="scsi", PROGRAM="/sbin/scsi_id", RESULT="OEM 0815", NAME="disk1"
 253
 254 # USB printer to be called lp_color
 255 BUS="usb", SYSFS{serial}="W09090207101241330", NAME="lp_color"
 256
 257 # SCSI disk with a specific vendor and model number is to be called boot
 258 BUS="scsi", SYSFS{vendor}="IBM", SYSFS{model}="ST336", NAME="boot%n"
 259
 260 # sound card with PCI bus id 00:0b.0 to be called dsp
 261 BUS="pci", ID="00:0b.0", NAME="dsp"
 262
 263 # USB mouse at third port of the second hub to be called mouse1
 264 BUS="usb", PLACE="2.3", NAME="mouse1"
 265
 266 # ttyUSB1 should always be called pda with two additional symlinks
 267 KERNEL="ttyUSB1", NAME="pda", SYMLINK="palmtop handheld"
 268
 269 # multiple USB webcams with symlinks to be called webcam0, webcam1, ...
 270 BUS="usb", SYSFS{model}="XV3", NAME="video%n", SYMLINK="webcam%n"
 271 .fi
 272 .P
 273 Permissions and ownership for the created device files may specified at
 274 .I /etc/udev/udev.permissions
 275 or specified by the
 276 .I udev_permission
 277 value in the
 278 .I /etc/udev/udev.conf
 279 file.
 280 .br
 281 Every line lists a device name followed by owner, group and permission
 282 mode. All values are separated by colons. The name field may contain a
 283 pattern to apply the values to a whole class of devices.
 284 .sp
 285 .RI "A sample " udev.permissions " might look like this:"
 286 .sp
 287 .nf
 288 #name:user:group:mode
 289 input/*:root:root:644
 290 ttyUSB1:0:8:0660
 291 video*:root:video:0660
 292 dsp1:::0666
 293 .fi
 294 .P
 295 A number of different fields in the above configuration files support a simple
 296 form of shell style pattern matching. It supports the following pattern characters:
 297 .TP
 298 .B *
 299 Matches zero, one, or more characters.
 300 .TP
 301 .B ?
 302 Matches any single character, but does not match zero characters.
 303 .TP
 304 .B [ ]
 305 Matches any single character specified within the brackets. For example, the
 306 pattern string "tty[SR]" would match either "ttyS" or "ttyR".  Ranges are also
 307 supported within this match with the '\-' character.  For example, to match on
 308 the range of all digits, the pattern [0\-9] would be used. If the first character
 309 following the '[' is a '!' then any character not enclosed is matched.
 310 .SH "FILES"
 311 .nf
 312 /sbin/udev                           udev program
 313 /etc/udev/*                          udev config files
 314 /etc/hotplug.d/default/udev.hotplug  hotplug symlink to udev program
 315 .fi
 316 .LP
 317 .SH "SEE ALSO"
 318 .BR udevinfo (8),
 319 .BR udevd (8),
 320 .BR hotplug (8)
 321 .PP
 322 The
 323 .I http://linux\-hotplug.sourceforge.net/
 324 web site.
 325 .SH AUTHORS
 326 .B udev
 327 was developed by Greg Kroah-Hartman <greg@kroah.com> with much help from
 328 Dan Stekloff <dsteklof@us.ibm.com>, Kay Sievers <kay.sievers@vrfy.org>, and
 329 many others.