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 .SH "DESCRIPTION"
   7 .B udev
   8 creates or removes device node files usually located in the /dev directory.
   9 Its goal is to provide a dynamic device directory that contains only the files
  10 for devices that are actually present.
  11 .P
  12 As part of the
  13 .B hotplug
  14 subsystem,
  15 .B udev
  16 is executed if a kernel device is added or removed from the system.
  17 On device creation,
  18 .B udev
  19 reads the sysfs directory of the given device to collect device attributes
  20 like label, serial number or bus device number.
  21 These attributes may used as keys to determine a
  22 unique name for device file creation.
  23 .B udev
  24 maintains a database for devices present on the system.
  25 .br
  26 On device removal,
  27 .B udev
  28 queries its database for the name of the device file to be deleted.
  29 .SH "CONFIGURATION"
  30 All
  31 .B udev
  32 configuration files consist of a set of lines of text.  All empty
  33 lines, and lines beginning with a '#' will be ignored.
  34 .P
  35
  36 .B udev
  37 expects its main configuration file at
  38 .I /etc/udev/udev.conf.
  39 The file consists of a set of variables and values that allow the user to
  40 override default udev values.  The current set of variables that can be
  41 overridden in this file is:
  42 .TP
  43 .B udev_root
  44 This is the where in the filesystem to place the device nodes.  The default
  45 value for this is
  46 .I /udev/
  47 .TP
  48 .B udev_db
  49 The name and location of the udev database.  The default value for this is
  50 .I /udev/.udev.tdb
  51 .TP
  52 .B udev_rules
  53 This is the location of the udev rules file.  The default value for this is
  54 .I /etc/udev/udev.rules
  55 .TP
  56 .B udev_permissions
  57 This is the location of the udev permission file.  The default value for this is
  58 .I /etc/udev/udev.permissions
  59 .TP
  60 .B default_mode
  61 This is the default mode for all nodes that have no explicit match in the
  62 permissions file.  The default value for this is
  63 .I 0666
  64 .TP
  65 .B default_owner
  66 This is the default owner for all nodes that have no explicit match in the
  67 permissions file.  The default value for this is
  68 .I root
  69 .TP
  70 .B default_group
  71 This is the default group for all nodes that have no explicit match in the
  72 permissions file.  The default value for this is
  73 .I root
  74 .br
  75 .P
  76 .RI "A sample " udev.conf " might look like this:
  77 .sp
  78 .nf
  79 # udev_root - where in the filesystem to place the device nodes
  80 udev_root="/udev/"
  81
  82 # udev_db - The name and location of the udev database.
  83 udev_db="/udev/.udev.tdb"
  84
  85 # udev_rules - The name and location of the udev rules file
  86 udev_rules="/etc/udev/udev.rules"
  87
  88 # udev_permissions - The name and location of the udev permission file
  89 udev_permissions="/etc/udev/udev.permissions"
  90
  91 # default_mode - set the default mode for all nodes that have no
  92 #                explicit match in the permissions file
  93 default_mode="0666"
  94
  95 # default_owner - set the default owner for all nodes that have no
  96 #                 explicit match in the permissions file
  97 default_owner="root"
  98
  99 # default_group - set the default group for all nodes that have no
 100 #                 explicit match in the permissions file
 101 default_group="root"
 102 .fi
 103 .P
 104 The rules for udev to use when naming devices may specified at
 105 .I /etc/udev/udev.rules
 106 or specified by the
 107 .I udev_rules
 108 value in the
 109 .I /etc/udev/udev.conf
 110 file.
 111 .P
 112 Every line in the rules file defines the mapping between device attributes
 113 and the device file name. One ore more keys are specified to match a rule
 114 with the current device. If all keys are matching, the rule will be applied
 115 and the name is used for the device node. One or more optional symlinks
 116 targeting the node may be specified.
 117 .br
 118 If no matching rule is found, the default kernel device name is used.
 119 .P
 120 The line format is:
 121 .sp
 122 .I key,[key,...] name [, symlink]
 123 .sp
 124 where keys are:
 125 .TP
 126 .B BUS
 127 Match the bus type of the device.
 128 (The sysfs device bus must be able to be determined by a "device" symlink.)
 129 .TP
 130 .B KERNEL
 131 Match the kernel device name.
 132 .TP
 133 .B ID
 134 Match the device number on the bus, like PCI bus id.
 135 .TP
 136 .B PLACE
 137 Match the topological position on bus, like physical port of USB device
 138 .TP
 139 .BI SYSFS_ filename
 140 Match sysfs device attribute like label, vendor, USB serial number, SCSI UUID
 141 or file system label.  Up to 5 different sysfs files can be checked, with
 142 all of the values being required in order to match the rule.
 143 .TP
 144 .B PROGRAM
 145 Call external program. This key is valid if the program returns successful.
 146 The string returned by the program may additionally matched with the
 147 .B RESULT
 148 key.
 149 .TP
 150 .B RESULT
 151 Match the returned string of the last
 152 .B PROGRAM
 153 call. This key may used in any following rule after a
 154 .B PROGRAM
 155 call.
 156 .P
 157 .RB "The " NAME " ," SYMLINK " and " PROGRAM
 158 fields support simple printf-like string substitution:
 159 .TP
 160 .B %n
 161 The "kernel number" of the device.
 162 for example, 'sda3' has a "kernel number" of '3'
 163 .TP
 164 .B %k
 165 The "kernel name" for the device.
 166 .TP
 167 .B %M
 168 The kernel major number for the device.
 169 .TP
 170 .B %m
 171 The kernel minor number for the device.
 172 .TP
 173 .B %b
 174 The bus id for the device.
 175 .TP
 176 .B %c
 177 The
 178 .B PROGRAM
 179 returned string.
 180 (This does not work within the
 181 .B PROGRAM
 182 field for the obvious reason.)
 183 .TP
 184 .B %%
 185 The '%' char itself.
 186 .P
 187 .RI "A sample " udev.rules " might look like this:"
 188 .sp
 189 .nf
 190 # if /sbin/scsi_id returns "OEM 0815" device will be called disk1
 191 BUS="scsi", PROGRAM="/sbin/scsi_id", RESULT="OEM 0815", NAME="disk1"
 192
 193 # USB printer to be called lp_color
 194 BUS="usb", SYSFS_serial="W09090207101241330", NAME="lp_color"
 195
 196 # SCSI disk with a specific vendor and model number is to be called boot
 197 BUS="scsi", SYSFS_vendor="IBM", SYSFS_model="ST336", NAME="boot%n"
 198
 199 # sound card with PCI bus id 00:0b.0 to be called dsp
 200 BUS="pci", ID="00:0b.0", NAME="dsp"
 201
 202 # USB mouse at third port of the second hub to be called mouse1
 203 BUS="usb", PLACE="2.3", NAME="mouse1"
 204
 205 # ttyUSB1 should always be called pda with two additional symlinks
 206 KERNEL="ttyUSB1", NAME="pda", SYMLINK="palmtop handheld"
 207
 208 # multiple USB webcams with symlinks to be called webcam0, webcam1, ...
 209 BUS="usb", SYSFS_model="XV3", NAME="video%n", SYMLINK="webcam%n"
 210 .fi
 211 .P
 212 Permissions and ownership for the created device files may specified at
 213 .I /etc/udev/udev.permissions
 214 or specified by the
 215 .I udev_permission
 216 value in the
 217 .I /etc/udev/udev.conf
 218 file.
 219 .br
 220 Every line lists a device name followed by owner, group and permission
 221 mode. All values are separated by colons. The name field may contain a
 222 pattern to apply the values to a whole class of devices.
 223 .br
 224 If
 225 .B udev
 226 was built using klibc or is used before the user database is accessible (e.g.
 227 .BR initrd "(4)), only numeric owner and group values may be used."
 228 .sp
 229 .RI "A sample " udev.permissions " might look like this:"
 230 .sp
 231 .nf
 232 #name:user:group:mode
 233 input/*:root:root:644
 234 ttyUSB1:0:8:0660
 235 video*:root:video:0660
 236 dsp1:::0666
 237 .fi
 238 .P
 239 A number of different fields in the above configuration files support a simple
 240 form of shell style pattern matching. It supports the following pattern characters:
 241 .TP
 242 .B *
 243 Matches zero, one, or more characters.
 244 .TP
 245 .B ?
 246 Matches any single character, but does not match zero characters.
 247 .TP
 248 .B [ ]
 249 Matches any single character specified within the brackets. For example, the
 250 pattern string "tty[SR]" would match either "ttyS" or "ttyR".  Ranges are also
 251 supported within this match with the '-' character.  For example, to match on
 252 the range of all digits, the pattern [0-9] would be used. If the first character
 253 following the '[' is a '!' then any character not enclosed is matched.
 254 .SH "FILES"
 255 .nf
 256 /sbin/udev                           udev program
 257 /etc/udev/*                          udev config files
 258 /etc/hotplug.d/default/udev.hotplug  hotplug symlink to udev program
 259 .fi
 260 .LP
 261 .SH "SEE ALSO"
 262 .BR udevinfo (8),
 263 .BR hotplug (8)
 264 .PP
 265 The
 266 .I http://linux-hotplug.sourceforge.net/
 267 web site.
 268 .SH AUTHORS
 269 .B udev
 270 was developed by Greg Kroah-Hartman <greg@kroah.com> with much help from
 271 Dan Stekloff <dsteklof@us.ibm.com>, Kay Sievers <kay.sievers@vrfy.org>, and
 272 many others.