  The KAPM Handbook
  Ryan Cumming, bodnar42@bodnar42.dhs.org
  v0.2.1, 02 August 1999

  This document describes KAPM 0.2.x
  ______________________________________________________________________

  Table of Contents


  1. Introduction

     1.1 Features

  2. Installation

     2.1 How to obtain KAPM
     2.2 Requirements
     2.3 Installation

  3. The Dock Icon

     3.1 Reading The Status
     3.2 Using The Mouse

  4. The Popup Menu

     4.1 Standby
     4.2 Suspend
     4.3 Power Off
     4.4 APM Status
     4.5 Options
     4.6 Help
     4.7 About KAPM
     4.8 Quit

  5. The Options Dialog

     5.1 General Tab
     5.2 Notification Tab


  ______________________________________________________________________

  11..  IInnttrroodduuccttiioonn

  KAPM is a docking KDE utility that allows you to monitor your laptop's
  battery status and perform other APM (advanced power management)
  tasks.


  11..11..  FFeeaattuurreess


  +o  PPaanneell DDoocckkiinngg KAPM displays a small bar on your panel depicting the
     status of your battery

  +o  SSttaattuuss NNoottiiffiiccaattiioonn KAPM can optionally tell you when your battery
     is done charging or running low

  +o  PPoowweerr MMaannaaggmmeenntt KAPM can suspend, standby, or power off your
     computer




  22..  IInnssttaallllaattiioonn

  22..11..  HHooww ttoo oobbttaaiinn KKAAPPMM

  The latest version of KAPM can be downloaded from
  ftp://ftp.bodnar42.dhs.org/pub/kapm


  22..22..  RReeqquuiirreemmeennttss


  +o  A recent Linux 2.x kernel with APM support compiled in

  +o  KDE libraries, with KWM and KPanel running

  +o  APM BIOS version 1.1+, with 32-bit support


  22..33..  IInnssttaallllaattiioonn

  In order to compile and install KAPM on your system, type the
  following in the base directory of the KAPM distribution:


       % ./configure
       % make
       % make install




  Since KAPM uses autoconf you should have not trouble compiling it.
  Should you run into problems please report them to the author.


  33..  TThhee DDoocckk IIccoonn

  33..11..  RReeaaddiinngg TThhee SSttaattuuss

  On the KDE panel, KAPM displays a small colored bar. This bar
  represents the charge left in your computer's battery. If the icon is
  a question mark, your system currently does not have a battery. If the
  bar is animated, going from empty to full and then repeating, your
  battery is charging.

  33..22..  UUssiinngg TThhee MMoouussee


  Holding your cursor over the icon will display a tool-tip with basic
  APM status information. Right clicking on the icon will display a
  popup menu (this popup menu is described in the "Popup Menu" section
  of this document). A left click will immediately update the status
  icon and tool-tip. A middle click will display a detailed APM status
  window (this is normally available through "APM Status..." in the
  popup menu).

  44..  TThhee PPooppuupp MMeennuu

  44..11..  SSttaannddbbyy

  This puts your computer in to standby mode. When your computer is in
  standby mode it uses very little power, but it stops functioning.
  Input such as pressing a key will "wake up" your computer, making it
  usable again.


  44..22..  SSuussppeenndd

  This puts your computer in to suspend mode. This mode is simular to
  standby, and in some cases the same thing.

  44..33..  PPoowweerr OOffff

  "Power Off" shuts down Linux and powers off your computer.

  44..44..  AAPPMM SSttaattuuss

  This brings up a small window containing information about your BIOS,
  the kernel driver, and the current APM status.

  44..55..  OOppttiioonnss

  This will show the options dialog. This dialog allows you to change
  KAPM's settings. See the "The Options Dialog" section in this
  documentation.

  44..66..  HHeellpp

  Selecting this will bring up the online help you are reading now.

  44..77..  AAbboouutt KKAAPPMM

  This shows the about box, which contains the version of KAPM and
  credits.

  44..88..  QQuuiitt

  This exits KAPM. Quitting will not interfere with power management.


  55..  TThhee OOppttiioonnss DDiiaalloogg

  55..11..  GGeenneerraall TTaabb

  II aamm rruunnnniinngg aappmmdd If you are running apmd, check this box. This
  prevents KAPM from duplicating tasks apmd usually performs before a
  suspend or standby. This makes putting your computer in to suspend or
  standby mode faster. If you are unsure, leave this box unchecked.

  SSeeccoonnddss bbeettwweeeenn iiccoonn uuppddaatteess Use this to adjust how frequently KAPM
  updates its dock icon and tooltip. If you have status notification
  enabled, KAPM also checks to see if it should popup a notification.
  The default value should be fine.


  55..22..  NNoottiiffiiccaattiioonn TTaabb

  WWaarrnn mmee wwhheenn mmyy bbaatttteerryy iiss llooww If you check this box, KAPM will warn
  you when your battery charge drops below a certain percentage. This
  percentage is specified in the spinbox below.

  PPeerrcceennttaaggee aatt wwhhiicchh ttoo wwaarrnn mmee See above

  NNoottiiffyy mmee wwhheenn mmyy bbaatttteerryy iiss ffuullll If you check this box, KAPM will
  notify you when your battery charge is above a certain percentage.
  This percentage is specified in the spinbox below.

  PPeerrcceennttaaggee aatt wwhhiicchh ttoo nnoottiiffyy mmee See above




