source: general/sysutils/power-profiles-daemon.xml@ ce315bbd

gimp3 lazarus trunk xry111/for-12.3 xry111/spidermonkey128
Last change on this file since ce315bbd was 158956b, checked in by Rahul Chandra <rahul@…>, 4 months ago

Update to power-profiles-daemon-0.21

  • Property mode set to 100644
File size: 9.8 KB
RevLine 
[16d42f6]1<?xml version="1.0" encoding="UTF-8"?>
2<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3 "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4 <!ENTITY % general-entities SYSTEM "../../general.ent">
5 %general-entities;
6
7 <!-- Place this in the packages.ent file
8 <!ENTITY power-profiles-daemon-version "">
9 -->
10
11 <!ENTITY power-profiles-daemon-download-http "https://gitlab.freedesktop.org/upower/power-profiles-daemon/-/archive/&power-profiles-daemon-version;/power-profiles-daemon-&power-profiles-daemon-version;.tar.gz">
12 <!ENTITY power-profiles-daemon-download-ftp " ">
[158956b]13 <!ENTITY power-profiles-daemon-md5sum "0196aae5798263d3d8f33a9280a6cb10">
14 <!ENTITY power-profiles-daemon-size "76 KB">
15 <!ENTITY power-profiles-daemon-buildsize "3.2 MB">
[16d42f6]16 <!ENTITY power-profiles-daemon-time "less than 0.1 SBU (with tests)">
17]>
18
19<sect1 id="power-profiles-daemon" xreflabel="power-profiles-daemon-&power-profiles-daemon-version;">
20 <?dbhtml filename="power-profiles-daemon.html"?>
21
22
23 <title>Power-profiles-daemon-&power-profiles-daemon-version;</title>
24
25 <indexterm zone="power-profiles-daemon">
26 <primary sortas="a-Power-profiles-daemon">power-profiles-daemon</primary>
27 </indexterm>
28
29 <sect2 role="package">
30 <title>Introduction to Power-profiles-daemon</title>
31
32 <para>
33 The <application>Power-profiles-daemon</application> package provides a program
34 that allows modification of the system power/behavior state. This is used on
35 many laptops and can be used by a Desktop Environment to activate power saving
[21a65a3]36 or performance CPU governors through dbus. On other systems, Power-profiles-daemon
37 can be used as a streamlined way to set the CPU governor in order to increase system
38 performance at the cost of energy usage.
[16d42f6]39 </para>
40
[f2716192]41 &lfs121_checked;
[16d42f6]42
43 <bridgehead renderas="sect3">Package Information</bridgehead>
44 <itemizedlist spacing="compact">
45 <listitem>
46 <para>
47 Download (HTTP): <ulink url="&power-profiles-daemon-download-http;"/>
48 </para>
49 </listitem>
50 <listitem>
51 <para>
52 Download (FTP): <ulink url="&power-profiles-daemon-download-ftp;"/>
53 </para>
54 </listitem>
55 <listitem>
56 <para>
57 Download MD5 sum: &power-profiles-daemon-md5sum;
58 </para>
59 </listitem>
60 <listitem>
61 <para>
62 Download size: &power-profiles-daemon-size;
63 </para>
64 </listitem>
65 <listitem>
66 <para>
67 Estimated disk space required: &power-profiles-daemon-buildsize;
68 </para>
69 </listitem>
70 <listitem>
71 <para>
72 Estimated build time: &power-profiles-daemon-time;
73 </para>
74 </listitem>
75 </itemizedlist>
76
77 <bridgehead renderas="sect3">Power-profiles-daemon Dependencies</bridgehead>
78
79 <bridgehead renderas="sect4">Required</bridgehead>
80 <para role="required">
[e5fa35a]81 <xref linkend="polkit"/>,
82 <xref linkend="pygobject3"/>, and
83 <xref linkend="upower"/>,
[16d42f6]84 </para>
85
86 <bridgehead renderas="sect4">Optional</bridgehead>
87 <para role="optional">
88 <xref linkend="gtk-doc"/>,
89 The rest are for the tests,
90 <xref linkend="python-dbusmock"/>,
91 <xref linkend="umockdev"/>,
92 <ulink url="https://github.com/PyCQA/isort">isort</ulink>, and
[f1e2498]93 <ulink url="https://github.com/PyCQA/mccabe">mccabe</ulink>
[16d42f6]94 </para>
95 </sect2>
96
97 <sect2 role="kernel" id="power-profiles-daemon-kernel">
98 <title>Kernel Configuration</title>
99
100 <para>
101 Enable the following options in the kernel configuration and recompile the
102 kernel if necessary:
103 </para>
104
105 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
106 href="power-profiles-daemon-kernel.xml"/>
107
108 <para>
109 Select the appropriate sub-options that appear when the above options are
110 selected. As much as possible, the layout should be the same as in
111 kernel configuration menus.
112 </para>
113
114 <indexterm zone="power-profiles-daemon power-profiles-daemon-kernel">
115 <primary sortas="d-Power-profiles-daemon">Power-profiles-daemon</primary>
116 </indexterm>
117 </sect2>
118
119 <sect2 role="installation">
120 <title>Installation of Power-profiles-daemon</title>
121
122 <para>
123 Install <application>Power-profiles-daemon</application> by
124 running the following commands:
125 </para>
126<screen revision="sysv"><userinput>mkdir build &amp;&amp;
127cd build &amp;&amp;
128
[f2716192]129meson setup \
130 --prefix=/usr \
131 --buildtype=release \
132 -Dgtk_doc=false \
133 -Dtests=false \
134 -Dsystemdsystemunitdir=/tmp \
[16d42f6]135 .. &amp;&amp;
136ninja</userinput></screen>
137
138
139<screen revision="systemd"><userinput>mkdir build &amp;&amp;
140cd build &amp;&amp;
141
[8b5da84]142meson setup \
143 --prefix=/usr \
[16d42f6]144 --buildtype=release \
[8b5da84]145 -Dgtk_doc=false \
[7669ff25]146 -Dtests=false \
[16d42f6]147 .. &amp;&amp;
148ninja</userinput></screen>
149
150 <para>
151 If you have installed the external dependencies, to test the results issue: <command>
[7669ff25]152 ninja test</command>.
[16d42f6]153 </para>
154
155 <para>
156 Now, as the <systemitem class="username">root</systemitem> user:
157 </para>
158
159<screen role="root"><userinput>ninja install</userinput></screen>
[f2716192]160
[21a65a3]161 <para revision="sysv">
[f2716192]162 Now, clean up an unneeded systemd unit installed into /tmp:
163 </para>
164
165<screen revision="sysv" role="root">
166<userinput>rm -fv /tmp/power-profiles-daemon.service</userinput>
[158956b]167</screen>
168
169 <para revision="sysv">
170 Create a directory required for persistant power states
171 after reboot:
172 </para>
173
174<screen revision="sysv" role="root">
175<userinput>install -vdm755 /var/lib/power-profiles-daemon</userinput>
[f2716192]176</screen>
177
[16d42f6]178 </sect2>
179
[f2716192]180
[16d42f6]181 <sect2 role="commands">
182 <title>Command Explanations</title>
183
184 <para>
[f1e2498]185 <parameter>-Dgtk_doc=false</parameter>: Prevents building the
[16d42f6]186 documentation. Remove this if you have <application>GTK-Doc</application>
187 installed and wish to build the documentation.
188 </para>
189
[7669ff25]190 <para>
191 <parameter>-Dtests=false</parameter>: Prevents building the
[b458da5]192 tests because they cannot be run within the boundaries of
[7669ff25]193 BLFS. Remove this if you have installed the external dependencies
194 and wish to run the tests.
195 </para>
196
[16d42f6]197 <para revision="sysv">
[f2716192]198 <parameter>-Dsystemdsystemunitdir=/tmp</parameter>: Removes
[16d42f6]199 the dependency on <application>systemd</application>.
200 </para>
201
202 </sect2>
203
204 <sect2 role="configuration">
205 <title>Configuring Power-profiles-daemon</title>
206
207 <sect3 id="power-profiles-daemon-init" revision="sysv">
208 <title>Boot Script</title>
209
210 <para>
211 To automatically start the <command>power-profiles-daemon</command> when the
212 system is rebooted, install the
213 <filename>/etc/rc.d/init.d/power-profiles-daemon</filename> bootscript from the
[f1e2498]214 <xref linkend="bootscripts" revision="sysv"/> as the
[16d42f6]215 <systemitem class="username">root</systemitem> user:
216 </para>
217
218 <indexterm zone="power-profiles-daemon power-profiles-daemon-init">
219 <primary sortas="f-Power-profiles-daemon">power-profiles-daemon</primary>
220 </indexterm>
221
222<screen role="root"><userinput>make install-power-profiles-daemon</userinput></screen>
223 </sect3>
224
225
226 <sect3 id="power-profiles-daemon-systemd" revision="systemd">
227 <title>Systemd Unit</title>
228
229 <para>
230 To start the power-profiles-daemon on boot, enable the systemd
231 service that was installed by running the following command as the
232 <systemitem class="username">root</systemitem> user:
233 </para>
234
235 <screen role="root"><userinput>systemctl enable power-profiles-daemon</userinput></screen>
236 </sect3>
237
[e8b98762]238 <sect3>
239 <title>Select a Power Profile</title>
240
241 <para>
242 To list all supported power profiles, issue:
243 </para>
244
245 <screen role="nodump"><userinput>powerprofilesctl</userinput></screen>
246
247 <para>
248 To activate a power profile (for example
249 <replaceable>performance</replaceable>), issue:
250 </para>
251
252 <screen role="nodump"><userinput>powerprofilesctl set <replaceable>performance</replaceable></userinput></screen>
253
254 <para>
255 Some desktop environments (for example GNOME and KDE) also provide
256 a graphical interface to interact with
257 <command>power-profiles-daemon</command> and activate a power
258 profile.
259 </para>
260
261 <para>
262 The activated power profile is automatically stored in
263 <filename>/var/lib/power-profiles-daemon/state.ini</filename> and
264 <command>power-profiles-daemon</command> will read it out and
265 activate it again on the next boot if the
266 <phrase revision='sysv'>bootscript is
267 installed</phrase><phrase revision='systemd'>Systemd
268 unit is enabled</phrase> as above.
269 </para>
270 </sect3>
271
[16d42f6]272 </sect2>
273
274
275
276 <sect2 role="content">
277 <title>Contents</title>
278
279 <segmentedlist>
280 <segtitle>Installed Program</segtitle>
281 <segtitle>Installed Libraries</segtitle>
282 <segtitle>Installed Directories</segtitle>
283
284 <seglistitem>
285 <seg>
[f1e2498]286 powerprofilesctl
[16d42f6]287 </seg>
288 <seg>
[f1e2498]289 None
[16d42f6]290 </seg>
291 <seg>
[f1e2498]292 None
[16d42f6]293 </seg>
294 </seglistitem>
295 </segmentedlist>
296
297 <variablelist>
298 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
299 <?dbfo list-presentation="list"?>
300 <?dbhtml list-presentation="table"?>
301
302 <varlistentry id="powerprofilesctl">
303 <term><command>powerprofilesctl</command></term>
304 <listitem>
305 <para>
[8b5da84]306 This allows the user to set the power governor of the
[f1e2498]307 CPU.
[16d42f6]308 </para>
309 <indexterm zone="powerprofilesctl">
310 <primary sortas="b-powerprofilesctl">powerprofilesctl</primary>
311 </indexterm>
312 </listitem>
313 </varlistentry>
314
315 </variablelist>
316 </sect2>
317</sect1>
Note: See TracBrowser for help on using the repository browser.