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";
107 The following sub-statements are supported within the
110 .Bl -tag -width ".Ic directory"
111 .It Ic directory \*q/some/path\*q;
112 Adds the given directory to the list of directories from which
115 configuration files. Any number of
117 statements can be used.
118 .It Ic pid-file \*q/var/run/devd.pid\*q;
120 .It Ic set regexp-name \*q(some|regexp)\*q;
121 Creates a regular expression and assigns it to the variable
123 The variable is avaiable 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 \*qcommand\*q;
137 Command to execute upon a successful match.
139 .Ic /etc/pccard_ether $device-name start
140 .It Ic class \*qstring\*q;
141 This is shorthand for
142 .Dq match \*qclass\*q .
143 .It Ic device-name \*qstring\*q;
144 This is shorthand for
145 .Dq match \*qdevice-name\*q .
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 avaiable for later use with the action-statement.
154 .It Ic match \*qvariable\*q \*qvalue\*q;
155 Matches the content of
161 may be a regular expression.
168 statement takes care of all device matching.
169 For a partial list of variables, see below.
170 .It Ic media-type \*qstring\*q;
171 This is shorthand for
172 .Dq match \*qdevice-name\*q .
173 .It Ic subdevice \*qstring\*q;
174 This is shorthand for
175 .Dq match \*qsubdevice\*q .
178 The following sub-statements are supported within the
181 .Bl -tag -width ".Ic directory"
182 .It Ic action \*qcommand\*q;
184 .It Ic match \*qvariable\*q \*qvalue\*q;
185 Matches the content of
191 may be a regular expression.
192 For a partial list of variables, see below.
195 The following sub-statements are supported within the
200 variable is avaiable inside this statement and contains, a value, depending
201 on which system and subsystem that delivered the event.
202 .Bl -tag -width ".Ic directory"
203 .It Ic action \*qcommand\*q;
204 Command to execute upon a successful match. Example
205 .Ic /etc/rc.d/power_profile $notify
206 .It Ic match \*qsystem|subsystem|type|notify\*q \*qvalue\*q;
209 statements can exists within a
213 can be either a fixed string or a regular expression.
214 Below is a list of avaiable systems, subsystems, and types.
216 .Ss Variables that can be used with the match statement
217 A partial list of variables and their possible values that can be used together
222 .Bl -tag -width "manufacturer" -compact
226 Device name of parent bus
236 Name of attached/detached device
240 Manufacturer ID (pccard)
242 Match the value of the
256 Matches a subsystem of a system, see below
258 Matches a system type, see below
260 Type of notification, see below
265 A Partial list of systems, subsystems, and types used within the
269 .Bl -tag -width "IFNET" -compact
272 Events related to the ACPI subsystem.
276 AC Line state ($notify=0x00 is offline, 0x01 is online).
278 Button state ($notify=0x00 is power, 0x01 is sleep).
282 Lid state ($notify=0x00 is closed, 0x01 is open).
288 Events related to the network subsystem.
294 is the actual name of the network interface on which the event
299 Carrier status changed to UP.
301 Carrier status changed to DOWN.
306 A link state change to UP on the interface
308 would result in the following notify event:
309 .Bd -literal -offset indent
310 system=IFNET, subsystem=fxp0, type=LINK_UP
313 An AC line state change to
315 would result in the following event:
316 .Bd -literal -offset indent
317 system=ACPI, subsystem=ACAD, notify=0x00
320 Comments may appear anywhere that whitespace may appear in a
322 To appeal to programmers of all kinds, they can
323 be written in C, C++, or shell/Perl constructs.
325 C-style comments start with the two characters
327 (slash, star) and end with
330 Because they are completely delimited with these characters,
331 they can be used to comment only a portion of a line or to span
334 C-style comments cannot be nested.
335 For example, the following is
336 not valid because the entire comment ends with the first
338 .Bd -literal -offset indent
339 /* This is the start of a comment.
340 This is still part of the comment.
341 /* This is an incorrect attempt at nesting a comment. */
342 This is no longer in any comment. */
345 C++-style comments start with the two characters
347 (slash, slash) and continue to the end of the physical line.
348 They cannot be continued across multiple physical lines; to have
349 one logical comment span multiple lines, each line must use the
353 .Bd -literal -offset indent
354 // This is the start of a comment. The next line
355 // is a new comment, even though it is logically
356 // part of the previous comment.
361 # This will catch link down events on the interfaces fxp0 and ath0
364 match "system" "IFNET";
365 match "subsystem" "(fxp0|ath0)";
366 match "type" "LINK_DOWN";
367 action "logger $subsystem is DOWN";
371 # Match lid open/close events
372 # These can be combined to a single event, by passing the
373 # value of $notify to the external script.
376 match "system" "ACPI";
377 match "subsystem" "Lid";
378 match "notify" "0x00";
379 action "logger Lid closed, we can sleep now!";
383 match "system" "ACPI";
384 match "subsystem" "Lid";
385 match "notify" "0x01";
386 action "logger Lid opened, the sleeper must awaken!";
390 # Try to configure ath and wi devices with pccard_ether
391 # as they are attached.
394 device-name "(ath|wi)[0-9]+";
395 action "/etc/pccard_ether $device-name start";
399 # Stop ath and wi devices as they are detached from
403 device-name "(ath|wi)[0-9]+";
404 action "/etc/pccard_ether $device-name stop";
410 has many additional examples.
412 .Bl -tag -width ".Pa /etc/devd.conf" -compact
413 .It Pa /etc/devd.conf