source: clfs-sysroot/BOOK/final-system/common/procps.xml @ a6c1085

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
  "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;
]>

<sect1 id="ch-system-procps" role="wrap">
  <?dbhtml filename="procps.html"?>

  <title>Procps-&procps-version;</title>

  <indexterm zone="ch-system-procps">
    <primary sortas="a-Procps">Procps</primary>
  </indexterm>

  <sect2 role="package">
    <title/>

    <para>The Procps package contains programs for monitoring
    processes.</para>

  </sect2>

  &env-target;

  <sect2 role="installation">
    <title>Installation of Procps</title>

    <para os="a">Compile the package:</para>

<screen os="b"><userinput>make CPPFLAGS= lib64=lib m64=</userinput></screen>

    <para os="c">Install the package:</para>

<screen os="d"><userinput>make DESTDIR=${CLFS} lib64=lib m64= ldconfig= \
    install="install -D" install</userinput></screen>

    <variablelist os="e">
      <title>The meaning of the make options:</title>
      <varlistentry>
        <term><parameter>CPPFLAGS=</parameter></term>
        <listitem>
        <para>By default, procps tries to include the host system
        ncurses headers, so we have to disable that.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><parameter>lib64=lib</parameter></term>
        <listitem>
          <para>By default, procps will attempt to install into
          <filename class="directory">/lib64</filename> if it
          exists, even if the package is not built 64-bit. This option
          forces procps to install its libraries into
          <filename class="directory">/lib</filename> instead.</para>
        </listitem>
      </varlistentry>
    </variablelist>

  </sect2>

  <sect2 id="contents-procps" role="content">
    <title>Contents of Procps</title>

    <segmentedlist>
      <segtitle>Installed programs</segtitle>
      <segtitle>Installed library</segtitle>

      <seglistitem>
        <seg>free, kill, pgrep, pkill, pmap, ps, pwdx, skill, slabtop, snice, sysctl,
        tload, top, uptime, vmstat, w, and watch</seg>
        <seg>libproc.so</seg>
      </seglistitem>
    </segmentedlist>

    <variablelist>
      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
      <?dbfo list-presentation="list"?>
      <?dbhtml list-presentation="table"?>

      <varlistentry id="free">
        <term><command>free</command></term>
        <listitem>
          <para>Reports the amount of free and used memory (both physical and
          swap memory) in the system</para>
          <indexterm zone="ch-system-procps free">
            <primary sortas="b-free">free</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="kill">
        <term><command>kill</command></term>
        <listitem>
          <para>Sends signals to processes</para>
          <indexterm zone="ch-system-procps kill">
            <primary sortas="b-kill">kill</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="pgrep">
        <term><command>pgrep</command></term>
        <listitem>
          <para>Looks up processes based on their name and other attributes</para>
          <indexterm zone="ch-system-procps pgrep">
            <primary sortas="b-pgrep">pgrep</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="pkill">
        <term><command>pkill</command></term>
        <listitem>
          <para>Signals processes based on their name and other attributes</para>
          <indexterm zone="ch-system-procps pkill">
            <primary sortas="b-pkill">pkill</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="pmap">
        <term><command>pmap</command></term>
        <listitem>
          <para>Reports the memory map of the given process</para>
          <indexterm zone="ch-system-procps pmap">
            <primary sortas="b-pmap">pmap</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="ps">
        <term><command>ps</command></term>
        <listitem>
          <para>Lists the current running processes</para>
          <indexterm zone="ch-system-procps ps">
            <primary sortas="b-ps">ps</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="pwdx">
        <term><command>pwdx</command></term>
        <listitem>
          <para>Reports the current working directory of a process</para>
          <indexterm zone="ch-system-procps pwdx">
            <primary sortas="b-pwdx">pwdx</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="skill">
        <term><command>skill</command></term>
        <listitem>
          <para>Sends signals to processes matching the given criteria</para>
          <indexterm zone="ch-system-procps skill">
            <primary sortas="b-skill">skill</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="slabtop">
        <term><command>slabtop</command></term>
        <listitem>
          <para>Displays detailed kernel slab cache information in real time</para>
          <indexterm zone="ch-system-procps slabtop">
            <primary sortas="b-slabtop">slabtop</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="snice">
        <term><command>snice</command></term>
        <listitem>
          <para>Changes the scheduling priority of processes matching the given
          criteria</para>
          <indexterm zone="ch-system-procps snice">
            <primary sortas="b-snice">snice</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="sysctl">
        <term><command>sysctl</command></term>
        <listitem>
          <para>Modifies kernel parameters at run time</para>
          <indexterm zone="ch-system-procps sysctl">
            <primary sortas="b-sysctl">sysctl</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="tload">
        <term><command>tload</command></term>
        <listitem>
          <para>Prints a graph of the current system load average</para>
          <indexterm zone="ch-system-procps tload">
            <primary sortas="b-tload">tload</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="top">
        <term><command>top</command></term>
        <listitem>
          <para>Displays a list of the most CPU intensive processes; it
          provides an ongoing look at processor activity in real time</para>
          <indexterm zone="ch-system-procps top">
            <primary sortas="b-top">top</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="uptime">
        <term><command>uptime</command></term>
        <listitem>
          <para>Reports how long the system has been running, how many users are
          logged on, and the system load averages</para>
          <indexterm zone="ch-system-procps uptime">
            <primary sortas="b-uptime">uptime</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="vmstat">
        <term><command>vmstat</command></term>
        <listitem>
          <para>Reports virtual memory statistics, giving information about
          processes, memory, paging, block Input/Output (IO), traps, and CPU
          activity</para>
          <indexterm zone="ch-system-procps vmstat">
            <primary sortas="b-vmstat">vmstat</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="w">
        <term><command>w</command></term>
        <listitem>
          <para>Shows which users are currently logged on, where, and since
          when</para>
          <indexterm zone="ch-system-procps w">
            <primary sortas="b-w">w</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="watch">
        <term><command>watch</command></term>
        <listitem>
          <para>Runs a given command repeatedly, displaying the first
          screen-full of its output; this allows a user to watch the output
          change over time</para>
          <indexterm zone="ch-system-procps watch">
            <primary sortas="b-watch">watch</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libproc">
        <term><filename class="libraryfile">libproc</filename></term>
        <listitem>
          <para>Contains the functions used by most programs in this
          package</para>
          <indexterm zone="ch-system-procps libproc">
            <primary sortas="c-libproc">libproc</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>