procps.xml 9.1 KB

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