Some mdoc fixes in various places.
[dragonfly.git] / etc / devd.conf
blobadbcfc797e024ed042c0a0b0db678f9246eb280c
1 # $FreeBSD: src/etc/devd.conf,v 1.42 2008/06/27 12:04:36 rpaulo Exp $
2 # $DragonFly: src/etc/devd.conf,v 1.1 2008/10/03 00:26:20 hasso Exp $
4 # Refer to devd.conf(5) and devd(8) man pages for the details on how to
5 # run and configure devd.
8 # NB: All regular expressions have an implicit ^$ around them.
9 # NB: device-name is shorthand for 'match device-name'
11 options {
12         # Each directory directive adds a directory the list of directories
13         # that we scan for files.  Files are read-in in the order that they
14         # are returned from readdir(3).  The rule-sets are combined to
15         # create a DFA that's used to match events to actions.
16         directory "/etc/devd";
17         directory "/usr/local/etc/devd";
19         # Setup some shorthand for regex that we use later in the file.
20         #XXX Yes, these are gross -- imp
21         set scsi-controller-regex
22                 "(aac|adv|adw|aha|ahb|ahc|ahd|aic|amd|amr|asr|bt|ciss|ct|dpt|\
23                 esp|ida|iir|ips|isp|mlx|mly|mpt|ncr|ncv|nsp|stg|sym|trm|wds)\
24                 [0-9]+";
27 # Note that the attach/detach with the highest value wins, so that one can
28 # override these general rules.
31 # Configure the interface on attach.  Due to a historical accident, this
32 # script is called pccard_ether.
34 # notify 0 {
35 #       match "system"          "IFNET";
36 #       match "type"            "ATTACH";
37 #       action "/etc/pccard_ether $subsystem start";
38 # };
40 # notify 0 {
41 #       match "system"          "IFNET";
42 #       match "type"            "DETACH";
43 #       action "/etc/pccard_ether $subsystem stop";
44 # };
47 # Try to start dhclient on Ethernet like interfaces when the link comes
48 # up.  Only devices that are configured to support DHCP will actually
49 # run it.  No link down rule exists because dhclient automaticly exits
50 # when the link goes down.
52 # notify 0 {
53 #       match "system"          "IFNET";
54 #       match "type"            "LINK_UP";
55 #       media-type              "ethernet";
56 #       action "/etc/rc.d/dhclient start $subsystem";
57 # };
60 # Like Ethernet devices, but separate because
61 # they have a different media type.  We may want
62 # to exploit this later.
64 # detach 0 {
65 #       media-type "802.11";
66 #       action "/etc/pccard_ether $device-name stop";
67 # };
68 # attach 0 {
69 #       media-type "802.11";
70 #       action "/etc/pccard_ether $device-name start";
71 # };
72 # notify 0 {
73 #       match "system"          "IFNET";
74 #       match "type"            "LINK_UP";
75 #       media-type              "802.11";
76 #       action "/etc/rc.d/dhclient start $subsystem";
77 # };
80 # An entry like this might be in a different file, but is included here
81 # as an example of how to override things.  Normally 'ed50' would match
82 # the above attach/detach stuff, but the value of 100 makes it
83 # hard wired to 1.2.3.4.
84 # attach 100 {
85 #       device-name "ed50";
86 #       action "ifconfig $device-name inet 1.2.3.4 netmask 0xffff0000";
87 # };
88 # detach 100 {
89 #       device-name "ed50";
90 # };
93 # When a USB Bluetooth dongle appears activate it.
94 # XXX FIX for DragonFly XXX
95 # attach 100 {
96 #       device-name "ubt[0-9]+";
97 #       action "/etc/rc.d/bluetooth start $device-name";
98 # };
99 # detach 100 {
100 #       device-name "ubt[0-9]+";
101 #       action "/etc/rc.d/bluetooth stop $device-name";
102 # };
105 # When a USB keyboard arrives, attach it as the console keyboard.
106 # XXX Fix for DragonFly XXX
107 # attach 100 {
108 #       device-name "ukbd0";
109 #       action "/etc/rc.d/syscons setkeyboard /dev/ukbd0";
110 # };
111 # detach 100 {
112 #       device-name "ukbd0";
113 #       action "/etc/rc.d/syscons setkeyboard /dev/kbd0";
114 # };
116 # attach 100 {
117 #       device-name "ums[0-9]+";
118 #       action "/etc/rc.d/moused start $device-name";
119 # };
121 # detach 100 { 
122 #       device-name "ums[0-9]+"; 
123 #       action "/etc/rc.d/moused stop $device-name"; 
124 # }; 
127 # Rescan scsi device-names on attach, but not detach.  However, it is
128 # disabled by default due to reports of problems.
130 # attach 0 {
131 #       device-name "$scsi-controller-regex";
132 #       action "camcontrol rescan all";
133 # };
135 # Don't even try to second guess what to do about drivers that don't
136 # match here.  Instead, pass it off to syslog.  Commented out for the
137 # moment, as the pnpinfo variable isn't set in devd yet.  Individual
138 # variables within the bus supplied pnpinfo are set.
139 # nomatch 0 {
140 #       action "logger Unknown device: $pnpinfo $location $bus";
144 # Various logging of unknown devices.
145 # nomatch 10 {
146 #       match "bus" "uhub[0-9]+";
147 #       action "logger Unknown USB device: vendor $vendor product $product \
148 #               bus $bus";
149 # };
152 # Some PC-CARDs don't offer numerical manufacturer/product IDs, just
153 # show the CIS info there.
154 # nomatch 20 {
155 #       match "bus" "pccard[0-9]+";
156 #       match "manufacturer" "0xffffffff";
157 #       match "product" "0xffffffff";
158 #       action "logger Unknown PCCARD device: CISproduct $cisproduct \
159 #               CIS-vendor $cisvendor bus $bus";
160 # };
162 # nomatch 10 {
163 #       match "bus" "pccard[0-9]+";
164 #       action "logger Unknown PCCARD device: manufacturer $manufacturer \
165 #               product $product CISproduct $cisproduct CIS-vendor \
166 #               $cisvendor bus $bus";
167 # };
169 # nomatch 10 {
170 #       match "bus" "cardbus[0-9]+";
171 #       action "logger Unknown Cardbus device: device $device class $class \
172 #               vendor $vendor bus $bus";
173 # };
176 # Switch power profiles when the AC line state changes.
177 # notify 10 {
178 #       match "system"          "ACPI";
179 #       match "subsystem"       "ACAD";
180 #       action "/etc/rc.d/power_profile $notify";
181 # };
184 # Notify all users before beginning emergency shutdown when we get
185 # a _CRT or _HOT thermal event and we're going to power down the system
186 # very soon.
187 # notify 10 {
188 #       match "system"          "ACPI";
189 #       match "subsystem"       "Thermal";
190 #       match "notify"          "0xcc";
191 #       action "logger -p kern.emerg \
192 #               'WARNING: system temperature too high, shutting down soon!'";
196 # User requested suspend, so perform preparation steps and then execute
197 # the actual suspend process.
198 # notify 10 {
199 #       match "system"          "ACPI";
200 #       match "subsystem"       "Suspend";
201 #       action "/etc/rc.suspend acpi $notify";
202 # };
203 # notify 10 {
204 #       match "system"          "ACPI";
205 #       match "subsystem"       "Resume";
206 #       action "/etc/rc.resume acpi $notify";
207 # };
210 # The next blocks enable volume hotkeys that can be found on the Asus EeePC
211 # XXX ASUS-Eee subsystem isn't available in DragonFly
212 # notify 0 {
213 #       match "system"          "ACPI";
214 #       match "subsystem"       "ASUS-Eee";
215 #       match "notify"          "0x13";
216 #       action                  "mixer 0";
217 # };
219 # notify 0 {
220 #       match "system"          "ACPI";
221 #       match "subsystem"       "ASUS-Eee";
222 #       match "notify"          "0x14";
223 #       action                  "mixer vol -10";
224 # };
226 # notify 0 {
227 #       match "system"          "ACPI";
228 #       match "subsystem"       "ASUS-Eee";
229 #       match "notify"          "0x15";
230 #       action                  "mixer vol +10";
231 # };
234 # The following might be an example of something that a vendor might
235 # install if you were to add their device.  This might reside in
236 # /usr/local/etc/devd/deqna.conf.  A deqna is, in this hypothetical
237 # example, a pccard ethernet-like device.  Students of history may
238 # know other devices by this name, and will get the in-jokes in this
239 # entry.
240 # nomatch 10 {
241 #       match "bus" "pccard[0-9]+";
242 #       match "manufacturer" "0x1234";
243 #       match "product" "0x2323";
244 #       action "kldload if_deqna";
245 # };
246 # attach 10 {
247 #       device-name "deqna[0-9]+";
248 #       action "/etc/pccard_ether $device-name start";
249 # };
250 # detach 10 {
251 #       device-name "deqna[0-9]+";
252 #       action "/etc/pccard_ether $device-name stop";
253 # };
256 # Examples of notify hooks.  A notify is a generic way for a kernel
257 # subsystem to send event notification to userland.
259 # Here are some examples of ACPI notify handlers.  ACPI subsystems that
260 # generate notifies include the AC adapter, power/sleep buttons,
261 # control method batteries, lid switch, and thermal zones.
263 # Information returned is not always the same as the ACPI notify
264 # events.  See the ACPI specification for more information about
265 # notifies.  Here is the information returned for each subsystem:
267 # ACAD:         AC line state (0 is offline, 1 is online)
268 # Button:       Button pressed (0 for power, 1 for sleep)
269 # CMBAT:        ACPI battery events
270 # Lid:          Lid state (0 is closed, 1 is open)
271 # Suspend, Resume: Suspend and resume notification
272 # Thermal:      ACPI thermal zone events
274 # This example calls a script when the AC state changes, passing the
275 # notify value as the first argument.  If the state is 0x00, it might
276 # call some sysctls to implement economy mode.  If 0x01, it might set
277 # the mode to performance.
278 # notify 10 {
279 #       match "system"          "ACPI";
280 #       match "subsystem"       "ACAD";
281 #       action                  "/etc/acpi_ac $notify";
282 # };