docs: OpenBSD Man Pages Added

1 files changed, 221 insertions, 0 deletions

diff --git a/static/openbsd/man4/man4.i386/apm.4 b/static/openbsd/man4/man4.i386/apm.4
new file mode 100644
index 00000000..84775dec
--- /dev/null
+++ b/static/openbsd/man4/man4.i386/apm.4
@@ -0,0 +1,221 @@
+.\"	$OpenBSD: apm.4,v 1.36 2023/01/30 14:43:29 jcs Exp $
+.\"
+.\"	Copyright (c) 1998 Marco S. Hyman
+.\"
+.\"	Permission to copy all or part of this material for any purpose is
+.\"	granted provided that the above copyright notice and this paragraph
+.\"	are duplicated in all copies.  THIS SOFTWARE IS PROVIDED ``AS IS''
+.\"	AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, WITHOUT
+.\"	LIMITATION, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
+.\"	FOR A PARTICULAR PURPOSE.
+.\"
+.Dd $Mdocdate: January 30 2023 $
+.Dt APM 4 i386
+.Os
+.Sh NAME
+.Nm apm
+.Nd advanced power management device interface
+.Sh SYNOPSIS
+.Cd "apm0 at bios0 flags 0x0000"
+.Sh DESCRIPTION
+The
+.Nm
+driver provides an interface to the Advanced Power Management
+.Pq APM
+BIOS functions.
+The driver supports versions 1.0, 1.1, and 1.2 interface specifications.
+.Pp
+This driver also provides an interface to
+.Xr acpi 4
+on some machines.
+.Pp
+The low two bytes of the flags specify the version of the specification
+driver should conform to in binary decimal notation.
+The value of 0x0101 would specify version 1.1 of the interface
+specification to be used.
+.Pp
+The value of 0x10000 specifies whether to leave interrupts enabled
+when calling APM BIOS routines.
+This is needed for some
+.Tn IBM
+laptops, the symptoms are
+hangs and freezes on suspend, stand by, and hibernation activities.
+.Pp
+The value of 0x20000 specifies to swap the bytes of the battery
+life estimation (the DX register) as given from the APM BIOS.
+This is needed for some
+.Tn SONY VAIO
+laptops, such as some 505 models.
+.Pp
+Configuration options:
+.Pp
+.Bl -tag -width DIAGNOSTIC -compact -offset indent
+.It Dv APMDEBUG
+Enable various driver status messages.
+.It Dv DIAGNOSTIC
+Enable debugging messages.
+.It Dv DEBUG
+Enable other debugging messages.
+.El
+.Pp
+The
+.Nm
+driver implements the following
+.Xr ioctl 2
+calls.
+They are defined in
+.In machine/apmvar.h .
+.Bl -tag -width Ds
+.It Dv APM_IOC_REJECT
+.Em Not implemented . DO NOT USE .
+.It Dv APM_IOC_STANDBY
+.Pq Li "no parameters"
+Request
+.Dq standby
+mode.
+.It Dv APM_IOC_SUSPEND
+.Pq Li "no parameters"
+Request
+.Dq suspend
+mode.
+.It Dv APM_IOC_HIBERNATE
+.Pq Li "no parameters"
+Request
+.Dq hibernate
+mode.
+.It Dv APM_IOC_GETPOWER
+.Pq Li "struct apm_power_info"
+Request the current power state.
+The argument structure is as follows:
+.Bd -literal -offset indent
+struct apm_power_info {
+	u_char battery_state;
+	u_char ac_state;
+	u_char battery_life;
+	u_char spare1;
+	u_int minutes_left;
+	u_int spare2[6];
+};
+.Ed
+.Pp
+The following values are defined for
+.Va battery_state :
+.Bl -tag -width Ds
+.It Dv APM_BATT_HIGH
+Battery has a high state of charge.
+.It Dv APM_BATT_LOW
+Battery has a low state of charge.
+.It Dv APM_BATT_CRITICAL
+Battery has a critical state of charge.
+.It Dv APM_BATT_CHARGING
+Battery is not high, low, or critical and is currently charging.
+.It Dv APM_BATT_UNKNOWN
+Cannot read the current battery state.
+.It Dv APM_BATTERY_ABSENT
+No battery installed.
+.El
+.Pp
+The following values are defined for
+.Va ac_state :
+.Bl -tag -width Ds
+.It Dv APM_AC_OFF
+External power not detected.
+.It Dv APM_AC_ON
+External power detected.
+.It Dv APM_AC_BACKUP
+Backup power in use.
+.It Dv APM_AC_UNKNOWN
+External power state unknown.
+.El
+.Pp
+The
+.Va battery_life
+value contains the estimated percentage of battery life available.
+100% indicates a full charge.
+.Pp
+The
+.Va minutes_left
+value contains the estimated number of minutes of battery life
+remaining.
+.It Dv APM_IOC_DEV_CTL
+.Pq Li "struct apm_ctl"
+Allows an application to directly set the
+APM operating mode.
+The argument structure is as follows:
+.Bd -literal -offset indent
+struct apm_ctl {
+	u_int dev;
+	u_int mode;
+};
+.Ed
+.Pp
+.Va dev
+indicates the device, typically
+.Dv APM_DEV_ALLDEVS .
+.Pp
+.Va mode
+indicates the desired operating mode.
+Possible values are
+.Bl -tag -width Ds -compact -offset indent
+.It Dv APM_SYS_READY
+.It Dv APM_SYS_STANDBY
+.It Dv APM_SYS_SUSPEND
+.It Dv APM_SYS_OFF
+.It Dv APM_LASTREQ_INPROG
+.It Dv APM_LASTREQ_REJECTED
+.El
+.It Dv APM_IOC_PRN_CTL
+.Pq Li "int"
+This
+.Xr ioctl 2
+controls message output by the APM
+driver when a power change event is detected.
+The integer parameter is one of:
+.Bl -tag -width Ds
+.It Dv APM_PRINT_ON
+All power change events result in a message.
+This is the normal operating mode for the driver.
+.It Dv APM_PRINT_OFF
+Power change event messages are suppressed.
+.It Dv APM_PRINT_PCT
+Power change event messages are suppressed unless the estimated
+battery life percentage changes.
+.El
+.El
+.Sh FILES
+.Bl -tag -width "/dev/apmctlXXX"
+.It /dev/apm
+Power management data device.
+May only be opened read-only.
+May be opened by multiple concurrent users.
+.It /dev/apmctl
+Power management control device.
+May be opened read-write or write-only.
+May only be opened by one user at a time.
+An attempt to open the file when in use will fail, returning
+.Er EBUSY .
+.El
+.Sh SEE ALSO
+.Xr acpi 4 ,
+.Xr intro 4 ,
+.Xr apm 8 ,
+.Xr apmd 8 ,
+.Xr halt 8
+.Sh HISTORY
+The
+.Nm
+driver source code contains these copyrights:
+.Pp
+.Bl -item -compact
+.It
+.Li Copyright (c) 1995 John T. Kohl.  All rights reserved.
+.It
+.Li Copyright (C) 1994 by HOSOKAWA Tatsumi <hosokawa@mt.cs.keio.ac.jp>
+.El
+.Pp
+\&...and has been hacked on by many others since.
+.Sh BUGS
+Not all the BIOSes support power down the way we are attempting
+to execute it.
+.Pp
+Not all BIOS vendors even read the specification.