xref: /freebsd/usr.sbin/acpi/acpiconf/acpiconf.8 (revision 1c05a6ea6b849ff95e539c31adea887c644a6a01)
1.\"-
2.\" Copyright (c) 2000 Dag-Erling Coïdan Smørgrav
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.\"    in this position and unchanged.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice, this list of conditions and the following disclaimer in the
13.\"    documentation and/or other materials provided with the distribution.
14.\" 3. The name of the author may not be used to endorse or promote products
15.\"    derived from this software without specific prior written permission.
16.\"
17.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27.\"
28.\" $FreeBSD$
29.\"
30.Dd September 22, 2015
31.Dt ACPICONF 8
32.Os
33.Sh NAME
34.Nm acpiconf
35.Nd control ACPI power management
36.Sh SYNOPSIS
37.Nm
38.Op Fl h
39.Op Fl i Ar batt
40.Op Fl k Ar ack
41.Op Fl s Ar type
42.Sh DESCRIPTION
43The
44.Nm
45utility allows the user control of the ACPI power management
46functions.
47The following command-line options are recognized:
48.Bl -tag -width ".Fl s Ar type"
49.It Fl h
50Displays a summary of available options.
51.It Fl i Ar batt
52Get design information about the specified battery.
53.It Fl k Ar ack
54Ack or abort a pending suspend request using the argument provided.
55.Sy Most users should not use this option directly.
56.It Fl s Ar type
57Enters the specified sleep mode.
58Recognized types are
59.Cm 1
60(only the CPU clock is stopped),
61.Cm 2
62(not implemented on most systems but similar to S1),
63.Cm 3
64(the CPU context is lost and memory context is preserved),
65and
66.Cm 4
67(the CPU context is lost and memory context is stored to disk).
68Sleep states may also be given as S1, S2, etc.
69The supported states depend on BIOS implementation, including ACPI
70byte code (AML).
71If the
72.Pa /etc/rc.suspend
73and
74.Pa /etc/rc.resume
75scripts are executable, they will be run before and after entering
76the given sleep state.
77.El
78.Sh SEE ALSO
79.Xr acpi 4 ,
80.Xr acpidump 8 ,
81.Xr apm 8
82.Sh HISTORY
83The
84.Nm
85utility appeared in
86.Fx 5.0 .
87.Sh AUTHORS
88.An -nosplit
89The
90.Nm
91utility was written by
92.An Mitsuru Iwasaki Aq Mt iwasaki@FreeBSD.org .
93This manual page was written by
94.An Dag-Erling Sm\(/orgrav Aq Mt des@FreeBSD.org .
95