2 .\" Copyright (c) 2002 M. Warner Losh <imp@FreeBSD.org>
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\" notice, this list of conditions and the following disclaimer.
9 .\" 2. The name of the author may not be used to endorse or promote products
10 .\" derived from this software without specific prior written permission.
12 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
13 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
14 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
15 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
16 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
17 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
18 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
19 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
20 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
21 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26 .\" The section on comments was taken from named.conf.5, which has the
27 .\" following copyright:
28 .\" Copyright (c) 1999-2000 by Internet Software Consortium
30 .\" Permission to use, copy, modify, and distribute this software for any
31 .\" purpose with or without fee is hereby granted, provided that the above
32 .\" copyright notice and this permission notice appear in all copies.
34 .\" THE SOFTWARE IS PROVIDED "AS IS" AND INTERNET SOFTWARE CONSORTIUM DISCLAIMS
35 .\" ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES
36 .\" OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL INTERNET SOFTWARE
37 .\" CONSORTIUM BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
38 .\" DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
39 .\" PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS
40 .\" ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
48 .Nd configuration file for
54 configuration consists of two general features, statements
56 All statements end with a semicolon.
57 Many statements can contain substatements, which are also
58 terminated with a semicolon.
60 The following statements are supported:
61 .Bl -tag -width ".Ic options"
63 Specifies various matching criteria and actions to perform when
64 a newly attached device matches said criteria.
66 Specifies various matching criteria and actions to perform when
67 a newly detached device matches said criteria.
69 Specifies various matching criteria and actions to perform when
70 no device driver currently loaded in the kernel claims a (new)
73 Specifies various matching criteria and actions to perform when the kernel
74 sends an event notification to userland.
76 Specifies various options and parameters for the operation of
80 Statements may occur in any order in the configuration file, and may be
81 repeated as often as required.
82 Further details on the syntax and meaning of each statement and their
83 substatements are explained below.
85 Each statement, except
87 has a priority (an arbitrary number) associated with it, where
89 is defined as the lowest priority.
90 If two statements match the same event, only the action of the statement with
91 highest priority will be executed.
92 In this way generic statements can be overridden for devices or
93 notifications that require special attention.
95 The general syntax of a statement is:
96 .Bd -literal -offset indent
100 substatement "value";
104 The following sub-statements are supported within the
107 .Bl -tag -width ".Ic directory"
108 .It Ic directory Qq Ar /some/path ;
109 Adds the given directory to the list of directories from which
111 will read all files named "*.conf" as further
115 statements can be used.
116 .It Ic pid-file Qq Pa /var/run/devd.pid ;
118 .It Ic set Ar regexp-name Qq Ar (some|regexp) ;
119 Creates a regular expression and assigns it to the variable
121 The variable is available throughout the rest of
122 the configuration file.
123 If the string begins with
125 it matches if the regular expression formed by the rest of the string
127 All regular expressions have an implicit
132 The following sub-statements are supported within the
137 .Bl -tag -width ".Ic directory"
138 .It Ic action Qq Ar command ;
139 Command to execute upon a successful match.
141 .Dq Li "/etc/pccard_ether $device-name start" .
142 .It Ic class Qq Ar string ;
143 This is shorthand for
144 .Dq Ic match Qo Li class Qc Qq Ar string .
145 .It Ic device-name Qq string ;
146 This is shorthand for
147 .Dq Ic match Qo Li device-name Qc Qq Ar string .
148 This matches a device named
150 which is allowed to be a regular expression or a variable previously created
151 containing a regular expression.
155 is available for later use with the
158 .It Ic match Qo Ar variable Qc Qq Ar value ;
159 Matches the content of
165 may be a regular expression.
172 statement takes care of all device matching.
173 For a partial list of variables, see below.
174 .It Ic media-type Qq Ar string ;
177 will match devices that have the given media type.
178 Valid media types are:
185 .It Ic subdevice Qq Ar string ;
186 This is shorthand for
187 .Dq Ic match Qo Li subdevice Qc Qq Ar string .
190 The following sub-statements are supported within the
193 .Bl -tag -width ".Ic directory"
194 .It Ic action Qq Ar command ;
196 .It Ic match Qo Ar variable Qc Qq Ar value ;
197 Matches the content of
203 may be a regular expression.
204 For a partial list of variables, see below.
207 The following sub-statements are supported within the
212 variable is available inside this statement and contains, a value, depending
213 on which system and subsystem that delivered the event.
214 .Bl -tag -width ".Ic directory"
215 .It Ic action Qq Ar command ;
216 Command to execute upon a successful match.
218 .Dq Li "/etc/rc.d/power_profile $notify" .
219 .It Ic match Qo Ar system | subsystem | type | notify Qc Qq Ar value ;
222 statements can exist within a
226 can be either a fixed string or a regular expression.
227 Below is a list of available systems, subsystems, and types.
228 .It Ic media-type Qq Ar string ;
231 .Ss Variables that can be used with the match statement
232 A partial list of variables and their possible values that can be used together
236 The variables are published by the bus based on characteristics of the device
237 that generated the event (for device events).
238 Variables for other classes of events are dependent on those events.
240 .Bl -tag -width ".Li manufacturer" -compact
244 The entire message from the current event.
246 The entire message from the current event, after the initial type character.
248 The time this event was processed, in seconds since 1970 dot fraction.
250 Device name of parent bus.
252 Device node path if one is created by the
258 Executable name (kernel).
260 Path to core file (kernel).
266 Device Sub-class (USB).
268 Name of attached/detached device.
270 Endpoint count (USB).
276 Interface Class (USB).
278 Interface Protocol (USB).
280 Interface Sub-class (USB).
282 Jail name for the process triggering the rule (RCTL).
284 Peripheral mode (USB).
286 Match the value of the
292 PID of the process triggering the rule (RCTL).
294 Hub port number (USB).
298 Hardware revision (USB).
300 Real UID of the process triggering the rule (RCTL).
312 Matches a subsystem of a system, see below.
314 Matches a system type, see below.
316 Type of notification, see below.
321 A partial list of systems, subsystems, and types used within the
325 .\" Please keep these tables sorted. Also, please use the same parameters
326 .\" for each of the tables so that things line up in columns nicely.
327 .\" Please do not omit the type column for notifiers that omit it.
329 .Bl -column "System" "Subsystem" "1234567" -compact
330 .Sy "System" Ta Sy "Subsystem" Ta Sy "Type" Ta Sy "Description"
332 Events related to the ACPI Sybsystem.
333 .It Li ACPI Ta Li ACAD Ta Ta
334 AC line state ($notify=0x00 is offline, 0x01 is online).
335 .It Li ACPI Ta Li Button Ta Ta
336 Button state ($notify=0x00 is power, 0x01 is sleep).
337 .It Li ACPI Ta Li CMBAT Ta Ta
339 .It Li ACPI Ta Li Dock Ta Ta
340 Dock state ($notify=0x00 is undocked, 0x01 is docked).
341 .It Li ACPI Ta Li Lid Ta Ta
342 Lid state ($notify=0x00 is closed, 0x01 is open).
343 .It Li ACPI Ta Li PROCESSOR Ta Ta
344 Processor state/configuration ($notify=0x81 is a change in available Cx states).
345 .It Li ACPI Ta Li Resume Ta Ta
347 .It Li ACPI Ta Li Suspend Ta Ta
348 Suspend notification.
349 .It Li ACPI Ta Li Thermal Ta Ta
353 .Bl -column "System" "Subsystem" "1234567" -compact
354 .Sy "System" Ta Sy "Subsystem" Ta Sy "Type" Ta Sy "Description"
356 Events related to the
359 .It Li CAM Ta Li periph Ta Ta
360 Events related to peripheral devices.
361 .It Li CAM Ta Li periph Ta Li error Ta
363 .It Li CAM Ta Li periph Ta Li timeout Ta
367 .Bl -column "System" "Subsystem" "1234567" -compact
368 .Sy "System" Ta Sy "Subsystem" Ta Sy "Type" Ta Sy "Description"
370 Events related to the
373 .It CARP Ta Ar vhid@inet Ta Ta
376 contains the actual CARP vhid and the name of the network interface
377 on which the event took place.
378 .It CARP Ta Ar vhid@inet Ta MASTER Ta
379 Node become the master for a virtual host.
380 .It CARP Ta Ar vhid@inet Ta BACKUP Ta
381 Node become the backup for a virtual host.
384 .Bl -column "System" "Subsystem" "1234567" -compact
385 .Sy "System" Ta Sy "Subsystem" Ta Sy "Type" Ta Sy "Description"
386 .It Li coretemp Ta Ta Ta
387 Events related to the
390 .It Li coretemp Ta Li Thermal Ta Ta
391 Notification that the CPU core has reached critical temperature.
392 .It Li coretemp Ta Li Thermal Ta Li temperature Ta
393 String containing the temperature of the core that has become too hot.
396 .Bl -column "System" "Subsystem" "1234567" -compact
397 .Sy "System" Ta Sy "Subsystem" Ta Sy "Type" Ta Sy "Description"
399 .It Li IFNET Ta Ar inet Ta Ta
402 is the actual name of the network interface on which the event
404 .It Li IFNET Ta Ar inet Ta Li LINK_UP Ta
405 Carrier status changed to UP.
406 .It Li IFNET Ta Ar inet Ta Li LINK_DOWN Ta
407 Carrier status changed to DOWN.
408 .It Li IFNET Ta Ar inet Ta Li ATTACH Ta
409 The network interface is attached to the system.
410 .It Li IFNET Ta Ar inet Ta Li DETACH Ta
411 The network interface is detached from the system.
414 .Bl -column "System" "Subsystem" "1234567" -compact
415 .Sy "System" Ta Sy "Subsystem" Ta Sy "Type" Ta Sy "Description"
417 .It Li DEVFS Ta Li CDEV Ta Li CREATE Ta
421 .It Li DEVFS Ta Li CDEV Ta Li DESTROY Ta
427 .Bl -column "System" "Subsystem" "1234567" -compact
428 .Sy "System" Ta Sy "Subsystem" Ta Sy "Type" Ta Sy "Description"
430 Events related to the
433 The difference compared to
437 only includes disk-like devices.
438 .It Li GEOM Ta Li DEV Ta Li CREATE Ta
442 .It Li GEOM Ta Li DEV Ta Li DESTROY Ta
445 provider is destroyed.
446 .It Li GEOM Ta Li DEV Ta Li GEOM::physpath Ta
447 The physical path of a device has changed.
448 .It Li GEOM Ta Li DEV Ta Li GEOM::rotation_rate Ta
449 The roation rate of the disk has changed.
450 .It Li GEOM Ta Li DEV Ta Li MEDIACHANGE Ta
451 Physical media has changed.
452 .It Li GEOM Ta Li DEV Ta Li SIZECHANGE Ta
455 provider size has changed.
458 .Bl -column "System" "Subsystem" "1234567" -compact
459 .Sy "System" Ta Sy "Subsystem" Ta Sy "Type" Ta Sy "Description"
460 .It Li kern Ta Li power Ta Li resume Ta
461 Notification that the system has woken from the suspended state.
465 .Bl -column "System" "Subsystem" "1234567" -compact
466 .Sy "System" Ta Sy "Subsystem" Ta Sy "Type" Ta Sy "Description"
467 .It Li kernel Ta Li signal Ta Li coredump Ta
468 Notification that a process has crashed and dumped core.
471 .Bl -column "System" "Subsystem" "1234567" -compact
472 .Sy "System" Ta Sy "Subsystem" Ta Sy "Type" Ta Sy "Description"
474 Events related to the
477 .It Li RCTL Ta Li rule Ta Li matched Ta
478 A rule with action specified as "devctl" was triggered.
481 .Bl -column "System" "Subsystem" "1234567" -compact
482 .Sy "System" Ta Sy "Subsystem" Ta Sy "Type" Ta Sy "Description"
484 Events related to the USB subsystem.
485 .It Li USB Ta Li DEVICE Ta Li ATTACH Ta
486 USB device is attached to the system.
487 .It Li USB Ta Li DEVICE Ta Li DETACH Ta
488 USB device is detached to the system.
489 .It Li USB Ta Li INTERFACE Ta Li ATTACH Ta
490 USB interface is attached to a device.
491 .It Li USB Ta Li INTERFACE Ta Li DETACH Ta
492 USB interface is detached from a device.
499 A link state change to UP on the interface
501 would result in the following notify event:
502 .Bd -literal -offset indent
503 system=IFNET subsystem=fxp0 type=LINK_UP
506 An AC line state change to
508 would result in the following event:
509 .Bd -literal -offset indent
510 system=ACPI subsystem=ACAD notify=0x00
513 Comments may appear anywhere that whitespace may appear in a
515 To appeal to programmers of all kinds, they can
516 be written in C, C++, or shell/Perl constructs.
518 C-style comments start with the two characters
520 (slash, star) and end with
523 Because they are completely delimited with these characters,
524 they can be used to comment only a portion of a line or to span
527 C-style comments cannot be nested.
528 For example, the following is
529 not valid because the entire comment ends with the first
531 .Bd -literal -offset indent
532 /* This is the start of a comment.
533 This is still part of the comment.
534 /* This is an incorrect attempt at nesting a comment. */
535 This is no longer in any comment. */
538 C++-style comments start with the two characters
540 (slash, slash) and continue to the end of the physical line.
541 They cannot be continued across multiple physical lines; to have
542 one logical comment span multiple lines, each line must use the
546 .Bd -literal -offset indent
547 // This is the start of a comment. The next line
548 // is a new comment, even though it is logically
549 // part of the previous comment.
552 .Bl -tag -width ".Pa /etc/devd.conf" -compact
553 .It Pa /etc/devd.conf
561 # This will catch link down events on the interfaces fxp0 and ath0
564 match "system" "IFNET";
565 match "subsystem" "(fxp0|ath0)";
566 match "type" "LINK_DOWN";
567 action "logger $subsystem is DOWN";
571 # Match lid open/close events
572 # These can be combined to a single event, by passing the
573 # value of $notify to the external script.
576 match "system" "ACPI";
577 match "subsystem" "Lid";
578 match "notify" "0x00";
579 action "logger Lid closed, we can sleep now!";
583 match "system" "ACPI";
584 match "subsystem" "Lid";
585 match "notify" "0x01";
586 action "logger Lid opened, the sleeper must awaken!";
590 # Match a USB device type
593 match "system" "USB";
594 match "subsystem" "INTERFACE";
595 match "type" "ATTACH";
596 match "intclass" "0x0e";
597 action "logger USB video device attached";
601 # Try to configure ath and iwn devices with pccard_ether
602 # as they are attached.
605 device-name "(ath|iwn)[0-9]+";
606 action "/etc/pccard_ether $device-name start";
610 # Stop ath and iwn devices as they are detached from
614 device-name "(ath|iwn)[0-9]+";
615 action "/etc/pccard_ether $device-name stop";
621 has many additional examples.