source: chapter08/procps.xml@ 141a1fa

12.1 multilib trunk xry111/arm64 xry111/loongarch xry111/loongarch-12.1 xry111/mips64el
Last change on this file since 141a1fa was 28614cdd, checked in by Bruce Dubbs <bdubbs@…>, 4 months ago

Update descriptions for some test failures.

  • Property mode set to 100644
File size: 9.6 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
8<sect1 id="ch-system-procps" role="wrap">
9 <?dbhtml filename="procps-ng.html"?>
10
11 <sect1info condition="script">
12 <productname>procps-ng</productname>
13 <productnumber>&procps-ng-version;</productnumber>
14 <address>&procps-ng-url;</address>
15 </sect1info>
16
17 <title>Procps-ng-&procps-ng-version;</title>
18
19 <indexterm zone="ch-system-procps">
20 <primary sortas="a-Procps">Procps-ng</primary>
21 </indexterm>
22
23 <sect2 role="package">
24 <title/>
25
26 <para>The Procps-ng package contains programs for monitoring processes.</para>
27
28 <segmentedlist>
29 <segtitle>&buildtime;</segtitle>
30 <segtitle>&diskspace;</segtitle>
31
32 <seglistitem>
33 <seg>&procps-ng-fin-sbu;</seg>
34 <seg>&procps-ng-fin-du;</seg>
35 </seglistitem>
36 </segmentedlist>
37
38 </sect2>
39
40 <sect2 role="installation">
41 <title>Installation of Procps-ng</title>
42
43 <para>Prepare Procps-ng for compilation:</para>
44
45<screen revision="sysv"><userinput remap="configure">./configure --prefix=/usr \
46 --docdir=/usr/share/doc/procps-ng-&procps-ng-version; \
47 --disable-static \
48 --disable-kill</userinput></screen>
49
50<screen revision="systemd"><userinput remap="configure">./configure --prefix=/usr \
51 --docdir=/usr/share/doc/procps-ng-&procps-ng-version; \
52 --disable-static \
53 --disable-kill \
54 --with-systemd</userinput></screen>
55
56 <variablelist>
57 <title>The meaning of the configure option:</title>
58
59 <varlistentry>
60 <term><parameter>--disable-kill</parameter></term>
61 <listitem>
62 <para>This switch disables building the <command>kill</command>
63 command; it will be installed from the Util-linux package.</para>
64 </listitem>
65 </varlistentry>
66 </variablelist>
67
68 <para>Compile the package:</para>
69
70<screen revision='sysv'><userinput remap="make">make</userinput></screen>
71<screen revision='systemd'><userinput remap="make">make src_w_LDADD='$(LDADD) -lsystemd'</userinput></screen>
72
73 <para> To run the test suite, run:</para>
74
75<screen><userinput remap="test">make check</userinput></screen>
76
77 <para>One test in the "ps" tests is known to fail.</para>
78
79 <para>Install the package:</para>
80
81<screen><userinput remap="install">make install</userinput></screen>
82
83 </sect2>
84
85 <sect2 id="contents-procps" role="content">
86 <title>Contents of Procps-ng</title>
87
88 <segmentedlist>
89 <segtitle>Installed programs</segtitle>
90 <segtitle>Installed library</segtitle>
91 <segtitle>Installed directories</segtitle>
92
93 <seglistitem>
94 <seg>free, pgrep, pidof, pkill, pmap, ps, pwdx, slabtop,
95 sysctl, tload, top, uptime, vmstat, w, and watch</seg>
96 <seg>libproc-2.so</seg>
97 <seg>/usr/include/procps and /usr/share/doc/procps-ng-&procps-ng-version;</seg>
98 </seglistitem>
99 </segmentedlist>
100
101 <variablelist>
102 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
103 <?dbfo list-presentation="list"?>
104 <?dbhtml list-presentation="table"?>
105
106 <varlistentry id="free">
107 <term><command>free</command></term>
108 <listitem>
109 <para>Reports the amount of free and used memory (both physical and
110 swap memory) in the system</para>
111 <indexterm zone="ch-system-procps free">
112 <primary sortas="b-free">free</primary>
113 </indexterm>
114 </listitem>
115 </varlistentry>
116
117 <varlistentry id="pgrep">
118 <term><command>pgrep</command></term>
119 <listitem>
120 <para>Looks up processes based on their name and other attributes</para>
121 <indexterm zone="ch-system-procps pgrep">
122 <primary sortas="b-pgrep">pgrep</primary>
123 </indexterm>
124 </listitem>
125 </varlistentry>
126
127 <varlistentry id="pidof">
128 <term><command>pidof</command></term>
129 <listitem>
130 <para>Reports the PIDs of the given programs</para>
131 <indexterm zone="ch-system-procps pidof">
132 <primary sortas="b-pidof">pidof</primary>
133 </indexterm>
134 </listitem>
135 </varlistentry>
136
137 <varlistentry id="pkill">
138 <term><command>pkill</command></term>
139 <listitem>
140 <para>Signals processes based on their name and other attributes</para>
141 <indexterm zone="ch-system-procps pkill">
142 <primary sortas="b-pkill">pkill</primary>
143 </indexterm>
144 </listitem>
145 </varlistentry>
146
147 <varlistentry id="pmap">
148 <term><command>pmap</command></term>
149 <listitem>
150 <para>Reports the memory map of the given process</para>
151 <indexterm zone="ch-system-procps pmap">
152 <primary sortas="b-pmap">pmap</primary>
153 </indexterm>
154 </listitem>
155 </varlistentry>
156
157 <varlistentry id="ps">
158 <term><command>ps</command></term>
159 <listitem>
160 <para>Lists the current running processes</para>
161 <indexterm zone="ch-system-procps ps">
162 <primary sortas="b-ps">ps</primary>
163 </indexterm>
164 </listitem>
165 </varlistentry>
166
167 <!-- <varlistentry id="pwait">
168 <term><command>pwait</command></term>
169 <listitem>
170 <para>Waits for a process to finish before executing.</para>
171 <indexterm zone="ch-system-procps pwait">
172 <primary sortas="b-pwait">pwait</primary>
173 </indexterm>
174 </listitem>
175 </varlistentry> This program no longer exists;
176 it's already been removed from the Installed programs list. -->
177
178 <varlistentry id="pwdx">
179 <term><command>pwdx</command></term>
180 <listitem>
181 <para>Reports the current working directory of a process</para>
182 <indexterm zone="ch-system-procps pwdx">
183 <primary sortas="b-pwdx">pwdx</primary>
184 </indexterm>
185 </listitem>
186 </varlistentry>
187
188 <varlistentry id="slabtop">
189 <term><command>slabtop</command></term>
190 <listitem>
191 <para>Displays detailed kernel slab cache information in real time</para>
192 <indexterm zone="ch-system-procps slabtop">
193 <primary sortas="b-slabtop">slabtop</primary>
194 </indexterm>
195 </listitem>
196 </varlistentry>
197
198 <varlistentry id="sysctl">
199 <term><command>sysctl</command></term>
200 <listitem>
201 <para>Modifies kernel parameters at run time</para>
202 <indexterm zone="ch-system-procps sysctl">
203 <primary sortas="b-sysctl">sysctl</primary>
204 </indexterm>
205 </listitem>
206 </varlistentry>
207
208 <varlistentry id="tload">
209 <term><command>tload</command></term>
210 <listitem>
211 <para>Prints a graph of the current system load average</para>
212 <indexterm zone="ch-system-procps tload">
213 <primary sortas="b-tload">tload</primary>
214 </indexterm>
215 </listitem>
216 </varlistentry>
217
218 <varlistentry id="top">
219 <term><command>top</command></term>
220 <listitem>
221 <para>Displays a list of the most CPU intensive processes; it
222 provides an ongoing look at processor activity in real time</para>
223 <indexterm zone="ch-system-procps top">
224 <primary sortas="b-top">top</primary>
225 </indexterm>
226 </listitem>
227 </varlistentry>
228
229 <varlistentry id="uptime">
230 <term><command>uptime</command></term>
231 <listitem>
232 <para>Reports how long the system has been running, how many users are
233 logged on, and the system load averages</para>
234 <indexterm zone="ch-system-procps uptime">
235 <primary sortas="b-uptime">uptime</primary>
236 </indexterm>
237 </listitem>
238 </varlistentry>
239
240 <varlistentry id="vmstat">
241 <term><command>vmstat</command></term>
242 <listitem>
243 <para>Reports virtual memory statistics, giving information about
244 processes, memory, paging, block Input/Output (IO), traps, and CPU
245 activity</para>
246 <indexterm zone="ch-system-procps vmstat">
247 <primary sortas="b-vmstat">vmstat</primary>
248 </indexterm>
249 </listitem>
250 </varlistentry>
251
252 <varlistentry id="w">
253 <term><command>w</command></term>
254 <listitem>
255 <para>Shows which users are currently logged on, where, and since
256 when</para>
257 <indexterm zone="ch-system-procps w">
258 <primary sortas="b-w">w</primary>
259 </indexterm>
260 </listitem>
261 </varlistentry>
262
263 <varlistentry id="watch">
264 <term><command>watch</command></term>
265 <listitem>
266 <para>Runs a given command repeatedly, displaying the first
267 screen-full of its output; this allows a user to watch the output
268 change over time</para>
269 <indexterm zone="ch-system-procps watch">
270 <primary sortas="b-watch">watch</primary>
271 </indexterm>
272 </listitem>
273 </varlistentry>
274
275 <varlistentry id="libproc-2">
276 <term><filename class="libraryfile">libproc-2</filename></term>
277 <listitem>
278 <para>Contains the functions used by most programs in this
279 package</para>
280 <indexterm zone="ch-system-procps libproc-2">
281 <primary sortas="c-libproc-2">libproc-2</primary>
282 </indexterm>
283 </listitem>
284 </varlistentry>
285
286 </variablelist>
287
288 </sect2>
289
290</sect1>
Note: See TracBrowser for help on using the repository browser.