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 All regular expressions have an implicit
129 The following sub-statements are supported within the
134 .Bl -tag -width ".Ic directory"
135 .It Ic action Qq Ar command ;
136 Command to execute upon a successful match.
138 .Dq Li "/etc/pccard_ether $device-name start" .
139 .It Ic class Qq Ar string ;
140 This is shorthand for
141 .Dq Ic match Qo Li class Qc Qq Ar string .
142 .It Ic device-name Qq string ;
143 This is shorthand for
144 .Dq Ic match Qo Li device-name Qc Qq Ar string .
145 This matches a device named
147 which is allowed to be a regular expression or a variable previously created
148 containing a regular expression.
152 is available for later use with the
155 .It Ic match Qo Ar variable Qc Qq Ar value ;
156 Matches the content of
162 may be a regular expression.
169 statement takes care of all device matching.
170 For a partial list of variables, see below.
171 .It Ic media-type Qq Ar string ;
174 will match devices that have the given media type.
175 Valid media types are:
183 .It Ic subdevice Qq Ar string ;
184 This is shorthand for
185 .Dq Ic match Qo Li subdevice Qc Qq Ar string .
188 The following sub-statements are supported within the
191 .Bl -tag -width ".Ic directory"
192 .It Ic action Qq Ar command ;
194 .It Ic match Qo Ar variable Qc Qq Ar value ;
195 Matches the content of
201 may be a regular expression.
202 For a partial list of variables, see below.
205 The following sub-statements are supported within the
210 variable is available inside this statement and contains, a value, depending
211 on which system and subsystem that delivered the event.
212 .Bl -tag -width ".Ic directory"
213 .It Ic action Qq Ar command ;
214 Command to execute upon a successful match.
216 .Dq Li "/etc/rc.d/power_profile $notify" .
217 .It Ic match Qo Ar system | subsystem | type | notify Qc Qq Ar value ;
220 statements can exist within a
224 can be either a fixed string or a regular expression.
225 Below is a list of available systems, subsystems, and types.
226 .It Ic media-type Qq Ar string ;
229 .Ss Variables that can be used with the match statement
230 A partial list of variables and their possible values that can be used together
235 .Bl -tag -width ".Li manufacturer" -compact
239 Device name of parent bus.
241 Device node path if one is created by the
255 Device Sub-class (USB)
257 Name of attached/detached device.
265 Interface Class (USB)
267 Interface Protocol (USB)
269 Interface Sub-class (USB)
271 Manufacturer ID (pccard).
273 Peripheral mode (USB)
275 Match the value of the
281 Hub port number (USB)
283 Product ID (pccard/USB).
285 Hardware revision (USB)
295 Matches a subsystem of a system, see below.
297 Matches a system type, see below.
299 Type of notification, see below.
304 A partial list of systems, subsystems, and types used within the
308 .Bl -tag -width ".Li coretemp" -compact
311 Events related to the ACPI subsystem.
312 .Bl -tag -width ".Sy Subsystem" -compact
315 AC line state ($notify=0x00 is offline, 0x01 is online).
317 Button state ($notify=0x00 is power, 0x01 is sleep).
321 Lid state ($notify=0x00 is closed, 0x01 is open).
327 Events related to the network subsystem.
328 .Bl -tag -width ".Sy Subsystem" -compact
333 is the actual name of the network interface on which the event
335 .Bl -tag -width ".Li LINK_DOWN" -compact
338 Carrier status changed to UP.
340 Carrier status changed to DOWN.
342 The network interface is attached to the system.
344 The network interface is detached from the system.
348 Events related to the
351 .Bl -tag -width ".Sy Subsystem" -compact
354 .Bl -tag -width ".Li DESTROY" -compact
367 Events related to the USB subsystem.
368 .Bl -tag -width ".Sy Subsystem" -compact
371 .Bl -tag -width ".Li DETACH" -compact
374 USB device is attached to the system.
376 USB device is detached from the system.
379 .Bl -tag -width ".Li DETACH" -compact
382 USB interface is attached to a device.
384 USB interface is detached from a device.
388 Events related to the
391 .Bl -tag -width ".Sy Subsystem" -compact
394 Notification that the CPU core has reached critical temperature.
395 .Bl -tag -width ".Ar temperature" -compact
398 String containing the temperature of the core that has become too hot.
402 Events related to the kernel.
403 .Bl -tag -width ".Sy Subsystem" -compact
406 Information about the state of the system.
407 .Bl -tag -width ".li resume" -compact
410 Notification that the system has woken from the suspended state.
415 A link state change to UP on the interface
417 would result in the following notify event:
418 .Bd -literal -offset indent
419 system=IFNET, subsystem=fxp0, type=LINK_UP
422 An AC line state change to
424 would result in the following event:
425 .Bd -literal -offset indent
426 system=ACPI, subsystem=ACAD, notify=0x00
429 Comments may appear anywhere that whitespace may appear in a
431 To appeal to programmers of all kinds, they can
432 be written in C, C++, or shell/Perl constructs.
434 C-style comments start with the two characters
436 (slash, star) and end with
439 Because they are completely delimited with these characters,
440 they can be used to comment only a portion of a line or to span
443 C-style comments cannot be nested.
444 For example, the following is
445 not valid because the entire comment ends with the first
447 .Bd -literal -offset indent
448 /* This is the start of a comment.
449 This is still part of the comment.
450 /* This is an incorrect attempt at nesting a comment. */
451 This is no longer in any comment. */
454 C++-style comments start with the two characters
456 (slash, slash) and continue to the end of the physical line.
457 They cannot be continued across multiple physical lines; to have
458 one logical comment span multiple lines, each line must use the
462 .Bd -literal -offset indent
463 // This is the start of a comment. The next line
464 // is a new comment, even though it is logically
465 // part of the previous comment.
468 .Bl -tag -width ".Pa /etc/devd.conf" -compact
469 .It Pa /etc/devd.conf
477 # This will catch link down events on the interfaces fxp0 and ath0
480 match "system" "IFNET";
481 match "subsystem" "(fxp0|ath0)";
482 match "type" "LINK_DOWN";
483 action "logger $subsystem is DOWN";
487 # Match lid open/close events
488 # These can be combined to a single event, by passing the
489 # value of $notify to the external script.
492 match "system" "ACPI";
493 match "subsystem" "Lid";
494 match "notify" "0x00";
495 action "logger Lid closed, we can sleep now!";
499 match "system" "ACPI";
500 match "subsystem" "Lid";
501 match "notify" "0x01";
502 action "logger Lid opened, the sleeper must awaken!";
506 # Match a USB device type
509 match "system" "USB";
510 match "subsystem" "INTERFACE";
511 match "type" "ATTACH";
512 match "intclass" "0x0e";
513 action "logger USB video device attached";
517 # Try to configure ath and wi devices with pccard_ether
518 # as they are attached.
521 device-name "(ath|wi)[0-9]+";
522 action "/etc/pccard_ether $device-name start";
526 # Stop ath and wi devices as they are detached from
530 device-name "(ath|wi)[0-9]+";
531 action "/etc/pccard_ether $device-name stop";
537 has many additional examples.