usr.sbin/apm/apm.8

   1 .\" LP (Laptop Package)
   2 .\"
   3 .\" Copyright (c) 1994 by Tatsumi Hosokawa <hosokawa@jp.FreeBSD.org>
   4 .\"
   5 .\" This software may be used, modified, copied, and distributed, in
   6 .\" both source and binary form provided that the above copyright and
   7 .\" these terms are retained. Under no circumstances is the author
   8 .\" responsible for the proper functioning of this software, nor does
   9 .\" the author assume any responsibility for damages incurred with its
  10 .\"
  11 .\" $FreeBSD: src/usr.sbin/apm/apm.8,v 1.16.2.7 2003/05/07 17:42:02 tobez Exp $
  12 .\"
  13 .\" use.
  14 .Dd November 1, 1994
  15 .Dt APM 8
  16 .Os
  17 .Sh NAME
  18 .Nm apm , zzz
  19 .Nd control the APM BIOS and display its information
  20 .Sh SYNOPSIS
  21 .Nm
  22 .Op Fl ablstzZ
  23 .Op Fl d Ar enable
  24 .Op Fl e Ar enable
  25 .Op Fl h Ar enable
  26 .Op Fl r Ar delta
  27 .Pp
  28 .Nm zzz
  29 .Sh DESCRIPTION
  30 The
  31 .Nm
  32 utility
  33 controls the Intel / Microsoft APM (Advanced Power Management) BIOS and
  34 displays the current status of APM on laptop PCs.
  35 The
  36 .Nm zzz
  37 utility suspends the system by controlling APM.
  38 .Pp
  39 The following options are available for
  40 .Nm
  41 (no options are available for
  42 .Nm zzz ) .
  43 If no options are specified,
  44 .Nm
  45 displays information and current status of APM in verbose mode.
  46 If multiple display options are given, the values are displayed one
  47 per line in the order given here.
  48 .Bl -tag -width indent
  49 .It Fl a
  50 Display the current AC-line status as an integer value.  The values
  51 0 and 1 correspond to the
  52 .Dq off-line
  53 state or
  54 .Dq on-line
  55 state, respectively.
  56 .It Fl b
  57 Display an integer value reflecting the current battery status.
  58 The values 0, 1, 2, 3, correspond to the
  59 .Dq high
  60 status,
  61 .Dq low
  62 status,
  63 .Dq critical
  64 status,
  65 .Dq charging
  66 status respectively.
  67 .It Fl d Ar enable
  68 Disable/enable suspending of the display separately from a normal suspend
  69 using the boolean value for
  70 .Ar enable .
  71 This feature seems to not work on many different laptops,
  72 including the Libretto 30CT and 50CT.
  73 .It Fl e Ar enable
  74 Enable or disable APM functions of the computer,
  75 depending on the boolean
  76 .Ar enable
  77 argument.
  78 .It Fl h Ar enable
  79 Depending on the boolean value of
  80 .Ar enable ,
  81 enable or disable the HLT instruction in the kernel context switch routine.
  82 These options are not necessary for almost all APM implementations,
  83 but for some implementations whose
  84 .Dq Pa Idle CPU
  85 call executes both CPU clock slowdown and HLT instruction,
  86 .Fl h Ar false
  87 is necessary to prevent the system from reducing its peak performance.
  88 See
  89 .Xr apm 4
  90 for details.
  91 .It Fl l
  92 Display the remaining battery percentage.  If your laptop does not
  93 support this function, 255 is displayed.
  94 .It Fl r Ar delta
  95 Enable the resume wakeup timer, if the laptop supports it.  This
  96 doesn't actually suspend the laptop, but if the laptop is suspended,
  97 and it supports resume from suspend, then it will be resumed after
  98 .Ar delta
  99 seconds (from when you run this command, not from when you suspend).
 100 .It Fl s
 101 Display the status of the APM support as an integer value.  The values
 102 0 and 1 correspond to the
 103 .Dq disabled
 104 state or
 105 .Dq enabled
 106 state respectively.
 107 .It Fl t
 108 Display the estimated remaining battery lifetime in seconds.  If
 109 it is unknown, -1 is displayed.
 110 .It Fl Z
 111 Transition the system into standby mode.  This mode uses less power than
 112 full power mode, but more than suspend mode.  Some laptops support
 113 resuming from this state on timer or Ring Indicator events.  The
 114 output of
 115 .Nm
 116 tells what your laptop claims to support.
 117 .It Fl z
 118 Suspend the system.
 119 It is equivalent to
 120 .Nm zzz .
 121 .El
 122 .Sh BUGS
 123 Some APM implementations do not support parameters needed by
 124 .Nm .
 125 On such systems,
 126 .Nm
 127 displays them as unknown.
 128 .Pp
 129 Some APM implementations cannot handle events such as pushing the
 130 power button or closing the cover.  On such implementations, the system
 131 .Ar must
 132 be suspended
 133 .Ar only
 134 by using
 135 .Nm
 136 or
 137 .Nm zzz .
 138 .Sh NOTES
 139 .Xr apmconf 8
 140 has been merged in
 141 .Nm
 142 and thus
 143 .Nm
 144 replaces all of its functionality.
 145 .Sh SEE ALSO
 146 .Xr apm 4
 147 .Sh AUTHORS
 148 .An Tatsumi Hosokawa Aq hosokawa@jp.FreeBSD.org