systemd: simplify systemd man page installation
[linux_from_scratch.git] / BOOK / chapter08 / libcap.xml
blobf3b6c00742223da83b0d243e4d2aec02fe04141c
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-libcap" role="wrap">
9   <?dbhtml filename="libcap.html"?>
11   <sect1info condition="script">
12     <productname>libcap</productname>
13     <productnumber>&libcap-version;</productnumber>
14     <address>&libcap-url;</address>
15   </sect1info>
17   <title>Libcap-&libcap-version;</title>
19   <indexterm zone="ch-system-libcap">
20     <primary sortas="a-Libcap">Libcap</primary>
21   </indexterm>
23   <sect2 role="package">
24     <title/>
26     <para>The Libcap package implements the user-space interfaces to the POSIX
27     1003.1e capabilities available in Linux kernels. These capabilities are a
28     partitioning of the all powerful root privilege into a set of distinct
29     privileges.</para>
31     <segmentedlist>
32       <segtitle>&buildtime;</segtitle>
33       <segtitle>&diskspace;</segtitle>
35       <seglistitem>
36         <seg>&libcap-fin-sbu;</seg>
37         <seg>&libcap-fin-du;</seg>
38       </seglistitem>
39     </segmentedlist>
41   </sect2>
43   <sect2 role="installation">
44     <title>Installation of Libcap</title>
46     <para>Prevent static libraries from being installed:</para>
48 <screen><userinput remap="pre">sed -i '/install -m.*STA/d' libcap/Makefile</userinput></screen>
50     <para>Compile the package:</para>
52 <screen><userinput remap="make">make prefix=/usr lib=lib</userinput></screen>
54     <variablelist>
55       <title>The meaning of the make option:</title>
57       <varlistentry>
58         <term><parameter>lib=lib</parameter></term>
59         <listitem>
60           <para>This parameter sets the library directory to
61           <filename>/usr/lib</filename> rather than
62           <filename>/usr/lib64</filename> on x86_64. It has no effect on
63           x86.</para>
64         </listitem>
65       </varlistentry>
66     </variablelist>
68     <para>To test the results, issue:</para>
70 <screen><userinput remap="test">make test</userinput></screen>
72     <para>Install the package and make sure the essential libraries are in
73     the correct directory:</para>
75 <screen><userinput remap="install">make prefix=/usr lib=lib install
76 for libname in cap psx; do
77     mv -v /usr/lib/lib${libname}.so.* /lib
78     ln -sfv ../../lib/lib${libname}.so.2 /usr/lib/lib${libname}.so
79     chmod -v 755 /lib/lib${libname}.so.&libcap-version;
80 done</userinput></screen>
82   </sect2>
84   <sect2 id="contents-libcap" role="content">
85     <title>Contents of Libcap</title>
87     <segmentedlist>
88       <segtitle>Installed programs</segtitle>
89       <segtitle>Installed library</segtitle>
91       <seglistitem>
92         <seg>capsh, getcap, getpcaps, and setcap</seg>
93         <seg>libcap.so and libpsx.so</seg>
94       </seglistitem>
95     </segmentedlist>
97     <variablelist>
98       <bridgehead renderas="sect3">Short Descriptions</bridgehead>
99       <?dbfo list-presentation="list"?>
100       <?dbhtml list-presentation="table"?>
102       <varlistentry id="capsh">
103         <term><command>capsh</command></term>
104         <listitem>
105           <para>A shell wrapper to explore and constrain capability support</para>
106           <indexterm zone="ch-system-libcap capsh">
107             <primary sortas="b-capsh">capsh</primary>
108           </indexterm>
109         </listitem>
110       </varlistentry>
112       <varlistentry id="getcap">
113         <term><command>getcap</command></term>
114         <listitem>
115           <para>Examines file capabilities</para>
116           <indexterm zone="ch-system-libcap getcap">
117             <primary sortas="b-getcap">getcap</primary>
118           </indexterm>
119         </listitem>
120       </varlistentry>
122       <varlistentry id="getpcaps">
123         <term><command>getpcaps</command></term>
124         <listitem>
125           <para>Displays the capabilities on the queried process(es)</para>
126           <indexterm zone="ch-system-libcap getpcaps">
127             <primary sortas="b-getpcaps">getpcaps</primary>
128           </indexterm>
129         </listitem>
130       </varlistentry>
132       <varlistentry id="setcap">
133         <term><command>setcap</command></term>
134         <listitem>
135           <para>Sets file capabilities</para>
136           <indexterm zone="ch-system-libcap setcap">
137             <primary sortas="b-setcap">setcap</primary>
138           </indexterm>
139         </listitem>
140       </varlistentry>
142       <varlistentry id="libcap">
143         <term><filename class="libraryfile">libcap</filename></term>
144         <listitem>
145           <para>Contains the library functions for manipulating POSIX 1003.1e
146           capabilities</para>
147           <indexterm zone="ch-system-libcap libcap">
148             <primary sortas="c-libcap">libcap</primary>
149           </indexterm>
150         </listitem>
151       </varlistentry>
153       <varlistentry id="libpsx">
154         <term><filename class="libraryfile">libpsx</filename></term>
155         <listitem>
156           <para>Contains functions to support POSIX semantics for syscalls
157           associated with the pthread library</para>
158           <indexterm zone="ch-system-libcap libpsx">
159             <primary sortas="c-libpsx">libpsx</primary>
160           </indexterm>
161         </listitem>
162       </varlistentry>
164     </variablelist>
166   </sect2>
168 </sect1>