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:
97 .Bd -literal -offset indent
101 substatement "value";
105 The following sub-statements are supported within the
108 .Bl -tag -width ".Ic directory"
109 .It Ic directory Qq Ar /some/path ;
110 Adds the given directory to the list of directories from which
112 will read all files named "*.conf" as further
116 statements can be used.
117 .It Ic pid-file Qq Pa /var/run/devd.pid ;
119 .It Ic set Ar regexp-name Qq Ar (some|regexp) ;
120 Creates a regular expression and assigns it to the variable
122 The variable is available throughout the rest of
123 the configuration file.
124 If the string begins with
126 it matches if the regular expression formed by the rest of the string
128 All regular expressions have an implicit
133 The following sub-statements are supported within the
138 .Bl -tag -width ".Ic directory"
139 .It Ic action Qq Ar command ;
140 Command to execute upon a successful match.
142 .Dq Li "/etc/pccard_ether $device-name start" .
143 .It Ic class Qq Ar string ;
144 This is shorthand for
145 .Dq Ic match Qo Li class Qc Qq Ar string .
146 .It Ic device-name Qq string ;
147 This is shorthand for
148 .Dq Ic match Qo Li device-name Qc Qq Ar string .
149 This matches a device named
151 which is allowed to be a regular expression or a variable previously created
152 containing a regular expression.
156 is available for later use with the
159 .It Ic match Qo Ar variable Qc Qq Ar value ;
160 Matches the content of
166 may be a regular expression.
173 statement takes care of all device matching.
174 For a partial list of variables, see below.
175 .It Ic media-type Qq Ar string ;
178 will match devices that have the given media type.
179 Valid media types are:
187 .It Ic subdevice Qq Ar string ;
188 This is shorthand for
189 .Dq Ic match Qo Li subdevice Qc Qq Ar string .
192 The following sub-statements are supported within the
195 .Bl -tag -width ".Ic directory"
196 .It Ic action Qq Ar command ;
198 .It Ic match Qo Ar variable Qc Qq Ar value ;
199 Matches the content of
205 may be a regular expression.
206 For a partial list of variables, see below.
209 The following sub-statements are supported within the
214 variable is available inside this statement and contains, a value, depending
215 on which system and subsystem that delivered the event.
216 .Bl -tag -width ".Ic directory"
217 .It Ic action Qq Ar command ;
218 Command to execute upon a successful match.
220 .Dq Li "/etc/rc.d/power_profile $notify" .
221 .It Ic match Qo Ar system | subsystem | type | notify Qc Qq Ar value ;
224 statements can exist within a
228 can be either a fixed string or a regular expression.
229 Below is a list of available systems, subsystems, and types.
230 .It Ic media-type Qq Ar string ;
233 .Ss Variables that can be used with the match statement
234 A partial list of variables and their possible values that can be used together
239 .Bl -tag -width ".Li manufacturer" -compact
243 Device name of parent bus.
245 Device node path if one is created by the
259 Device Sub-class (USB)
261 Name of attached/detached device.
269 Interface Class (USB)
271 Interface Protocol (USB)
273 Interface Sub-class (USB)
275 Manufacturer ID (pccard).
277 Peripheral mode (USB)
279 Match the value of the
285 Hub port number (USB)
287 Product ID (pccard/USB).
289 Hardware revision (USB)
299 Matches a subsystem of a system, see below.
301 Matches a system type, see below.
303 Type of notification, see below.
308 A partial list of systems, subsystems, and types used within the
312 .Bl -tag -width ".Li coretemp" -compact
315 Events related to the ACPI subsystem.
316 .Bl -tag -width ".Sy Subsystem" -compact
319 AC line state ($notify=0x00 is offline, 0x01 is online).
321 Button state ($notify=0x00 is power, 0x01 is sleep).
325 Lid state ($notify=0x00 is closed, 0x01 is open).
331 Events related to the network subsystem.
332 .Bl -tag -width ".Sy Subsystem" -compact
337 is the actual name of the network interface on which the event
339 .Bl -tag -width ".Li LINK_DOWN" -compact
342 Carrier status changed to UP.
344 Carrier status changed to DOWN.
346 The network interface is attached to the system.
348 The network interface is detached from the system.
352 Events related to the
355 .Bl -tag -width ".Sy Subsystem" -compact
358 .Bl -tag -width ".Li DESTROY" -compact
371 Events related to the USB subsystem.
372 .Bl -tag -width ".Sy Subsystem" -compact
375 .Bl -tag -width ".Li DETACH" -compact
378 USB device is attached to the system.
380 USB device is detached from the system.
383 .Bl -tag -width ".Li DETACH" -compact
386 USB interface is attached to a device.
388 USB interface is detached from a device.
392 Events related to the
395 .Bl -tag -width ".Sy Subsystem" -compact
398 Notification that the CPU core has reached critical temperature.
399 .Bl -tag -width ".Ar temperature" -compact
402 String containing the temperature of the core that has become too hot.
406 Events related to the kernel.
407 .Bl -tag -width ".Sy Subsystem" -compact
410 Information about the state of the system.
411 .Bl -tag -width ".li resume" -compact
414 Notification that the system has woken from the suspended state.
419 A link state change to UP on the interface
421 would result in the following notify event:
422 .Bd -literal -offset indent
423 system=IFNET, subsystem=fxp0, type=LINK_UP
426 An AC line state change to
428 would result in the following event:
429 .Bd -literal -offset indent
430 system=ACPI, subsystem=ACAD, notify=0x00
433 Comments may appear anywhere that whitespace may appear in a
435 To appeal to programmers of all kinds, they can
436 be written in C, C++, or shell/Perl constructs.
438 C-style comments start with the two characters
440 (slash, star) and end with
443 Because they are completely delimited with these characters,
444 they can be used to comment only a portion of a line or to span
447 C-style comments cannot be nested.
448 For example, the following is
449 not valid because the entire comment ends with the first
451 .Bd -literal -offset indent
452 /* This is the start of a comment.
453 This is still part of the comment.
454 /* This is an incorrect attempt at nesting a comment. */
455 This is no longer in any comment. */
458 C++-style comments start with the two characters
460 (slash, slash) and continue to the end of the physical line.
461 They cannot be continued across multiple physical lines; to have
462 one logical comment span multiple lines, each line must use the
466 .Bd -literal -offset indent
467 // This is the start of a comment. The next line
468 // is a new comment, even though it is logically
469 // part of the previous comment.
472 .Bl -tag -width ".Pa /etc/devd.conf" -compact
473 .It Pa /etc/devd.conf
481 # This will catch link down events on the interfaces fxp0 and ath0
484 match "system" "IFNET";
485 match "subsystem" "(fxp0|ath0)";
486 match "type" "LINK_DOWN";
487 action "logger $subsystem is DOWN";
491 # Match lid open/close events
492 # These can be combined to a single event, by passing the
493 # value of $notify to the external script.
496 match "system" "ACPI";
497 match "subsystem" "Lid";
498 match "notify" "0x00";
499 action "logger Lid closed, we can sleep now!";
503 match "system" "ACPI";
504 match "subsystem" "Lid";
505 match "notify" "0x01";
506 action "logger Lid opened, the sleeper must awaken!";
510 # Match a USB device type
513 match "system" "USB";
514 match "subsystem" "INTERFACE";
515 match "type" "ATTACH";
516 match "intclass" "0x0e";
517 action "logger USB video device attached";
521 # Try to configure ath and wi devices with pccard_ether
522 # as they are attached.
525 device-name "(ath|wi)[0-9]+";
526 action "/etc/pccard_ether $device-name start";
530 # Stop ath and wi devices as they are detached from
534 device-name "(ath|wi)[0-9]+";
535 action "/etc/pccard_ether $device-name stop";
541 has many additional examples.