chiark / gitweb /
docs: update some docs and delete outdated stuff
[elogind.git] / udev.7
1 .\"     Title: udev
2 .\"    Author: 
3 .\" Generator: DocBook XSL Stylesheets v1.73.2 <>
4 .\"      Date: August 2005
5 .\"    Manual: udev
6 .\"    Source: udev
7 .\"
8 .TH "UDEV" "7" "August 2005" "udev" "udev"
9 .\" disable hyphenation
10 .nh
11 .\" disable justification (adjust text to left margin only)
12 .ad l
13 .SH "NAME"
14 udev - dynamic device management
16 .PP
17 udev provides a dynamic device directory containing only the files for actually present devices\. It creates or removes device node files in the
18 \fI/dev\fR
19 directory, or it renames network interfaces\.
20 .PP
21 Usually udev runs as
22 \fBudevd\fR(8)
23 and receives uevents directly from the kernel if a device is added or removed from the system\.
24 .PP
25 If udev receives a device event, it matches its configured rules against the available device attributes provided in sysfs to identify the device\. Rules that match may provide additional device information or specify a device node name and multiple symlink names and instruct udev to run additional programs as part of the device event handling\.
27 .PP
28 All udev configuration files are placed in
29 \fI/etc/udev/*\fR\. Every file consists of a set of lines of text\. All empty lines or lines beginning with \'#\' will be ignored\.
30 .SS "Configuration file"
31 .PP
32 udev expects its main configuration file at
33 \fI/etc/udev/udev\.conf\fR\. It consists of a set of variables allowing the user to override default udev values\. The following variables can be set:
34 .PP
35 \fBudev_root\fR
36 .RS 4
37 Specifies where to place the device nodes in the filesystem\. The default value is
38 \fI/dev\fR\.
39 .RE
40 .PP
41 \fBudev_rules\fR
42 .RS 4
43 The name of the udev rules file or directory to look for files with the suffix
44 \fI\.rules\fR\. Multiple rule files are read in lexical order\. The default value is
45 \fI/etc/udev/rules\.d\fR\.
46 .RE
47 .PP
48 \fBudev_log\fR
49 .RS 4
50 The logging priority\. Valid values are the numerical syslog priorities or their textual representations:
51 \fBerr\fR,
52 \fBinfo\fR
53 and
54 \fBdebug\fR\.
55 .RE
56 .SS "Rules files"
57 .PP
58 The udev rules are read from the files located in the
59 \fI/etc/udev/rules\.d\fR
60 directory or at the location specified value in the configuration file\. Every line in the rules file contains at least one key value pair\. There are two kind of keys, match and assignment keys\. If all match keys are matching against its value, the rule gets applied and the assign keys get the specified value assigned\.
61 .PP
62 A matching rule may specify the name of the device node, add a symlink pointing to the node, or run a specified program as part of the event handling\. If no matching rule is found, the default device node name is used\.
63 .PP
64 A rule may consist of a list of one or more key value pairs separated by a comma\. Each key has a distinct operation, depending on the used operator\. Valid operators are:
65 .PP
66 \fB==\fR
67 .RS 4
68 Compare for equality\.
69 .RE
70 .PP
71 \fB!=\fR
72 .RS 4
73 Compare for non\-equality\.
74 .RE
75 .PP
76 \fB=\fR
77 .RS 4
78 Assign a value to a key\. Keys that represent a list, are reset and only this single value is assigned\.
79 .RE
80 .PP
81 \fB+=\fR
82 .RS 4
83 Add the value to a key that holds a list of entries\.
84 .RE
85 .PP
86 \fB:=\fR
87 .RS 4
88 Assign a value to a key finally; disallow any later changes, which may be used to prevent changes by any later rules\.
89 .RE
90 .PP
91 The following key names can be used to match against device properties\. Some of the keys also match against properties of the parent devices in sysfs, not only the device that has generated the event\. If multiple keys that match a parent device are specified in a single rule, all these keys must match at one and the same parent device\.
92 .PP
94 .RS 4
95 Match the name of the event action\.
96 .RE
97 .PP
99 .RS 4
100 Match the devpath of the event device\.
101 .RE
102 .PP
103 \fBKERNEL\fR
104 .RS 4
105 Match the name of the event device\.
106 .RE
107 .PP
108 \fBNAME\fR
109 .RS 4
110 Match the name of the node or network interface\. It can be used once the NAME key has been set in one of the preceding rules\.
111 .RE
112 .PP
114 .RS 4
115 Match the subsystem of the event device\.
116 .RE
117 .PP
118 \fBDRIVER\fR
119 .RS 4
120 Match the driver name of the event device\. Only set for devices which are bound to a driver at the time the event is generated\.
121 .RE
122 .PP
123 \fBATTR{\fR\fB\fIfilename\fR\fR\fB}\fR
124 .RS 4
125 Match sysfs attribute values of the event device\. Up to five
126 \fBATTR\fR
127 keys can be specified per rule\. Trailing whitespace in the attribute values is ignored, if the specified match value does not contain trailing whitespace itself\. Depending on the type of operator, this key is also used to set the value of a sysfs attribute\.
128 .RE
129 .PP
131 .RS 4
132 Search the devpath upwards for a matching device name\.
133 .RE
134 .PP
136 .RS 4
137 Search the devpath upwards for a matching device subsystem name\.
138 .RE
139 .PP
141 .RS 4
142 Search the devpath upwards for a matching device driver name\.
143 .RE
144 .PP
145 \fBATTRS{\fR\fB\fIfilename\fR\fR\fB}\fR
146 .RS 4
147 Search the devpath upwards for a device with matching sysfs attribute values\. Up to five
148 \fBATTRS\fR
149 keys can be specified per rule, but all of them must match on the same device\. Trailing whitespace in the attribute values is ignored, if the specified match value does not contain trailing whitespace itself\.
150 .RE
151 .PP
152 \fBENV{\fR\fB\fIkey\fR\fR\fB}\fR
153 .RS 4
154 Match against the value of an environment variable\. Up to five
155 \fBENV\fR
156 keys can be specified per rule\. Depending on the type of operator, this key is also used to export a variable to the environment\.
157 .RE
158 .PP
159 \fBTEST{\fR\fB\fIoctal mode mask\fR\fR\fB}\fR
160 .RS 4
161 Test the existence of a file\. An octal mode mask can be specified if needed\.
162 .RE
163 .PP
165 .RS 4
166 Execute external program\. The key is true, if the program returns with exit code zero\. The whole event environment is available to the executed program\. The program\'s output printed to stdout, is available in the RESULT key\.
167 .RE
168 .PP
169 \fBRESULT\fR
170 .RS 4
171 Match the returned string of the last PROGRAM call\. This key can be used in the same or in any later rule after a PROGRAM call\.
172 .RE
173 .PP
174 Most of the fields support a shell style pattern matching\. The following pattern characters are supported:
175 .PP
176 \fB*\fR
177 .RS 4
178 Matches zero, or any number of characters\.
179 .RE
180 .PP
181 \fB?\fR
182 .RS 4
183 Matches any single character\.
184 .RE
185 .PP
186 \fB[]\fR
187 .RS 4
188 Matches any single character specified within the brackets\. For example, the pattern string \'tty[SR]\' would match either \'ttyS\' or \'ttyR\'\. Ranges are also supported within this match with the \'\-\' character\. For example, to match on the range of all digits, the pattern [0\-9] would be used\. If the first character following the \'[\' is a \'!\', any characters not enclosed are matched\.
189 .RE
190 .PP
191 The following keys can get values assigned:
192 .PP
193 \fBNAME\fR
194 .RS 4
195 The name of the node to be created, or the name the network interface should be renamed to\. Only one rule can set the node name, all later rules with a NAME key will be ignored\.
196 .RE
197 .PP
199 .RS 4
200 The name of a symlink targeting the node\. Every matching rule can add this value to the list of symlinks to be created along with the device node\. Multiple symlinks may be specified by separating the names by the space character\.
201 .RE
202 .PP
204 .RS 4
205 The permissions for the device node\. Every specified value overwrites the compiled\-in default value\.
206 .RE
207 .PP
208 \fBATTR{\fR\fB\fIkey\fR\fR\fB}\fR
209 .RS 4
210 The value that should be written to a sysfs attribute of the event device\. Depending on the type of operator, this key is also used to match against the value of a sysfs attribute\.
211 .RE
212 .PP
213 \fBENV{\fR\fB\fIkey\fR\fR\fB}\fR
214 .RS 4
215 Export a variable to the environment\. Depending on the type of operator, this key is also to match against an environment variable\.
216 .RE
217 .PP
218 \fBRUN\fR
219 .RS 4
220 Add a program to the list of programs to be executed for a specific device\. This can only be used for very short running tasks\. Running an event process for a long period of time may block all further events for this or a dependent device\. Long running tasks need to be immediately detached from the event process itself\.
221 .sp
222 If the specifiefd string starts with
223 \fBsocket:\fR\fB\fIpath\fR\fR, all current event values will be passed to the specified socket, as a message in the same format the kernel sends an uevent\. If the first character of the specified path is an @ character, an abstract namespace socket is used, instead of an existing socket file\.
224 .RE
225 .PP
226 \fBLABEL\fR
227 .RS 4
228 Named label where a GOTO can jump to\.
229 .RE
230 .PP
231 \fBGOTO\fR
232 .RS 4
233 Jumps to the next LABEL with a matching name
234 .RE
235 .PP
236 \fBIMPORT{\fR\fB\fItype\fR\fR\fB}\fR
237 .RS 4
238 Import a set of variables into the event environment, depending on
239 \fItype\fR:
240 .PP
241 \fBprogram\fR
242 .RS 4
243 Execute an external program specified as the assigned value and import its output, which must be in environment key format\.
244 .RE
245 .PP
246 \fBfile\fR
247 .RS 4
248 Import a text file specified as the assigned value, which must be in environment key format\.
249 .RE
250 .PP
251 \fBparent\fR
252 .RS 4
253 Import the stored keys from the parent device by reading the database entry of the parent device\. The value assigned to
254 \fBIMPORT{parent}\fR
255 is used as a filter of key names to import (with the same shell\-style pattern matching used for comparisons)\.
256 .RE
257 .sp
258 If no option is given, udev will choose between
259 \fBprogram\fR
260 and
261 \fBfile\fR
262 based on the executable bit of the file permissions\.
263 .RE
264 .PP
265 \fBWAIT_FOR\fR
266 .RS 4
267 Wait for a file to become available\.
268 .RE
269 .PP
271 .RS 4
272 Rule and device options:
273 .PP
274 \fBlast_rule\fR
275 .RS 4
276 Stops further rules application\. No later rules will have any effect\.
277 .RE
278 .PP
279 \fBignore_device\fR
280 .RS 4
281 Ignore this event completely\.
282 .RE
283 .PP
284 \fBignore_remove\fR
285 .RS 4
286 Do not remove the device node when the device goes away\. This may be useful as a workaround for broken device drivers\.
287 .RE
288 .PP
289 \fBlink_priority=\fR\fB\fIvalue\fR\fR
290 .RS 4
291 Specify the priority of the created symlinks\. Devices with higher priorities overwrite existing symlinks of other devices\.
292 .RE
293 .PP
294 \fBall_partitions\fR
295 .RS 4
296 Create the device nodes for all available partitions of a block device\. This may be useful for removable media devices where media changes are not detected\.
297 .RE
298 .PP
299 \fBevent_timeout=\fR
300 .RS 4
301 Number of seconds an event will wait for operations to finish, before it will terminate itself\.
302 .RE
303 .PP
304 \fBstring_escape=\fR\fB\fInone|replace\fR\fR
305 .RS 4
306 Usually control and other possibly unsafe characters are replaced in strings used for device naming\. The mode of replacement can be specified with this option\.
307 .RE
308 .RE
309 .PP
310 The
311 \fBNAME\fR,
312 \fBSYMLINK\fR,
313 \fBPROGRAM\fR,
314 \fBOWNER\fR,
315 \fBGROUP\fR,
316 \fBMODE\fR
317 and
318 \fBRUN\fR
319 fields support simple printf\-like string substitutions\. The
320 \fBRUN\fR
321 format chars gets applied after all rules have been processed, right before the program is executed\. It allows the use of the complete environment set by earlier matching rules\. For all other fields, substitutions are applied while the individual rule is being processed\. The available substitutions are:
322 .PP
323 \fB$kernel\fR, \fB%k\fR
324 .RS 4
325 The kernel name for this device\.
326 .RE
327 .PP
328 \fB$number\fR, \fB%n\fR
329 .RS 4
330 The kernel number for this device\. For example, \'sda3\' has kernel number of \'3\'
331 .RE
332 .PP
333 \fB$devpath\fR, \fB%p\fR
334 .RS 4
335 The devpath of the device\.
336 .RE
337 .PP
338 \fB$id\fR, \fB%b\fR
339 .RS 4
340 The name of the device matched while searching the devpath upwards for
342 \fBKERNELS\fR,
344 and
345 \fBATTRS\fR\.
346 .RE
347 .PP
348 \fB$driver\fR
349 .RS 4
350 The driver name of the device matched while searching the devpath upwards for
352 \fBKERNELS\fR,
354 and
355 \fBATTRS\fR\.
356 .RE
357 .PP
358 \fB$attr{\fR\fB\fIfile\fR\fR\fB}\fR, \fB%s{\fR\fB\fIfile\fR\fR\fB}\fR
359 .RS 4
360 The value of a sysfs attribute found at the device, where all keys of the rule have matched\. If the matching device does not have such an attribute, all devices along the chain of parents are searched for a matching attribute\. If the attribute is a symlink, the last element of the symlink target is returned as the value\.
361 .RE
362 .PP
363 \fB$env{\fR\fB\fIkey\fR\fR\fB}\fR, \fB%E{\fR\fB\fIkey\fR\fR\fB}\fR
364 .RS 4
365 The value of an environment variable\.
366 .RE
367 .PP
368 \fB$major\fR, \fB%M\fR
369 .RS 4
370 The kernel major number for the device\.
371 .RE
372 .PP
373 \fB$minor\fR, \fB%m\fR
374 .RS 4
375 The kernel minor number for the device\.
376 .RE
377 .PP
378 \fB$result\fR, \fB%c\fR
379 .RS 4
380 The string returned by the external program requested with PROGRAM\. A single part of the string, separated by a space character may be selected by specifying the part number as an attribute:
381 \fB%c{N}\fR\. If the number is followed by the \'+\' char this part plus all remaining parts of the result string are substituted:
382 \fB%c{N+}\fR
383 .RE
384 .PP
385 \fB$parent\fR, \fB%P\fR
386 .RS 4
387 The node name of the parent device\.
388 .RE
389 .PP
390 \fB$name\fR
391 .RS 4
392 The current name of the device node\. If not changed by a rule, it is the name of the kernel device\.
393 .RE
394 .PP
395 \fB$links\fR
396 .RS 4
397 The current list of symlinks, separated by a space character\. The value is only set if an earlier rule assigned a value, or during a remove events\.
398 .RE
399 .PP
400 \fB$root\fR, \fB%r\fR
401 .RS 4
402 The udev_root value\.
403 .RE
404 .PP
405 \fB$sys\fR, \fB%S\fR
406 .RS 4
407 The sysfs mount point\.
408 .RE
409 .PP
410 \fB$tempnode\fR, \fB%N\fR
411 .RS 4
412 The name of a created temporary device node to provide access to the device from a external program before the real node is created\.
413 .RE
414 .PP
415 \fB%%\fR
416 .RS 4
417 The \'%\' character itself\.
418 .RE
419 .PP
420 \fB$$\fR
421 .RS 4
422 The \'$\' character itself\.
423 .RE
424 .PP
425 The count of characters to be substituted may be limited by specifying the format length value\. For example, \'%3s{file}\' will only insert the first three characters of the sysfs attribute
426 .SH "AUTHOR"
427 .PP
428 Written by Greg Kroah\-Hartman
429 <greg@kroah\.com>
430 and Kay Sievers
431 <kay\.sievers@vrfy\.org>\. With much help from Dan Stekloff and many others\.
432 .SH "SEE ALSO"
433 .PP
434 \fBudevd\fR(8),
435 \fBudevadm\fR(8)