summaryrefslogtreecommitdiff
path: root/man/pm-powersave.xml
blob: eea23e445e955fcd9f72802fc1ea0635e4afc5c5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
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>