chiark / gitweb /
[PATCH] let the extras/ programs build "pretty" also
[elogind.git] / 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 .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:
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_DEVD
24 The default behavior of
25 .B udev
26 is to execute programs in the
27 .I /etc/dev.d/
28 directory after device handling. If set,
29 .B udev
30 will skip this step.
31 .SH "DESCRIPTION"
32 .B udev
33 provides a dynamic device directory containing only the files for actually
34 present devices. It creates or removes device node files usually located in
35 the /dev directory, or it renames network interfaces.
36 .br
37
38 .P
39 As part of the
40 .B hotplug
41 subsystem,
42 .B udev
43 is executed if a kernel device is added or removed from the system.
44 On device creation,
45 .B udev
46 reads the sysfs directory of the given device to collect device attributes
47 like label, serial number or bus device number.
48 These attributes may be used as keys to determine a
49 unique name for the device.
50 .B udev
51 maintains a database for devices present on the system.
52 .br
53 On device removal,
54 .B udev
55 queries its database for the name of the device file to be deleted.
56 .SH "CONFIGURATION"
57 All
58 .B udev
59 configuration files consist of a set of lines of text.  All empty
60 lines and lines beginning with a '#' will be ignored.
61 .P
62
63 .B udev
64 expects its main configuration file at
65 .IR /etc/udev/udev.conf .
66 The file consists of a set of variables and values allowing the user to
67 override default udev values. The following variables can be overridden
68 in this file:
69 .TP
70 .B udev_root
71 Indicates where to place the device nodes in the filesystem. The default
72 value is
73 .IR @udevdir@/ .
74 .TP
75 .B udev_db
76 The name and location of the udev database. The default value is
77 .IR @udevdir@/.udev.tdb .
78 .TP
79 .B udev_rules
80 The name of the udev rules file or directory to look for files with the suffix
81 .IR .rules .
82 All rule files are read in lexical order. The default value is
83 .IR /etc/udev/rules.d/ .
84 .TP
85 .B udev_permissions
86 The name of the udev permission file or directory to look for files with the
87 suffix
88 .IR .permissions .
89 All permission files are read in lexical order. The default value is
90 .IR /etc/udev/permissions.d/ .
91 .TP
92 .B udev_log
93 The switch, if udev logs some information for every device handled.
94 The default value is
95 .IR yes .
96 .TP
97 .B default_mode
98 The default mode for all nodes not explicitely matching in the permissions
99 file. The default value is
100 .IR 0666 .
101 .TP
102 .B default_owner
103 The default owner for all nodes not explicitely matching in the permissions
104 file. The default value is
105 .IR root .
106 .TP
107 .B default_group
108 The default group for all nodes not explicitely matching in the permissions
109 file. The default value is
110 .IR root .
111 .br
112 .P
113 .RI "A sample " udev.conf " might look like this:
114 .sp
115 .nf
116 # udev_root - where to place the device nodes in the filesystem
117 udev_root="/udev"
118
119 # udev_db - The name and location of the udev database
120 udev_db="/udev/.udev.tdb"
121
122 # udev_rules - The name of the udev rules file or directory to look
123                for files with the suffix .rules
124 udev_rules="/etc/udev/rules.d/"
125
126 # udev_permissions - The name of the udev permission file or directory
127                      to look for files with the suffix .permissions
128 udev_permissions="/etc/udev/udev.permissions"
129
130 # udev_log - set to "yes" if you want logging, else "no"
131 udev_log="yes"
132
133 # default_mode - set the default mode for all nodes not
134 #                explicitely matching in the permissions file
135 default_mode="0666"
136
137 # default_owner - set the default owner for all nodes not
138 #                 explicitely matching in the permissions file
139 default_owner="root"
140
141 # default_group - set the default group for all nodes not
142 #                 explicitely matching in the permissions file
143 default_group="root"
144 .fi
145 .P
146 The rules for device naming, are read from the files located in the
147 .I /etc/udev/rules.d/
148 directory, or at the location specified by the
149 .I udev_rules
150 value in the
151 .I /etc/udev/udev.conf
152 file.
153 .br
154 Every line in the rules file defines the mapping between device attributes
155 and the device name. One or more keys are specified to match a rule with
156 the current device. If all keys are matching, the rule will be applied and
157 the name is used to name the device file or the network interface.
158 .br
159 If no matching rule is found, the default kernel device name is used.
160 .P
161 Every rule consists of a list of comma separated fields:
162 .sp
163 .IR "key " ,[ "key " ,...] " name " [, " symlink" ]
164 .sp
165 where fields are:
166 .TP
167 .B BUS
168 Match the bus type of the device.
169 (The sysfs device bus must be able to be determined by a "device" symlink.)
170 .TP
171 .B KERNEL
172 Match the kernel device name.
173 .TP
174 .B ID
175 Match the device number on the bus, like PCI bus id.
176 .TP
177 .B PLACE
178 Match the topological position on bus, like physical port of USB device
179 .TP
180 .BI SYSFS{ filename }
181 Match sysfs device attribute like label, vendor, USB serial number, SCSI UUID
182 or file system label.  Up to 5 different sysfs files can be checked, with
183 all of the values being required to match the rule.
184 .br
185 Trailing whitespace characters in the sysfs attribute value are ignored, if
186 the key doesn't have any trailing whitespace characters by itself.
187 .TP
188 .B PROGRAM
189 Call external program. This key is valid if the program returns successful.
190 The environment variables of
191 .B udev
192 are also available for the program.
193 .br
194 The string returned by the program may be additionally matched with the
195 .B RESULT
196 key.
197 .TP
198 .B RESULT
199 Match the returned string of the last
200 .B PROGRAM
201 call. This key may be used in any following rule after a
202 .B PROGRAM
203 call.
204 .TP
205 .B NAME
206 The name of the node to be created, or the name, the network interface
207 should be renamed to.
208 .br
209 If given with the attribute
210 .BR NAME{ all_partitions }
211 it will  create all 15 partitions of a blockdevice.
212 This may be useful for removable media devices.
213 .TP
214 .B SYMLINK
215 The name of a symlink targeting the node. Multiple symlinks may be
216 specified by separating the names by the space character.
217 .br
218 If both the name and the symlink fields are omitted or its
219 values empty, the device will be ignored and no node will be created.
220 .br
221 If only the symlink field is given and the name field is omitted,
222 the rule will not be applied immediatly, but the symlink field is added
223 to the symlink list of the rule which will create the node.
224 This makes it possible to specify additional symlinks in a possibly
225 separate rules file, while the device nodes are maintained by the
226 distribution provided rules file.
227 .TP
228 .B OWNER, GROUP, MODE
229 The permissions for this device. Every specified value overwrites the value
230 given in the permissions file.
231 .P
232 .RB "The " NAME " ," SYMLINK " and " PROGRAM
233 fields support simple printf-like string substitution:
234 .TP
235 .B %n
236 The "kernel number" of the device.
237 For example, 'sda3' has a "kernel number" of '3'.
238 .TP
239 .B %k
240 The "kernel name" for the device.
241 .TP
242 .B %M
243 The kernel major number for the device.
244 .TP
245 .B %m
246 The kernel minor number for the device.
247 .TP
248 .B %b
249 The bus id for the device.
250 .TP
251 .B %c
252 The string returned from the execution of
253 .B PROGRAM
254 (This does not work within the
255 .B PROGRAM
256 field for the obvious reason.)
257 .br
258 A single part of the string, separated by a space character
259 may be selected by specifying the part number as an attribute:
260 .BI %c{ N }
261 If the number is followed by the + char this part plus
262 all remaining parts of the result string are substituted:
263 .BI %c{ N+ }
264 .TP
265 .BI %s{ filename }
266 The content of a sysfs attribute.
267 .TP
268 .B %e
269 If a device node already exists with the name, the smallest positive
270 decimal integer N is substituted such that the resulting name doesn't
271 match an existing device node. Otherwise nothing is substituted. This
272 can be used to create compatibility symlinks and enumerate devices of
273 the same type originating from different kernel subsystems.
274 .TP
275 .B %%
276 The '%' character itself.
277 .P
278 The count of charcters to insert may be limited by specifying
279 the format length value. For example, '%3s{file}' will only insert
280 the first three characters of the sysfs attribute.
281 .P
282 .RI "A sample " udev.rules " might look like this:"
283 .sp
284 .nf
285 # if /sbin/scsi_id returns "OEM 0815" device will be called disk1
286 BUS="scsi", PROGRAM="/sbin/scsi_id", RESULT="OEM 0815", NAME="disk1"
287
288 # USB printer to be called lp_color
289 BUS="usb", SYSFS{serial}="W09090207101241330", NAME="lp_color"
290
291 # SCSI disk with a specific vendor and model number will be called boot
292 BUS="scsi", SYSFS{vendor}="IBM", SYSFS{model}="ST336", NAME="boot%n"
293
294 # sound card with PCI bus id 00:0b.0 to be called dsp
295 BUS="pci", ID="00:0b.0", NAME="dsp"
296
297 # USB mouse at third port of the second hub to be called mouse1
298 BUS="usb", PLACE="2.3", NAME="mouse1"
299
300 # ttyUSB1 should always be called pda with two additional symlinks
301 KERNEL="ttyUSB1", NAME="pda", SYMLINK="palmtop handheld"
302
303 # multiple USB webcams with symlinks to be called webcam0, webcam1, ...
304 BUS="usb", SYSFS{model}="XV3", NAME="video%n", SYMLINK="webcam%n"
305
306 # grouping of optical drives from multiple kernel subsystems
307 KERNEL="sr*", NAME="%k", SYMLINK="cdrom%e"
308 KERNEL="scd*", NAME="%k", SYMLINK="cdrom%e"
309 KERNEL="pcd*", NAME="%k", SYMLINK="cdrom%e"
310 KERNEL="hd[a-z]", PROGRAM="/bin/cat /proc/ide/%k/media", RESULT="cdrom",
311   NAME="%k", SYMLINK="cdrom%e"
312
313 .fi
314 .P
315 The permissions and ownership of the created device file is read from
316 the files located in the
317 .I /etc/udev/permissions.d/
318 directory, or at the location specified by the
319 .I udev_permission
320 value in the
321 .I /etc/udev/udev.conf
322 file.
323 .br
324 Every line lists a device name followed by owner, group and permission
325 mode. All values are separated by colons. The name field may contain a
326 pattern to apply the values to a whole class of devices.
327 .sp
328 .RI "A sample " udev.permissions " might look like this:"
329 .sp
330 .nf
331 #name:user:group:mode
332 input/*:root:root:644
333 ttyUSB1:0:8:0660
334 video*:root:video:0660
335 dsp1:::0666
336 .fi
337 .P
338 The value
339 .I $local
340 can be used instead of a specific username.  In that case, udev will determine
341 the current local user at the time of device node creation and substitute
342 that username as the owner of the new device node.  This is useful, for
343 example, to let hot-plugged devices, such as cameras, be owned by the user at
344 the current console.  Note that if no user is currently logged in, or if udev
345 otherwise fails to determine a current user, the
346 .I default_owner
347 value is used in lieu.
348 .P
349 A number of different fields in the above configuration files support a simple
350 form of shell style pattern matching. It supports the following pattern characters:
351 .TP
352 .B *
353 Matches zero, one, or more characters.
354 .TP
355 .B ?
356 Matches any single character, but does not match zero characters.
357 .TP
358 .B [ ]
359 Matches any single character specified within the brackets. For example, the
360 pattern string "tty[SR]" would match either "ttyS" or "ttyR".  Ranges are also
361 supported within this match with the '\-' character.  For example, to match on
362 the range of all digits, the pattern [0\-9] would be used. If the first character
363 following the '[' is a '!', any character not enclosed is matched.
364 .P
365 After device node creation, removal, or network device renaming,
366 .B udev
367 executes the programs in the directory tree under
368 .IR /etc/dev.d/ .
369 The name of a program must end with
370 .I .dev
371 suffix, to be recognized.
372 .br
373 In addition to the hotplug environment variables,
374 .B DEVNAME
375 is exported to make the name of the created node, or the name the network
376 device is renamed to, available to the executed program. The programs in every
377 directory are sorted in lexical order, while the directories are searched in
378 the following order:
379 .sp
380 .nf
381 /etc/dev.d/$(DEVNAME)/*.dev
382 /etc/dev.d/$(SUBSYSTEM)/*.dev
383 /etc/dev.d/default/*.dev
384 .fi
385 .SH "FILES"
386 .nf
387 /sbin/udev                           udev program
388 /etc/udev/*                          udev config files
389 /etc/hotplug.d/default/udev.hotplug  hotplug symlink to udev program
390 /etc/dev.d/*                         programs invoked by udev
391 .fi
392 .LP
393 .SH "SEE ALSO"
394 .BR udevinfo (8),
395 .BR udevd (8),
396 .BR hotplug (8)
397 .PP
398 The
399 .I http://linux\-hotplug.sourceforge.net/
400 web site.
401 .SH AUTHORS
402 .B udev
403 was developed by Greg Kroah-Hartman <greg@kroah.com> with much help from
404 Dan Stekloff <dsteklof@us.ibm.com>, Kay Sievers <kay.sievers@vrfy.org>, and
405 many others.