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: src/usr.sbin/apm/apm.8,v 1.16.2.7 2003/05/07 17:42:02 tobez Exp $
  13 .\"
  14 .Dd November 1, 1994
  15 .Dt APM 8
  16 .Os
  17 .Sh NAME
  18 .Nm apm ,
  19 .Nm 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, 1 and 2 correspond to the
  53 .Dq off-line
  54 state,
  55 .Dq on-line
  56 state or
  57 .Dq backup power
  58 state, respectively.
  59 .It Fl b
  60 Display an integer value reflecting the current battery status.
  61 The values 0, 1, 2, 3, correspond to the
  62 .Dq high
  63 status,
  64 .Dq low
  65 status,
  66 .Dq critical
  67 status,
  68 .Dq charging
  69 status respectively.
  70 .It Fl d Ar enable
  71 Disable/enable suspending of the display separately from a normal suspend
  72 using the boolean value for
  73 .Ar enable .
  74 This feature seems to not work on many different laptops,
  75 including the Libretto 30CT and 50CT.
  76 .It Fl e Ar enable
  77 Enable or disable APM functions of the computer,
  78 depending on the boolean
  79 .Ar enable
  80 argument.
  81 .It Fl h Ar enable
  82 Depending on the boolean value of
  83 .Ar enable ,
  84 enable or disable the HLT instruction in the kernel context switch routine.
  85 These options are not necessary for almost all APM implementations,
  86 but for some implementations whose
  87 .Dq Pa Idle CPU
  88 call executes both CPU clock slowdown and HLT instruction,
  89 .Fl h Ar false
  90 is necessary to prevent the system from reducing its peak performance.
  91 See
  92 .Xr apm 4
  93 for details.
  94 .It Fl l
  95 Display the remaining battery percentage.  If your laptop does not
  96 support this function, 255 is displayed.
  97 .It Fl r Ar delta
  98 Enable the resume wakeup timer, if the laptop supports it.  This
  99 doesn't actually suspend the laptop, but if the laptop is suspended,
 100 and it supports resume from suspend, then it will be resumed after
 101 .Ar delta
 102 seconds (from when you run this command, not from when you suspend).
 103 .It Fl s
 104 Display the status of the APM support as an integer value.  The values
 105 0 and 1 correspond to the
 106 .Dq disabled
 107 state or
 108 .Dq enabled
 109 state respectively.
 110 .It Fl t
 111 Display the estimated remaining battery lifetime in seconds.  If
 112 it is unknown, -1 is displayed.
 113 .It Fl Z
 114 Transition the system into standby mode.  This mode uses less power than
 115 full power mode, but more than suspend mode.  Some laptops support
 116 resuming from this state on timer or Ring Indicator events.  The
 117 output of
 118 .Nm
 119 tells what your laptop claims to support.
 120 .It Fl z
 121 Suspend the system.
 122 It is equivalent to
 123 .Nm zzz .
 124 .El
 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 .Sh AUTHORS
 135 .An Tatsumi Hosokawa Aq Mt hosokawa@jp.FreeBSD.org
 136 .Sh BUGS
 137 Some APM implementations do not support parameters needed by
 138 .Nm .
 139 On such systems,
 140 .Nm
 141 displays them as unknown.
 142 .Pp
 143 Some APM implementations cannot handle events such as pushing the
 144 power button or closing the cover.  On such implementations, the system
 145 .Ar must
 146 be suspended
 147 .Ar only
 148 by using
 149 .Nm
 150 or
 151 .Nm zzz .