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