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 All regular expressions have an implicit
130 The following sub-statements are supported within the
135 .Bl -tag -width ".Ic directory"
136 .It Ic action Qq Ar command ;
137 Command to execute upon a successful match.
139 .Dq Li "/etc/pccard_ether $device-name start" .
140 .It Ic class Qq Ar string ;
141 This is shorthand for
142 .Dq Ic match Qo Li class Qc Qq Ar string .
143 .It Ic device-name Qq string ;
144 This is shorthand for
145 .Dq Ic match Qo Li device-name Qc Qq Ar string .
146 This matches a device named
148 which is allowed to be a regular expression or a variable previously created
149 containing a regular expression.
153 is available for later use with the
156 .It Ic match Qo Ar variable Qc Qq Ar value ;
157 Matches the content of
163 may be a regular expression.
170 statement takes care of all device matching.
171 For a partial list of variables, see below.
172 .It Ic media-type Qq Ar string ;
175 will match devices that have the given media type.
176 Valid media types are:
184 .It Ic subdevice Qq Ar string ;
185 This is shorthand for
186 .Dq Ic match Qo Li subdevice Qc Qq Ar string .
189 The following sub-statements are supported within the
192 .Bl -tag -width ".Ic directory"
193 .It Ic action Qq Ar command ;
195 .It Ic match Qo Ar variable Qc Qq Ar value ;
196 Matches the content of
202 may be a regular expression.
203 For a partial list of variables, see below.
206 The following sub-statements are supported within the
211 variable is available inside this statement and contains, a value, depending
212 on which system and subsystem that delivered the event.
213 .Bl -tag -width ".Ic directory"
214 .It Ic action Qq Ar command ;
215 Command to execute upon a successful match.
217 .Dq Li "/etc/rc.d/power_profile $notify" .
218 .It Ic match Qo Ar system | subsystem | type | notify Qc Qq Ar value ;
221 statements can exist within a
225 can be either a fixed string or a regular expression.
226 Below is a list of available systems, subsystems, and types.
227 .It Ic media-type Qq Ar string ;
230 .Ss Variables that can be used with the match statement
231 A partial list of variables and their possible values that can be used together
236 .Bl -tag -width ".Li manufacturer" -compact
240 Device name of parent bus.
242 Device node path if one is created by the
256 Device Sub-class (USB)
258 Name of attached/detached device.
266 Interface Class (USB)
268 Interface Protocol (USB)
270 Interface Sub-class (USB)
272 Manufacturer ID (pccard).
274 Peripheral mode (USB)
276 Match the value of the
282 Hub port number (USB)
284 Product ID (pccard/USB).
286 Hardware revision (USB)
296 Matches a subsystem of a system, see below.
298 Matches a system type, see below.
300 Type of notification, see below.
305 A partial list of systems, subsystems, and types used within the
309 .Bl -tag -width ".Li coretemp" -compact
312 Events related to the ACPI subsystem.
313 .Bl -tag -width ".Sy Subsystem" -compact
316 AC line state ($notify=0x00 is offline, 0x01 is online).
318 Button state ($notify=0x00 is power, 0x01 is sleep).
322 Lid state ($notify=0x00 is closed, 0x01 is open).
328 Events related to the network subsystem.
329 .Bl -tag -width ".Sy Subsystem" -compact
334 is the actual name of the network interface on which the event
336 .Bl -tag -width ".Li LINK_DOWN" -compact
339 Carrier status changed to UP.
341 Carrier status changed to DOWN.
343 The network interface is attached to the system.
345 The network interface is detached from the system.
349 Events related to the
352 .Bl -tag -width ".Sy Subsystem" -compact
355 .Bl -tag -width ".Li DESTROY" -compact
368 Events related to the USB subsystem.
369 .Bl -tag -width ".Sy Subsystem" -compact
372 .Bl -tag -width ".Li DETACH" -compact
375 USB device is attached to the system.
377 USB device is detached from the system.
380 .Bl -tag -width ".Li DETACH" -compact
383 USB interface is attached from a device.
385 USB interface is detached from a device.
389 Events related to the
392 .Bl -tag -width ".Sy Subsystem" -compact
395 Notification that the CPU core has reached critical temperature.
396 .Bl -tag -width ".Ar temperature" -compact
399 String containing the temperature of the core that has become too hot.
403 Events related to the kernel.
404 .Bl -tag -width ".Sy Subsystem" -compact
407 Information about the state of the system.
408 .Bl -tag -width ".li resume" -compact
411 Notification that the system has woken from the suspended state.
416 A link state change to UP on the interface
418 would result in the following notify event:
419 .Bd -literal -offset indent
420 system=IFNET, subsystem=fxp0, type=LINK_UP
423 An AC line state change to
425 would result in the following event:
426 .Bd -literal -offset indent
427 system=ACPI, subsystem=ACAD, notify=0x00
430 Comments may appear anywhere that whitespace may appear in a
432 To appeal to programmers of all kinds, they can
433 be written in C, C++, or shell/Perl constructs.
435 C-style comments start with the two characters
437 (slash, star) and end with
440 Because they are completely delimited with these characters,
441 they can be used to comment only a portion of a line or to span
444 C-style comments cannot be nested.
445 For example, the following is
446 not valid because the entire comment ends with the first
448 .Bd -literal -offset indent
449 /* This is the start of a comment.
450 This is still part of the comment.
451 /* This is an incorrect attempt at nesting a comment. */
452 This is no longer in any comment. */
455 C++-style comments start with the two characters
457 (slash, slash) and continue to the end of the physical line.
458 They cannot be continued across multiple physical lines; to have
459 one logical comment span multiple lines, each line must use the
463 .Bd -literal -offset indent
464 // This is the start of a comment. The next line
465 // is a new comment, even though it is logically
466 // part of the previous comment.
469 .Bl -tag -width ".Pa /etc/devd.conf" -compact
470 .It Pa /etc/devd.conf
478 # This will catch link down events on the interfaces fxp0 and ath0
481 match "system" "IFNET";
482 match "subsystem" "(fxp0|ath0)";
483 match "type" "LINK_DOWN";
484 action "logger $subsystem is DOWN";
488 # Match lid open/close events
489 # These can be combined to a single event, by passing the
490 # value of $notify to the external script.
493 match "system" "ACPI";
494 match "subsystem" "Lid";
495 match "notify" "0x00";
496 action "logger Lid closed, we can sleep now!";
500 match "system" "ACPI";
501 match "subsystem" "Lid";
502 match "notify" "0x01";
503 action "logger Lid opened, the sleeper must awaken!";
507 # Match a USB device type
510 match "system" "USB";
511 match "subsystem" "INTERFACE";
512 match "type" "ATTACH";
513 match "intclass" "0x0e";
514 action "logger USB video device attached";
518 # Try to configure ath and wi devices with pccard_ether
519 # as they are attached.
522 device-name "(ath|wi)[0-9]+";
523 action "/etc/pccard_ether $device-name start";
527 # Stop ath and wi devices as they are detached from
531 device-name "(ath|wi)[0-9]+";
532 action "/etc/pccard_ether $device-name stop";
538 has many additional examples.