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