usr.sbin/acpi/acpiconf/acpiconf.8

   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: src/usr.sbin/acpi/acpiconf/acpiconf.8,v 1.15.20.1 2009/04/15 03:14:26 kensmith Exp $
  29 .\"
  30 .Dd August 16, 2004
  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 s Ar type
  41 .Sh DESCRIPTION
  42 The
  43 .Nm
  44 utility allows the user control of the ACPI power management
  45 functions.
  46 The following command-line options are recognized:
  47 .Bl -tag -width ".Fl s Ar type"
  48 .It Fl h
  49 Displays a summary of available options.
  50 .It Fl i Ar batt
  51 Get design information about the specified battery.
  52 .It Fl s Ar type
  53 Enters the specified sleep mode.
  54 Recognized types are
  55 .Cm 1
  56 (only the CPU clock is stopped),
  57 .Cm 2
  58 (not implemented on most systems but similar to S1),
  59 .Cm 3
  60 (the CPU context is lost and memory context is preserved),
  61 .Cm 4
  62 (the CPU context is lost and memory context is stored to disk)
  63 and
  64 .Cm 5
  65 (soft off).
  66 Sleep states may also be given as S1, S2, etc.
  67 The supported states depend on BIOS implementation, including ACPI
  68 byte code (AML).
  69 If the
  70 .Pa /etc/rc.suspend
  71 and
  72 .Pa /etc/rc.resume
  73 scripts are executable, they will be run before and after entering
  74 the given sleep state.
  75 .El
  76 .Sh SEE ALSO
  77 .Xr acpi 4 ,
  78 .Xr acpidump 8 ,
  79 .Xr apm 8
  80 .Sh HISTORY
  81 The
  82 .Nm
  83 utility appeared in
  84 .Fx 5.0 .
  85 .Sh AUTHORS
  86 .An -nosplit
  87 The
  88 .Nm
  89 utility was written by
  90 .An Mitsuru Iwasaki Aq iwasaki@FreeBSD.org .
  91 This manual page was written by
  92 .An Dag-Erling Sm\(/orgrav Aq des@FreeBSD.org .