xref: /dragonfly/usr.sbin/acpi/acpiconf/acpiconf.8 (revision 0db87cb7)
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: head/usr.sbin/acpi/acpiconf/acpiconf.8 267668 2014-06-20 09:57:27Z bapt $
29.\"
30.Dd June 20, 2015
31.Dt ACPICONF 8
32.Os
33.Sh NAME
34.Nm acpiconf ,
35.Nm apm
36.Nd control ACPI power management
37.Sh SYNOPSIS
38.Nm
39.Op Fl h
40.Op Fl i Ar batt
41.Op Fl k Ar ack
42.Op Fl s Ar type
43.Pp
44.Nm apm
45.Sh DESCRIPTION
46The
47.Nm
48utility allows the user control of the ACPI power management
49functions.
50The following command-line options are recognized:
51.Bl -tag -width ".Fl s Ar type"
52.It Fl h
53Displays a summary of available options.
54.It Fl i Ar batt
55Get design information about the specified battery.
56A value of 0 means the first battery.
57.It Fl k Ar ack
58Ack or abort a pending suspend request using the argument provided.
59.Sy Most users should not use this option directly.
60.It Fl s Ar type
61Enters the specified sleep mode.
62Recognized types are
63.Cm 1
64(only the CPU clock is stopped),
65.Cm 2
66(not implemented on most systems but similar to S1),
67.Cm 3
68(the CPU context is lost and memory context is preserved),
69.Cm 4
70(the CPU context is lost and memory context is stored to disk)
71and
72.Cm 5
73(soft off).
74Sleep states may also be given as S1, S2, etc.
75The supported states depend on BIOS implementation, including ACPI
76byte code (AML).
77If the
78.Pa /etc/rc.suspend
79and
80.Pa /etc/rc.resume
81scripts are executable, they will be run before and after entering
82the given sleep state.
83.El
84.Pp
85.Nm apm
86is a shortcut for
87.Nm Fl i Ar 0 .
88.Sh SEE ALSO
89.Xr acpi 4 ,
90.Xr acpibin 8 ,
91.Xr acpicall 8 ,
92.Xr acpidump 8 ,
93.Xr acpiexec 8 ,
94.Xr acpihelp 8 ,
95.Xr acpinames 8 ,
96.Xr acpixtract 8 ,
97.Xr iasl 8
98.Sh HISTORY
99The
100.Nm
101utility appeared in
102.Fx 5.0 .
103.Sh AUTHORS
104.An -nosplit
105The
106.Nm
107utility was written by
108.An Mitsuru Iwasaki Aq Mt iwasaki@FreeBSD.org .
109This manual page was written by
110.An Dag-Erling Sm\(/orgrav Aq Mt des@FreeBSD.org .
111