xacpi.1

   1 .\" xacpi.1 --
   2 .\" Created: Thu Jan 11 16:29:49 1996 by r.faith@ieee.org
   3 .\" Revised: Sun Apr 21 16:37:42 1996 by r.faith@ieee.org
   4 .\" Revised: Sun Jun 13 01:59:58 2004 by francois@fleuret.org
   5 .\" Revised: Wed Oct 13 18:33:12 2004 by francois@fleuret.org
   6 .\" Revised: Wed Dec 03 08:52:14 2004 by francois@fleuret.org
   7 .\" Copyright 1996 Rickard E. Faith (r.faith@ieee.org)
   8 .\"
   9 .\" Permission is granted to make and distribute verbatim copies of this
  10 .\" manual provided the copyright notice and this permission notice are
  11 .\" preserved on all copies.
  12 .\"
  13 .\" Permission is granted to copy and distribute modified versions of this
  14 .\" manual under the conditions for verbatim copying, provided that the
  15 .\" entire resulting derived work is distributed under the terms of a
  16 .\" permission notice identical to this one
  17 .\"
  18 .\" Since the Linux kernel and libraries are constantly changing, this
  19 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  20 .\" responsibility for errors or omissions, or for damages resulting from
  21 .\" the use of the information contained herein.  The author(s) may not
  22 .\" have taken the same level of care in the production of this manual,
  23 .\" which is licensed free of charge, as they might when working
  24 .\" professionally.
  25 .\"
  26 .\" Formatted or processed versions of this manual, if unaccompanied by
  27 .\" the source, must acknowledge the copyright and authors of this work.
  28 .\"
  29 .TH XACPI 1 "June 2004" "" ""
  30 .SH NAME
  31 xacpi \- display Advanced Configuration and Power Interface (ACPI) BIOS information
  32 .SH SYNOPSIS
  33 .B xacpi [ ... ]
  34 .SH DESCRIPTION
  35 .B xacpi
  36 puts up an X window that displays, from left to right and optionally:
  37 the time and date, the AC state (L for line and B for battery), the
  38 battery charge (in percentage or remaining time for complete charge or
  39 discharge), a colored bar representing the same, the CPU temperature
  40 and the CPU frequency in Ghz. Clicking on the charge time will toggle
  41 the display between time and percentage, and clicking on the temperature
  42 will toggle between Celsius and Fahrenheit.
  43 .SH "OPTIONS AND RESOURCES"
  44 In addition to standard Xt options, the following options are available:
  45 .TP
  46 .B \-V
  47 Print the program version number and exit.
  48 .TP
  49 .B \-H
  50 Print a short help
  51 .TP
  52 .BI \-highcolor " color"
  53 The color of the bar when the battery percentage is above
  54 .IR highvalue .
  55 Defaults to "green". (*highColor)
  56 .TP
  57 .BI \-lowcolor " color"
  58 The color of the bar when the battery percentage is between
  59 .I lowvalue
  60 and
  61 .IR highvalue .
  62 Defaults to "yellow". (*lowColor)
  63 .TP
  64 .BI \-criticalcolor " color"
  65 The color of the bar when the battery percentage is below
  66 .IR lowvalue
  67 or the color of the temperature when higher then the critical temperature.
  68 Defaults to "red".
  69 This color is also used to flash the alphanumeric part of the display
  70 when the power status is critical. (*criticalColor)
  71 .TP
  72 .BI \-highvalue " highvalue"
  73 Set
  74 .IR highvalue .
  75 The default is 50. (*highValue)
  76 .TP
  77 .BI \-lowvalue " lowvalue"
  78 Set
  79 .IR lowvalue .
  80 The default is 10. (*lowValue)
  81 .TP
  82 .BI \-criticaltemperature " criticaltemperature"
  83 Set
  84 .IR criticaltemperature .
  85 If not set the default is 70C or 158F. (*criticalTemperature)
  86 .TP
  87 .BI \-chargingcolor " color"
  88 The color of the printed display when charging.
  89 The default is "blue".
  90 Use
  91 .B \-foreground
  92 to change the color used when on battery power. (*chargingColor)
  93 .TP
  94 .BI \-delay " delay"
  95 Sets the number of seconds delay between each update.
  96 The default is 1. (*delay)
  97 .TP
  98 .B \-percent
  99 Display percentage on startup, instead of time remaining. (*percent, boolean)
 100 .TP
 101 .B \-percentauto
 102 Swap automatically between displaying percentage and displaying the
 103 time remaining. When on AC power, display percentage, when on battery
 104 power, display the time remaining. (*percentAuto, boolean)
 105 .TP
 106 .B \-showbar
 107 Show the battery colored bar. (*showBar, boolean)
 108 .TP
 109 .B \-showdate
 110 Show the current time and date. (*showDate, boolean)
 111 .TP
 112 .B \-dateformat
 113 Specifies the format for the date (cf. strftime). Default is
 114 .I %a %b %e %H:%M:%S %Z %Y
 115  (*dateFormat).
 116 .TP
 117 .B \-showtemp
 118 Show the temperature (maximum among the sensors). (*showTemperature, boolean)
 119 .TP
 120 .B \-showcpufreq
 121 Show the CPU frequency (in Ghz). (*showCpufreq, boolean)
 122 .TP
 123 .B \-fahrenheit
 124 Display the temperature in Fahrenheit. (*fahrenheit, boolean)
 125 .TP
 126 .B \-acpidir
 127 Specifies the ACPI directory. Default is
 128 .I /proc/acpi
 129  (*acpiDir).
 130 .TP
 131 .B \-cpufreqdir
 132 Specifies the cpu frequency directory. Default is
 133 .I /sys/devices/system/cpu/cpu0/cpufreq
 134  (*cpuFreqDir).
 135 .SH BUGS
 136 When the battery percentage is low, using a bright color to warn you
 137 of impending doom may be futile because the bar is too short. Because
 138 of the form widget's desire to maintain proportions, dynamic resizing
 139 of the window may not do what you want it to do.
 140 .SH FILES
 141 .I /proc/acpi
 142 .SH AUTHOR
 143 This program is an extension of xapm, originally written by Rik Faith
 144 (faith@cs.unc.edu). The changes to xacpi were written by Francois
 145 Fleuret (francois@fleuret.org). Xacpi may be freely distributed
 146 under the terms of the GNU General Public License.  There is
 147 ABSOLUTELY NO WARRANTY for this program.
 148 .SH "SEE ALSO"
 149 .BR acpi (1),
 150 .BR acpid (8),
 151 .BR strftime (3).