procps.xml 9.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292
  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-ng.html"?>
  9. <sect1info condition="script">
  10. <productname>procps-ng</productname>
  11. <productnumber>&procps-ng-version;</productnumber>
  12. <address>&procps-ng-url;</address>
  13. </sect1info>
  14. <title>Procps-ng-&procps-ng-version;</title>
  15. <indexterm zone="ch-system-procps">
  16. <primary sortas="a-Procps">Procps-ng</primary>
  17. </indexterm>
  18. <sect2 role="package">
  19. <title/>
  20. <para>The Procps-ng package contains programs for monitoring processes.</para>
  21. <segmentedlist>
  22. <segtitle>&buildtime;</segtitle>
  23. <segtitle>&diskspace;</segtitle>
  24. <seglistitem>
  25. <seg>&procps-ng-fin-sbu;</seg>
  26. <seg>&procps-ng-fin-du;</seg>
  27. </seglistitem>
  28. </segmentedlist>
  29. </sect2>
  30. <sect2 role="installation">
  31. <title>Installation of Procps-ng</title>
  32. <para>Prepare procps-ng for compilation:</para>
  33. <screen revision="sysv"><userinput remap="configure">./configure --prefix=/usr \
  34. --exec-prefix= \
  35. --libdir=/usr/lib \
  36. --docdir=/usr/share/doc/procps-ng-&procps-ng-version; \
  37. --disable-static \
  38. --disable-kill</userinput></screen>
  39. <screen revision="systemd"><userinput remap="configure">./configure --prefix=/usr \
  40. --exec-prefix= \
  41. --libdir=/usr/lib \
  42. --docdir=/usr/share/doc/procps-ng-&procps-ng-version; \
  43. --disable-static \
  44. --disable-kill \
  45. --with-systemd</userinput></screen>
  46. <variablelist>
  47. <title>The meaning of the configure option:</title>
  48. <varlistentry>
  49. <term><parameter>--disable-kill</parameter></term>
  50. <listitem>
  51. <para>This switch disables building the <command>kill</command>
  52. command that will be installed by the Util-linux package.</para>
  53. </listitem>
  54. </varlistentry>
  55. </variablelist>
  56. <para>Compile the package:</para>
  57. <screen><userinput remap="make">make</userinput></screen>
  58. <para>The test suite needs some custom modifications for LFS.
  59. Remove a test that fails when scripting does not use a tty device and
  60. fix two others.
  61. To run the test suite, run the following commands:</para>
  62. <screen><userinput remap="test">sed -i -r 's|(pmap_initname)\\\$|\1|' testsuite/pmap.test/pmap.exp
  63. sed -i '/set tty/d' testsuite/pkill.test/pkill.exp
  64. rm testsuite/pgrep.test/pgrep.exp
  65. make check</userinput></screen>
  66. <para>Install the package:</para>
  67. <screen><userinput remap="install">make install</userinput></screen>
  68. <para>Finally, move essential libraries to a location that can be found if
  69. <filename class="directory">/usr</filename> is not mounted.</para>
  70. <screen><userinput remap="install">mv -v /usr/lib/libprocps.so.* /lib
  71. ln -sfv ../../lib/$(readlink /usr/lib/libprocps.so) /usr/lib/libprocps.so</userinput></screen>
  72. </sect2>
  73. <sect2 id="contents-procps" role="content">
  74. <title>Contents of Procps-ng</title>
  75. <segmentedlist>
  76. <segtitle>Installed programs</segtitle>
  77. <segtitle>Installed library</segtitle>
  78. <segtitle>Installed directories</segtitle>
  79. <seglistitem>
  80. <seg>free, pgrep, pidof, pkill, pmap, ps, pwdx, slabtop,
  81. sysctl, tload, top, uptime, vmstat, w, and watch</seg>
  82. <seg>libprocps.so</seg>
  83. <seg>/usr/include/proc and /usr/share/doc/procps-ng-&procps-ng-version;</seg>
  84. </seglistitem>
  85. </segmentedlist>
  86. <variablelist>
  87. <bridgehead renderas="sect3">Short Descriptions</bridgehead>
  88. <?dbfo list-presentation="list"?>
  89. <?dbhtml list-presentation="table"?>
  90. <varlistentry id="free">
  91. <term><command>free</command></term>
  92. <listitem>
  93. <para>Reports the amount of free and used memory (both physical and
  94. swap memory) in the system</para>
  95. <indexterm zone="ch-system-procps free">
  96. <primary sortas="b-free">free</primary>
  97. </indexterm>
  98. </listitem>
  99. </varlistentry>
  100. <varlistentry id="pgrep">
  101. <term><command>pgrep</command></term>
  102. <listitem>
  103. <para>Looks up processes based on their name and other attributes</para>
  104. <indexterm zone="ch-system-procps pgrep">
  105. <primary sortas="b-pgrep">pgrep</primary>
  106. </indexterm>
  107. </listitem>
  108. </varlistentry>
  109. <varlistentry id="pidof">
  110. <term><command>pidof</command></term>
  111. <listitem>
  112. <para>Reports the PIDs of the given programs</para>
  113. <indexterm zone="ch-system-procps pidof">
  114. <primary sortas="b-pidof">pidof</primary>
  115. </indexterm>
  116. </listitem>
  117. </varlistentry>
  118. <varlistentry id="pkill">
  119. <term><command>pkill</command></term>
  120. <listitem>
  121. <para>Signals processes based on their name and other attributes</para>
  122. <indexterm zone="ch-system-procps pkill">
  123. <primary sortas="b-pkill">pkill</primary>
  124. </indexterm>
  125. </listitem>
  126. </varlistentry>
  127. <varlistentry id="pmap">
  128. <term><command>pmap</command></term>
  129. <listitem>
  130. <para>Reports the memory map of the given process</para>
  131. <indexterm zone="ch-system-procps pmap">
  132. <primary sortas="b-pmap">pmap</primary>
  133. </indexterm>
  134. </listitem>
  135. </varlistentry>
  136. <varlistentry id="ps">
  137. <term><command>ps</command></term>
  138. <listitem>
  139. <para>Lists the current running processes</para>
  140. <indexterm zone="ch-system-procps ps">
  141. <primary sortas="b-ps">ps</primary>
  142. </indexterm>
  143. </listitem>
  144. </varlistentry>
  145. <varlistentry id="pwdx">
  146. <term><command>pwdx</command></term>
  147. <listitem>
  148. <para>Reports the current working directory of a process</para>
  149. <indexterm zone="ch-system-procps pwdx">
  150. <primary sortas="b-pwdx">pwdx</primary>
  151. </indexterm>
  152. </listitem>
  153. </varlistentry>
  154. <varlistentry id="slabtop">
  155. <term><command>slabtop</command></term>
  156. <listitem>
  157. <para>Displays detailed kernel slab cache information in real time</para>
  158. <indexterm zone="ch-system-procps slabtop">
  159. <primary sortas="b-slabtop">slabtop</primary>
  160. </indexterm>
  161. </listitem>
  162. </varlistentry>
  163. <varlistentry id="sysctl">
  164. <term><command>sysctl</command></term>
  165. <listitem>
  166. <para>Modifies kernel parameters at run time</para>
  167. <indexterm zone="ch-system-procps sysctl">
  168. <primary sortas="b-sysctl">sysctl</primary>
  169. </indexterm>
  170. </listitem>
  171. </varlistentry>
  172. <varlistentry id="tload">
  173. <term><command>tload</command></term>
  174. <listitem>
  175. <para>Prints a graph of the current system load average</para>
  176. <indexterm zone="ch-system-procps tload">
  177. <primary sortas="b-tload">tload</primary>
  178. </indexterm>
  179. </listitem>
  180. </varlistentry>
  181. <varlistentry id="top">
  182. <term><command>top</command></term>
  183. <listitem>
  184. <para>Displays a list of the most CPU intensive processes; it
  185. provides an ongoing look at processor activity in real time</para>
  186. <indexterm zone="ch-system-procps top">
  187. <primary sortas="b-top">top</primary>
  188. </indexterm>
  189. </listitem>
  190. </varlistentry>
  191. <varlistentry id="uptime">
  192. <term><command>uptime</command></term>
  193. <listitem>
  194. <para>Reports how long the system has been running, how many users are
  195. logged on, and the system load averages</para>
  196. <indexterm zone="ch-system-procps uptime">
  197. <primary sortas="b-uptime">uptime</primary>
  198. </indexterm>
  199. </listitem>
  200. </varlistentry>
  201. <varlistentry id="vmstat">
  202. <term><command>vmstat</command></term>
  203. <listitem>
  204. <para>Reports virtual memory statistics, giving information about
  205. processes, memory, paging, block Input/Output (IO), traps, and CPU
  206. activity</para>
  207. <indexterm zone="ch-system-procps vmstat">
  208. <primary sortas="b-vmstat">vmstat</primary>
  209. </indexterm>
  210. </listitem>
  211. </varlistentry>
  212. <varlistentry id="w">
  213. <term><command>w</command></term>
  214. <listitem>
  215. <para>Shows which users are currently logged on, where, and since
  216. when</para>
  217. <indexterm zone="ch-system-procps w">
  218. <primary sortas="b-w">w</primary>
  219. </indexterm>
  220. </listitem>
  221. </varlistentry>
  222. <varlistentry id="watch">
  223. <term><command>watch</command></term>
  224. <listitem>
  225. <para>Runs a given command repeatedly, displaying the first
  226. screen-full of its output; this allows a user to watch the output
  227. change over time</para>
  228. <indexterm zone="ch-system-procps watch">
  229. <primary sortas="b-watch">watch</primary>
  230. </indexterm>
  231. </listitem>
  232. </varlistentry>
  233. <varlistentry id="libprocps">
  234. <term><filename class="libraryfile">libprocps</filename></term>
  235. <listitem>
  236. <para>Contains the functions used by most programs in this
  237. package</para>
  238. <indexterm zone="ch-system-procps libprocps">
  239. <primary sortas="c-libprocps">libprocps</primary>
  240. </indexterm>
  241. </listitem>
  242. </varlistentry>
  243. </variablelist>
  244. </sect2>
  245. </sect1>