[Goodies-commits] r5973 - in xfce4-power-manager/trunk/doc/C: . images

Tue Nov 4 20:05:17 CET 2008

Author: aliov
Date: 2008-11-04 19:05:17 +0000 (Tue, 04 Nov 2008)
New Revision: 5973

Modified:
   xfce4-power-manager/trunk/doc/C/images/general-settings.png
   xfce4-power-manager/trunk/doc/C/xfce4-power-manager.html
   xfce4-power-manager/trunk/doc/C/xfce4-power-manager.xml
Log:
update doc file

Modified: xfce4-power-manager/trunk/doc/C/images/general-settings.png
===================================================================
(Binary files differ)

Modified: xfce4-power-manager/trunk/doc/C/xfce4-power-manager.html
===================================================================

--- xfce4-power-manager/trunk/doc/C/xfce4-power-manager.html	2008-11-04 18:36:35 UTC (rev 5972)
+++ xfce4-power-manager/trunk/doc/C/xfce4-power-manager.html	2008-11-04 19:05:17 UTC (rev 5973)
@@ -1,4 +1,4 @@
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=ANSI_X3.4-1968"><title>Xfce 4 Power Manager</title><link rel="stylesheet" href="../xfce.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.73.2"><link rel="start" href="#xfce4-power-manager" title="Xfce 4 Power Manager"><link rel="next" href="#xfpm-intro" title="Introduction"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="article" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="xfce4-power-manager"></a>Xfce 4 Power Manager</h2></div><div><div class="authorgroup"><div class="author"><h3 class="author"><span class="firstname">Ali</span> <span class="surname">Abdallah</span></h3><div class="affiliation"><div class="address"><p><code class="email"><<a class="email" href="mailto:ali.slackware at gmail.com">ali.slackware at gmail.com</a>></code></p></div></div></div></div></div><div><span xmlns="http://www.
 w3.org/TR/xhtml1/transitional" class="releaseinfo">This manual describes <strong xmlns="" class="application"><code>xfce4-power-manager</code></strong> version 0.6.0
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=ANSI_X3.4-1968"><title>Xfce 4 Power Manager</title><link rel="stylesheet" href="../xfce.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.73.2"><link rel="start" href="#xfce4-power-manager" title="Xfce 4 Power Manager"><link rel="next" href="#xfpm-intro" title="Introduction"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="article" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="xfce4-power-manager"></a>Xfce 4 Power Manager</h2></div><div><div class="authorgroup"><div class="author"><h3 class="author"><span class="firstname">Ali</span> <span class="surname">Abdallah</span></h3><div class="affiliation"><div class="address"><p><code class="email"><<a class="email" href="mailto:aliov at xfce.org">aliov at xfce.org</a>></code></p></div></div></div></div></div><div><span xmlns="http://www.w3.org/TR/xhtml1/t
 ransitional" class="releaseinfo">This manual describes <strong xmlns="" class="application"><code>xfce4-power-manager</code></strong> version 0.6.0
 <br></br></span></div><div><p class="copyright">Copyright © 2008 Ali Abdallah</p></div></div><hr></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="sect1"><a href="#xfpm-intro">Introduction</a></span></dt><dd><dl><dt><span class="sect2"><a href="#xfpm-started">Getting Started</a></span></dt></dl></dd><dt><span class="sect1"><a href="#xfpm-configuration">Power Manager Configuration</a></span></dt><dd><dl><dt><span class="sect2"><a href="#xfpm-general">General Settings</a></span></dt><dt><span class="sect2"><a href="#xfpm-cpu">CPU Settings</a></span></dt><dt><span class="sect2"><a href="#xfpm-battery">Battery settings</a></span></dt><dt><span class="sect2"><a href="#xfpm-button">Keyboard shortcuts</a></span></dt><dt><span class="sect2"><a href="#xfpm-monitor">Monitor settings</a></span></dt></dl></dd><dt><span class="sect1"><a href="#xfpm-systray-notify">System Tray Icon and Notification</a></span></dt><dt><span class="sect1"><a href="#xfpm-faq">FA
 Q</a></span></dt><dt><span class="sect1"><a href="#xfpm-about">About <strong class="application"><code>xfce4-power-manager</code></strong></a></span></dt></dl></div><p> </p><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="xfpm-intro"></a>Introduction</h2></div></div></div>
   The Xfce4 power manager is a part of the Xfce goodies project and features cpu frequency control,
   battery monitoring, monitor DPMS control, LCD brightness control, lid sleep and power buttons controls.
