usr.sbin/apm/apm.8

   1 .\"     $NetBSD: apm.8,v 1.18 2008/04/30 13:11:01 martin Exp $
   2 .\"
   3 .\" Copyright (c) 1996 The NetBSD Foundation, Inc.
   4 .\" All rights reserved.
   5 .\"
   6 .\" This code is derived from software contributed to The NetBSD Foundation
   7 .\" by John Kohl.
   8 .\"
   9 .\" Redistribution and use in source and binary forms, with or without
  10 .\" modification, are permitted provided that the following conditions
  11 .\" are met:
  12 .\" 1. Redistributions of source code must retain the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer.
  14 .\" 2. Redistributions in binary form must reproduce the above copyright
  15 .\"    notice, this list of conditions and the following disclaimer in the
  16 .\"    documentation and/or other materials provided with the distribution.
  17 .\"
  18 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  19 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  20 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  21 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  22 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  23 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  24 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  25 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  26 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  27 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  28 .\" POSSIBILITY OF SUCH DAMAGE.
  29 .\"
  30 .Dd June 18, 1996
  31 .Dt APM 8
  32 .Os
  33 .Sh NAME
  34 .Nm apm ,
  35 .Nm zzz
  36 .Nd Advanced Power Management control program
  37 .Sh SYNOPSIS
  38 .Nm
  39 .Op Fl abdlmsSvz
  40 .Bk -words
  41 .Op Fl f Ar sockname
  42 .Ek
  43 .Nm zzz
  44 .Op Fl Sz
  45 .Bk -words
  46 .Op Fl f Ar sockname
  47 .Ek
  48 .Sh DESCRIPTION
  49 .Nm
  50 communicates with the Advanced Power Management daemon,
  51 .Xr apmd 8 ,
  52 making requests of it for current power status or to place the system
  53 into a suspend or stand-by state.
  54 The
  55 .Nm
  56 tool is only installed on supported platforms.
  57 .Pp
  58 With no flags,
  59 .Nm
  60 displays the current power management state in verbose form.
  61 .Pp
  62 Available command-line flags are:
  63 .Bl -tag -width indent -compact
  64 .It Fl z
  65 Put the system into suspend (deep sleep) mode.
  66 .It Fl S
  67 Put the system into stand-by (light sleep) mode.
  68 .It Fl l
  69 Display the estimated battery lifetime in percent.
  70 .It Fl m
  71 Display the estimated battery lifetime in minutes.
  72 .It Fl b
  73 Display the battery status.  0 means high, 1 means low, 2 means
  74 critical, 3 means charging, 4 means absent, and 255 means unknown.
  75 .It Fl a
  76 Display the external charger (A/C status).  0 means disconnected, 1
  77 means connected, 2 means backup power source, and 255 means unknown.
  78 .It Fl s
  79 Display if power management is enabled.
  80 .It Fl v
  81 Request more verbose description of the displayed states.
  82 .It Fl f Ar sockname
  83 Set the name of the socket via which to contact
  84 .Xr apmd 8
  85 to
  86 .Pa sockname .
  87 .It Fl d
  88 Do not communicate with the APM daemon; attempt instead to manipulate
  89 the APM control device directly.
  90 .El
  91 .Pp
  92 The
  93 .Nm zzz
  94 variant of this command is an alternative for suspending the system.
  95 With no arguments,
  96 .Nm zzz
  97 places the system into suspend mode.
  98 The command line flags serve the same purpose as for the
  99 .Nm
 100 variant of this command.
 101 .Pp
 102 This command does not wait for positive confirmation that the requested
 103 mode has been entered; to do so would mean the command does not return
 104 until the system resumes from its sleep state.
 105 .Sh FILES
 106 .Pa /var/run/apmdev
 107 is the default UNIX-domain socket used for communication with
 108 .Xr apmd 8 .
 109 The
 110 .Fl f
 111 flag may be used to specify an alternate socket name.
 112 The protection modes on this socket govern which users may access the
 113 APM functions.
 114 .Pp
 115 .Pa /dev/apmctl
 116 is the control device which is used when the
 117 .Fl d
 118 flag is specified; it must be writable for the
 119 .Fl d
 120 flag to work successfully.
 121 .Pa /dev/apm
 122 is the status device used when the socket is not accessible; it must be
 123 readable to provide current APM status.
 124 .Sh SEE ALSO
 125 .Xr apm 4 ,
 126 .Xr apmd 8
 127 .Sh REFERENCES
 128 Advanced Power Management (APM) BIOS Interface Specification (revision
 129 1.1), Intel Corporation and Microsoft Corporation
 130 .Sh HISTORY
 131 The
 132 .Nm
 133 command appeared in
 134 .Nx 1.3 .