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