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