1.\" 2.\" Copyright (c) 2002 M. Warner Losh 3.\" All rights reserved. 4.\" 5.\" Redistribution and use in source and binary forms, with or without 6.\" modification, are permitted provided that the following conditions 7.\" are met: 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. 12.\" 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 23.\" SUCH DAMAGE. 24.\" 25.\" $FreeBSD$ 26.\" 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 30.\" 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. 34.\" 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 42.\" SOFTWARE. 43.\" 44.Dd October 25, 2006 45.Dt DEVD.CONF 5 46.Os 47.Sh NAME 48.Nm devd.conf 49.Nd configuration file for 50.Xr devd 8 51.Sh DESCRIPTION 52.Ss General Syntax 53A 54.Xr devd 8 55configuration consists of two general features, statements 56and comments. 57All statements end with a semicolon. 58Many statements can contain substatements, which are also 59terminated with a semicolon. 60.Pp 61The following statements are supported: 62.Bl -tag -width ".Ic options" 63.It Ic attach 64Specifies various matching criteria and actions to perform when 65a newly attached device matches said criteria. 66.It Ic detach 67Specifies various matching criteria and actions to perform when 68a newly detached device matches said criteria. 69.It Ic nomatch 70Specifies various matching criteria and actions to perform when 71no device driver currently loaded in the kernel claims a (new) 72device. 73.It Ic notify 74Specifies various matching criteria and actions to perform when the kernel 75sends an event notification to userland. 76.It Ic options 77Specifies various options and parameters for the operation of 78.Xr devd 8 . 79.El 80.Pp 81Statements may occur in any order in the configuration file, and may be 82repeated as often as required. 83Further details on the syntax and meaning of each statement and their 84substatements are explained below. 85.Pp 86Each statement, except 87.Ic options 88has a priority (an arbitrary number) associated with it, where 89.Ql 0 90is defined as the lowest priority. 91If two statements match the same event, only the action of the statement with 92highest priority will be executed. 93In this way generic statements can be overridden for devices or 94notifications that require special attention. 95.Pp 96The general syntax of a statement is: 97.Pp 98.Bd -literal -offset indent 99statement priority { 100 substatement "value"; 101 ... 102 substatement "value"; 103}; 104.Ed 105.Ss Sub-statements 106The following sub-statements are supported within the 107.Ic options 108statement. 109.Bl -tag -width ".Ic directory" 110.It Ic directory Qq Ar /some/path ; 111Adds the given directory to the list of directories from which 112.Xr devd 8 113will read 114configuration files. 115Any number of 116.Ic directory 117statements can be used. 118.It Ic pid-file Qq Pa /var/run/devd.pid ; 119Specifies PID file. 120.It Ic set Ar regexp-name Qq Ar (some|regexp) ; 121Creates a regular expression and assigns it to the variable 122.Ar regexp-name . 123The variable is avaiable throughout the rest of 124the configuration file. 125All regular expressions have an implicit 126.Ql ^$ 127around them. 128.El 129.Pp 130The following sub-statements are supported within the 131.Ic attach 132and 133.Ic detach 134statements. 135.Bl -tag -width ".Ic directory" 136.It Ic action Qq Ar command ; 137Command to execute upon a successful match. 138Example 139.Dq Li "/etc/pccard_ether $device-name start" . 140.It Ic class Qq Ar string ; 141This is shorthand for 142.Dq Ic match Qo Li class Qc Qq Ar string . 143.It Ic device-name Qq string ; 144This is shorthand for 145.Dq Ic match Qo Li device-name Qc Qq Ar string . 146This matches a device named 147.Ar string , 148which is allowed to be a regular expression or a variable previously created 149containing a regular expression. 150The 151.Dq Li device-name 152variable 153is available for later use with the 154.Ic action 155statement. 156.It Ic match Qo Ar variable Qc Qq Ar value ; 157Matches the content of 158.Ar value 159against 160.Ar variable ; 161the content of 162.Ar value 163may be a regular expression. 164Not required during 165.Ic attach 166nor 167.Ic detach 168events since the 169.Ic device-name 170statement takes care of all device matching. 171For a partial list of variables, see below. 172.It Ic media-type Qq Ar string ; 173For network devices, 174.Ic media-type 175will match devices that have the given media type. 176Valid media types are: 177.Dq Li Ethernet , 178.Dq Li Tokenring , 179.Dq Li FDDI , 180.Dq Li 802.11 , 181.Dq Li ATM , 182and 183.Dq Li CARP . 184.It Ic subdevice Qq Ar string ; 185This is shorthand for 186.Dq Ic match Qo Li subdevice Qc Qq Ar string . 187.El 188.Pp 189The following sub-statements are supported within the 190.Ic nomatch 191statement. 192.Bl -tag -width ".Ic directory" 193.It Ic action Qq Ar command ; 194Same as above. 195.It Ic match Qo Ar variable Qc Qq Ar value ; 196Matches the content of 197.Ar value 198against 199.Ar variable ; 200the content of 201.Ar value 202may be a regular expression. 203For a partial list of variables, see below. 204.El 205.Pp 206The following sub-statements are supported within the 207.Ic notify 208statement. 209The 210.Dq Li notify 211variable is avaiable inside this statement and contains, a value, depending 212on which system and subsystem that delivered the event. 213.Bl -tag -width ".Ic directory" 214.It Ic action Qq Ar command ; 215Command to execute upon a successful match. 216Example 217.Dq Li "/etc/rc.d/power_profile $notify" . 218.It Ic match Qo Ar system | subsystem | type | notify Qc Qq Ar value ; 219Any number of 220.Ic match 221statements can exist within a 222.Ic notify 223statement; 224.Ar value 225can be either a fixed string or a regular expression. 226Below is a list of avaiable systems, subsystems, and types. 227.It Ic media-type Qq Ar string ; 228See above. 229.El 230.Ss Variables that can be used with the match statement 231A partial list of variables and their possible values that can be used together 232with the 233.Ic match 234statement. 235.Pp 236.Bl -tag -width ".Li manufacturer" -compact 237.It Ic Variable 238.Ic Description 239.It Li bus 240Device name of parent bus. 241.It Li cisproduct 242CIS-product. 243.It Li cisvendor 244CIS-vendor. 245.It Li class 246Device class. 247.It Li device 248Device ID. 249.It Li device-name 250Name of attached/detached device. 251.It Li function 252Card functions. 253.It Li manufacturer 254Manufacturer ID (pccard). 255.It Li notify 256Match the value of the 257.Dq Li notify 258variable. 259.It Li product 260Product ID (pccard). 261.It Li serial 262Serial Number (USB). 263.It Li slot 264Card slot. 265.It Li subvendor 266Sub-vendor ID. 267.It Li subdevice 268Sub-device ID. 269.It Li subsystem 270Matches a subsystem of a system, see below. 271.It Li system 272Matches a system type, see below. 273.It Li type 274Type of notification, see below. 275.It Li vendor 276Vendor ID. 277.El 278.Ss Notify matching 279A partial list of systems, subsystems, and types used within the 280.Ic notify 281mechanism. 282.Pp 283.Bl -tag -width ".Li IFNET" -compact 284.It Sy System 285.It Li ACPI 286Events related to the ACPI subsystem. 287.Bl -tag -width ".Sy Subsystem" -compact 288.It Sy Subsystem 289.It Li ACAD 290AC line state ($notify=0x00 is offline, 0x01 is online). 291.It Li Button 292Button state ($notify=0x00 is power, 0x01 is sleep). 293.It Li CMBAT 294Battery events. 295.It Li Lid 296Lid state ($notify=0x00 is closed, 0x01 is open). 297.It Li Thermal 298Thermal zone events. 299.El 300.Pp 301.It Li IFNET 302Events related to the network subsystem. 303.Bl -tag -width ".Sy Subsystem" -compact 304.It Sy Subsystem 305.It Ar interface 306The 307.Dq subsystem 308is the actual name of the network interface on which the event 309took place. 310.Bl -tag -width ".Li LINK_DOWN" -compact 311.It Sy Type 312.It Li LINK_UP 313Carrier status changed to UP. 314.It Li LINK_DOWN 315Carrier status changed to DOWN. 316.El 317.El 318.El 319.Pp 320A link state change to UP on the interface 321.Dq Li fxp0 322would result in the following notify event: 323.Bd -literal -offset indent 324system=IFNET, subsystem=fxp0, type=LINK_UP 325.Ed 326.Pp 327An AC line state change to 328.Dq offline 329would result in the following event: 330.Bd -literal -offset indent 331system=ACPI, subsystem=ACAD, notify=0x00 332.Ed 333.Ss Comments 334Comments may appear anywhere that whitespace may appear in a 335configuration file. 336To appeal to programmers of all kinds, they can 337be written in C, C++, or shell/Perl constructs. 338.Pp 339C-style comments start with the two characters 340.Ql /* 341(slash, star) and end with 342.Ql */ 343(star, slash). 344Because they are completely delimited with these characters, 345they can be used to comment only a portion of a line or to span 346multiple lines. 347.Pp 348C-style comments cannot be nested. 349For example, the following is 350not valid because the entire comment ends with the first 351.Ql */ : 352.Bd -literal -offset indent 353/* This is the start of a comment. 354 This is still part of the comment. 355/* This is an incorrect attempt at nesting a comment. */ 356 This is no longer in any comment. */ 357.Ed 358.Pp 359C++-style comments start with the two characters 360.Ql // 361(slash, slash) and continue to the end of the physical line. 362They cannot be continued across multiple physical lines; to have 363one logical comment span multiple lines, each line must use the 364.Ql // 365pair. 366For example: 367.Bd -literal -offset indent 368// This is the start of a comment. The next line 369// is a new comment, even though it is logically 370// part of the previous comment. 371.Ed 372.Sh FILES 373.Bl -tag -width ".Pa /etc/devd.conf" -compact 374.It Pa /etc/devd.conf 375The 376.Xr devd 8 377configuration file. 378.El 379.Sh EXAMPLES 380.Bd -literal 381# 382# This will catch link down events on the interfaces fxp0 and ath0 383# 384notify 0 { 385 match "system" "IFNET"; 386 match "subsystem" "(fxp0|ath0)"; 387 match "type" "LINK_DOWN"; 388 action "logger $subsystem is DOWN"; 389}; 390 391# 392# Match lid open/close events 393# These can be combined to a single event, by passing the 394# value of $notify to the external script. 395# 396notify 0 { 397 match "system" "ACPI"; 398 match "subsystem" "Lid"; 399 match "notify" "0x00"; 400 action "logger Lid closed, we can sleep now!"; 401}; 402 403notify 0 { 404 match "system" "ACPI"; 405 match "subsystem" "Lid"; 406 match "notify" "0x01"; 407 action "logger Lid opened, the sleeper must awaken!"; 408}; 409 410# 411# Try to configure ath and wi devices with pccard_ether 412# as they are attached. 413# 414attach 0 { 415 device-name "(ath|wi)[0-9]+"; 416 action "/etc/pccard_ether $device-name start"; 417}; 418 419# 420# Stop ath and wi devices as they are detached from 421# the system. 422# 423detach 0 { 424 device-name "(ath|wi)[0-9]+"; 425 action "/etc/pccard_ether $device-name stop"; 426}; 427.Ed 428.Pp 429The installed 430.Pa /etc/devd.conf 431has many additional examples. 432.Sh SEE ALSO 433.Xr devd 8 434