@@ -8,7 +8,7 @@
   , a popup should be displayed only if the power manager isn't already running to ask you if you want to. 
   Once the power manager is launched for the first time, it'll place a autostart desktop file in your .config/autostart
   so like that it gets launched automatically second time you log into your Xfce desktop.
-  </p></div></div><p> </p><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="xfpm-configuration"></a>Power Manager Configuration</h2></div></div></div><div class="figure"><a name="id2535579"></a><p class="title"><b>Figure 1. Power Manager settings</b></p><div class="figure-contents"><div class="screenshot"><div class="mediaobject"><img src="images/settings.png" alt="Power Manager settings"></div></div></div></div><p><br class="figure-break"></p><p>
+  </p></div></div><p> </p><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="xfpm-configuration"></a>Power Manager Configuration</h2></div></div></div><div class="figure"><a name="id2763457"></a><p class="title"><b>Figure 1. Power Manager settings</b></p><div class="figure-contents"><div class="screenshot"><div class="mediaobject"><img src="images/settings.png" alt="Power Manager settings"></div></div></div></div><p><br class="figure-break"></p><p>
   Almost all the <strong class="application"><code>xfce4-power-manager</code></strong> items are configurable from the configuration window, laptop users can set up 
   a power profile for two different modes “on battery power” and “on ac power”, desktop users still can change 
   DPMS settings and CPU frequency.
@@ -17,10 +17,10 @@
   the available manageabale interfaces.  
   </p><p>
   In this section we will describe the possible configuration for the power manager.
-  </p><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="xfpm-general"></a>General Settings</h3></div></div></div><div class="figure"><a name="id2550515"></a><p class="title"><b>Figure 2. General settings</b></p><div class="figure-contents"><div class="screenshot"><div class="mediaobject"><img src="images/general-settings.png" alt="General settings"></div></div></div></div><p><br class="figure-break"></p><p>
+  </p><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="xfpm-general"></a>General Settings</h3></div></div></div><div class="figure"><a name="id2792113"></a><p class="title"><b>Figure 2. General settings</b></p><div class="figure-contents"><div class="screenshot"><div class="mediaobject"><img src="images/general-settings.png" alt="General settings"></div></div></div></div><p><br class="figure-break"></p><p>
 	Here you can select the configuration of the system tray icon, enable/disable cpu frequency and DPMS controls, 
 	typical reason to disable DPMS control for example if you are watching a movie.	
-	</p></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="xfpm-cpu"></a>CPU Settings</h3></div></div></div><div class="figure"><a name="id2535417"></a><p class="title"><b>Figure 3. CPU Linux governors</b></p><div class="figure-contents"><div class="screenshot"><div class="mediaobject"><img src="images/cpu-settings.png" alt="CPU Linux governors"></div></div></div></div><p><br class="figure-break"></p><p>
+	</p></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="xfpm-cpu"></a>CPU Settings</h3></div></div></div><div class="figure"><a name="id2782506"></a><p class="title"><b>Figure 3. CPU Linux governors</b></p><div class="figure-contents"><div class="screenshot"><div class="mediaobject"><img src="images/cpu-settings.png" alt="CPU Linux governors"></div></div></div></div><p><br class="figure-break"></p><p>
 	The linux governors found in the system are listed for choice as a radio buttons,
 	if the acpi_cpufreq module is not loaded in the kernel or the cpu itself doesn't support
 	changes in it's frequency these options might not be shown.
@@ -37,7 +37,7 @@
 	 the CPU speed rather than jumping to max speed the moment there is any load on the CPU.
 	</p></dd></dl></div><p>
 NOTE:In <strong class="application"><code>xfce4-power-manager</code></strong> version 0.6.0 only Linux is supported for changing the CPU frequency.
