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$
  12 .\"
  13 .\" use.
  14 .Dd November 1, 1994
  15 .Dt APM 8 i386
  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.
  51 The values
  52 0, 1 and 2 correspond to the
  53 .Dq off-line
  54 state,
  55 .Dq on-line
  56 state or
  57 .Dq backup power
  58 state, respectively.
  59 .It Fl b
  60 Display an integer value reflecting the current battery status.
  61 The values 0, 1, 2, 3, correspond to the
  62 .Dq high
  63 status,
  64 .Dq low
  65 status,
  66 .Dq critical
  67 status,
  68 .Dq charging
  69 status respectively.
  70 .It Fl d Ar enable
  71 Disable/enable suspending of the display separately from a normal suspend
  72 using the boolean value for
  73 .Ar enable .
  74 This feature seems to not work on many different laptops,
  75 including the Libretto 30CT and 50CT.
  76 .It Fl e Ar enable
  77 Enable or disable APM functions of the computer,
  78 depending on the boolean
  79 .Ar enable
  80 argument.
  81 .It Fl h Ar enable
  82 Depending on the boolean value of
  83 .Ar enable ,
  84 enable or disable the HLT instruction in the kernel context switch routine.
  85 These options are not necessary for almost all APM implementations,
  86 but for some implementations whose
  87 .Dq Pa Idle CPU
  88 call executes both CPU clock slowdown and HLT instruction,
  89 .Fl h Cm false
  90 is necessary to prevent the system from reducing its peak performance.
  91 See
  92 .Xr apm 4
  93 for details.
  94 .It Fl l
  95 Display the remaining battery percentage.
  96 If your laptop does not
  97 support this function, 255 is displayed.
  98 .It Fl r Ar delta
  99 Enable the resume wakeup timer, if the laptop supports it.
 100 This
 101 does not actually suspend the laptop, but if the laptop is suspended,
 102 and it supports resume from suspend, then it will be resumed after
 103 .Ar delta
 104 seconds (from when you run this command, not from when you suspend).
 105 .It Fl s
 106 Display the status of the APM support as an integer value.
 107 The values
 108 0 and 1 correspond to the
 109 .Dq disabled
 110 state or
 111 .Dq enabled
 112 state respectively.
 113 .It Fl t
 114 Display the estimated remaining battery lifetime in seconds.
 115 If
 116 it is unknown, -1 is displayed.
 117 .It Fl Z
 118 Transition the system into standby mode.
 119 This mode uses less power than
 120 full power mode, but more than suspend mode.
 121 Some laptops support
 122 resuming from this state on timer or Ring Indicator events.
 123 The
 124 output of
 125 .Nm
 126 tells what your laptop claims to support.
 127 .It Fl z
 128 Suspend the system.
 129 It is equivalent to
 130 .Nm zzz .
 131 .El
 132 .Sh NOTES
 133 .Xr apmconf 8
 134 has been merged in
 135 .Nm
 136 and thus
 137 .Nm
 138 replaces all of its functionality.
 139 .Sh SEE ALSO
 140 .Xr apm 4
 141 .Sh AUTHORS
 142 .An Tatsumi Hosokawa Aq hosokawa@jp.FreeBSD.org
 143 .Sh BUGS
 144 Some APM implementations do not support parameters needed by
 145 .Nm .
 146 On such systems,
 147 .Nm
 148 displays them as unknown.
 149 .Pp
 150 Some APM implementations cannot handle events such as pushing the
 151 power button or closing the cover.
 152 On such implementations, the system
 153 .Ar must
 154 be suspended
 155 .Ar only
 156 by using
 157 .Nm
 158 or
 159 .Nm zzz .