Update to libcap-2.28.
[linux_from_scratch.git] / chapter06 / psmisc.xml
blobb01303131cf51cccf137b31866b6b2692d4fec20
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 ]>
8 <sect1 id="ch-system-psmisc" role="wrap">
9   <?dbhtml filename="psmisc.html"?>
11   <sect1info condition="script">
12     <productname>psmisc</productname>
13     <productnumber>&psmisc-version;</productnumber>
14     <address>&psmisc-url;</address>
15   </sect1info>
17   <title>Psmisc-&psmisc-version;</title>
19   <indexterm zone="ch-system-psmisc">
20     <primary sortas="a-Psmisc">Psmisc</primary>
21   </indexterm>
23   <sect2 role="package">
24     <title/>
26     <para>The Psmisc package contains programs for displaying information about
27     running processes.</para>
29     <segmentedlist>
30       <segtitle>&buildtime;</segtitle>
31       <segtitle>&diskspace;</segtitle>
33       <seglistitem>
34         <seg>&psmisc-ch6-sbu;</seg>
35         <seg>&psmisc-ch6-du;</seg>
36       </seglistitem>
37     </segmentedlist>
39   </sect2>
41   <sect2 role="installation">
42     <title>Installation of Psmisc</title>
44     <para>Prepare Psmisc for compilation:</para>
46 <screen><userinput remap="configure">./configure --prefix=/usr</userinput></screen>
48     <para>Compile the package:</para>
50 <screen><userinput remap="make">make</userinput></screen>
52     <para>This package does not come with a test suite.</para>
54     <para>Install the package:</para>
56 <screen><userinput remap="install">make install</userinput></screen>
58     <para>Finally, move the <command>killall</command> and <command>fuser</command>
59     programs to the location specified by the FHS:</para>
61 <screen><userinput remap="install">mv -v /usr/bin/fuser   /bin
62 mv -v /usr/bin/killall /bin</userinput></screen>
64   </sect2>
66   <sect2 id="contents-psmisc" role="content">
67     <title>Contents of Psmisc</title>
69     <segmentedlist>
70       <segtitle>Installed programs</segtitle>
72       <seglistitem>
73         <seg>fuser, killall, peekfd, prtstat, pslog, pstree, and pstree.x11 (link to pstree)</seg>
74       </seglistitem>
75     </segmentedlist>
77     <variablelist>
78       <bridgehead renderas="sect3">Short Descriptions</bridgehead>
79       <?dbfo list-presentation="list"?>
80       <?dbhtml list-presentation="table"?>
82       <varlistentry id="fuser">
83         <term><command>fuser</command></term>
84         <listitem>
85           <para>Reports the Process IDs (PIDs) of processes that use the given
86           files or file systems</para>
87           <indexterm zone="ch-system-psmisc fuser">
88             <primary sortas="b-fuser">fuser</primary>
89           </indexterm>
90         </listitem>
91       </varlistentry>
93       <varlistentry id="killall">
94         <term><command>killall</command></term>
95         <listitem>
96           <para>Kills processes by name; it sends a signal to all processes
97           running any of the given commands</para>
98           <indexterm zone="ch-system-psmisc killall">
99             <primary sortas="b-killall">killall</primary>
100           </indexterm>
101         </listitem>
102       </varlistentry>
104       <varlistentry id="peekfd">
105         <term><command>peekfd</command></term>
106         <listitem>
107           <para>Peek at file descriptors of a running process, given its
108           PID</para>
109           <indexterm zone="ch-system-psmisc peekfd">
110             <primary sortas="b-peekfd">peekfd</primary>
111           </indexterm>
112         </listitem>
113       </varlistentry>
115       <varlistentry id="prtstat">
116         <term><command>prtstat</command></term>
117         <listitem>
118           <para>Prints information about a process</para>
119           <indexterm zone="ch-system-psmisc prtstat">
120             <primary sortas="b-prtstat">prtstat</primary>
121           </indexterm>
122         </listitem>
123       </varlistentry>
125       <varlistentry id="pslog">
126         <term><command>pslog</command></term>
127         <listitem>
128           <para>Reports current logs path of a process</para>
129           <indexterm zone="ch-system-psmisc pslog">
130             <primary sortas="b-pslog">pslog</primary>
131           </indexterm>
132         </listitem>
133       </varlistentry>
135       <varlistentry id="pstree">
136         <term><command>pstree</command></term>
137         <listitem>
138           <para>Displays running processes as a tree</para>
139           <indexterm zone="ch-system-psmisc pstree">
140             <primary sortas="b-pstree">pstree</primary>
141           </indexterm>
142         </listitem>
143       </varlistentry>
145       <varlistentry id="pstree.x11">
146         <term><command>pstree.x11</command></term>
147         <listitem>
148           <para>Same as <command>pstree</command>, except that it waits for
149           confirmation before exiting</para>
150           <indexterm zone="ch-system-psmisc pstree.x11">
151             <primary sortas="b-pstree.x11">pstree.x11</primary>
152           </indexterm>
153         </listitem>
154       </varlistentry>
156     </variablelist>
158   </sect2>
160 </sect1>