-</p></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="xfpm-battery"></a>Battery settings</h3></div></div></div><div class="figure"><a name="id2539308"></a><p class="title"><b>Figure 4. Battery settings</b></p><div class="figure-contents"><div class="screenshot"><div class="mediaobject"><img src="images/battery-settings.png" alt="Battery settings"></div></div></div></div><p><br class="figure-break"></p><p>
+</p></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="xfpm-battery"></a>Battery settings</h3></div></div></div><div class="figure"><a name="id2763260"></a><p class="title"><b>Figure 4. Battery settings</b></p><div class="figure-contents"><div class="screenshot"><div class="mediaobject"><img src="images/battery-settings.png" alt="Battery settings"></div></div></div></div><p><br class="figure-break"></p><p>
 	The user can select the percentage of the battery to be considered as critical, usually this is for a laptop or
 	UPS battery, this option is important as for a broken battery for example, the battery when it is 10% charged 
 	can last	5 minutes, so the user can increase the level at wish the battery charge will be considered critical.    
@@ -48,11 +48,11 @@
    The battery notification is a way to notify the user when the battery state changes ( ex: battery charge is full )
    <p>
    
-   </p></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="xfpm-button"></a>Keyboard shortcuts</h3></div></div></div><div class="figure"><a name="id2550901"></a><p class="title"><b>Figure 5. button control</b></p><div class="figure-contents"><div class="screenshot"><div class="mediaobject"><img src="images/button-settings.png" alt="button control"></div></div></div></div><p><br class="figure-break"></p>
+   </p></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="xfpm-button"></a>Keyboard shortcuts</h3></div></div></div><div class="figure"><a name="id2778284"></a><p class="title"><b>Figure 5. button control</b></p><div class="figure-contents"><div class="screenshot"><div class="mediaobject"><img src="images/button-settings.png" alt="button control"></div></div></div></div><p><br class="figure-break"></p>
    For those buttons you can define an action to be taken by the power manager when happen to press one of them, 
    for example when you close the laptop screen. 
     
-  </div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="xfpm-monitor"></a>Monitor settings</h3></div></div></div><div class="figure"><a name="id2536153"></a><p class="title"><b>Figure 6. Monitor DPMS and lcd brightness</b></p><div class="figure-contents"><div class="screenshot"><div class="mediaobject"><img src="images/monitor-settings.png" alt="Monitor DPMS and lcd brightness"></div></div></div></div><p><br class="figure-break"></p><p>
+  </div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="xfpm-monitor"></a>Monitor settings</h3></div></div></div><div class="figure"><a name="id2776249"></a><p class="title"><b>Figure 6. Monitor DPMS and LCD brightness</b></p><div class="figure-contents"><div class="screenshot"><div class="mediaobject"><img src="images/monitor-settings.png" alt="Monitor DPMS and LCD brightness"></div></div></div></div><p><br class="figure-break"></p><p>
 	DPMS is an old X extension that allows standby/suspend/turn off options of the monitor, usually the timeouts 
 	have to be succesitive, so standby timeout less than suspend timeout and so on, but one always can disable any option.
 	</p><p>
@@ -60,7 +60,7 @@
 	it detects that system in running on battery power and set it again to the maximum value when system is running
 	on AC power.
 	</p></div></div><p> </p><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="xfpm-systray-notify"></a>System Tray Icon and Notification</h2></div></div></div><p>
-</p><div class="figure"><a name="id2550384"></a><p class="title"><b>Figure 7. Battery icon in the system tray</b></p><div class="figure-contents"><div class="screenshot"><div class="mediaobject"><img src="images/battery.png" alt="Battery icon in the system tray"></div></div></div></div><p><br class="figure-break"></p><p>
+</p><div class="figure"><a name="id2798957"></a><p class="title"><b>Figure 7. Battery icon in the system tray</b></p><div class="figure-contents"><div class="screenshot"><div class="mediaobject"><img src="images/battery.png" alt="Battery icon in the system tray"></div></div></div></div><p><br class="figure-break"></p><p>
 
 The "system tray" is an application running on a given X screen that can display small icons 
 provided by running applications. In Xfce it's a panel plugin that catch the icon and resize it
@@ -69,7 +69,7 @@
 </p><p>
 <strong class="application"><code>xfce4-power-manager</code></strong> uses GtkStatusIcon to display the different kinds of  batteries found in the system.
 </p><p>
