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 December 16, 2011 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.Bd -literal -offset indent 98statement priority { 99 substatement "value"; 100 ... 101 substatement "value"; 102}; 103.Ed 104.Ss Sub-statements 105The following sub-statements are supported within the 106.Ic options 107statement. 108.Bl -tag -width ".Ic directory" 109.It Ic directory Qq Ar /some/path ; 110Adds the given directory to the list of directories from which 111.Xr devd 8 112will read all files named "*.conf" as further 113configuration files. 114Any number of 115.Ic directory 116statements can be used. 117.It Ic pid-file Qq Pa /var/run/devd.pid ; 118Specifies PID file. 119.It Ic set Ar regexp-name Qq Ar (some|regexp) ; 120Creates a regular expression and assigns it to the variable 121.Ar regexp-name . 122The variable is available throughout the rest of 123the configuration file. 124If the string begins with 125.Ql \&! , 126it matches if the regular expression formed by the rest of the string 127does not match. 128All regular expressions have an implicit 129.Ql ^$ 130around them. 131.El 132.Pp 133The following sub-statements are supported within the 134.Ic attach 135and 136.Ic detach 137statements. 138.Bl -tag -width ".Ic directory" 139.It Ic action Qq Ar command ; 140Command to execute upon a successful match. 141Example 142.Dq Li "/etc/pccard_ether $device-name start" . 143.It Ic class Qq Ar string ; 144This is shorthand for 145.Dq Ic match Qo Li class Qc Qq Ar string . 146.It Ic device-name Qq string ; 147This is shorthand for 148.Dq Ic match Qo Li device-name Qc Qq Ar string . 149This matches a device named 150.Ar string , 151which is allowed to be a regular expression or a variable previously created 152containing a regular expression. 153The 154.Dq Li device-name 155variable 156is available for later use with the 157.Ic action 158statement. 159.It Ic match Qo Ar variable Qc Qq Ar value ; 160Matches the content of 161.Ar value 162against 163.Ar variable ; 164the content of 165.Ar value 166may be a regular expression. 167Not required during 168.Ic attach 169nor 170.Ic detach 171events since the 172.Ic device-name 173statement takes care of all device matching. 174For a partial list of variables, see below. 175.It Ic media-type Qq Ar string ; 176For network devices, 177.Ic media-type 178will match devices that have the given media type. 179Valid media types are: 180.Dq Li Ethernet , 181.Dq Li Tokenring , 182.Dq Li FDDI , 183.Dq Li 802.11 , 184.Dq Li ATM , 185and 186.Dq Li CARP . 187.It Ic subdevice Qq Ar string ; 188This is shorthand for 189.Dq Ic match Qo Li subdevice Qc Qq Ar string . 190.El 191.Pp 192The following sub-statements are supported within the 193.Ic nomatch 194statement. 195.Bl -tag -width ".Ic directory" 196.It Ic action Qq Ar command ; 197Same as above. 198.It Ic match Qo Ar variable Qc Qq Ar value ; 199Matches the content of 200.Ar value 201against 202.Ar variable ; 203the content of 204.Ar value 205may be a regular expression. 206For a partial list of variables, see below. 207.El 208.Pp 209The following sub-statements are supported within the 210.Ic notify 211statement. 212The 213.Dq Li notify 214variable is available inside this statement and contains, a value, depending 215on which system and subsystem that delivered the event. 216.Bl -tag -width ".Ic directory" 217.It Ic action Qq Ar command ; 218Command to execute upon a successful match. 219Example 220.Dq Li "/etc/rc.d/power_profile $notify" . 221.It Ic match Qo Ar system | subsystem | type | notify Qc Qq Ar value ; 222Any number of 223.Ic match 224statements can exist within a 225.Ic notify 226statement; 227.Ar value 228can be either a fixed string or a regular expression. 229Below is a list of available systems, subsystems, and types. 230.It Ic media-type Qq Ar string ; 231See above. 232.El 233.Ss Variables that can be used with the match statement 234A partial list of variables and their possible values that can be used together 235with the 236.Ic match 237statement. 238.Pp 239.Bl -tag -width ".Li manufacturer" -compact 240.It Ic Variable 241.Ic Description 242.It Li bus 243Device name of parent bus. 244.It Li cdev 245Device node path if one is created by the 246.Xr devfs 5 247filesystem. 248.It Li cisproduct 249CIS-product. 250.It Li cisvendor 251CIS-vendor. 252.It Li class 253Device class. 254.It Li device 255Device ID. 256.It Li devclass 257Device Class (USB) 258.It Li devsubclass 259Device Sub-class (USB) 260.It Li device-name 261Name of attached/detached device. 262.It Li endpoints 263Endpoint count (USB) 264.It Li function 265Card functions. 266.It Li interface 267Interface ID (USB) 268.It Li intclass 269Interface Class (USB) 270.It Li intprotocol 271Interface Protocol (USB) 272.It Li intsubclass 273Interface Sub-class (USB) 274.It Li manufacturer 275Manufacturer ID (pccard). 276.It Li mode 277Peripheral mode (USB) 278.It Li notify 279Match the value of the 280.Dq Li notify 281variable. 282.It Li parent 283Parent device 284.It Li port 285Hub port number (USB) 286.It Li product 287Product ID (pccard/USB). 288.It Li release 289Hardware revision (USB) 290.It Li sernum 291Serial Number (USB). 292.It Li slot 293Card slot. 294.It Li subvendor 295Sub-vendor ID. 296.It Li subdevice 297Sub-device ID. 298.It Li subsystem 299Matches a subsystem of a system, see below. 300.It Li system 301Matches a system type, see below. 302.It Li type 303Type of notification, see below. 304.It Li vendor 305Vendor ID. 306.El 307.Ss Notify matching 308A partial list of systems, subsystems, and types used within the 309.Ic notify 310mechanism. 311.Pp 312.Bl -tag -width ".Li coretemp" -compact 313.It Sy System 314.It Li ACPI 315Events related to the ACPI subsystem. 316.Bl -tag -width ".Sy Subsystem" -compact 317.It Sy Subsystem 318.It Li ACAD 319AC line state ($notify=0x00 is offline, 0x01 is online). 320.It Li Button 321Button state ($notify=0x00 is power, 0x01 is sleep). 322.It Li CMBAT 323Battery events. 324.It Li Lid 325Lid state ($notify=0x00 is closed, 0x01 is open). 326.It Li Thermal 327Thermal zone events. 328.El 329.Pp 330.It Li IFNET 331Events related to the network subsystem. 332.Bl -tag -width ".Sy Subsystem" -compact 333.It Sy Subsystem 334.It Ar interface 335The 336.Dq subsystem 337is the actual name of the network interface on which the event 338took place. 339.Bl -tag -width ".Li LINK_DOWN" -compact 340.It Sy Type 341.It Li LINK_UP 342Carrier status changed to UP. 343.It Li LINK_DOWN 344Carrier status changed to DOWN. 345.It Li ATTACH 346The network interface is attached to the system. 347.It Li DETACH 348The network interface is detached from the system. 349.El 350.El 351.It Li DEVFS 352Events related to the 353.Xr devfs 5 354filesystem. 355.Bl -tag -width ".Sy Subsystem" -compact 356.It Sy Subsystem 357.It Li CDEV 358.Bl -tag -width ".Li DESTROY" -compact 359.It Sy Type 360.It Li CREATE 361The 362.Xr devfs 5 363node is created. 364.It Li DESTROY 365The 366.Xr devfs 5 367node is destroyed. 368.El 369.El 370.It Li USB 371Events related to the USB subsystem. 372.Bl -tag -width ".Sy Subsystem" -compact 373.It Sy Subsystem 374.It Li DEVICE 375.Bl -tag -width ".Li DETACH" -compact 376.It Sy Type 377.It Li ATTACH 378USB device is attached to the system. 379.It Li DETACH 380USB device is detached from the system. 381.El 382.It Li INTERFACE 383.Bl -tag -width ".Li DETACH" -compact 384.It Sy Type 385.It Li ATTACH 386USB interface is attached to a device. 387.It Li DETACH 388USB interface is detached from a device. 389.El 390.El 391.It Li coretemp 392Events related to the 393.Xr coretemp 4 394device. 395.Bl -tag -width ".Sy Subsystem" -compact 396.It Sy Subsystem 397.It Li Thermal 398Notification that the CPU core has reached critical temperature. 399.Bl -tag -width ".Ar temperature" -compact 400.It Sy Type 401.It Ar temperature 402String containing the temperature of the core that has become too hot. 403.El 404.El 405.It Li kern 406Events related to the kernel. 407.Bl -tag -width ".Sy Subsystem" -compact 408.It Sy Subsystem 409.It Li power 410Information about the state of the system. 411.Bl -tag -width ".li resume" -compact 412.It Sy Type 413.It Li resume 414Notification that the system has woken from the suspended state. 415.El 416.El 417.El 418.Pp 419A link state change to UP on the interface 420.Dq Li fxp0 421would result in the following notify event: 422.Bd -literal -offset indent 423system=IFNET, subsystem=fxp0, type=LINK_UP 424.Ed 425.Pp 426An AC line state change to 427.Dq offline 428would result in the following event: 429.Bd -literal -offset indent 430system=ACPI, subsystem=ACAD, notify=0x00 431.Ed 432.Ss Comments 433Comments may appear anywhere that whitespace may appear in a 434configuration file. 435To appeal to programmers of all kinds, they can 436be written in C, C++, or shell/Perl constructs. 437.Pp 438C-style comments start with the two characters 439.Ql /* 440(slash, star) and end with 441.Ql */ 442(star, slash). 443Because they are completely delimited with these characters, 444they can be used to comment only a portion of a line or to span 445multiple lines. 446.Pp 447C-style comments cannot be nested. 448For example, the following is 449not valid because the entire comment ends with the first 450.Ql */ : 451.Bd -literal -offset indent 452/* This is the start of a comment. 453 This is still part of the comment. 454/* This is an incorrect attempt at nesting a comment. */ 455 This is no longer in any comment. */ 456.Ed 457.Pp 458C++-style comments start with the two characters 459.Ql // 460(slash, slash) and continue to the end of the physical line. 461They cannot be continued across multiple physical lines; to have 462one logical comment span multiple lines, each line must use the 463.Ql // 464pair. 465For example: 466.Bd -literal -offset indent 467// This is the start of a comment. The next line 468// is a new comment, even though it is logically 469// part of the previous comment. 470.Ed 471.Sh FILES 472.Bl -tag -width ".Pa /etc/devd.conf" -compact 473.It Pa /etc/devd.conf 474The 475.Xr devd 8 476configuration file. 477.El 478.Sh EXAMPLES 479.Bd -literal 480# 481# This will catch link down events on the interfaces fxp0 and ath0 482# 483notify 0 { 484 match "system" "IFNET"; 485 match "subsystem" "(fxp0|ath0)"; 486 match "type" "LINK_DOWN"; 487 action "logger $subsystem is DOWN"; 488}; 489 490# 491# Match lid open/close events 492# These can be combined to a single event, by passing the 493# value of $notify to the external script. 494# 495notify 0 { 496 match "system" "ACPI"; 497 match "subsystem" "Lid"; 498 match "notify" "0x00"; 499 action "logger Lid closed, we can sleep now!"; 500}; 501 502notify 0 { 503 match "system" "ACPI"; 504 match "subsystem" "Lid"; 505 match "notify" "0x01"; 506 action "logger Lid opened, the sleeper must awaken!"; 507}; 508 509# 510# Match a USB device type 511# 512notify 0 { 513 match "system" "USB"; 514 match "subsystem" "INTERFACE"; 515 match "type" "ATTACH"; 516 match "intclass" "0x0e"; 517 action "logger USB video device attached"; 518}; 519 520# 521# Try to configure ath and wi devices with pccard_ether 522# as they are attached. 523# 524attach 0 { 525 device-name "(ath|wi)[0-9]+"; 526 action "/etc/pccard_ether $device-name start"; 527}; 528 529# 530# Stop ath and wi devices as they are detached from 531# the system. 532# 533detach 0 { 534 device-name "(ath|wi)[0-9]+"; 535 action "/etc/pccard_ether $device-name stop"; 536}; 537.Ed 538.Pp 539The installed 540.Pa /etc/devd.conf 541has many additional examples. 542.Sh SEE ALSO 543.Xr coretemp 4 , 544.Xr devfs 5 , 545.Xr re_format 7 , 546.Xr devd 8 547