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