xref: /freebsd/usr.sbin/acpi/acpiconf/acpiconf.8 (revision ba3c1f5972d7b90feb6e6da47905ff2757e0fe57)
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 June 16, 2023
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 and current status of the battery specified
53by its number, starting with
54.Cm 0 .
55.It Fl k Ar ack
56Ack or abort a pending suspend request using the argument provided.
57.Sy Most users should not use this option directly.
58.It Fl s Ar type
59Enters the specified sleep mode.
60Recognized types are
61.Cm 1
62(only the CPU clock is stopped),
63.Cm 2
64(not implemented on most systems but similar to S1),
65.Cm 3
66(the CPU context is lost and memory context is preserved),
67and
68.Cm 4
69(the CPU context is lost and memory context is stored to disk).
70Sleep states may also be given as S1, S2, etc.
71The supported states depend on BIOS implementation, including ACPI
72byte code (AML).
73If the
74.Pa /etc/rc.suspend
75and
76.Pa /etc/rc.resume
77scripts are executable, they will be run by
78.Xr devd 8
79or
80.Xr apmd 8
81before and after entering the given sleep state.
82.Pp
83The
84.Pa /etc/rc.suspend
85and
86.Pa /etc/rc.resume
87scripts use the
88.Xr rcorder 8
89utility to call scripts in
90.Pa /etc/rc.d/
91and the
92.Va $local_startup
93directories that have a "suspend" or "resume" KEYWORD, respectively.
94Called scripts are supplied with a single "suspend" / "resume"
95command line argument.
96See
97.Xr rc.conf 5
98for more information about
99.Va $local_startup .
100.El
101.Sh SEE ALSO
102.Xr acpi 4 ,
103.Xr rc.conf 5 ,
104.Xr acpidump 8 ,
105.Xr apm 8 ,
106.Xr apmd 8 ,
107.Xr devd 8 ,
108.Xr rcorder 8
109.Sh HISTORY
110The
111.Nm
112utility appeared in
113.Fx 5.0 .
114.Sh AUTHORS
115.An -nosplit
116The
117.Nm
118utility was written by
119.An Mitsuru Iwasaki Aq Mt iwasaki@FreeBSD.org .
120This manual page was written by
121.An Dag-Erling Sm\(/orgrav Aq Mt des@FreeBSD.org .
122