From 312ba610a1e98fc656fb58178227d7d45a64494e Mon Sep 17 00:00:00 2001 From: Perberos Date: Mon, 14 Nov 2011 18:24:48 -0300 Subject: initial --- battstat/docs/C/battstat.xml | 508 +++++++++++++++++++++ .../docs/C/figures/battstat-applet-expanded.png | Bin 0 -> 9276 bytes battstat/docs/C/figures/battstat-applet.png | Bin 0 -> 8883 bytes battstat/docs/C/figures/battstat-credits-hal.png | Bin 0 -> 28320 bytes battstat/docs/C/figures/battstat-preferences.png | Bin 0 -> 32093 bytes battstat/docs/C/figures/context-menu.png | Bin 0 -> 8102 bytes battstat/docs/C/legal.xml | 76 +++ 7 files changed, 584 insertions(+) create mode 100644 battstat/docs/C/battstat.xml create mode 100644 battstat/docs/C/figures/battstat-applet-expanded.png create mode 100644 battstat/docs/C/figures/battstat-applet.png create mode 100644 battstat/docs/C/figures/battstat-credits-hal.png create mode 100644 battstat/docs/C/figures/battstat-preferences.png create mode 100644 battstat/docs/C/figures/context-menu.png create mode 100644 battstat/docs/C/legal.xml (limited to 'battstat/docs/C') diff --git a/battstat/docs/C/battstat.xml b/battstat/docs/C/battstat.xml new file mode 100644 index 00000000..04c5d03f --- /dev/null +++ b/battstat/docs/C/battstat.xml @@ -0,0 +1,508 @@ + + + + +]> + + + + +
+ + + + &applet; Manual + + &applet; shows the current charge of the + battery and provides notifications if charge drops below a certain + threshold. + + + 2005 + Davyd Madeley + + + 2004 + Angela Boyle + + + 2004 + Sun Microsystems + + + 2002 + Trevor Curtis + + + 1999 + 2000 + Jorgen Pehrson + + + + + MATE Documentation Project + + + &legal; + + + + + Sun + MATE Documentation Team + Sun Microsystems + + + Trevor + Curtis + + MATE Documentation Project +
tcurtis@somaradio.ca
+ + + + Jorgen + Pehrson + + MATE Documentation Project +
jp@spektr.eu.org
+ + + + Angela + Boyle + + MATE Documentation Project + + + + Davyd + Madeley + + MATE Project + + + + + + + + + + + Version 2.12 + September 2005 + + Davyd Madeley + + + + Version 2.10 + March 2005 + + Davyd Madeley + + + + Version 2.8 + September 2004 + + Angela Boyle + MATE Documentation Project + + + + Battery Charge Monitor Applet Manual V2.2 + August 2004 + + Sun MATE Documentation Team + MATE Documentation Project + + + + Battery Charge Monitor Applet Manual V2.0 + May 2002 + + Trevor Curtis + tcurtis@somaradio.ca + + Jorgen Pehrson + jp@spektr.eu.org + + MATE Documentation Project + + + + + This manual describes version &appletversion; of &applet;. + + + + Feedback + + To report a bug or make a suggestion regarding the &applet; applet or + this manual, follow the directions in the MATE Feedback Page. + + + + + + Battery Charge Monitor Applet + + + + Battstat Applet + + + + + + Introduction + +
+ &applet; Applet + + + + + + The &applet; applet. + + + +
+ + + The &applet; shows the + status of any batteries in your laptop computer. The monitor can tell you + the capacity remaining both visually and as a percentage, as well as offer + you an estimate of the time remaining based off the current usage rate. + + + + To Add &applet; to a Panel + To add &applet; to a panel, + right-click on the panel, then choose Add to + Panel. Select &applet; + in the Add to the panel dialog, then + click OK. + + The layout of the &applet; applet varies depending on the size and type of panel in which the applet resides. + + + + + Power Management Backends + + + The battery monitor supports a number of power management backends. If it + is available, the monitor will attempt to use the freedesktop.org + HAL (Hardware Abstraction + Layer). If it is unavailable or unsupported on your platform, the + battery monitor will attempt direct access to the power management system. + + + Not all power management backends are available from all vendors, and some + vendors add their own additional backends for specific platforms and + hardware. If the battery monitor is misreporting information from your + battery see . + + + + + Getting Help + + If the battery monitor doesn't work for you, + see these additional resources: + + + + ; + + + MATE mailing + lists + + + + + + + + + + Preferences + To bring up the preferences for the monitor, right-click on + the monitor in the panel and then choose + Preferences +
+ &applet; context (right-click) menu + + + + + + &applet; context menu + + + +
+
+ Preferences Dialog + + + + + + Preferences Dialog + + + +
+ + + Appearance + + + + Compact view + + This view shows only a single graphic in the panel, either an + upright battery to indicate remaining capacity or a plug to + indicate your laptop is connected to an external power source. +
+ Compact view + + + + + + Compact View + + + +
+ + + The compact view is the default view for the monitor as of MATE + 2.12. + + + + Expanded view + + The expanded view is old look from previous versions of MATE. It + has the larger graphic for the battery as well as a separate + graphic to indicate what state the battery is in. +
+ Expanded view + + + + + + Expanded View + + + +
+ + + + Show time/percentage + Selecting this option will display one of two + pieces of information. Show time remaining + will tell you how many hours and minutes until the battery is + fully discharged or recharged. Show percentage + remaining will tell you the percentage charge remaining + in the battery. + + + + + + Notifications + + + + Warn when battery charge drops to + + + Selecting this option will cause a warning dialog to be displayed + whenever your laptop + battery reaches specified value, either as a percentage remaining or + a number of minutes remaining. This indicates that the amount of + charge remaining in your battery is critically low. + charge. You can dismiss this warning dialog yourself, otherwise it + will vanish automatically when you plug your laptop into mains + power. + + + + + Notify when the battery is fully recharged + + + Selecting this option notifies when your battery is fully + recharged. If you have compiled the &applet; with libmatenotify + support a non-intrusive notification will popup from the monitor on + the panel. + + + + + + + + + + Troubleshooting + + + Due to the complexities of power management and the vast differences + between each of the different power management systems available, + debugging errors in the battery monitor can be difficult. You will need to + determine if the error exists in the battery monitor or is a bug in the + information provided by your machine. + + + The following information may be useful for troubleshooting what is wrong + with your battery monitor. It is by no means exhaustive. If you find a bug + with the &applet; (that is not caused by bad information being reported + by ACPI), please report it. + + + + Determining the backend + + If you are using the Hardware Abstraction Layer + (see ) then that will be + indicated in the about dialog by placing a star next to the author of the + HAL backend. +
+ Check you're using the HAL backend + + + + + + Expanded View + + + +
+ + + + Other backends do not currently give indication they are being used, so + you will have to guess based on your hardware. Most modern PC laptops are + using ACPI as the backend. This is also the backend with the largest + number of inconsistencies. + + + + + Checking the ACPI information + + If you are using the ACPI backend for the &applet;, it is important to + check that ACPI is giving you the right information. If it isn't, then + you will need to look into upgrading your DSDT or something else related + to ACPI. + + Example ACPI output + +[rupert@laptop ~]$ cat /proc/acpi/battery/BAT1/info +present: yes +design capacity: 41040 mWh +last full capacity: 37044 mWh +battery technology: rechargeable +design voltage: 10800 mV +design capacity warning: 745 mWh +design capacity low: 0 mWh +capacity granularity 1: 10 mWh +capacity granularity 2: 10 mWh +model number: G71C00056110 +serial number: 0000000008 +battery type: Li-ION +OEM info: +[rupert@laptop ~]$ cat /proc/acpi/battery/BAT1/state +present: yes +capacity state: ok +charging state: discharging +present rate: 11232 mW +remaining capacity: 27140 mWh +present voltage: 11400 mV +[rupert@laptop ~]$ + + + You can quickly calculate the percentage remaining using remaining + capacity divided by last full capacity, you can + calculate the time remaining by taking remaining capacity + divided by present rate. + + + + + Hardware Abstraction Layer + + You can check that your battery is detected by HAL using the command + hal-device-manager. If your battery is not detected + by HAL or the wrong information is being reported, you can attempt to + disable the HAL backend by setting a MateConf key. + + + Select Configuration Editor from the + Applications menu, under + System Tools. Search for the key value + OAFIID:MATE_BattstatApplet which should be located in + the path /apps/panel/applets. + + + Assuming the path is /apps/panel/applets/applet_1. + In /apps/panel/applets/applet_1/prefs add a + New Key... called no_hal + and set it to the boolean value of true. This will disable the usage of + HAL (see to learn how + to check this). + + + + + +
diff --git a/battstat/docs/C/figures/battstat-applet-expanded.png b/battstat/docs/C/figures/battstat-applet-expanded.png new file mode 100644 index 00000000..ab87e2e6 Binary files /dev/null and b/battstat/docs/C/figures/battstat-applet-expanded.png differ diff --git a/battstat/docs/C/figures/battstat-applet.png b/battstat/docs/C/figures/battstat-applet.png new file mode 100644 index 00000000..cfb03a0c Binary files /dev/null and b/battstat/docs/C/figures/battstat-applet.png differ diff --git a/battstat/docs/C/figures/battstat-credits-hal.png b/battstat/docs/C/figures/battstat-credits-hal.png new file mode 100644 index 00000000..ca014e92 Binary files /dev/null and b/battstat/docs/C/figures/battstat-credits-hal.png differ diff --git a/battstat/docs/C/figures/battstat-preferences.png b/battstat/docs/C/figures/battstat-preferences.png new file mode 100644 index 00000000..4c2c60d0 Binary files /dev/null and b/battstat/docs/C/figures/battstat-preferences.png differ diff --git a/battstat/docs/C/figures/context-menu.png b/battstat/docs/C/figures/context-menu.png new file mode 100644 index 00000000..af67fbef Binary files /dev/null and b/battstat/docs/C/figures/context-menu.png differ diff --git a/battstat/docs/C/legal.xml b/battstat/docs/C/legal.xml new file mode 100644 index 00000000..acb0b403 --- /dev/null +++ b/battstat/docs/C/legal.xml @@ -0,0 +1,76 @@ + + + Permission is granted to copy, distribute and/or modify this + document under the terms of the GNU Free Documentation + License (GFDL), Version 1.1 or any later version published + by the Free Software Foundation with no Invariant Sections, + no Front-Cover Texts, and no Back-Cover Texts. You can find + a copy of the GFDL at this link or in the file COPYING-DOCS + distributed with this manual. + + This manual is part of a collection of MATE manuals + distributed under the GFDL. If you want to distribute this + manual separately from the collection, you can do so by + adding a copy of the license to the manual, as described in + section 6 of the license. + + + + Many of the names used by companies to distinguish their + products and services are claimed as trademarks. Where those + names appear in any MATE documentation, and the members of + the MATE Documentation Project are made aware of those + trademarks, then the names are in capital letters or initial + capital letters. + + + + DOCUMENT AND MODIFIED VERSIONS OF THE DOCUMENT ARE PROVIDED + UNDER THE TERMS OF THE GNU FREE DOCUMENTATION LICENSE + WITH THE FURTHER UNDERSTANDING THAT: + + + + DOCUMENT IS PROVIDED ON AN "AS IS" BASIS, + WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR + IMPLIED, INCLUDING, WITHOUT LIMITATION, WARRANTIES + THAT THE DOCUMENT OR MODIFIED VERSION OF THE + DOCUMENT IS FREE OF DEFECTS MERCHANTABLE, FIT FOR + A PARTICULAR PURPOSE OR NON-INFRINGING. THE ENTIRE + RISK AS TO THE QUALITY, ACCURACY, AND PERFORMANCE + OF THE DOCUMENT OR MODIFIED VERSION OF THE + DOCUMENT IS WITH YOU. SHOULD ANY DOCUMENT OR + MODIFIED VERSION PROVE DEFECTIVE IN ANY RESPECT, + YOU (NOT THE INITIAL WRITER, AUTHOR OR ANY + CONTRIBUTOR) ASSUME THE COST OF ANY NECESSARY + SERVICING, REPAIR OR CORRECTION. THIS DISCLAIMER + OF WARRANTY CONSTITUTES AN ESSENTIAL PART OF THIS + LICENSE. NO USE OF ANY DOCUMENT OR MODIFIED + VERSION OF THE DOCUMENT IS AUTHORIZED HEREUNDER + EXCEPT UNDER THIS DISCLAIMER; AND + + + + UNDER NO CIRCUMSTANCES AND UNDER NO LEGAL + THEORY, WHETHER IN TORT (INCLUDING NEGLIGENCE), + CONTRACT, OR OTHERWISE, SHALL THE AUTHOR, + INITIAL WRITER, ANY CONTRIBUTOR, OR ANY + DISTRIBUTOR OF THE DOCUMENT OR MODIFIED VERSION + OF THE DOCUMENT, OR ANY SUPPLIER OF ANY OF SUCH + PARTIES, BE LIABLE TO ANY PERSON FOR ANY + DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR + CONSEQUENTIAL DAMAGES OF ANY CHARACTER + INCLUDING, WITHOUT LIMITATION, DAMAGES FOR LOSS + OF GOODWILL, WORK STOPPAGE, COMPUTER FAILURE OR + MALFUNCTION, OR ANY AND ALL OTHER DAMAGES OR + LOSSES ARISING OUT OF OR RELATING TO USE OF THE + DOCUMENT AND MODIFIED VERSIONS OF THE DOCUMENT, + EVEN IF SUCH PARTY SHALL HAVE BEEN INFORMED OF + THE POSSIBILITY OF SUCH DAMAGES. + + + + + + -- cgit v1.2.1