DEVD.CONF(5)

FreeBSD File Formats Manual

DEVD.CONF(5)

NAME

devd.conf — configuration file for devd(8)

DESCRIPTION

General Syntax

A devd(8) configuration consists of two general features, statements and comments. All statements end with a semicolon. Many statements can contain substatements, which are also terminated with a semicolon.

The following statements are supported:

Statements may occur in any order in the configuration file, and may be repeated as often as required. Further details on the syntax and meaning of each statement and their substatements are explained below.

Each statement, except options has a priority (an arbitrary number) associated with it, where ‘ 0’ is defined as the lowest priority. If two statements match the same event, only the action of the statement with highest priority will be executed. In this way generic statements can be overridden for devices or notifications that require special attention.

The general syntax of a statement is:

statement priority { 
 substatement "value"; 
 ... 
 substatement "value"; 
};

Sub-statements

The following sub-statements are supported within the options statement.

The following sub-statements are supported within the attach and detach statements.

The following sub-statements are supported within the nomatch statement.

The following sub-statements are supported within the notify statement. The “ notify” variable is available inside this statement and contains, a value, depending on which system and subsystem that delivered the event.

Variables that can be used with the match statement

A partial list of variables and their possible values that can be used together with the match statement.

Notify matching

A partial list of systems, subsystems, and types used within the notify mechanism.

System

ACPI

Events related to the ACPI subsystem.

IFNET

Events related to the network subsystem.

DEVFS

Events related to the devfs(5) filesystem.

USB

Events related to the USB subsystem.

coretemp

Events related to the coretemp(4) device.

kern

Events related to the kernel.

A link state change to UP on the interface “ fxp0” would result in the following notify event:

system=IFNET, subsystem=fxp0, type=LINK_UP

An AC line state change to “offline” would result in the following event:

system=ACPI, subsystem=ACAD, notify=0x00

Comments

Comments may appear anywhere that whitespace may appear in a configuration file. To appeal to programmers of all kinds, they can be written in C, C++, or shell/Perl constructs.

C-style comments start with the two characters ‘ /*’ (slash, star) and end with ‘ */’ (star, slash). Because they are completely delimited with these characters, they can be used to comment only a portion of a line or to span multiple lines.

C-style comments cannot be nested. For example, the following is not valid because the entire comment ends with the first ‘ */’:

/* This is the start of a comment. 
   This is still part of the comment. 
/* This is an incorrect attempt at nesting a comment. */ 
   This is no longer in any comment. */

C++-style comments start with the two characters ‘ //’ (slash, slash) and continue to the end of the physical line. They cannot be continued across multiple physical lines; to have one logical comment span multiple lines, each line must use the ‘ //’ pair. For example:

// This is the start of a comment.  The next line 
// is a new comment, even though it is logically 
// part of the previous comment.

FILES

EXAMPLES

# 
# This will catch link down events on the interfaces fxp0 and ath0 
# 
notify 0 { 
 match "system"   "IFNET"; 
 match "subsystem"  "(fxp0|ath0)"; 
 match "type"   "LINK_DOWN"; 
 action "logger $subsystem is DOWN"; 
}; 
 
# 
# Match lid open/close events 
# These can be combined to a single event, by passing the 
# value of $notify to the external script. 
# 
notify 0 { 
 match "system"   "ACPI"; 
 match "subsystem"  "Lid"; 
 match "notify"   "0x00"; 
 action "logger Lid closed, we can sleep now!"; 
}; 
 
notify 0 { 
 match "system"   "ACPI"; 
 match "subsystem"  "Lid"; 
 match "notify"   "0x01"; 
 action "logger Lid opened, the sleeper must awaken!"; 
}; 
 
# 
# Match a USB device type 
# 
notify 0 { 
 match "system"   "USB"; 
 match "subsystem"  "INTERFACE"; 
 match "type"   "ATTACH"; 
 match "intclass"  "0x0e"; 
 action "logger USB video device attached"; 
}; 
 
# 
# Try to configure ath and wi devices with pccard_ether 
# as they are attached. 
# 
attach 0 { 
        device-name "(ath|wi)[0-9]+"; 
        action "/etc/pccard_ether $device-name start"; 
}; 
 
# 
# Stop ath and wi devices as they are detached from 
# the system. 
# 
detach 0 { 
        device-name "(ath|wi)[0-9]+"; 
        action "/etc/pccard_ether $device-name stop"; 
};

The installed /etc/devd.conf has many additional examples.

YOS OPENSONAR