diff options
Diffstat (limited to 'doc/kcontrol')
| -rw-r--r-- | doc/kcontrol/Makefile.am | 6 | ||||
| -rw-r--r-- | doc/kcontrol/kcmlowbatcrit/Makefile.am | 2 | ||||
| -rw-r--r-- | doc/kcontrol/kcmlowbatcrit/index.docbook | 47 | ||||
| -rw-r--r-- | doc/kcontrol/kcmlowbatwarn/Makefile.am | 2 | ||||
| -rw-r--r-- | doc/kcontrol/kcmlowbatwarn/index.docbook | 104 | ||||
| -rw-r--r-- | doc/kcontrol/laptop/Makefile.am | 2 | ||||
| -rw-r--r-- | doc/kcontrol/laptop/index.docbook | 111 | ||||
| -rw-r--r-- | doc/kcontrol/powerctrl/Makefile.am | 2 | ||||
| -rw-r--r-- | doc/kcontrol/powerctrl/index.docbook | 77 |
9 files changed, 353 insertions, 0 deletions
diff --git a/doc/kcontrol/Makefile.am b/doc/kcontrol/Makefile.am new file mode 100644 index 0000000..930c270 --- /dev/null +++ b/doc/kcontrol/Makefile.am @@ -0,0 +1,6 @@ + +SUBDIRS = $(AUTODIRS) + +KDE_LANG = en +KDE_DOCS = AUTO + diff --git a/doc/kcontrol/kcmlowbatcrit/Makefile.am b/doc/kcontrol/kcmlowbatcrit/Makefile.am new file mode 100644 index 0000000..335ba2c --- /dev/null +++ b/doc/kcontrol/kcmlowbatcrit/Makefile.am @@ -0,0 +1,2 @@ +KDE_LANG=en +KDE_DOCS=kcontrol/kcmlowbatcrit
\ No newline at end of file diff --git a/doc/kcontrol/kcmlowbatcrit/index.docbook b/doc/kcontrol/kcmlowbatcrit/index.docbook new file mode 100644 index 0000000..24bf9e0 --- /dev/null +++ b/doc/kcontrol/kcmlowbatcrit/index.docbook @@ -0,0 +1,47 @@ +<?xml version="1.0" ?> +<!DOCTYPE article PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" +"dtd/kdex.dtd" [ +<!ENTITY % addindex "IGNORE"> +<!ENTITY % English "INCLUDE" > <!-- change language only here --> +]> + +<article> +<articleinfo> + +<authorgroup> +<author> +&Mike.McBride; &Mike.McBride.mail; +</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<date>2002-02-12</date> +<releaseinfo>3.00.00</releaseinfo> + +<keywordset> +<keyword>KDE</keyword> +<keyword>KControl</keyword> +<keyword>Battery</keyword> +<keyword>Power</keyword> +</keywordset> +</articleinfo> + +<sect1 id="lowbatcrit"> + +<title>Low Battery Critical</title> +<!-- <note><para>The laptop modules require the correct installation of the +apm modules. For more information see the section entitled Laptop +Information</link>.</para></note> --> +<sect2 id="low-bat-crit-use"> +<title>Use</title> +<para>This module works in exactly the same manner as the Low battery Warning module. By convention, this module should be set to warn you or automatically perform any action necessary just prior to the loss of battery power.</para> +</sect2> +<sect2 id="low-bat-crit-author"> +<title>Section Author</title> +<para>This section written by &Paul.Campbell; &Paul.Campbell.mail;</para> +<para>Converted to Docbook by &Mike.McBride; &Mike.McBride.mail;</para> +<!-- TRANS:CREDIT_FOR_TRANSLATORS --> +</sect2> +</sect1> + +</article> diff --git a/doc/kcontrol/kcmlowbatwarn/Makefile.am b/doc/kcontrol/kcmlowbatwarn/Makefile.am new file mode 100644 index 0000000..9baf4af --- /dev/null +++ b/doc/kcontrol/kcmlowbatwarn/Makefile.am @@ -0,0 +1,2 @@ +KDE_LANG=en +KDE_DOCS=kcontrol/kcmlowbatwarn
\ No newline at end of file diff --git a/doc/kcontrol/kcmlowbatwarn/index.docbook b/doc/kcontrol/kcmlowbatwarn/index.docbook new file mode 100644 index 0000000..97ceaf2 --- /dev/null +++ b/doc/kcontrol/kcmlowbatwarn/index.docbook @@ -0,0 +1,104 @@ +<?xml version="1.0" ?> +<!DOCTYPE article PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" +"dtd/kdex.dtd" [ +<!ENTITY % addindex "IGNORE"> +<!ENTITY % English "INCLUDE" > <!-- change language only here --> +]> + +<article lang="&language;"> +<articleinfo> + +<authorgroup> +<author> +&Mike.McBride; &Mike.McBride.mail; +</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<date>2002-02-12</date> +<releaseinfo>3.00.00</releaseinfo> + +<keywordset> +<keyword>KDE</keyword> +<keyword>KControl</keyword> +<keyword>Battery</keyword> +<keyword>Power</keyword> +</keywordset> +</articleinfo> + +<sect1 id="lowbatwarn"> + + +<title>The Low Battery Warning and Low Battery Critical Panels +</title> + +<sect2 id="low-bat-warn-intro"> +<title>Introduction</title> + + +<para>These two modules work together to control what happens when a +predetermined low battery condition occurs. There are two of them, so you can +set a warning for when time is getting close, and something more desperate for +the last minute save or suspend.</para> + +<!-- <note><para>The laptop modules require the correct installation of the apm modules. For more information see the section entitled <link linkend="laptop">Laptop Information</link>.</para></note> --> + +</sect2> + +<sect2 id="low-bat-warn-use"> +<title>Use</title> + +<para><emphasis>Low trigger</emphasis></para> + +<para>This field specifies at which point the battery low state is detected - it +is the number of minutes left (according to APM) in your batteries. When this +number is crossed the low state is triggered and one or more of the following +things will occur</para> + +<variablelist> +<varlistentry> +<term><guilabel>Run Command</guilabel></term> +<listitem><para>This is a shell command that will be executed when the battery +low is detected. By default, this is turned off.</para></listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Play Sound</guilabel></term> +<listitem><para>This specifies a sound to play when battery low is detected. Simply specify the path to the +file to have it played. By default, this is turned off.</para></listitem> +</varlistentry> +<varlistentry> +<term><guilabel>System Beep</guilabel></term> +<listitem><para>Enabling this will cause the battery monitor to beep whenever +the battery level drops below the preset value. This is probably the least +intrusive, yet still active, method of alerting the user that the battery is +low. By default, this is on.</para></listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Notify</guilabel></term> +<listitem><para>Enabling this will cause Battery to pop up a window when the +battery becomes low.</para></listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Suspend</guilabel></term> +<listitem><para>If you have set up <filename>/usr/bin/apm</filename> to be run +setuid (see the instructions for the <guilabel>Power</guilabel> panel) then this check box will +appear - if checked it will cause your computer to be put into <guilabel>Suspend</guilabel> +mode.</para></listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Standby</guilabel></term> +<listitem><para>Like <guilabel>Suspend</guilabel> above, but it puts your computer into <guilabel>Standby</guilabel> +mode.</para></listitem> +</varlistentry> +</variablelist> + +</sect2> +<sect2 id="low-bat-warn-author"> +<title>Section Author</title> +<para>This section written by &Paul.Campbell; &Paul.Campbell.mail;</para> +<para>Converted to Docbook by &Mike.McBride; &Mike.McBride.mail;</para> +<!-- TRANS:CREDIT_FOR_TRANSLATORS --> +</sect2> +</sect1> + +</article> diff --git a/doc/kcontrol/laptop/Makefile.am b/doc/kcontrol/laptop/Makefile.am new file mode 100644 index 0000000..446ee8e --- /dev/null +++ b/doc/kcontrol/laptop/Makefile.am @@ -0,0 +1,2 @@ +KDE_LANG=en +KDE_DOCS=kcontrol/laptop
\ No newline at end of file diff --git a/doc/kcontrol/laptop/index.docbook b/doc/kcontrol/laptop/index.docbook new file mode 100644 index 0000000..fb83afd --- /dev/null +++ b/doc/kcontrol/laptop/index.docbook @@ -0,0 +1,111 @@ +<?xml version="1.0" ?> +<!DOCTYPE article PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" +"dtd/kdex.dtd" [ +<!ENTITY % addindex "IGNORE"> +<!ENTITY % English "INCLUDE" > <!-- change language only here --> +]> + +<article lang="&language;"> +<articleinfo> + + + +<authorgroup> +<author> +&Mike.McBride; &Mike.McBride.mail; +</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<date>2002-02-12</date> +<releaseinfo>3.00.00</releaseinfo> + +<keywordset> +<keyword>KDE</keyword> +<keyword>KControl</keyword> +<keyword>Battery</keyword> +<keyword>level</keyword> +</keywordset> +</articleinfo> + +<sect1 id="battery-monitor"> + +<title>The Battery Monitor Panel</title> + +<!-- <note><para>The laptop modules require the correct installation of the +apm modules. For more information see the section entitled <link +linkend="laptop">Laptop Information</link>.</para></note> --> + +<sect2 id="batmon-intro"> +<title>Introduction</title> + +<para>This panel controls whether or not a battery state icon appears +in &kde;'s panel.</para> + +<para>Once enabled a battery will appear in your docking bar as one of +3 icons - a <guiicon>battery with a red X</guiicon> through it +indicates that <acronym>APM</acronym> has not been installed (in +particular <filename>/proc/apm</filename> can't be read).</para> + +<para>The other two icons indicate the battery state - a +<guiicon>small plug with a bar</guiicon> beside it indicates your +batteries are charging - the height of the blue portion of the bar +indicate how full your batteries are. A small +<guiicon>battery</guiicon> in the dock indicates you are running on +batteries, the amount of blue in the battery indicates how full your +batteries are.</para> + +<para>If you <mousebutton>left</mousebutton> click on the docked icon a +pop-up will tell you how much time you have left in minutes.</para> + +<para>If you <mousebutton>right</mousebutton> click you get a pop-up +that lets you put your laptop into suspend or standby modes - or to +bring up the laptop configuration widget.</para> + +<para>All features of Battery are configured from the Setup dialog.</para> + +</sect2> +<sect2 id="batmon-use"> +<title>Use</title> + +<para>The configuration window can be divided into 3 parts.</para> + +<variablelist> +<varlistentry> +<term><guilabel>Show Battery Monitor</guilabel></term> +<listitem><para>This controls whether or not the battery icon appears. This is +disabled by default.</para></listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Poll</guilabel></term> +<listitem><para>This setting controls how often, in seconds, the battery is +updated. </para> +<para>The default is 20 seconds.</para></listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Icons</guilabel></term> +<listitem><para>The battery monitor uses three icons to represent the three +states: No APM, Charging, and Not Charging. The icons shown are the <quote>large</quote> +icons. To select new ones, click on the buttons and a icon loader dialog will +pop up. </para> +<note><para>If you create your own icons - they will work with the battery +monitor - but be careful.</para> +<para>All the exactly white pixels in the icon get filled by blue for the +battery meter - if you want some white looking pixels to stay choose a slightly +off-white or gray color for them.</para></note> +<para>The author does not claim to be a graphic artist and would love for +someone to donate some better looking icons to the cause.</para> +</listitem> +</varlistentry> +</variablelist> + +</sect2> +<sect2 id="batmon-author"> +<title>Section Author</title> +<para>This section written by &Paul.Campbell; &Paul.Campbell.mail;</para> +<para>Converted to Docbook by &Mike.McBride; &Mike.McBride.mail;</para> +<!-- TRANS:CREDIT_FOR_TRANSLATORS --> +</sect2> +</sect1> + +</article> diff --git a/doc/kcontrol/powerctrl/Makefile.am b/doc/kcontrol/powerctrl/Makefile.am new file mode 100644 index 0000000..eefb119 --- /dev/null +++ b/doc/kcontrol/powerctrl/Makefile.am @@ -0,0 +1,2 @@ +KDE_LANG=en +KDE_DOCS=kcontrol/powerctrl
\ No newline at end of file diff --git a/doc/kcontrol/powerctrl/index.docbook b/doc/kcontrol/powerctrl/index.docbook new file mode 100644 index 0000000..2a09b95 --- /dev/null +++ b/doc/kcontrol/powerctrl/index.docbook @@ -0,0 +1,77 @@ +<?xml version="1.0" ?> +<!DOCTYPE article PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" +"dtd/kdex.dtd" [ +<!ENTITY % addindex "IGNORE"> +<!ENTITY % English "INCLUDE" > <!-- change language only here --> +]> + +<article lang="&language;"> +<articleinfo> + +<authorgroup> +<author> +&Mike.McBride; &Mike.McBride.mail; +</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<date>2002-10-16</date> +<releaseinfo>3.1</releaseinfo> + +<keywordset> +<keyword>KDE</keyword> +<keyword>KControl</keyword> +<keyword>Laptop</keyword> +<keyword>Power</keyword> +</keywordset> +</articleinfo> +<sect1 id="powerctrl"> + +<title>Laptop Power Control</title> +<!-- <note><para>The laptop modules require the correct installation of the apm modules. For more information see the section entitled <link linkend="laptop">Laptop Information</link>.</para></note> --> +<sect2 id="powerctrl-intro"> +<title>Introduction</title> + +<para>This tab provides a screensaver-style interface to the APM +suspend/standby modes. It allows you to configure different wait +times and/or actions depending on whether or not your laptop is +plugged into the wall. It's intended to be used in addition to the +existing &kde; screensavers - you could for example disable +suspend/standby when plugged in to the wall, but enable suspend with a +shorter time than your normal screensaver kicks in while running on +batteries.</para> + +<warning><para>Standby mode seems to do different things on different laptops - +in particular on some it may not stay in standby mode and your laptop may be +continually waking/sleeping if you leave it in this mode.</para></warning> + +</sect2> +<sect2 id="powerctrl-use"> +<title>Use</title> + +<para>This panel configures the power-down feature of your laptop. It works as +a sort of extreme screen saver.</para> +<para>You can configure different timeouts and behavior depending on whether +your computer is plugged in or running on battery power.</para> +<para>For both the <guilabel>Powered</guilabel> and <guilabel>Not Powered</guilabel>, you should select one of the +following options:</para> +<itemizedlist> +<listitem><para>Standby - Puts your laptop into standby state</para></listitem> +<listitem><para>Suspend - Puts your laptop into suspend state</para></listitem> +<listitem><para>Off - Nothing happens at the specified time.</para></listitem> +</itemizedlist> + +<para>Below that, is a text box labeled <guilabel>Wait for</guilabel>. Enter +the time in minutes, that your computer should remain unused, before the laptop +is powered down.</para> + +</sect2> +<sect2 id="powerctrl-author"> +<title>Section Author</title> +<para>This section written by &Paul.Campbell; &Paul.Campbell.mail;</para> +<para>Converted to Docbook by &Mike.McBride; &Mike.McBride.mail;</para> +<!-- TRANS:CREDIT_FOR_TRANSLATORS --> +</sect2> +</sect1> + +</article> |