procps.xml 6.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193
  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>6.2 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>Install the package:</para>
  28. <screen><userinput>make install</userinput></screen>
  29. </sect2>
  30. <sect2 id="contents-procps" role="content"><title>Contents of Procps</title>
  31. <segmentedlist>
  32. <segtitle>Installed programs</segtitle>
  33. <segtitle>Installed library</segtitle>
  34. <seglistitem><seg>free, kill, pgrep, pkill,
  35. pmap, ps, skill, snice, sysctl, tload, top, uptime, vmstat, w, and watch</seg>
  36. <seg>libproc.so</seg></seglistitem>
  37. </segmentedlist>
  38. <variablelist><bridgehead renderas="sect3">Short Descriptions</bridgehead>
  39. <?dbfo list-presentation="list"?>
  40. <?dbhtml list-presentation="table"?>
  41. <varlistentry id="free">
  42. <term><command>free</command></term>
  43. <listitem>
  44. <para>Reports the amount of free and used memory (both physical and
  45. swap memory) in the system</para>
  46. <indexterm zone="ch-system-procps free"><primary sortas="b-free">free</primary></indexterm>
  47. </listitem>
  48. </varlistentry>
  49. <varlistentry id="kill">
  50. <term><command>kill</command></term>
  51. <listitem>
  52. <para>Sends signals to processes</para>
  53. <indexterm zone="ch-system-procps kill"><primary sortas="b-kill">kill</primary></indexterm>
  54. </listitem>
  55. </varlistentry>
  56. <varlistentry id="pgrep">
  57. <term><command>pgrep</command></term>
  58. <listitem>
  59. <para>Looks up processes based on their name and other attributes</para>
  60. <indexterm zone="ch-system-procps pgrep"><primary sortas="b-pgrep">pgrep</primary></indexterm>
  61. </listitem>
  62. </varlistentry>
  63. <varlistentry id="pkill">
  64. <term><command>pkill</command></term>
  65. <listitem>
  66. <para>Signals processes based on their name and other attributes</para>
  67. <indexterm zone="ch-system-procps pkill"><primary sortas="b-pkill">pkill</primary></indexterm>
  68. </listitem>
  69. </varlistentry>
  70. <varlistentry id="pmap">
  71. <term><command>pmap</command></term>
  72. <listitem>
  73. <para>Reports the memory map of the given process</para>
  74. <indexterm zone="ch-system-procps pmap"><primary sortas="b-pmap">pmap</primary></indexterm>
  75. </listitem>
  76. </varlistentry>
  77. <varlistentry id="ps">
  78. <term><command>ps</command></term>
  79. <listitem>
  80. <para>Lists the current running processes</para>
  81. <indexterm zone="ch-system-procps ps"><primary sortas="b-ps">ps</primary></indexterm>
  82. </listitem>
  83. </varlistentry>
  84. <varlistentry id="skill">
  85. <term><command>skill</command></term>
  86. <listitem>
  87. <para>Sends signals to processes matching the given criteria</para>
  88. <indexterm zone="ch-system-procps skill"><primary sortas="b-skill">skill</primary></indexterm>
  89. </listitem>
  90. </varlistentry>
  91. <varlistentry id="snice">
  92. <term><command>snice</command></term>
  93. <listitem>
  94. <para>Changes the scheduling priority of processes matching the given criteria</para>
  95. <indexterm zone="ch-system-procps snice"><primary sortas="b-snice">snice</primary></indexterm>
  96. </listitem>
  97. </varlistentry>
  98. <varlistentry id="sysctl">
  99. <term><command>sysctl</command></term>
  100. <listitem>
  101. <para>Modifies kernel parameters at run time</para>
  102. <indexterm zone="ch-system-procps sysctl"><primary sortas="b-sysctl">sysctl</primary></indexterm>
  103. </listitem>
  104. </varlistentry>
  105. <varlistentry id="tload">
  106. <term><command>tload</command></term>
  107. <listitem>
  108. <para>Prints a graph of the current system load average</para>
  109. <indexterm zone="ch-system-procps tload"><primary sortas="b-tload">tload</primary></indexterm>
  110. </listitem>
  111. </varlistentry>
  112. <varlistentry id="top">
  113. <term><command>top</command></term>
  114. <listitem>
  115. <para>Displays the top CPU processes; it provides an ongoing look at
  116. processor activity in real time</para>
  117. <indexterm zone="ch-system-procps top"><primary sortas="b-top">top</primary></indexterm>
  118. </listitem>
  119. </varlistentry>
  120. <varlistentry id="uptime">
  121. <term><command>uptime</command></term>
  122. <listitem>
  123. <para>Reports how long the system has been running, how many users are
  124. logged on, and the system load averages</para>
  125. <indexterm zone="ch-system-procps uptime"><primary sortas="b-uptime">uptime</primary></indexterm>
  126. </listitem>
  127. </varlistentry>
  128. <varlistentry id="vmstat">
  129. <term><command>vmstat</command></term>
  130. <listitem>
  131. <para>Reports virtual memory statistics, giving information about
  132. processes, memory, paging, block Input/Output (IO), traps, and CPU activity</para>
  133. <indexterm zone="ch-system-procps vmstat"><primary sortas="b-vmstat">vmstat</primary></indexterm>
  134. </listitem>
  135. </varlistentry>
  136. <varlistentry id="w">
  137. <term><command>w</command></term>
  138. <listitem>
  139. <para>Shows which users are currently logged on, where, and since when</para>
  140. <indexterm zone="ch-system-procps w"><primary sortas="b-w">w</primary></indexterm>
  141. </listitem>
  142. </varlistentry>
  143. <varlistentry id="watch">
  144. <term><command>watch</command></term>
  145. <listitem>
  146. <para>Runs a given command repeatedly, displaying the first screen-full of its
  147. output; this allows a user to watch the output change over time</para>
  148. <indexterm zone="ch-system-procps watch"><primary sortas="b-watch">watch</primary></indexterm>
  149. </listitem>
  150. </varlistentry>
  151. <varlistentry id="libproc">
  152. <term><filename class="libraryfile">libproc</filename></term>
  153. <listitem>
  154. <para>Contains the functions used by most programs in this package</para>
  155. <indexterm zone="ch-system-procps libproc"><primary sortas="c-libproc">libproc</primary></indexterm>
  156. </listitem>
  157. </varlistentry>
  158. </variablelist>
  159. </sect2>
  160. </sect1>