BOOK/chapter06/procps.xml

   1 <?xml version="1.0" encoding="ISO-8859-1"?>
   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-ch6-sbu;</seg>
  34         <seg>&procps-ng-ch6-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             --exec-prefix=                           \
  47             --libdir=/usr/lib                        \
  48             --docdir=/usr/share/doc/procps-ng-&procps-ng-version; \
  49             --disable-static                         \
  50             --disable-kill</userinput></screen>
  51
  52 <screen revision="systemd"><userinput remap="configure">./configure --prefix=/usr                            \
  53             --exec-prefix=                           \
  54             --libdir=/usr/lib                        \
  55             --docdir=/usr/share/doc/procps-ng-&procps-ng-version; \
  56             --disable-static                         \
  57             --disable-kill                           \
  58             --with-systemd</userinput></screen>
  59
  60     <variablelist>
  61       <title>The meaning of the configure options:</title>
  62
  63       <varlistentry>
  64         <term><parameter>--disable-kill</parameter></term>
  65         <listitem>
  66           <para>This switch disables building the <command>kill</command>
  67           command that will be installed by the Util-linux package.</para>
  68         </listitem>
  69       </varlistentry>
  70     </variablelist>
  71
  72     <para>Compile the package:</para>
  73
  74 <screen><userinput remap="make">make</userinput></screen>
  75
  76     <para>The test suite needs some custom modifications for LFS.
  77     Remove a test that fails when scripting does not use a tty device and
  78     fix two others.
  79     To run the test suite, run the following commands:</para>
  80
  81 <screen><userinput remap="test">sed -i -r 's|(pmap_initname)\\\$|\1|' testsuite/pmap.test/pmap.exp
  82 sed -i '/set tty/d' testsuite/pkill.test/pkill.exp
  83 rm testsuite/pgrep.test/pgrep.exp
  84 make check</userinput></screen>
  85
  86     <para>Install the package:</para>
  87
  88 <screen><userinput remap="install">make install</userinput></screen>
  89
  90 <para>Finally, move essential libraries to a location that can be found if
  91 <filename class="directory">/usr</filename> is not mounted.</para>
  92
  93 <screen><userinput remap="install">mv -v /usr/lib/libprocps.so.* /lib
  94 ln -sfv ../../lib/$(readlink /usr/lib/libprocps.so) /usr/lib/libprocps.so</userinput></screen>
  95
  96   </sect2>
  97
  98   <sect2 id="contents-procps" role="content">
  99     <title>Contents of Procps-ng</title>
 100
 101     <segmentedlist>
 102       <segtitle>Installed programs</segtitle>
 103       <segtitle>Installed library</segtitle>
 104       <segtitle>Installed directories</segtitle>
 105
 106       <seglistitem>
 107         <seg>free, pgrep, pidof, pkill, pmap, ps, pwdx, slabtop,
 108         sysctl, tload, top, uptime, vmstat, w, and watch</seg>
 109         <seg>libprocps.so</seg>
 110         <seg>/usr/include/proc and /usr/share/doc/procps-ng-&procps-ng-version;</seg>
 111       </seglistitem>
 112     </segmentedlist>
 113
 114     <variablelist>
 115       <bridgehead renderas="sect3">Short Descriptions</bridgehead>
 116       <?dbfo list-presentation="list"?>
 117       <?dbhtml list-presentation="table"?>
 118
 119       <varlistentry id="free">
 120         <term><command>free</command></term>
 121         <listitem>
 122           <para>Reports the amount of free and used memory (both physical and
 123           swap memory) in the system</para>
 124           <indexterm zone="ch-system-procps free">
 125             <primary sortas="b-free">free</primary>
 126           </indexterm>
 127         </listitem>
 128       </varlistentry>
 129
 130       <varlistentry id="pgrep">
 131         <term><command>pgrep</command></term>
 132         <listitem>
 133           <para>Looks up processes based on their name and other attributes</para>
 134           <indexterm zone="ch-system-procps pgrep">
 135             <primary sortas="b-pgrep">pgrep</primary>
 136           </indexterm>
 137         </listitem>
 138       </varlistentry>
 139
 140       <varlistentry id="pidof">
 141         <term><command>pidof</command></term>
 142         <listitem>
 143           <para>Reports the PIDs of the given programs</para>
 144           <indexterm zone="ch-system-procps pidof">
 145             <primary sortas="b-pidof">pidof</primary>
 146           </indexterm>
 147         </listitem>
 148       </varlistentry>
 149
 150       <varlistentry id="pkill">
 151         <term><command>pkill</command></term>
 152         <listitem>
 153           <para>Signals processes based on their name and other attributes</para>
 154           <indexterm zone="ch-system-procps pkill">
 155             <primary sortas="b-pkill">pkill</primary>
 156           </indexterm>
 157         </listitem>
 158       </varlistentry>
 159
 160       <varlistentry id="pmap">
 161         <term><command>pmap</command></term>
 162         <listitem>
 163           <para>Reports the memory map of the given process</para>
 164           <indexterm zone="ch-system-procps pmap">
 165             <primary sortas="b-pmap">pmap</primary>
 166           </indexterm>
 167         </listitem>
 168       </varlistentry>
 169
 170       <varlistentry id="ps">
 171         <term><command>ps</command></term>
 172         <listitem>
 173           <para>Lists the current running processes</para>
 174           <indexterm zone="ch-system-procps ps">
 175             <primary sortas="b-ps">ps</primary>
 176           </indexterm>
 177         </listitem>
 178       </varlistentry>
 179
 180       <varlistentry id="pwdx">
 181         <term><command>pwdx</command></term>
 182         <listitem>
 183           <para>Reports the current working directory of a process</para>
 184           <indexterm zone="ch-system-procps pwdx">
 185             <primary sortas="b-pwdx">pwdx</primary>
 186           </indexterm>
 187         </listitem>
 188       </varlistentry>
 189
 190       <varlistentry id="slabtop">
 191         <term><command>slabtop</command></term>
 192         <listitem>
 193           <para>Displays detailed kernel slab cache information in real time</para>
 194           <indexterm zone="ch-system-procps slabtop">
 195             <primary sortas="b-slabtop">slabtop</primary>
 196           </indexterm>
 197         </listitem>
 198       </varlistentry>
 199
 200       <varlistentry id="sysctl">
 201         <term><command>sysctl</command></term>
 202         <listitem>
 203           <para>Modifies kernel parameters at run time</para>
 204           <indexterm zone="ch-system-procps sysctl">
 205             <primary sortas="b-sysctl">sysctl</primary>
 206           </indexterm>
 207         </listitem>
 208       </varlistentry>
 209
 210       <varlistentry id="tload">
 211         <term><command>tload</command></term>
 212         <listitem>
 213           <para>Prints a graph of the current system load average</para>
 214           <indexterm zone="ch-system-procps tload">
 215             <primary sortas="b-tload">tload</primary>
 216           </indexterm>
 217         </listitem>
 218       </varlistentry>
 219
 220       <varlistentry id="top">
 221         <term><command>top</command></term>
 222         <listitem>
 223           <para>Displays a list of the most CPU intensive processes; it
 224           provides an ongoing look at processor activity in real time</para>
 225           <indexterm zone="ch-system-procps top">
 226             <primary sortas="b-top">top</primary>
 227           </indexterm>
 228         </listitem>
 229       </varlistentry>
 230
 231       <varlistentry id="uptime">
 232         <term><command>uptime</command></term>
 233         <listitem>
 234           <para>Reports how long the system has been running, how many users are
 235           logged on, and the system load averages</para>
 236           <indexterm zone="ch-system-procps uptime">
 237             <primary sortas="b-uptime">uptime</primary>
 238           </indexterm>
 239         </listitem>
 240       </varlistentry>
 241
 242       <varlistentry id="vmstat">
 243         <term><command>vmstat</command></term>
 244         <listitem>
 245           <para>Reports virtual memory statistics, giving information about
 246           processes, memory, paging, block Input/Output (IO), traps, and CPU
 247           activity</para>
 248           <indexterm zone="ch-system-procps vmstat">
 249             <primary sortas="b-vmstat">vmstat</primary>
 250           </indexterm>
 251         </listitem>
 252       </varlistentry>
 253
 254       <varlistentry id="w">
 255         <term><command>w</command></term>
 256         <listitem>
 257           <para>Shows which users are currently logged on, where, and since
 258           when</para>
 259           <indexterm zone="ch-system-procps w">
 260             <primary sortas="b-w">w</primary>
 261           </indexterm>
 262         </listitem>
 263       </varlistentry>
 264
 265       <varlistentry id="watch">
 266         <term><command>watch</command></term>
 267         <listitem>
 268           <para>Runs a given command repeatedly, displaying the first
 269           screen-full of its output; this allows a user to watch the output
 270           change over time</para>
 271           <indexterm zone="ch-system-procps watch">
 272             <primary sortas="b-watch">watch</primary>
 273           </indexterm>
 274         </listitem>
 275       </varlistentry>
 276
 277       <varlistentry id="libprocps">
 278         <term><filename class="libraryfile">libprocps</filename></term>
 279         <listitem>
 280           <para>Contains the functions used by most programs in this
 281           package</para>
 282           <indexterm zone="ch-system-procps libprocps">
 283             <primary sortas="c-libprocps">libprocps</primary>
 284           </indexterm>
 285         </listitem>
 286       </varlistentry>
 287
 288     </variablelist>
 289
 290   </sect2>
 291
 292 </sect1>