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
25 .\" $FreeBSD: src/sbin/devd/devd.conf.5,v 1.11 2006/10/24 20:20:41 ru Exp $
26 .\" $DragonFly: src/sbin/devd/devd.conf.5,v 1.1 2008/10/03 00:26:21 hasso Exp $
28 .\" The section on comments was taken from named.conf.5, which has the
29 .\" following copyright:
30 .\" Copyright (c) 1999-2000 by Internet Software Consortium
32 .\" Permission to use, copy, modify, and distribute this software for any
33 .\" purpose with or without fee is hereby granted, provided that the above
34 .\" copyright notice and this permission notice appear in all copies.
36 .\" THE SOFTWARE IS PROVIDED "AS IS" AND INTERNET SOFTWARE CONSORTIUM DISCLAIMS
37 .\" ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES
38 .\" OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL INTERNET SOFTWARE
39 .\" CONSORTIUM BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
40 .\" DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
41 .\" PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS
42 .\" ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
50 .Nd configuration file for
56 configuration consists of two general features, statements
58 All statements end with a semicolon.
59 Many statements can contain substatements, which are also
60 terminated with a semicolon.
62 The following statements are supported:
63 .Bl -tag -width ".Ic options"
65 Specifies various matching criteria and actions to perform when
66 a newly attached device matches said criteria.
68 Specifies various matching criteria and actions to perform when
69 a newly detached device matches said criteria.
71 Specifies various matching criteria and actions to perform when
72 no device driver currently loaded in the kernel claims a (new)
75 Specifies various matching criteria and actions to perform when the kernel
76 sends an event notification to userland.
78 Specifies various options and parameters for the operation of
82 Statements may occur in any order in the configuration file, and may be
83 repeated as often as required.
84 Further details on the syntax and meaning of each statement and their
85 substatements are explained below.
87 Each statement, except
89 has a priority (an arbitrary number) associated with it, where
91 is defined as the lowest priority.
92 If two statements match the same event, only the action of the statement with
93 highest priority will be executed.
94 In this way generic statements can be overridden for devices or
95 notifications that require special attention.
97 The general syntax of a statement is:
99 .Bd -literal -offset indent
101 substatement "value";
103 substatement "value";
107 The following sub-statements are supported within the
110 .Bl -tag -width ".Ic directory"
111 .It Ic directory Qq Ar /some/path ;
112 Adds the given directory to the list of directories from which
118 statements can be used.
119 .\" .It Ic pid-file Qq Pa /var/run/devd.pid ;
120 .\" Specifies PID file.
121 .It Ic set Ar regexp-name Qq Ar (some|regexp) ;
122 Creates a regular expression and assigns it to the variable
124 The variable is avaiable throughout the rest of
125 the configuration file.
126 All regular expressions have an implicit
131 The following sub-statements are supported within the
136 .Bl -tag -width ".Ic directory"
137 .It Ic action Qq Ar command ;
138 Command to execute upon a successful match.
140 .Dq Li "/etc/pccard_ether $device-name start" .
141 .It Ic class Qq Ar string ;
142 This is shorthand for
143 .Dq Ic match Qo Li class Qc Qq Ar string .
144 .It Ic device-name Qq string ;
145 This is shorthand for
146 .Dq Ic match Qo Li device-name Qc Qq Ar string .
147 This matches a device named
149 which is allowed to be a regular expression or a variable previously created
150 containing a regular expression.
154 is available for later use with the
157 .It Ic match Qo Ar variable Qc Qq Ar value ;
158 Matches the content of
164 may be a regular expression.
171 statement takes care of all device matching.
172 For a partial list of variables, see below.
173 .It Ic media-type Qq Ar string ;
176 will match devices that have the given media type.
177 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 avaiable 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 avaiable 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.
249 Name of attached/detached device.
253 Manufacturer ID (pccard).
255 Match the value of the
269 Matches a subsystem of a system, see below.
271 Matches a system type, see below.
273 Type of notification, see below.
278 A partial list of systems, subsystems, and types used within the
282 .Bl -tag -width ".Li IFNET" -compact
285 Events related to the ACPI subsystem.
286 .Bl -tag -width ".Sy Subsystem" -compact
289 AC line state ($notify=0x00 is offline, 0x01 is online).
291 Button state ($notify=0x00 is power, 0x01 is sleep).
295 Lid state ($notify=0x00 is closed, 0x01 is open).
301 Events related to the network subsystem.
302 .Bl -tag -width ".Sy Subsystem" -compact
307 is the actual name of the network interface on which the event
309 .Bl -tag -width ".Li LINK_DOWN" -compact
312 Carrier status changed to UP.
314 Carrier status changed to DOWN.
319 A link state change to UP on the interface
321 would result in the following notify event:
322 .Bd -literal -offset indent
323 system=IFNET, subsystem=fxp0, type=LINK_UP
326 An AC line state change to
328 would result in the following event:
329 .Bd -literal -offset indent
330 system=ACPI, subsystem=ACAD, notify=0x00
333 Comments may appear anywhere that whitespace may appear in a
335 To appeal to programmers of all kinds, they can
336 be written in C, C++, or shell/Perl constructs.
338 C-style comments start with the two characters
340 (slash, star) and end with
343 Because they are completely delimited with these characters,
344 they can be used to comment only a portion of a line or to span
347 C-style comments cannot be nested.
348 For example, the following is
349 not valid because the entire comment ends with the first
351 .Bd -literal -offset indent
352 /* This is the start of a comment.
353 This is still part of the comment.
354 /* This is an incorrect attempt at nesting a comment. */
355 This is no longer in any comment. */
358 C++-style comments start with the two characters
360 (slash, slash) and continue to the end of the physical line.
361 They cannot be continued across multiple physical lines; to have
362 one logical comment span multiple lines, each line must use the
366 .Bd -literal -offset indent
367 // This is the start of a comment. The next line
368 // is a new comment, even though it is logically
369 // part of the previous comment.
372 .Bl -tag -width ".Pa /etc/devd.conf" -compact
373 .It Pa /etc/devd.conf
381 # This will catch link down events on the interfaces fxp0 and ath0
384 match "system" "IFNET";
385 match "subsystem" "(fxp0|ath0)";
386 match "type" "LINK_DOWN";
387 action "logger $subsystem is DOWN";
391 # Match lid open/close events
392 # These can be combined to a single event, by passing the
393 # value of $notify to the external script.
396 match "system" "ACPI";
397 match "subsystem" "Lid";
398 match "notify" "0x00";
399 action "logger Lid closed, we can sleep now!";
403 match "system" "ACPI";
404 match "subsystem" "Lid";
405 match "notify" "0x01";
406 action "logger Lid opened, the sleeper must awaken!";
410 # Try to configure ath and wi devices with pccard_ether
411 # as they are attached.
414 device-name "(ath|wi)[0-9]+";
415 action "/etc/pccard_ether $device-name start";
419 # Stop ath and wi devices as they are detached from
423 device-name "(ath|wi)[0-9]+";
424 action "/etc/pccard_ether $device-name stop";
430 has many additional examples.