Skip to content

Commit

Permalink
Add to and improve documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
signetica committed Jun 22, 2022
1 parent 1a7358d commit ab309f1
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 8 deletions.
26 changes: 24 additions & 2 deletions acpi_hidd.4
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ Notifications are passed to userland via
and
.Xr devd.conf 5
for examples.
The
When an ACPI key is pressed, the
.Nm
driver sends events with the following attributes:
.Pp
Expand Down Expand Up @@ -122,14 +122,36 @@ An integer corresponding to the new value of
.Em hw.acpi.hidd.brightness .
.El
.Sh BUGS
.Nm
only manages the ACPI BIOS's primary monitor's brightness. Use
.Xr acpi_video 4
and the
.Xr evdev 4
or
.Xr devd 8
interfaces to manage other displays.
.Pp
The
.Xr acpi_video 4
driver assumes that nothing else changes the ACPI BIOS brightness, and uses a
cached value instead of asking the ACPI BIOS before reporting it through its
.Xr sysctl 8 .
To avoid confusion, when a system such as a window manager is managing the screen
brightness, set
\fIhw.acpi.hidd.brightness_keycontrol\fP=0,
and do not write directly to
.Em hw.acpi.hidd.brightness
to adjust the brightness.
.Pp
The collection of key codes is very small at this time, comprising only the two that are
present on the GPD MicroPC. This does not prevent use of the driver with
.Xr devd 8 ,
but contributions from users will make the
.Xr evdev 4
interface more useful.
Submit your computer's key/code pairs and its make and model as an issue at
https://github.com/signetica/acpi_hidd.
\fIhttps://github.com/signetica/acpi_hidd\fP.
More detailed instructions are in the repository.
.Pp
For example:
.Bd -literal -offset indent
Expand Down
12 changes: 6 additions & 6 deletions port/pkg-descr
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
The acpi_hidd kernel module provides driver services for ACPI HIDD
hardware, in particular brightness and media control keyboard support.

The driver has devd(8), evdev(4), and sysctl(8) interfaces; the sysctl(8) interface
allows inspection and control of the screen brightness, the evdev(4) interface
allows applications to directly receive keystrokes corresponding to ACPI events, and
the devd(8) interface provides a way to have userland programs run when ACPI
keys are pressed.
The driver has devd(8), evdev(4), and sysctl(8) interfaces; the sysctl(8)
interface allows inspection and control of the screen brightness, the evdev(4)
interface allows applications to directly receive keystrokes corresponding to
ACPI events, and the devd(8) interface provides a way to have userland
programs run when ACPI keys are pressed.

WWW: www.github.com/signetica/acpi_hidd
WWW: https://www.github.com/signetica/acpi_hidd

0 comments on commit ab309f1

Please sign in to comment.