2 .\" Copyright (c) 2002 M. Warner Losh
3 .\" All rights reserved.
5 .\" Redistribution and use in source and binary forms, with or without
6 .\" modification, are permitted provided that the following conditions
8 .\" 1. Redistributions of source code must retain the above copyright
9 .\" notice, this list of conditions and the following disclaimer.
10 .\" 2. The name of the author may not be used to endorse or promote products
11 .\" derived from this software without specific prior written permission.
13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 .\" The section on comments was taken from named.conf.5, which has the
28 .\" following copyright:
29 .\" Copyright (c) 1999-2000 by Internet Software Consortium
31 .\" Permission to use, copy, modify, and distribute this software for any
32 .\" purpose with or without fee is hereby granted, provided that the above
33 .\" copyright notice and this permission notice appear in all copies.
35 .\" THE SOFTWARE IS PROVIDED "AS IS" AND INTERNET SOFTWARE CONSORTIUM DISCLAIMS
36 .\" ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES
37 .\" OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL INTERNET SOFTWARE
38 .\" CONSORTIUM BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
39 .\" DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
40 .\" PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS
41 .\" ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
49 .Nd configuration file for
55 configuration consists of two general features, statements
57 All statements end with a semicolon.
58 Many statements can contain substatements, which are also
59 terminated with a semicolon.
61 The following statements are supported:
62 .Bl -tag -width ".Ic options"
64 Specifies various matching criteria and actions to perform when
65 a newly attached device matches said criteria.
67 Specifies various matching criteria and actions to perform when
68 a newly detached device matches said criteria.
70 Specifies various matching criteria and actions to perform when
71 no device driver currently loaded in the kernel claims a (new)
74 Specifies various matching criteria and actions to perform when the kernel
75 sends an event notification to userland.
77 Specifies various options and parameters for the operation of
81 Statements may occur in any order in the configuration file, and may be
82 repeated as often as required.
83 Further details on the syntax and meaning of each statement and their
84 substatements are explained below.
86 Each statement, except
88 has a priority (an arbitrary number) associated with it, where
90 is defined as the lowest priority.
91 If two statements match the same event, only the action of the statement with
92 highest priority will be executed.
93 In this way generic statements can be overridden for devices or
94 notifications that require special attention.
96 The general syntax of a statement is:
98 .Bd -literal -offset indent
100 substatement "value";
102 substatement "value";
106 The following sub-statements are supported within the
109 .Bl -tag -width ".Ic directory"
110 .It Ic directory Qq Ar /some/path ;
111 Adds the given directory to the list of directories from which
113 will read all files named "*.conf" as further
117 statements can be used.
118 .It Ic pid-file Qq Pa /var/run/devd.pid ;
120 .It Ic set Ar regexp-name Qq Ar (some|regexp) ;
121 Creates a regular expression and assigns it to the variable
123 The variable is available throughout the rest of
124 the configuration file.
125 If the string begins with
127 it matches if the regular expression formed by the rest of the string
129 All regular expressions have an implicit
134 The following sub-statements are supported within the
139 .Bl -tag -width ".Ic directory"
140 .It Ic action Qq Ar command ;
141 Command to execute upon a successful match.
143 .Dq Li "/etc/pccard_ether $device-name start" .
144 .It Ic class Qq Ar string ;
145 This is shorthand for
146 .Dq Ic match Qo Li class Qc Qq Ar string .
147 .It Ic device-name Qq string ;
148 This is shorthand for
149 .Dq Ic match Qo Li device-name Qc Qq Ar string .
150 This matches a device named
152 which is allowed to be a regular expression or a variable previously created
153 containing a regular expression.
157 is available for later use with the
160 .It Ic match Qo Ar variable Qc Qq Ar value ;
161 Matches the content of
167 may be a regular expression.
174 statement takes care of all device matching.
175 For a partial list of variables, see below.
176 .It Ic media-type Qq Ar string ;
179 will match devices that have the given media type.
180 Valid media types are:
188 .It Ic subdevice Qq Ar string ;
189 This is shorthand for
190 .Dq Ic match Qo Li subdevice Qc Qq Ar string .
193 The following sub-statements are supported within the
196 .Bl -tag -width ".Ic directory"
197 .It Ic action Qq Ar command ;
199 .It Ic match Qo Ar variable Qc Qq Ar value ;
200 Matches the content of
206 may be a regular expression.
207 For a partial list of variables, see below.
210 The following sub-statements are supported within the
215 variable is available inside this statement and contains, a value, depending
216 on which system and subsystem that delivered the event.
217 .Bl -tag -width ".Ic directory"
218 .It Ic action Qq Ar command ;
219 Command to execute upon a successful match.
221 .Dq Li "/etc/rc.d/power_profile $notify" .
222 .It Ic match Qo Ar system | subsystem | type | notify Qc Qq Ar value ;
225 statements can exist within a
229 can be either a fixed string or a regular expression.
230 Below is a list of available systems, subsystems, and types.
231 .It Ic media-type Qq Ar string ;
234 .Ss Variables that can be used with the match statement
235 A partial list of variables and their possible values that can be used together
240 .Bl -tag -width ".Li manufacturer" -compact
244 Device name of parent bus.
246 Device node path if one is created by the
260 Device Sub-class (USB)
262 Name of attached/detached device.
270 Interface Class (USB)
272 Interface Protocol (USB)
274 Interface Sub-class (USB)
276 Manufacturer ID (pccard).
278 Peripheral mode (USB)
280 Match the value of the
286 Hub port number (USB)
288 Product ID (pccard/USB).
290 Hardware revision (USB)
300 Matches a subsystem of a system, see below.
302 Matches a system type, see below.
304 Type of notification, see below.
309 A partial list of systems, subsystems, and types used within the
313 .Bl -tag -width ".Li coretemp" -compact
316 Events related to the ACPI subsystem.
317 .Bl -tag -width ".Sy Subsystem" -compact
320 AC line state ($notify=0x00 is offline, 0x01 is online).
322 Button state ($notify=0x00 is power, 0x01 is sleep).
326 Lid state ($notify=0x00 is closed, 0x01 is open).
328 Processor state/configuration ($notify=0x81 is a change in available Cx states).
334 Events related to the network subsystem.
335 .Bl -tag -width ".Sy Subsystem" -compact
340 is the actual name of the network interface on which the event
342 .Bl -tag -width ".Li LINK_DOWN" -compact
345 Carrier status changed to UP.
347 Carrier status changed to DOWN.
349 The network interface is attached to the system.
351 The network interface is detached from the system.
355 Events related to the
358 .Bl -tag -width ".Sy Subsystem" -compact
361 .Bl -tag -width ".Li DESTROY" -compact
374 Events related to the USB subsystem.
375 .Bl -tag -width ".Sy Subsystem" -compact
378 .Bl -tag -width ".Li DETACH" -compact
381 USB device is attached to the system.
383 USB device is detached from the system.
386 .Bl -tag -width ".Li DETACH" -compact
389 USB interface is attached from a device.
391 USB interface is detached from a device.
395 Events related to the
398 .Bl -tag -width ".Sy Subsystem" -compact
401 Notification that the CPU core has reached critical temperature.
402 .Bl -tag -width ".Ar temperature" -compact
405 String containing the temperature of the core that has become too hot.
409 Events related to the kernel.
410 .Bl -tag -width ".Sy Subsystem" -compact
413 Information about the state of the system.
414 .Bl -tag -width ".li resume" -compact
417 Notification that the system has woken from the suspended state.
422 A link state change to UP on the interface
424 would result in the following notify event:
425 .Bd -literal -offset indent
426 system=IFNET, subsystem=fxp0, type=LINK_UP
429 An AC line state change to
431 would result in the following event:
432 .Bd -literal -offset indent
433 system=ACPI, subsystem=ACAD, notify=0x00
436 Comments may appear anywhere that whitespace may appear in a
438 To appeal to programmers of all kinds, they can
439 be written in C, C++, or shell/Perl constructs.
441 C-style comments start with the two characters
443 (slash, star) and end with
446 Because they are completely delimited with these characters,
447 they can be used to comment only a portion of a line or to span
450 C-style comments cannot be nested.
451 For example, the following is
452 not valid because the entire comment ends with the first
454 .Bd -literal -offset indent
455 /* This is the start of a comment.
456 This is still part of the comment.
457 /* This is an incorrect attempt at nesting a comment. */
458 This is no longer in any comment. */
461 C++-style comments start with the two characters
463 (slash, slash) and continue to the end of the physical line.
464 They cannot be continued across multiple physical lines; to have
465 one logical comment span multiple lines, each line must use the
469 .Bd -literal -offset indent
470 // This is the start of a comment. The next line
471 // is a new comment, even though it is logically
472 // part of the previous comment.
475 .Bl -tag -width ".Pa /etc/devd.conf" -compact
476 .It Pa /etc/devd.conf
484 # This will catch link down events on the interfaces fxp0 and ath0
487 match "system" "IFNET";
488 match "subsystem" "(fxp0|ath0)";
489 match "type" "LINK_DOWN";
490 action "logger $subsystem is DOWN";
494 # Match lid open/close events
495 # These can be combined to a single event, by passing the
496 # value of $notify to the external script.
499 match "system" "ACPI";
500 match "subsystem" "Lid";
501 match "notify" "0x00";
502 action "logger Lid closed, we can sleep now!";
506 match "system" "ACPI";
507 match "subsystem" "Lid";
508 match "notify" "0x01";
509 action "logger Lid opened, the sleeper must awaken!";
513 # Match a USB device type
516 match "system" "USB";
517 match "subsystem" "INTERFACE";
518 match "type" "ATTACH";
519 match "intclass" "0x0e";
520 action "logger USB video device attached";
524 # Try to configure ath and wi devices with pccard_ether
525 # as they are attached.
528 device-name "(ath|wi)[0-9]+";
529 action "/etc/pccard_ether $device-name start";
533 # Stop ath and wi devices as they are detached from
537 device-name "(ath|wi)[0-9]+";
538 action "/etc/pccard_ether $device-name stop";
544 has many additional examples.