procps.xml 6.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195
  1. <?xml version="1.0" encoding="ISO-8859-1"?>
  2. <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
  3. <!ENTITY % general-entities SYSTEM "../general.ent">
  4. %general-entities;
  5. ]>
  6. <sect1 id="ch-system-procps" role="wrap">
  7. <title>Procps-&procps-version;</title>
  8. <?dbhtml filename="procps.html"?>
  9. <indexterm zone="ch-system-procps"><primary sortas="a-Procps">Procps</primary></indexterm>
  10. <sect2 role="package"><title/>
  11. <para>The Procps package contains programs for monitoring processes.</para>
  12. <segmentedlist>
  13. <segtitle>&buildtime;</segtitle>
  14. <segtitle>&diskspace;</segtitle>
  15. <seglistitem><seg>0.1 SBU</seg><seg>2.3 MB</seg></seglistitem>
  16. </segmentedlist>
  17. <segmentedlist>
  18. <segtitle>&dependencies;</segtitle>
  19. <seglistitem><seg>Bash, Binutils, Coreutils, GCC, Glibc,
  20. Make, and Ncurses</seg></seglistitem>
  21. </segmentedlist>
  22. </sect2>
  23. <sect2 role="installation">
  24. <title>Installation of Procps</title>
  25. <para>Compile the package:</para>
  26. <screen><userinput>make</userinput></screen>
  27. <para>This package does not come with a test suite.</para>
  28. <para>Install the package:</para>
  29. <screen><userinput>make install</userinput></screen>
  30. </sect2>
  31. <sect2 id="contents-procps" role="content"><title>Contents of Procps</title>
  32. <segmentedlist>
  33. <segtitle>Installed programs</segtitle>
  34. <segtitle>Installed library</segtitle>
  35. <seglistitem><seg>free, kill, pgrep, pkill,
  36. pmap, ps, skill, snice, sysctl, tload, top, uptime, vmstat, w, and watch</seg>
  37. <seg>libproc.so</seg></seglistitem>
  38. </segmentedlist>
  39. <variablelist><bridgehead renderas="sect3">Short Descriptions</bridgehead>
  40. <?dbfo list-presentation="list"?>
  41. <?dbhtml list-presentation="table"?>
  42. <varlistentry id="free">
  43. <term><command>free</command></term>
  44. <listitem>
  45. <para>Reports the amount of free and used memory (both physical and
  46. swap memory) in the system</para>
  47. <indexterm zone="ch-system-procps free"><primary sortas="b-free">free</primary></indexterm>
  48. </listitem>
  49. </varlistentry>
  50. <varlistentry id="kill">
  51. <term><command>kill</command></term>
  52. <listitem>
  53. <para>Sends signals to processes</para>
  54. <indexterm zone="ch-system-procps kill"><primary sortas="b-kill">kill</primary></indexterm>
  55. </listitem>
  56. </varlistentry>
  57. <varlistentry id="pgrep">
  58. <term><command>pgrep</command></term>
  59. <listitem>
  60. <para>Looks up processes based on their name and other attributes</para>
  61. <indexterm zone="ch-system-procps pgrep"><primary sortas="b-pgrep">pgrep</primary></indexterm>
  62. </listitem>
  63. </varlistentry>
  64. <varlistentry id="pkill">
  65. <term><command>pkill</command></term>
  66. <listitem>
  67. <para>Signals processes based on their name and other attributes</para>
  68. <indexterm zone="ch-system-procps pkill"><primary sortas="b-pkill">pkill</primary></indexterm>
  69. </listitem>
  70. </varlistentry>
  71. <varlistentry id="pmap">
  72. <term><command>pmap</command></term>
  73. <listitem>
  74. <para>Reports the memory map of the given process</para>
  75. <indexterm zone="ch-system-procps pmap"><primary sortas="b-pmap">pmap</primary></indexterm>
  76. </listitem>
  77. </varlistentry>
  78. <varlistentry id="ps">
  79. <term><command>ps</command></term>
  80. <listitem>
  81. <para>Lists the current running processes</para>
  82. <indexterm zone="ch-system-procps ps"><primary sortas="b-ps">ps</primary></indexterm>
  83. </listitem>
  84. </varlistentry>
  85. <varlistentry id="skill">
  86. <term><command>skill</command></term>
  87. <listitem>
  88. <para>Sends signals to processes matching the given criteria</para>
  89. <indexterm zone="ch-system-procps skill"><primary sortas="b-skill">skill</primary></indexterm>
  90. </listitem>
  91. </varlistentry>
  92. <varlistentry id="snice">
  93. <term><command>snice</command></term>
  94. <listitem>
  95. <para>Changes the scheduling priority of processes matching the given criteria</para>
  96. <indexterm zone="ch-system-procps snice"><primary sortas="b-snice">snice</primary></indexterm>
  97. </listitem>
  98. </varlistentry>
  99. <varlistentry id="sysctl">
  100. <term><command>sysctl</command></term>
  101. <listitem>
  102. <para>Modifies kernel parameters at run time</para>
  103. <indexterm zone="ch-system-procps sysctl"><primary sortas="b-sysctl">sysctl</primary></indexterm>
  104. </listitem>
  105. </varlistentry>
  106. <varlistentry id="tload">
  107. <term><command>tload</command></term>
  108. <listitem>
  109. <para>Prints a graph of the current system load average</para>
  110. <indexterm zone="ch-system-procps tload"><primary sortas="b-tload">tload</primary></indexterm>
  111. </listitem>
  112. </varlistentry>
  113. <varlistentry id="top">
  114. <term><command>top</command></term>
  115. <listitem>
  116. <para>Displays a list of the most CPU intensive processes; it provides an
  117. ongoing look at processor activity in real time</para>
  118. <indexterm zone="ch-system-procps top"><primary sortas="b-top">top</primary></indexterm>
  119. </listitem>
  120. </varlistentry>
  121. <varlistentry id="uptime">
  122. <term><command>uptime</command></term>
  123. <listitem>
  124. <para>Reports how long the system has been running, how many users are
  125. logged on, and the system load averages</para>
  126. <indexterm zone="ch-system-procps uptime"><primary sortas="b-uptime">uptime</primary></indexterm>
  127. </listitem>
  128. </varlistentry>
  129. <varlistentry id="vmstat">
  130. <term><command>vmstat</command></term>
  131. <listitem>
  132. <para>Reports virtual memory statistics, giving information about
  133. processes, memory, paging, block Input/Output (IO), traps, and CPU activity</para>
  134. <indexterm zone="ch-system-procps vmstat"><primary sortas="b-vmstat">vmstat</primary></indexterm>
  135. </listitem>
  136. </varlistentry>
  137. <varlistentry id="w">
  138. <term><command>w</command></term>
  139. <listitem>
  140. <para>Shows which users are currently logged on, where, and since when</para>
  141. <indexterm zone="ch-system-procps w"><primary sortas="b-w">w</primary></indexterm>
  142. </listitem>
  143. </varlistentry>
  144. <varlistentry id="watch">
  145. <term><command>watch</command></term>
  146. <listitem>
  147. <para>Runs a given command repeatedly, displaying the first screen-full of its
  148. output; this allows a user to watch the output change over time</para>
  149. <indexterm zone="ch-system-procps watch"><primary sortas="b-watch">watch</primary></indexterm>
  150. </listitem>
  151. </varlistentry>
  152. <varlistentry id="libproc">
  153. <term><filename class="libraryfile">libproc</filename></term>
  154. <listitem>
  155. <para>Contains the functions used by most programs in this package</para>
  156. <indexterm zone="ch-system-procps libproc"><primary sortas="c-libproc">libproc</primary></indexterm>
  157. </listitem>
  158. </varlistentry>
  159. </variablelist>
  160. </sect2>
  161. </sect1>