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:
186 .It Ic subdevice Qq Ar string ;
187 This is shorthand for
188 .Dq Ic match Qo Li subdevice Qc Qq Ar string .
191 The following sub-statements are supported within the
194 .Bl -tag -width ".Ic directory"
195 .It Ic action Qq Ar command ;
197 .It Ic match Qo Ar variable Qc Qq Ar value ;
198 Matches the content of
204 may be a regular expression.
205 For a partial list of variables, see below.
208 The following sub-statements are supported within the
213 variable is available inside this statement and contains, a value, depending
214 on which system and subsystem that delivered the event.
215 .Bl -tag -width ".Ic directory"
216 .It Ic action Qq Ar command ;
217 Command to execute upon a successful match.
219 .Dq Li "/etc/rc.d/power_profile $notify" .
220 .It Ic match Qo Ar system | subsystem | type | notify Qc Qq Ar value ;
223 statements can exist within a
227 can be either a fixed string or a regular expression.
228 Below is a list of available systems, subsystems, and types.
229 .It Ic media-type Qq Ar string ;
232 .Ss Variables that can be used with the match statement
233 A partial list of variables and their possible values that can be used together
237 The variables are published by the bus based on characteristics of the device
238 that generated the event (for device events).
239 Variables for other classes of events are dependent on those events.
241 .Bl -tag -width ".Li manufacturer" -compact
245 The entire message from the current event.
247 The entire message from the current event, after the initial type character.
249 The time this event was processed, in seconds since 1970 dot fraction.
251 Device name of parent bus.
253 Device node path if one is created by the
263 Executable name (kernel).
265 Path to core file (kernel).
271 Device Sub-class (USB).
273 Name of attached/detached device.
275 Endpoint count (USB).
281 Interface Class (USB).
283 Interface Protocol (USB).
285 Interface Sub-class (USB).
287 Jail name for the process triggering the rule (RCTL).
289 Manufacturer ID (pccard).
291 Peripheral mode (USB).
293 Match the value of the
299 PID of the process triggering the rule (RCTL).
301 Hub port number (USB).
303 Product ID (pccard/USB).
305 Hardware revision (USB).
307 Real UID of the process triggering the rule (RCTL).
319 Matches a subsystem of a system, see below.
321 Matches a system type, see below.
323 Type of notification, see below.
328 A partial list of systems, subsystems, and types used within the
332 .Bl -tag -width ".Li coretemp" -compact
335 Events related to the ACPI subsystem.
336 .Bl -tag -width ".Sy Subsystem" -compact
339 AC line state ($notify=0x00 is offline, 0x01 is online).
341 Button state ($notify=0x00 is power, 0x01 is sleep).
345 Dock state ($notify=0x00 is undocked, 0x01 is docked).
347 Lid state ($notify=0x00 is closed, 0x01 is open).
349 Processor state/configuration ($notify=0x81 is a change in available Cx states).
353 Suspend notification.
359 Events related to the
362 .Bl -tag -width ".Sy Subsystem" -compact
364 .It Ar vhid@interface
367 contains the actual CARP vhid and the name of the network interface
368 on which the event took place.
369 .Bl -tag -width ".Li MASTER" -compact
372 Node become the master for a virtual host.
374 Node become the backup for a virtual host.
379 Events related to the network subsystem.
380 .Bl -tag -width ".Sy Subsystem" -compact
385 is the actual name of the network interface on which the event
387 .Bl -tag -width ".Li LINK_DOWN" -compact
390 Carrier status changed to UP.
392 Carrier status changed to DOWN.
394 The network interface is attached to the system.
396 The network interface is detached from the system.
401 Events related to the
404 .Bl -tag -width ".Sy Subsystem" -compact
407 .Bl -tag -width ".Li DESTROY" -compact
421 Events related to the
424 The difference compared to
428 only includes disk-like devices.
429 .Bl -tag -width ".Sy Subsystem" -compact
432 .Bl -tag -width ".Li MEDIACHANGE" -compact
437 device node is created.
441 device node is destroyed.
442 .It Li GEOM::physpath
443 The physical path of a device has changed.
445 Physical media has changed.
450 Events related to the
453 .Bl -tag -width ".Sy Subsystem" -compact
456 .Bl -tag -width ".Li matched" -compact
459 A rule with action specified as "devctl" was triggered.
464 Events related to the USB subsystem.
465 .Bl -tag -width ".Sy Subsystem" -compact
468 .Bl -tag -width ".Li DETACH" -compact
471 USB device is attached to the system.
473 USB device is detached from the system.
476 .Bl -tag -width ".Li DETACH" -compact
479 USB interface is attached to a device.
481 USB interface is detached from a device.
486 Events related to the
489 .Bl -tag -width ".Sy Subsystem" -compact
492 Notification that the CPU core has reached critical temperature.
493 .Bl -tag -width ".Ar temperature" -compact
496 String containing the temperature of the core that has become too hot.
501 Events related to the kernel.
502 .Bl -tag -width ".Sy Subsystem" -compact
505 .Bl -tag -width ".li resume" -compact
508 Notification that the system has woken from the suspended state.
513 More events related to the kernel.
514 .Bl -tag -width ".Sy Subsystem" -compact
517 .Bl -tag -width ".li resume" -compact
520 Notification that a process has crashed and dumped core.
525 Events related to the
528 .Bl -tag -width ".Sy Subsystem" -compact
531 Events related to peripheral devices.
532 .Bl -tag -width ".li timeout" -compact
542 A link state change to UP on the interface
544 would result in the following notify event:
545 .Bd -literal -offset indent
546 system=IFNET, subsystem=fxp0, type=LINK_UP
549 An AC line state change to
551 would result in the following event:
552 .Bd -literal -offset indent
553 system=ACPI, subsystem=ACAD, notify=0x00
556 Comments may appear anywhere that whitespace may appear in a
558 To appeal to programmers of all kinds, they can
559 be written in C, C++, or shell/Perl constructs.
561 C-style comments start with the two characters
563 (slash, star) and end with
566 Because they are completely delimited with these characters,
567 they can be used to comment only a portion of a line or to span
570 C-style comments cannot be nested.
571 For example, the following is
572 not valid because the entire comment ends with the first
574 .Bd -literal -offset indent
575 /* This is the start of a comment.
576 This is still part of the comment.
577 /* This is an incorrect attempt at nesting a comment. */
578 This is no longer in any comment. */
581 C++-style comments start with the two characters
583 (slash, slash) and continue to the end of the physical line.
584 They cannot be continued across multiple physical lines; to have
585 one logical comment span multiple lines, each line must use the
589 .Bd -literal -offset indent
590 // This is the start of a comment. The next line
591 // is a new comment, even though it is logically
592 // part of the previous comment.
595 .Bl -tag -width ".Pa /etc/devd.conf" -compact
596 .It Pa /etc/devd.conf
604 # This will catch link down events on the interfaces fxp0 and ath0
607 match "system" "IFNET";
608 match "subsystem" "(fxp0|ath0)";
609 match "type" "LINK_DOWN";
610 action "logger $subsystem is DOWN";
614 # Match lid open/close events
615 # These can be combined to a single event, by passing the
616 # value of $notify to the external script.
619 match "system" "ACPI";
620 match "subsystem" "Lid";
621 match "notify" "0x00";
622 action "logger Lid closed, we can sleep now!";
626 match "system" "ACPI";
627 match "subsystem" "Lid";
628 match "notify" "0x01";
629 action "logger Lid opened, the sleeper must awaken!";
633 # Match a USB device type
636 match "system" "USB";
637 match "subsystem" "INTERFACE";
638 match "type" "ATTACH";
639 match "intclass" "0x0e";
640 action "logger USB video device attached";
644 # Try to configure ath and wi devices with pccard_ether
645 # as they are attached.
648 device-name "(ath|wi)[0-9]+";
649 action "/etc/pccard_ether $device-name start";
653 # Stop ath and wi devices as they are detached from
657 device-name "(ath|wi)[0-9]+";
658 action "/etc/pccard_ether $device-name stop";
664 has many additional examples.