diff options
Diffstat (limited to 'man/pm-powersave.xml')
| -rw-r--r-- | man/pm-powersave.xml | 175 |
1 files changed, 175 insertions, 0 deletions
diff --git a/man/pm-powersave.xml b/man/pm-powersave.xml new file mode 100644 index 0000000..eea23e4 --- /dev/null +++ b/man/pm-powersave.xml @@ -0,0 +1,175 @@ +<?xml version='1.0' encoding='UTF-8'?> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" + "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [ + + + <!-- Fill in your name for FIRSTNAME and SURNAME. --> + <!ENTITY dhfirstname "Michael"> + <!ENTITY dhsurname "Biebl"> + <!-- dhusername could also be set to "&firstname; &surname;". --> + <!ENTITY dhusername "Michael Biebl"> + <!ENTITY dhemail "biebl@debian.org"> + <!-- Please adjust the date whenever revising the manpage. --> + <!ENTITY dhdate "Mar 5, 2007"> + <!-- SECTION should be 1-8, maybe w/ subsection other parameters are + allowed: see man(7), man(1) and + http://www.tldp.org/HOWTO/Man-Page/q2.html. --> + <!ENTITY dhsection "8"> + <!-- TITLE should be something like "User commands" or similar (see + http://www.tldp.org/HOWTO/Man-Page/q2.html). --> + <!ENTITY dhtitle "pm-utils User Manual"> + <!ENTITY dhucpackage "pm-powersave"> + <!ENTITY dhpackage "pm-powersave"> + + <!ENTITY debian "<productname>Debian</productname>"> + <!ENTITY gnu "<acronym>GNU</acronym>"> + <!ENTITY gpl "&gnu; <acronym>GPL</acronym>"> +]> + +<refentry> + <refentryinfo> + <title>&dhtitle;</title> + <productname>&dhpackage;</productname> + <date>&dhdate;</date> + <authorgroup> + <author> + <firstname>&dhfirstname;</firstname> + <surname>&dhsurname;</surname> + <contrib>Manpage author.</contrib> + <address> + <email>&dhemail;</email> + </address> + </author> + </authorgroup> + <copyright> + <year>2007</year> + <holder>&dhusername;</holder> + </copyright> + <legalnotice> + <para> + This manual page was written for the &debian; system + (but may be used by others). + </para> + <para> + Permission is granted to copy, distribute and/or modify this + document under the terms of the &gnu; General Public License, + Version 2 or (at your option) any later version published by + the Free Software Foundation. + </para> + <para> + On Debian systems, the complete text of the GNU General Public + License can be found + in <filename>file:///usr/share/common-licenses/GPL</filename>. + </para> + </legalnotice> + </refentryinfo> + <refmeta> + <refentrytitle>&dhucpackage;</refentrytitle> + <manvolnum>&dhsection;</manvolnum> + </refmeta> + <refnamediv> + <refname>&dhpackage;</refname> + <refpurpose>put your computer into low power mode</refpurpose> + </refnamediv> + <refsynopsisdiv> + <cmdsynopsis> + <command>&dhpackage;</command> + <!-- These are several examples, how syntaxes could look --> + <arg choice="opt"> + <group choice="req"> + <arg choice="plain"><option>true</option></arg> + <arg choice="plain"><option>false</option></arg> + </group> + </arg> + </cmdsynopsis> + </refsynopsisdiv> + + <refsect1 id="description"> + <title>DESCRIPTION</title> + <para> + This manual page documents briefly the <command>&dhpackage;</command> + command. + </para> + <para> + This manual page was written for the &debian; distribution + because the original program does not have a manual page.</para> + <para> + <command>&dhpackage;</command> can be used to set your system into + low power mode. + </para> + <para> + One of the features that is enabled by <command>pm-powersave</command> + is the so-called Laptop Mode. A feature of the Linux kernel that allows + to spin down the hard drive for longer periods of time. + </para> + </refsect1> + + <refsect1 id="options"> + <title>OPTIONS</title> + <variablelist> + <!-- Use the variablelist.term.separator and the + variablelist.term.break.after parameters to + control the term elements. --> + <varlistentry> + <term><option>true</option></term> + <listitem> + <para> + Set the computer into low power mode to reduce energy consumption + and extend your laptop's battery life. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><option>false</option></term> + <listitem> + <para> + Turn off low power mode. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsect1> + + <refsect1 id="files"> + <title>FILES</title> + <variablelist> + <varlistentry> + <term><filename>/etc/pm/power.d/</filename></term> + <term><filename>/usr/lib/pm-utils/power.d/</filename></term> + <listitem> + <para> + When you run <command>pm-powersave</command> it combines the + scripts in these two directories and executes them in sorted order. + If both directories contain a script with the same name, the one in + /etc/pm/power.d/ has a higher precedence and only + this one will be executed. + </para> + <para> + Therefore to disable a script from /usr/lib/pm-utils/power.d/ + simply create an empty file in /etc/pm/power.d/ with the same + name and without the execute bit set. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsect1> + + <refsect1 id="see_also"> + <title>SEE ALSO</title> + <!-- In alpabetical order. --> + <para> + <citerefentry> + <refentrytitle>pm-suspend</refentrytitle> + <manvolnum>8</manvolnum> + </citerefentry>, + <citerefentry> + <refentrytitle>pm-hibernate</refentrytitle> + <manvolnum>8</manvolnum> + </citerefentry> + </para> + <para> + To learn more about Laptop Mode read + <filename>/usr/src/linux/Documentation/laptop-mode.txt</filename>. + </para> + </refsect1> +</refentry> |