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

lazarus trunk
Last change on this file since f403a76a was e5fa35a, checked in by Bruce Dubbs <bdubbs@…>, 3 months ago

Adjust power-profiles-daemon dependencies.

  • Property mode set to 100644
File size: 8.2 KB
Line 
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 " ">
13 <!ENTITY power-profiles-daemon-md5sum "92df21de1148ef6e7c30e4a0829e02b1">
14 <!ENTITY power-profiles-daemon-size "68 KB">
15 <!ENTITY power-profiles-daemon-buildsize "1.4 MB">
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
36 or performance CPU governors through dbus.
37 </para>
38
39 &lfs121_checked;
40
41 <bridgehead renderas="sect3">Package Information</bridgehead>
42 <itemizedlist spacing="compact">
43 <listitem>
44 <para>
45 Download (HTTP): <ulink url="&power-profiles-daemon-download-http;"/>
46 </para>
47 </listitem>
48 <listitem>
49 <para>
50 Download (FTP): <ulink url="&power-profiles-daemon-download-ftp;"/>
51 </para>
52 </listitem>
53 <listitem>
54 <para>
55 Download MD5 sum: &power-profiles-daemon-md5sum;
56 </para>
57 </listitem>
58 <listitem>
59 <para>
60 Download size: &power-profiles-daemon-size;
61 </para>
62 </listitem>
63 <listitem>
64 <para>
65 Estimated disk space required: &power-profiles-daemon-buildsize;
66 </para>
67 </listitem>
68 <listitem>
69 <para>
70 Estimated build time: &power-profiles-daemon-time;
71 </para>
72 </listitem>
73 </itemizedlist>
74
75 <bridgehead renderas="sect3">Power-profiles-daemon Dependencies</bridgehead>
76
77 <bridgehead renderas="sect4">Required</bridgehead>
78 <para role="required">
79 <xref linkend="polkit"/>,
80 <xref linkend="pygobject3"/>, and
81 <xref linkend="upower"/>,
82 </para>
83
84 <bridgehead renderas="sect4">Optional</bridgehead>
85 <para role="optional">
86 <xref linkend="gtk-doc"/>,
87 The rest are for the tests,
88 <xref linkend="python-dbusmock"/>,
89 <xref linkend="umockdev"/>,
90 <ulink url="https://github.com/PyCQA/isort">isort</ulink>, and
91 <ulink url="https://github.com/PyCQA/mccabe">mccabe</ulink>
92 </para>
93 </sect2>
94
95 <sect2 role="kernel" id="power-profiles-daemon-kernel">
96 <title>Kernel Configuration</title>
97
98 <para>
99 Enable the following options in the kernel configuration and recompile the
100 kernel if necessary:
101 </para>
102
103 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
104 href="power-profiles-daemon-kernel.xml"/>
105
106 <para>
107 Select the appropriate sub-options that appear when the above options are
108 selected. As much as possible, the layout should be the same as in
109 kernel configuration menus.
110 </para>
111
112 <indexterm zone="power-profiles-daemon power-profiles-daemon-kernel">
113 <primary sortas="d-Power-profiles-daemon">Power-profiles-daemon</primary>
114 </indexterm>
115 </sect2>
116
117 <sect2 role="installation">
118 <title>Installation of Power-profiles-daemon</title>
119
120 <para>
121 Install <application>Power-profiles-daemon</application> by
122 running the following commands:
123 </para>
124<screen revision="sysv"><userinput>mkdir build &amp;&amp;
125cd build &amp;&amp;
126
127meson setup \
128 --prefix=/usr \
129 --buildtype=release \
130 -Dgtk_doc=false \
131 -Dtests=false \
132 -Dsystemdsystemunitdir=/tmp \
133 .. &amp;&amp;
134ninja</userinput></screen>
135
136
137<screen revision="systemd"><userinput>mkdir build &amp;&amp;
138cd build &amp;&amp;
139
140meson setup \
141 --prefix=/usr \
142 --buildtype=release \
143 -Dgtk_doc=false \
144 -Dtests=false \
145 .. &amp;&amp;
146ninja</userinput></screen>
147
148 <para>
149 If you have installed the external dependencies, to test the results issue: <command>
150 ninja test</command>.
151 </para>
152
153 <para>
154 Now, as the <systemitem class="username">root</systemitem> user:
155 </para>
156
157<screen role="root"><userinput>ninja install</userinput></screen>
158
159 <para>
160 Now, clean up an unneeded systemd unit installed into /tmp:
161 </para>
162
163<screen revision="sysv" role="root">
164<userinput>rm -fv /tmp/power-profiles-daemon.service</userinput>
165</screen>
166
167 </sect2>
168
169
170 <sect2 role="commands">
171 <title>Command Explanations</title>
172
173 <para>
174 <parameter>-Dgtk_doc=false</parameter>: Prevents building the
175 documentation. Remove this if you have <application>GTK-Doc</application>
176 installed and wish to build the documentation.
177 </para>
178
179 <para>
180 <parameter>-Dtests=false</parameter>: Prevents building the
181 tests because they cannot be run within the boundaries of
182 BLFS. Remove this if you have installed the external dependencies
183 and wish to run the tests.
184 </para>
185
186 <para revision="sysv">
187 <parameter>-Dsystemdsystemunitdir=/tmp</parameter>: Removes
188 the dependency on <application>systemd</application>.
189 </para>
190
191 </sect2>
192
193 <sect2 role="configuration">
194 <title>Configuring Power-profiles-daemon</title>
195
196 <sect3 id="power-profiles-daemon-init" revision="sysv">
197 <title>Boot Script</title>
198
199 <para>
200 To automatically start the <command>power-profiles-daemon</command> when the
201 system is rebooted, install the
202 <filename>/etc/rc.d/init.d/power-profiles-daemon</filename> bootscript from the
203 <xref linkend="bootscripts" revision="sysv"/> as the
204 <systemitem class="username">root</systemitem> user:
205 </para>
206
207 <indexterm zone="power-profiles-daemon power-profiles-daemon-init">
208 <primary sortas="f-Power-profiles-daemon">power-profiles-daemon</primary>
209 </indexterm>
210
211<screen role="root"><userinput>make install-power-profiles-daemon</userinput></screen>
212 </sect3>
213
214
215 <sect3 id="power-profiles-daemon-systemd" revision="systemd">
216 <title>Systemd Unit</title>
217
218 <para>
219 To start the power-profiles-daemon on boot, enable the systemd
220 service that was installed by running the following command as the
221 <systemitem class="username">root</systemitem> user:
222 </para>
223
224 <screen role="root"><userinput>systemctl enable power-profiles-daemon</userinput></screen>
225 </sect3>
226
227 </sect2>
228
229
230
231 <sect2 role="content">
232 <title>Contents</title>
233
234 <segmentedlist>
235 <segtitle>Installed Program</segtitle>
236 <segtitle>Installed Libraries</segtitle>
237 <segtitle>Installed Directories</segtitle>
238
239 <seglistitem>
240 <seg>
241 powerprofilesctl
242 </seg>
243 <seg>
244 None
245 </seg>
246 <seg>
247 None
248 </seg>
249 </seglistitem>
250 </segmentedlist>
251
252 <variablelist>
253 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
254 <?dbfo list-presentation="list"?>
255 <?dbhtml list-presentation="table"?>
256
257 <varlistentry id="powerprofilesctl">
258 <term><command>powerprofilesctl</command></term>
259 <listitem>
260 <para>
261 This allows the user to set the power governor of the
262 CPU.
263 </para>
264 <indexterm zone="powerprofilesctl">
265 <primary sortas="b-powerprofilesctl">powerprofilesctl</primary>
266 </indexterm>
267 </listitem>
268 </varlistentry>
269
270 </variablelist>
271 </sect2>
272</sect1>
Note: See TracBrowser for help on using the repository browser.