-</p><div class="figure"><a name="id2535259"></a><p class="title"><b>Figure 8. Battery Notification</b></p><div class="figure-contents"><div class="screenshot"><div class="mediaobject"><img src="images/battery-discharging.png" alt="Battery Notification"></div></div></div></div><p><br class="figure-break"></p><p>
+</p><div class="figure"><a name="id2758165"></a><p class="title"><b>Figure 8. Battery Notification</b></p><div class="figure-contents"><div class="screenshot"><div class="mediaobject"><img src="images/battery-discharging.png" alt="Battery Notification"></div></div></div></div><p><br class="figure-break"></p><p>
 
 To notify the user about the status of the battery, serious errors occured, the notification daemon is used
 to display such messages.
@@ -85,10 +85,9 @@
 	</p></dd><dt><span class="term">Q: How the power manager actually suspend or hibernate my system.</span></dt><dd><p>A: The power manager checks if the user is allowed to, then send a DBus message to HAL asking to suspend
 	/hibernate, usually the methods to suspend or hibernate used by HAL are scripts located in /usr/lib/hal/scripts/YourOs.
 	</p></dd><dt><span class="term">Q: If the power manager puts the computer in hibernate because my battery charge is critical what will happen
-	if i turn it on again without plugging my adapter.</span></dt><dd><p>A: Nothing actually, the power manager had take the action defined by the user already and understands
-	that the user insist of using the laptop so in the best cases it'll display a warning popup with options 
-	the user can do.
-	</p></dd><dt><span class="term">Q: I select the option of the lcd brightness control but i don't see the brightness changing when i switch 
+	if i turn it on again without plugging my adapter.</span></dt><dd><p>A: Nothing actually, the power manager had take the action defined by the user already
+	in the best cases it'll display a warning popup with options the user can choose.
+	</p></dd><dt><span class="term">Q: I select the option of the LCD brightness control but i don't see the brightness changing when i switch 
 	from AC adapter to battery power.</span></dt><dd><p>A: You kernel doesn't have the right driver, or the driver isn't loaded.
 	</p></dd></dl></div></div><p> </p><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="xfpm-about"></a>About <strong class="application"><code>xfce4-power-manager</code></strong></h2></div></div></div><p>
 	This power manager was written following the philosophy of Xfce, having leight weight application that does

Modified: xfce4-power-manager/trunk/doc/C/xfce4-power-manager.xml
===================================================================
--- xfce4-power-manager/trunk/doc/C/xfce4-power-manager.xml	2008-11-04 18:36:35 UTC (rev 5972)
+++ xfce4-power-manager/trunk/doc/C/xfce4-power-manager.xml	2008-11-04 19:05:17 UTC (rev 5973)
@@ -22,7 +22,7 @@
     <author>
       <firstname>Ali</firstname> <surname>Abdallah</surname>
       <affiliation>
-	<address><email>ali.slackware at gmail.com</email></address>
+	<address><email>aliov at xfce.org</email></address>
       </affiliation>
     </author>
     
@@ -236,7 +236,7 @@
   <sect2 id="xfpm-monitor">
    <title>Monitor settings</title>
    <para><figure float="0">
-	<title>Monitor DPMS and lcd brightness</title>
+	<title>Monitor DPMS and LCD brightness</title>
 	<screenshot><mediaobject>
 	<imageobject>
 	<imagedata fileref="images/monitor-settings.png" format="PNG"/>
@@ -352,15 +352,14 @@
 	<term>Q: If the power manager puts the computer in hibernate because my battery charge is critical what will happen
 	if i turn it on again without plugging my adapter.</term>
 	<listitem>
-	<para>A: Nothing actually, the power manager had take the action defined by the user already and understands
-	that the user insist of using the laptop so in the best cases it'll display a warning popup with options 
-	the user can do.
+	<para>A: Nothing actually, the power manager had take the action defined by the user already
+	in the best cases it'll display a warning popup with options the user can choose.
 	</para>
 	</listitem>
 	</varlistentry>
 	
 	 <varlistentry>
-	<term>Q: I select the option of the lcd brightness control but i don't see the brightness changing when i switch 
+	<term>Q: I select the option of the LCD brightness control but i don't see the brightness changing when i switch 
 	from AC adapter to battery power.</term>
 	<listitem>
 	<para>A: You kernel doesn't have the right driver, or the driver isn't loaded.


