systemd: simplify systemd man page installation
[linux_from_scratch.git] / BOOK / chapter08 / libelf.xml
blob41e1ae476a40e12556cf47301b1443df1f089997
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-libelf" role="wrap">
9   <?dbhtml filename="libelf.html"?>
11   <sect1info condition="script">
12     <productname>libelf</productname>
13     <productnumber>&elfutils-version;</productnumber>
14     <address>&elfutils-url;</address>
15   </sect1info>
17   <title>Libelf from Elfutils-&elfutils-version;</title>
19   <indexterm zone="ch-system-libelf">
20     <primary sortas="a-Libelf">Libelf</primary>
21   </indexterm>
23   <sect2 role="package">
24     <title/>
26     <para>Libelf is a library for handling ELF (Executable and Linkable Format)
27     files.</para>
29     <segmentedlist>
30       <segtitle>&buildtime;</segtitle>
31       <segtitle>&diskspace;</segtitle>
33       <seglistitem>
34         <seg>&elfutils-fin-sbu;</seg>
35         <seg>&elfutils-fin-du;</seg>
36       </seglistitem>
37     </segmentedlist>
39   </sect2>
41   <sect2 role="installation">
42     <title>Installation of Libelf</title>
44       <para>Libelf is part of elfutils-&elfutils-version; package. Use
45       the elfutils-&elfutils-version;.tar.bz2 as the source tarball.</para>
47     <para>Prepare Libelf for compilation:</para>
49     <screen><userinput remap="configure">./configure --prefix=/usr                \
50             --disable-debuginfod         \
51             --enable-libdebuginfod=dummy \
52             --libdir=/lib</userinput></screen>
54     <para>Compile the package:</para>
56 <screen><userinput remap="make">make</userinput></screen>
58     <para>To test the results, issue:</para>
59     
60 <screen><userinput remap="test">make check</userinput></screen>
62 <!--    <para>One test, run-elfclassify.sh, is known to fail.</para>-->
64     <para>Install only Libelf:</para>
66 <screen><userinput remap="install">make -C libelf install
67 install -vm644 config/libelf.pc /usr/lib/pkgconfig
68 rm /lib/libelf.a</userinput></screen>
70   </sect2>
72   <sect2 id="contents-elfutils" role="content">
73     <title>Contents of Libelf</title>
75     <segmentedlist>
76       <segtitle>Installed Library</segtitle>
77       <segtitle>Installed Directory</segtitle>
79       <seglistitem>
80         <seg>
81           libelf.so (symlink) and libelf-&elfutils-version;.so
82         </seg>
83         <seg>
84           /usr/include/elfutils
85         </seg>
86       </seglistitem>
88     </segmentedlist>
90     <variablelist>
91       <bridgehead renderas="sect3">Short Descriptions</bridgehead>
92       <?dbfo list-presentation="list"?>
93       <?dbhtml list-presentation="table"?>
95       <varlistentry id="libelf">
96         <term><filename class="libraryfile">libelf</filename></term>
97         <listitem>
98           <para>Contains API functions to handle ELF object files</para>
99           <indexterm zone="ch-system-libelf libelf">
100             <primary sortas="c-libelf">libelf</primary>
101           </indexterm>
102         </listitem>
103       </varlistentry>
105     </variablelist>
107   </sect2>
109 </sect1>