xref: /openbsd-src/share/man/man4/acpidock.4 (revision e5cc2e7e920dbd55478717f702d4358e7c5f977d)
1.\"	$OpenBSD: acpidock.4,v 1.5 2013/07/16 16:05:48 schwarze Exp $
2.\"
3.\" Copyright (c) 2007 Michael Knudsen <mk@openbsd.org>
4.\"
5.\" Permission to use, copy, modify, and distribute this software for any
6.\" purpose with or without fee is hereby granted, provided that the above
7.\" copyright notice and this permission notice appear in all copies.
8.\"
9.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16.\"
17.\"
18.Dd $Mdocdate: July 16 2013 $
19.Dt ACPIDOCK 4
20.Os
21.Sh NAME
22.Nm acpidock
23.Nd ACPI docking station
24.Sh SYNOPSIS
25.Cd "acpidock* at acpi?"
26.Sh DESCRIPTION
27The
28.Nm
29driver supports ACPI docking stations.
30Docking stations are units that, for example, laptops may attach to in
31order to expose a number of additional hardware devices.
32The
33.Nm
34driver handles docking and undocking machines to gracefully detach
35external devices.
36.Pp
37When docking and undocking, an event is passed to the driver which is
38then reacted upon.
39For undocking, this event is usually triggered by pressing a button on
40the docking station or using a special keyboard combination; for docking,
41the machine usually just has to be inserted.
42.Pp
43The
44.Nm
45driver sets up a sensor that indicates docking state that can be
46used with
47.Xr sensorsd 8
48to perform events when docking or undocking.
49.Sh SEE ALSO
50.Xr acpi 4 ,
51.Xr intro 4 ,
52.Xr sensorsd 8
53.Sh HISTORY
54The
55.Nm
56driver first appeared in
57.Ox 4.1 .
58.Sh AUTHORS
59.An -nosplit
60The
61.Nm
62driver was written by
63.An Michael Knudsen Aq Mt mk@openbsd.org .
64