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 Subsystem.
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"
355 .It Li AEON Ta Li power Ta Li press Ta
356 The power button on an Amiga has been pressed.
359 .Bl -column "System" "Subsystem" "1234567" -compact
360 .Sy "System" Ta Sy "Subsystem" Ta Sy "Type" Ta Sy "Description"
362 Events related to the
365 .It Li CAM Ta Li periph Ta Ta
366 Events related to peripheral devices.
367 .It Li CAM Ta Li periph Ta Li error Ta
369 .It Li CAM Ta Li periph Ta Li timeout Ta
373 .Bl -column "System" "Subsystem" "1234567" -compact
374 .Sy "System" Ta Sy "Subsystem" Ta Sy "Type" Ta Sy "Description"
376 Events related to the
379 .It CARP Ta Ar vhid@inet Ta Ta
382 contains the actual CARP vhid and the name of the network interface
383 on which the event took place.
384 .It CARP Ta Ar vhid@inet Ta MASTER Ta
385 Node become the master for a virtual host.
386 .It CARP Ta Ar vhid@inet Ta BACKUP Ta
387 Node become the backup for a virtual host.
390 .Bl -column "System" "Subsystem" "1234567" -compact
391 .Sy "System" Ta Sy "Subsystem" Ta Sy "Type" Ta Sy "Description"
392 .It Li coretemp Ta Ta Ta
393 Events related to the
396 .It Li coretemp Ta Li Thermal Ta Ta
397 Notification that the CPU core has reached critical temperature.
398 .It Li coretemp Ta Li Thermal Ta Li temperature Ta
399 String containing the temperature of the core that has become too hot.
402 .Bl -column "System" "Subsystem" "1234567" -compact
403 .Sy "System" Ta Sy "Subsystem" Ta Sy "Type" Ta Sy "Description"
405 .It Li DEVFS Ta Li CDEV Ta Li CREATE Ta
409 .It Li DEVFS Ta Li CDEV Ta Li DESTROY Ta
415 .Bl -column "System" "Subsystem" "1234567" -compact
416 .Sy "System" Ta Sy "Subsystem" Ta Sy "Type" Ta Sy "Description"
417 .It Li ETHERNET Ta Ar inet Ta IFATTACH Ta
418 Notification when the default VNET instance of the
420 interface is attached.
423 .Bl -column "System" "Subsystem" "1234567" -compact
424 .Sy "System" Ta Sy "Subsystem" Ta Sy "Type" Ta Sy "Description"
426 Events related to the
429 The difference compared to
433 only includes disk-like devices.
434 .It Li GEOM Ta Li DEV Ta Li CREATE Ta
438 .It Li GEOM Ta Li DEV Ta Li DESTROY Ta
441 provider is destroyed.
442 .It Li GEOM Ta Li DEV Ta Li GEOM::physpath Ta
443 The physical path of a device has changed.
444 .It Li GEOM Ta Li DEV Ta Li GEOM::rotation_rate Ta
445 The rotation rate of the disk has changed.
446 .It Li GEOM Ta Li DEV Ta Li MEDIACHANGE Ta
447 Physical media has changed.
448 .It Li GEOM Ta Li DEV Ta Li SIZECHANGE Ta
451 provider size has changed.
454 .Bl -column "System" "Subsystem" "1234567" -compact
455 .Sy "System" Ta Sy "Subsystem" Ta Sy "Type" Ta Sy "Description"
457 .It Li IFNET Ta Em inet Ta Ta
460 is the actual name of the network interface on which the event
462 .It Li IFNET Ta Em inet Ta Li LINK_UP Ta
463 Carrier status changed to UP.
464 .It Li IFNET Ta Em inet Ta Li LINK_DOWN Ta
465 Carrier status changed to DOWN.
466 .It Li IFNET Ta Em inet Ta Li ATTACH Ta
467 The network interface is attached to the system.
468 .It Li IFNET Ta Em inet Ta Li DETACH Ta
469 The network interface is detached from the system.
470 .It Li IFNET Ta Em inet Ta Li RENAME Ta
471 The network interface is renamed.
472 .It Li IFNET Ta Em inet Ta Li ADDR_ADD Ta
473 The network interface address added.
474 .It Li IFNET Ta Em inet Ta Li ADDR_DEL Ta
475 The network interface address removed.
478 .Bl -column "System" "Subsystem" "1234567" -compact
479 .Sy "System" Ta Sy "Subsystem" Ta Sy "Type" Ta Sy "Description"
480 .It Li kern Ta Li power Ta Li resume Ta
481 Notification that the system has woken from the suspended state.
482 Note: this notification is deprecated and will be removed in
486 .Bl -column "System" "Subsystem" "1234567" -compact
487 .Sy "System" Ta Sy "Subsystem" Ta Sy "Type" Ta Sy "Description"
488 .It Li kernel Ta Li signal Ta Li coredump Ta
489 Notification that a process has crashed and dumped core.
490 .It Li kernel Ta Li power Ta Li resume Ta
491 Notification that the system has woken from the suspended state.
494 .Bl -column "System" "Subsystem" "1234567" -compact
495 .Sy "System" Ta Sy "Subsystem" Ta Sy "Type" Ta Sy "Description"
497 Notification of events from various types of Power Management Units.
498 .It Li PMU Ta Li "AC" Ta Ta
499 Notifications of AC power related events.
500 .It Li PMU Ta Li "AC" Ta Li overvoltage Ta
501 An over-voltage condition was detected on the AC power line.
502 .It Li PMU Ta Li "AC" Ta Li plugged Ta
503 Power has been applied to the AC power line.
504 .It Li PMU Ta Li "AC" Ta Li unplugged Ta
505 Power has been removed from the AC power line.
506 .It Li PMU Ta Li Battery Ta Ta
507 .It Li PMU Ta Li Battery Ta absent Ta
508 Battery is no longer absent.
509 .It Li PMU Ta Li Battery Ta charged Ta
510 The battery has become charged.
511 .It Li PMU Ta Li Battery Ta charging Ta
512 The battery has started charging.
513 .It Li PMU Ta Li Battery Ta disconnected Ta
514 The battery has been disconnected.
515 .It Li PMU Ta Li Battery Ta high-temp Ta
516 The battery reported a temperature over the limit.
517 .It Li PMU Ta Li Battery Ta low-temp Ta
518 The battery reported a temperature under the limit.
519 .It Li PMU Ta Li Battery Ta plugged Ta
520 The battery has become plugged (eg connected).
521 .It Li PMU Ta Li Battery Ta shutdown-threshold Ta
522 The power in the battery has fallen below the shutdown threshold.
523 .It Li PMU Ta Li Battery Ta warning-threshold Ta
524 The power in the battery has fallen below the warn the user threshold.
525 .It Li PMU Ta Li Button Ta pressed Ta
531 .It Li PMU Ta Li keys Ta Ta
532 One of the keys on the
534 keyboard has been pressed.
535 .It Li PMU Ta Li keys Ta brightness Ta
536 A brightness level change has been requested.
537 Direction is in the $notify variable.
538 .It Li PMU Ta Li keys Ta mute Ta
540 .It Li PMU Ta Li keys Ta volume Ta
541 A volume level change has been requested.
542 Direction is in the $notify variable.
543 .It Li PMU Ta Li keys Ta eject Ta
544 An ejection has been requested.
545 .It Li PMU Ta Li lid Ta close Ta
548 device has detected the lid closing.
549 .It Li PMU Ta Li lid Ta open Ta
552 device has detected the lid openinging.
553 .It Li PMU Ta Li POWER Ta ACLINE Ta
556 device has deteted an AC line state ($notify=0x00 is offline, 0x01 is online).
557 .It Li PMU Ta Li USB Ta overvoltage Ta
558 An over-voltage condition on the power lines for the USB power pins.
559 .It Li PMU Ta Li USB Ta plugged Ta
560 A device has been plugged into a USB device.
561 .It Li PMU Ta Li USB Ta undervoltage Ta
562 An under-voltage condition on the power lines for the USB power pins.
563 .It Li PMU Ta Li USB Ta unplugged Ta
564 A device has been unplugged into a USB device.
567 .Bl -column "System" "Subsystem" "1234567" -compact
568 .Sy "System" Ta Sy "Subsystem" Ta Sy "Type" Ta Sy "Description"
570 Events related to the
573 .It Li RCTL Ta Li rule Ta Li matched Ta
574 A rule with action specified as "devctl" was triggered.
577 .Bl -column "System" "Subsystem" "1234567" -compact
578 .Sy "System" Ta Sy "Subsystem" Ta Sy "Type" Ta Sy "Description"
580 Events related to the USB subsystem.
581 .It Li USB Ta Li DEVICE Ta Li ATTACH Ta
582 USB device is attached to the system.
583 .It Li USB Ta Li DEVICE Ta Li DETACH Ta
584 USB device is detached to the system.
585 .It Li USB Ta Li INTERFACE Ta Li ATTACH Ta
586 USB interface is attached to a device.
587 .It Li USB Ta Li INTERFACE Ta Li DETACH Ta
588 USB interface is detached from a device.
591 .Bl -column "System" "Subsystem" "1234567" -compact
592 .Sy "System" Ta Sy "Subsystem" Ta Sy "Type" Ta Sy "Description"
594 Events from the vfs system.
595 .It Li VFS Ta Li FS Ta Ta
596 Events that change what is mounted to the system.
597 .It Li VFS Ta Li FS Ta Li MOUNT Ta
598 Notification of a filesystem is mounted for the first time.
599 .It Li VFS Ta Li FS Ta Li REMOUNT Ta
600 Notification of a filesystem is remounted (whether or not the options actually change).
601 .It Li VFS Ta Li FS Ta Li UNMOUNT Ta
602 Notification of a filesystem being unmounted.
605 .Bl -column "System" "Subsystem" "1234567" -compact
606 .Sy "System" Ta Sy "Subsystem" Ta Sy "Type" Ta Sy "Description"
607 .It Li VT Ta BELL Ta RING Ta
608 Notification that the console bell has rung.
614 .Bl -column "System" "Subsystem" "1234567" -compact
615 .Sy "System" Ta Sy "Subsystem" Ta Sy "Type" Ta Sy "Description"
616 .It Li ZFS Ta ZFS Ta Ta
617 Events about the ZFS subsystem.
621 .Pa /etc/devd/zfs.conf
628 A link state change to UP on the interface
630 would result in the following notify event:
631 .Bd -literal -offset indent
632 system=IFNET subsystem=fxp0 type=LINK_UP
635 An AC line state change to
637 would result in the following event:
638 .Bd -literal -offset indent
639 system=ACPI subsystem=ACAD notify=0x00
642 Comments may appear anywhere that whitespace may appear in a
644 To appeal to programmers of all kinds, they can
645 be written in C, C++, or shell/Perl constructs.
647 C-style comments start with the two characters
649 (slash, star) and end with
652 Because they are completely delimited with these characters,
653 they can be used to comment only a portion of a line or to span
656 C-style comments cannot be nested.
657 For example, the following is
658 not valid because the entire comment ends with the first
660 .Bd -literal -offset indent
661 /* This is the start of a comment.
662 This is still part of the comment.
663 /* This is an incorrect attempt at nesting a comment. */
664 This is no longer in any comment. */
667 C++-style comments start with the two characters
669 (slash, slash) and continue to the end of the physical line.
670 They cannot be continued across multiple physical lines; to have
671 one logical comment span multiple lines, each line must use the
675 .Bd -literal -offset indent
676 // This is the start of a comment. The next line
677 // is a new comment, even though it is logically
678 // part of the previous comment.
680 .Ss Notes on Variable Expansion
681 To prevent issues with special shell characters, the following happens for each
696 variable is inserted into the buffer with all single quote characters
697 prefixed by a backslash.
702 for what this construct means.
703 It is safe in all context, except one: inside single quotes.
704 If foo=meta and bar=var, then a rule like the following:
705 .Bd -literal -offset indent -compact
706 action "echo '$foo $bar'";
708 will be presented to the shell via
711 .Bd -literal -offset indent -compact
712 echo '$'meta' $'var''
714 which produces the following output:
715 .Bd -literal -offset indent -compact
719 This is an unanticipated result.
720 A future version of this software will change this behavior.
721 Users are discouraged from using single quotes inside
723 value without due care.
725 The above should be written as
726 .Bd -literal -offset indent -compact
727 action "echo $foo' '$bar"
729 to produce a single argument to echo.
730 Given the above expansion, juxtaposing bare variables with
731 single quote expressions will produce the right output,
732 regardless of the value of the variable.
734 .Bl -tag -width ".Pa /etc/devd.conf" -compact
735 .It Pa /etc/devd.conf
743 # This will catch link down events on the interfaces fxp0 and ath0
746 match "system" "IFNET";
747 match "subsystem" "(fxp0|ath0)";
748 match "type" "LINK_DOWN";
749 action "logger $subsystem is DOWN";
753 # Match lid open/close events
754 # These can be combined to a single event, by passing the
755 # value of $notify to the external script.
758 match "system" "ACPI";
759 match "subsystem" "Lid";
760 match "notify" "0x00";
761 action "logger Lid closed, we can sleep now!";
765 match "system" "ACPI";
766 match "subsystem" "Lid";
767 match "notify" "0x01";
768 action "logger Lid opened, the sleeper must awaken!";
772 # Match a USB device type
775 match "system" "USB";
776 match "subsystem" "INTERFACE";
777 match "type" "ATTACH";
778 match "intclass" "0x0e";
779 action "logger USB video device attached";
783 # Try to configure ath and iwn devices with pccard_ether
784 # as they are attached.
787 device-name "(ath|iwn)[0-9]+";
788 action "/etc/pccard_ether $device-name start";
792 # Stop ath and iwn devices as they are detached from
796 device-name "(ath|iwn)[0-9]+";
797 action "/etc/pccard_ether $device-name stop";
803 has many additional examples.
811 The variable expansion's interaction with single quotes is
812 suboptimal and surprising.