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.html"?>
  10
  11   <sect1info condition="script">
  12     <productname>procps</productname>
  13     <productnumber>&procps-version;</productnumber>
  14     <address>&procps-url;</address>
  15   </sect1info>
  16
  17   <title>Procps-&procps-version;</title>
  18
  19   <indexterm zone="ch-system-procps">
  20     <primary sortas="a-Procps">Procps</primary>
  21   </indexterm>
  22
  23   <sect2 role="package">
  24     <title/>
  25
  26     <para>The Procps package contains programs for monitoring processes.</para>
  27
  28     <segmentedlist>
  29       <segtitle>&buildtime;</segtitle>
  30       <segtitle>&diskspace;</segtitle>
  31
  32       <seglistitem>
  33         <seg>&procps-ch6-sbu;</seg>
  34         <seg>&procps-ch6-du;</seg>
  35       </seglistitem>
  36     </segmentedlist>
  37
  38   </sect2>
  39
  40   <sect2 role="installation">
  41     <title>Installation of Procps</title>
  42
  43     <para>Apply a patch to prevent an error message from being displayed when
  44     determining the kernel clock tick rate:</para>
  45
  46 <screen><userinput remap="pre">patch -Np1 -i ../&procps-hz_fixes-patch;</userinput></screen>
  47
  48     <para>Apply a patch to fix a unicode related issue in the
  49     <command>watch</command> program:</para>
  50
  51 <screen><userinput remap="pre">patch -Np1 -i ../&procps-watch-patch;</userinput></screen>
  52
  53     <para>Fix a bug in the Makefile, which prevents procps from building with
  54     make-&make-version;:</para>
  55
  56 <screen><userinput remap="pre">sed -i -e 's@\*/module.mk@proc/module.mk ps/module.mk@' Makefile</userinput></screen>
  57
  58     <para>Compile the package:</para>
  59
  60 <screen><userinput remap="make">make</userinput></screen>
  61
  62     <para>This package does not come with a test suite.</para>
  63
  64     <para>Install the package:</para>
  65
  66 <screen><userinput remap="install">make install</userinput></screen>
  67
  68   </sect2>
  69
  70   <sect2 id="contents-procps" role="content">
  71     <title>Contents of Procps</title>
  72
  73     <segmentedlist>
  74       <segtitle>Installed programs</segtitle>
  75       <segtitle>Installed library</segtitle>
  76
  77       <seglistitem>
  78         <seg>free, kill, pgrep, pkill, pmap, ps, pwdx, skill, slabtop, snice,
  79         sysctl, tload, top, uptime, vmstat, w, and watch</seg>
  80         <seg>libproc.so</seg>
  81       </seglistitem>
  82     </segmentedlist>
  83
  84     <variablelist>
  85       <bridgehead renderas="sect3">Short Descriptions</bridgehead>
  86       <?dbfo list-presentation="list"?>
  87       <?dbhtml list-presentation="table"?>
  88
  89       <varlistentry id="free">
  90         <term><command>free</command></term>
  91         <listitem>
  92           <para>Reports the amount of free and used memory (both physical and
  93           swap memory) in the system</para>
  94           <indexterm zone="ch-system-procps free">
  95             <primary sortas="b-free">free</primary>
  96           </indexterm>
  97         </listitem>
  98       </varlistentry>
  99
 100       <varlistentry id="kill">
 101         <term><command>kill</command></term>
 102         <listitem>
 103           <para>Sends signals to processes</para>
 104           <indexterm zone="ch-system-procps kill">
 105             <primary sortas="b-kill">kill</primary>
 106           </indexterm>
 107         </listitem>
 108       </varlistentry>
 109
 110       <varlistentry id="pgrep">
 111         <term><command>pgrep</command></term>
 112         <listitem>
 113           <para>Looks up processes based on their name and other attributes</para>
 114           <indexterm zone="ch-system-procps pgrep">
 115             <primary sortas="b-pgrep">pgrep</primary>
 116           </indexterm>
 117         </listitem>
 118       </varlistentry>
 119
 120       <varlistentry id="pkill">
 121         <term><command>pkill</command></term>
 122         <listitem>
 123           <para>Signals processes based on their name and other attributes</para>
 124           <indexterm zone="ch-system-procps pkill">
 125             <primary sortas="b-pkill">pkill</primary>
 126           </indexterm>
 127         </listitem>
 128       </varlistentry>
 129
 130       <varlistentry id="pmap">
 131         <term><command>pmap</command></term>
 132         <listitem>
 133           <para>Reports the memory map of the given process</para>
 134           <indexterm zone="ch-system-procps pmap">
 135             <primary sortas="b-pmap">pmap</primary>
 136           </indexterm>
 137         </listitem>
 138       </varlistentry>
 139
 140       <varlistentry id="ps">
 141         <term><command>ps</command></term>
 142         <listitem>
 143           <para>Lists the current running processes</para>
 144           <indexterm zone="ch-system-procps ps">
 145             <primary sortas="b-ps">ps</primary>
 146           </indexterm>
 147         </listitem>
 148       </varlistentry>
 149
 150       <varlistentry id="pwdx">
 151         <term><command>pwdx</command></term>
 152         <listitem>
 153           <para>Reports the current working directory of a process</para>
 154           <indexterm zone="ch-system-procps pwdx">
 155             <primary sortas="b-pwdx">pwdx</primary>
 156           </indexterm>
 157         </listitem>
 158       </varlistentry>
 159
 160       <varlistentry id="skill">
 161         <term><command>skill</command></term>
 162         <listitem>
 163           <para>Sends signals to processes matching the given criteria</para>
 164           <indexterm zone="ch-system-procps skill">
 165             <primary sortas="b-skill">skill</primary>
 166           </indexterm>
 167         </listitem>
 168       </varlistentry>
 169
 170       <varlistentry id="slabtop">
 171         <term><command>slabtop</command></term>
 172         <listitem>
 173           <para>Displays detailed kernel slap cache information in real time</para>
 174           <indexterm zone="ch-system-procps slabtop">
 175             <primary sortas="b-slabtop">slabtop</primary>
 176           </indexterm>
 177         </listitem>
 178       </varlistentry>
 179
 180       <varlistentry id="snice">
 181         <term><command>snice</command></term>
 182         <listitem>
 183           <para>Changes the scheduling priority of processes matching the given
 184           criteria</para>
 185           <indexterm zone="ch-system-procps snice">
 186             <primary sortas="b-snice">snice</primary>
 187           </indexterm>
 188         </listitem>
 189       </varlistentry>
 190
 191       <varlistentry id="sysctl">
 192         <term><command>sysctl</command></term>
 193         <listitem>
 194           <para>Modifies kernel parameters at run time</para>
 195           <indexterm zone="ch-system-procps sysctl">
 196             <primary sortas="b-sysctl">sysctl</primary>
 197           </indexterm>
 198         </listitem>
 199       </varlistentry>
 200
 201       <varlistentry id="tload">
 202         <term><command>tload</command></term>
 203         <listitem>
 204           <para>Prints a graph of the current system load average</para>
 205           <indexterm zone="ch-system-procps tload">
 206             <primary sortas="b-tload">tload</primary>
 207           </indexterm>
 208         </listitem>
 209       </varlistentry>
 210
 211       <varlistentry id="top">
 212         <term><command>top</command></term>
 213         <listitem>
 214           <para>Displays a list of the most CPU intensive processes; it
 215           provides an ongoing look at processor activity in real time</para>
 216           <indexterm zone="ch-system-procps top">
 217             <primary sortas="b-top">top</primary>
 218           </indexterm>
 219         </listitem>
 220       </varlistentry>
 221
 222       <varlistentry id="uptime">
 223         <term><command>uptime</command></term>
 224         <listitem>
 225           <para>Reports how long the system has been running, how many users are
 226           logged on, and the system load averages</para>
 227           <indexterm zone="ch-system-procps uptime">
 228             <primary sortas="b-uptime">uptime</primary>
 229           </indexterm>
 230         </listitem>
 231       </varlistentry>
 232
 233       <varlistentry id="vmstat">
 234         <term><command>vmstat</command></term>
 235         <listitem>
 236           <para>Reports virtual memory statistics, giving information about
 237           processes, memory, paging, block Input/Output (IO), traps, and CPU
 238           activity</para>
 239           <indexterm zone="ch-system-procps vmstat">
 240             <primary sortas="b-vmstat">vmstat</primary>
 241           </indexterm>
 242         </listitem>
 243       </varlistentry>
 244
 245       <varlistentry id="w">
 246         <term><command>w</command></term>
 247         <listitem>
 248           <para>Shows which users are currently logged on, where, and since
 249           when</para>
 250           <indexterm zone="ch-system-procps w">
 251             <primary sortas="b-w">w</primary>
 252           </indexterm>
 253         </listitem>
 254       </varlistentry>
 255
 256       <varlistentry id="watch">
 257         <term><command>watch</command></term>
 258         <listitem>
 259           <para>Runs a given command repeatedly, displaying the first
 260           screen-full of its output; this allows a user to watch the output
 261           change over time</para>
 262           <indexterm zone="ch-system-procps watch">
 263             <primary sortas="b-watch">watch</primary>
 264           </indexterm>
 265         </listitem>
 266       </varlistentry>
 267
 268       <varlistentry id="libproc">
 269         <term><filename class="libraryfile">libproc</filename></term>
 270         <listitem>
 271           <para>Contains the functions used by most programs in this
 272           package</para>
 273           <indexterm zone="ch-system-procps libproc">
 274             <primary sortas="c-libproc">libproc</primary>
 275           </indexterm>
 276         </listitem>
 277       </varlistentry>
 278
 279     </variablelist>
 280
 281   </sect2>
 282
 283 </sect1>