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