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