| 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 -k check</userinput></screen>
|
|---|
| 76 |
|
|---|
| 77 | <para>One test named
|
|---|
| 78 | <literal>ps with output flag bsdtime,cputime,etime,etimes</literal>
|
|---|
| 79 | is known to fail if the host kernel is not built with
|
|---|
| 80 | <literal>CONFIG_BSD_PROCESS_ACCT</literal> enabled.
|
|---|
| 81 | <!-- These two tests just do not work as root but they seem to pass
|
|---|
| 82 | in most time due to some internal hazards of Tcl/Expect/DejaGNU
|
|---|
| 83 | framework. However the failures have been really observed.
|
|---|
| 84 | TODO: run the test suite as tester after the freeze ends. -->
|
|---|
| 85 | Two tests named
|
|---|
| 86 | <literal>pmap X with unreachable process</literal> and
|
|---|
| 87 | <literal>pmap XX with unreachable process</literal> are known to
|
|---|
| 88 | fail occasionally.</para>
|
|---|
| 89 |
|
|---|
| 90 | <para>Install the package:</para>
|
|---|
| 91 |
|
|---|
| 92 | <screen><userinput remap="install">make install</userinput></screen>
|
|---|
| 93 |
|
|---|
| 94 | </sect2>
|
|---|
| 95 |
|
|---|
| 96 | <sect2 id="contents-procps" role="content">
|
|---|
| 97 | <title>Contents of Procps-ng</title>
|
|---|
| 98 |
|
|---|
| 99 | <segmentedlist>
|
|---|
| 100 | <segtitle>Installed programs</segtitle>
|
|---|
| 101 | <segtitle>Installed library</segtitle>
|
|---|
| 102 | <segtitle>Installed directories</segtitle>
|
|---|
| 103 |
|
|---|
| 104 | <seglistitem>
|
|---|
| 105 | <seg>free, pgrep, pidof, pkill, pmap, ps, pwdx, slabtop,
|
|---|
| 106 | sysctl, tload, top, uptime, vmstat, w, and watch</seg>
|
|---|
| 107 | <seg>libproc-2.so</seg>
|
|---|
| 108 | <seg>/usr/include/procps and /usr/share/doc/procps-ng-&procps-ng-version;</seg>
|
|---|
| 109 | </seglistitem>
|
|---|
| 110 | </segmentedlist>
|
|---|
| 111 |
|
|---|
| 112 | <variablelist>
|
|---|
| 113 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
|---|
| 114 | <?dbfo list-presentation="list"?>
|
|---|
| 115 | <?dbhtml list-presentation="table"?>
|
|---|
| 116 |
|
|---|
| 117 | <varlistentry id="free">
|
|---|
| 118 | <term><command>free</command></term>
|
|---|
| 119 | <listitem>
|
|---|
| 120 | <para>Reports the amount of free and used memory (both physical and
|
|---|
| 121 | swap memory) in the system</para>
|
|---|
| 122 | <indexterm zone="ch-system-procps free">
|
|---|
| 123 | <primary sortas="b-free">free</primary>
|
|---|
| 124 | </indexterm>
|
|---|
| 125 | </listitem>
|
|---|
| 126 | </varlistentry>
|
|---|
| 127 |
|
|---|
| 128 | <varlistentry id="pgrep">
|
|---|
| 129 | <term><command>pgrep</command></term>
|
|---|
| 130 | <listitem>
|
|---|
| 131 | <para>Looks up processes based on their name and other attributes</para>
|
|---|
| 132 | <indexterm zone="ch-system-procps pgrep">
|
|---|
| 133 | <primary sortas="b-pgrep">pgrep</primary>
|
|---|
| 134 | </indexterm>
|
|---|
| 135 | </listitem>
|
|---|
| 136 | </varlistentry>
|
|---|
| 137 |
|
|---|
| 138 | <varlistentry id="pidof">
|
|---|
| 139 | <term><command>pidof</command></term>
|
|---|
| 140 | <listitem>
|
|---|
| 141 | <para>Reports the PIDs of the given programs</para>
|
|---|
| 142 | <indexterm zone="ch-system-procps pidof">
|
|---|
| 143 | <primary sortas="b-pidof">pidof</primary>
|
|---|
| 144 | </indexterm>
|
|---|
| 145 | </listitem>
|
|---|
| 146 | </varlistentry>
|
|---|
| 147 |
|
|---|
| 148 | <varlistentry id="pkill">
|
|---|
| 149 | <term><command>pkill</command></term>
|
|---|
| 150 | <listitem>
|
|---|
| 151 | <para>Signals processes based on their name and other attributes</para>
|
|---|
| 152 | <indexterm zone="ch-system-procps pkill">
|
|---|
| 153 | <primary sortas="b-pkill">pkill</primary>
|
|---|
| 154 | </indexterm>
|
|---|
| 155 | </listitem>
|
|---|
| 156 | </varlistentry>
|
|---|
| 157 |
|
|---|
| 158 | <varlistentry id="pmap">
|
|---|
| 159 | <term><command>pmap</command></term>
|
|---|
| 160 | <listitem>
|
|---|
| 161 | <para>Reports the memory map of the given process</para>
|
|---|
| 162 | <indexterm zone="ch-system-procps pmap">
|
|---|
| 163 | <primary sortas="b-pmap">pmap</primary>
|
|---|
| 164 | </indexterm>
|
|---|
| 165 | </listitem>
|
|---|
| 166 | </varlistentry>
|
|---|
| 167 |
|
|---|
| 168 | <varlistentry id="ps">
|
|---|
| 169 | <term><command>ps</command></term>
|
|---|
| 170 | <listitem>
|
|---|
| 171 | <para>Lists the current running processes</para>
|
|---|
| 172 | <indexterm zone="ch-system-procps ps">
|
|---|
| 173 | <primary sortas="b-ps">ps</primary>
|
|---|
| 174 | </indexterm>
|
|---|
| 175 | </listitem>
|
|---|
| 176 | </varlistentry>
|
|---|
| 177 |
|
|---|
| 178 | <!-- <varlistentry id="pwait">
|
|---|
| 179 | <term><command>pwait</command></term>
|
|---|
| 180 | <listitem>
|
|---|
| 181 | <para>Waits for a process to finish before executing.</para>
|
|---|
| 182 | <indexterm zone="ch-system-procps pwait">
|
|---|
| 183 | <primary sortas="b-pwait">pwait</primary>
|
|---|
| 184 | </indexterm>
|
|---|
| 185 | </listitem>
|
|---|
| 186 | </varlistentry> This program no longer exists;
|
|---|
| 187 | it's already been removed from the Installed programs list. -->
|
|---|
| 188 |
|
|---|
| 189 | <varlistentry id="pwdx">
|
|---|
| 190 | <term><command>pwdx</command></term>
|
|---|
| 191 | <listitem>
|
|---|
| 192 | <para>Reports the current working directory of a process</para>
|
|---|
| 193 | <indexterm zone="ch-system-procps pwdx">
|
|---|
| 194 | <primary sortas="b-pwdx">pwdx</primary>
|
|---|
| 195 | </indexterm>
|
|---|
| 196 | </listitem>
|
|---|
| 197 | </varlistentry>
|
|---|
| 198 |
|
|---|
| 199 | <varlistentry id="slabtop">
|
|---|
| 200 | <term><command>slabtop</command></term>
|
|---|
| 201 | <listitem>
|
|---|
| 202 | <para>Displays detailed kernel slab cache information in real time</para>
|
|---|
| 203 | <indexterm zone="ch-system-procps slabtop">
|
|---|
| 204 | <primary sortas="b-slabtop">slabtop</primary>
|
|---|
| 205 | </indexterm>
|
|---|
| 206 | </listitem>
|
|---|
| 207 | </varlistentry>
|
|---|
| 208 |
|
|---|
| 209 | <varlistentry id="sysctl">
|
|---|
| 210 | <term><command>sysctl</command></term>
|
|---|
| 211 | <listitem>
|
|---|
| 212 | <para>Modifies kernel parameters at run time</para>
|
|---|
| 213 | <indexterm zone="ch-system-procps sysctl">
|
|---|
| 214 | <primary sortas="b-sysctl">sysctl</primary>
|
|---|
| 215 | </indexterm>
|
|---|
| 216 | </listitem>
|
|---|
| 217 | </varlistentry>
|
|---|
| 218 |
|
|---|
| 219 | <varlistentry id="tload">
|
|---|
| 220 | <term><command>tload</command></term>
|
|---|
| 221 | <listitem>
|
|---|
| 222 | <para>Prints a graph of the current system load average</para>
|
|---|
| 223 | <indexterm zone="ch-system-procps tload">
|
|---|
| 224 | <primary sortas="b-tload">tload</primary>
|
|---|
| 225 | </indexterm>
|
|---|
| 226 | </listitem>
|
|---|
| 227 | </varlistentry>
|
|---|
| 228 |
|
|---|
| 229 | <varlistentry id="top">
|
|---|
| 230 | <term><command>top</command></term>
|
|---|
| 231 | <listitem>
|
|---|
| 232 | <para>Displays a list of the most CPU intensive processes; it
|
|---|
| 233 | provides an ongoing look at processor activity in real time</para>
|
|---|
| 234 | <indexterm zone="ch-system-procps top">
|
|---|
| 235 | <primary sortas="b-top">top</primary>
|
|---|
| 236 | </indexterm>
|
|---|
| 237 | </listitem>
|
|---|
| 238 | </varlistentry>
|
|---|
| 239 |
|
|---|
| 240 | <varlistentry id="uptime">
|
|---|
| 241 | <term><command>uptime</command></term>
|
|---|
| 242 | <listitem>
|
|---|
| 243 | <para>Reports how long the system has been running, how many users are
|
|---|
| 244 | logged on, and the system load averages</para>
|
|---|
| 245 | <indexterm zone="ch-system-procps uptime">
|
|---|
| 246 | <primary sortas="b-uptime">uptime</primary>
|
|---|
| 247 | </indexterm>
|
|---|
| 248 | </listitem>
|
|---|
| 249 | </varlistentry>
|
|---|
| 250 |
|
|---|
| 251 | <varlistentry id="vmstat">
|
|---|
| 252 | <term><command>vmstat</command></term>
|
|---|
| 253 | <listitem>
|
|---|
| 254 | <para>Reports virtual memory statistics, giving information about
|
|---|
| 255 | processes, memory, paging, block Input/Output (IO), traps, and CPU
|
|---|
| 256 | activity</para>
|
|---|
| 257 | <indexterm zone="ch-system-procps vmstat">
|
|---|
| 258 | <primary sortas="b-vmstat">vmstat</primary>
|
|---|
| 259 | </indexterm>
|
|---|
| 260 | </listitem>
|
|---|
| 261 | </varlistentry>
|
|---|
| 262 |
|
|---|
| 263 | <varlistentry id="w">
|
|---|
| 264 | <term><command>w</command></term>
|
|---|
| 265 | <listitem>
|
|---|
| 266 | <para>Shows which users are currently logged on, where, and since
|
|---|
| 267 | when</para>
|
|---|
| 268 | <indexterm zone="ch-system-procps w">
|
|---|
| 269 | <primary sortas="b-w">w</primary>
|
|---|
| 270 | </indexterm>
|
|---|
| 271 | </listitem>
|
|---|
| 272 | </varlistentry>
|
|---|
| 273 |
|
|---|
| 274 | <varlistentry id="watch">
|
|---|
| 275 | <term><command>watch</command></term>
|
|---|
| 276 | <listitem>
|
|---|
| 277 | <para>Runs a given command repeatedly, displaying the first
|
|---|
| 278 | screen-full of its output; this allows a user to watch the output
|
|---|
| 279 | change over time</para>
|
|---|
| 280 | <indexterm zone="ch-system-procps watch">
|
|---|
| 281 | <primary sortas="b-watch">watch</primary>
|
|---|
| 282 | </indexterm>
|
|---|
| 283 | </listitem>
|
|---|
| 284 | </varlistentry>
|
|---|
| 285 |
|
|---|
| 286 | <varlistentry id="libproc-2">
|
|---|
| 287 | <term><filename class="libraryfile">libproc-2</filename></term>
|
|---|
| 288 | <listitem>
|
|---|
| 289 | <para>Contains the functions used by most programs in this
|
|---|
| 290 | package</para>
|
|---|
| 291 | <indexterm zone="ch-system-procps libproc-2">
|
|---|
| 292 | <primary sortas="c-libproc-2">libproc-2</primary>
|
|---|
| 293 | </indexterm>
|
|---|
| 294 | </listitem>
|
|---|
| 295 | </varlistentry>
|
|---|
| 296 |
|
|---|
| 297 | </variablelist>
|
|---|
| 298 |
|
|---|
| 299 | </sect2>
|
|---|
| 300 |
|
|---|
| 301 | </sect1>
|
|---|
