xref: /freebsd/usr.sbin/acpi/acpiconf/acpiconf.8 (revision 4b9d605768acabc460aa6dcfe8a1f8db35b16794)
1.\"-
2.\" Copyright (c) 2000 Dag-Erling 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.Dd June 16, 2023
29.Dt ACPICONF 8
30.Os
31.Sh NAME
32.Nm acpiconf
33.Nd control ACPI power management
34.Sh SYNOPSIS
35.Nm
36.Op Fl h
37.Op Fl i Ar batt
38.Op Fl k Ar ack
39.Op Fl s Ar type
40.Sh DESCRIPTION
41The
42.Nm
43utility allows the user control of the ACPI power management
44functions.
45The following command-line options are recognized:
46.Bl -tag -width ".Fl s Ar type"
47.It Fl h
48Displays a summary of available options.
49.It Fl i Ar batt
50Get design information and current status of the battery specified
51by its number, starting with
52.Cm 0 .
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 by
76.Xr devd 8
77or
78.Xr apmd 8
79before and after entering the given sleep state.
80.Pp
81The
82.Pa /etc/rc.suspend
83and
84.Pa /etc/rc.resume
85scripts use the
86.Xr rcorder 8
87utility to call scripts in
88.Pa /etc/rc.d/
89and the
90.Va $local_startup
91directories that have a "suspend" or "resume" KEYWORD, respectively.
92Called scripts are supplied with a single "suspend" / "resume"
93command line argument.
94See
95.Xr rc.conf 5
96for more information about
97.Va $local_startup .
98.El
99.Sh SEE ALSO
100.Xr acpi 4 ,
101.Xr rc.conf 5 ,
102.Xr acpidump 8 ,
103.Xr apm 8 ,
104.Xr apmd 8 ,
105.Xr devd 8 ,
106.Xr rcorder 8
107.Sh HISTORY
108The
109.Nm
110utility appeared in
111.Fx 5.0 .
112.Sh AUTHORS
113.An -nosplit
114The
115.Nm
116utility was written by
117.An Mitsuru Iwasaki Aq Mt iwasaki@FreeBSD.org .
118This manual page was written by
119.An Dag-Erling Sm\(/orgrav Aq Mt des@FreeBSD.org .
120