source: archive/elfutils.xml

trunk
Last change on this file was 3f2db3a6, checked in by Pierre Labastie <pierre.labastie@…>, 17 months ago

Remove sect1info tags

They only contain a date tag that is nowhere used.
  • Property mode set to 100644
File size: 10.7 KB
Line 
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 <!ENTITY elfutils-download-http
8 "https://sourceware.org/ftp/elfutils/&elfutils-version;/elfutils-&elfutils-version;.tar.bz2">
9 <!ENTITY elfutils-download-ftp
10 "ftp://sourceware.org/pub/elfutils/&elfutils-version;/elfutils-&elfutils-version;.tar.bz2">
11 <!ENTITY elfutils-md5sum "03599aee98c9b726c7a732a2dd0245d5">
12 <!ENTITY elfutils-size "8.0 MB">
13 <!ENTITY elfutils-buildsize "78 MB (with tests)">
14 <!ENTITY elfutils-time "0.9 SBU (with tests)">
15]>
16
17<sect1 id="elfutils" xreflabel="elfutils-&elfutils-version;">
18 <?dbhtml filename="elfutils.html"?>
19
20
21 <title>elfutils-&elfutils-version;</title>
22
23 <indexterm zone="elfutils">
24 <primary sortas="a-elfutils">elfutils</primary>
25 </indexterm>
26
27 <sect2 role="package">
28 <title>Introduction to elfutils</title>
29
30 <para>
31 The <application>elfutils</application> package contains a set of
32 utilities and libraries for handling ELF (Executable and Linkable Format)
33 files.
34 </para>
35
36 &lfs81_checked;
37
38 <bridgehead renderas="sect3">Package Information</bridgehead>
39 <itemizedlist spacing="compact">
40 <listitem>
41 <para>
42 Download (HTTP): <ulink url="&elfutils-download-http;"/>
43 </para>
44 </listitem>
45 <listitem>
46 <para>
47 Download (FTP): <ulink url="&elfutils-download-ftp;"/>
48 </para>
49 </listitem>
50 <listitem>
51 <para>
52 Download MD5 sum: &elfutils-md5sum;
53 </para>
54 </listitem>
55 <listitem>
56 <para>
57 Download size: &elfutils-size;
58 </para>
59 </listitem>
60 <listitem>
61 <para>
62 Estimated disk space required: &elfutils-buildsize;
63 </para>
64 </listitem>
65 <listitem>
66 <para>
67 Estimated build time: &elfutils-time;
68 </para>
69 </listitem>
70 </itemizedlist>
71
72 <bridgehead renderas="sect3">elfutils Dependencies</bridgehead>
73
74 <bridgehead renderas="sect4">Optional</bridgehead>
75 <para role="optional">
76 <xref linkend="valgrind"/>
77 </para>
78
79 <para condition="html" role="usernotes">
80 User Notes: <ulink url="&blfs-wiki;/elfutils"/>
81 </para>
82 </sect2>
83
84 <sect2 role="installation">
85 <title>Installation of elfutils</title>
86
87 <para>
88 Install <application>elfutils</application> by running the following
89 commands:
90 </para>
91
92<!-- don't disable static libs, disable-static switch doesn't work anyways -->
93<screen><userinput>./configure --prefix=/usr --program-prefix="eu-" &amp;&amp;
94make</userinput></screen>
95<!--
96 <para>
97 If you wish to run the test suite, first fix it to skip two failing tests:
98 </para>
99
100<screen><userinput>sed -i '/srcdir/ iexit 77\n' \
101 tests/run-backtrace-native.sh \
102 tests/run-backtrace-native-core.sh</userinput></screen>-->
103
104 <para>
105 To test the results, issue: <command>make check</command>.
106 One test, run-strip-nothing.sh, is known to fail.
107 </para>
108
109 <para>
110 Now, as the <systemitem class="username">root</systemitem> user:
111 </para>
112
113<screen role="root"><userinput>make install</userinput></screen>
114
115 </sect2>
116
117 <sect2 role="commands">
118 <title>Command Explanations</title>
119
120 <para>
121 <parameter>--program-prefix="eu-"</parameter>: This switch renames
122 installed programs to avoid conflict with
123 <application>Binutils</application> programs installed in LFS.
124 </para>
125
126 <para>
127 <option>--enable-valgrind</option>: Run all tests under valgrind.
128 </para>
129
130 </sect2>
131
132 <sect2 role="content">
133 <title>Contents</title>
134
135 <segmentedlist>
136 <segtitle>Installed Programs</segtitle>
137 <segtitle>Installed Libraries</segtitle>
138 <segtitle>Installed Directories</segtitle>
139
140 <seglistitem>
141 <seg>
142 eu-addr2line, eu-ar, eu-elfcmp, eu-elfcompress, eu-elflint,
143 eu-findtextrel, eu-make-debug-archive, eu-nm, eu-objdump,
144 eu-ranlib, eu-readelf, eu-size, eu-stack, eu-strings, eu-strip, and
145 eu-unstrip
146 </seg>
147 <seg>
148 libasm.{a,so}, libdw.{a,so}, libebl.a, libelf.{a,so}, and
149 some for different architectures under /usr/lib/elfutils
150 </seg>
151 <seg>
152 /usr/include/elfutils and
153 /usr/lib/elfutils
154 </seg>
155 </seglistitem>
156 </segmentedlist>
157
158 <variablelist>
159 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
160 <?dbfo list-presentation="list"?>
161 <?dbhtml list-presentation="table"?>
162
163 <varlistentry id="eu-addr2line">
164 <term><command>eu-addr2line</command></term>
165 <listitem>
166 <para>
167 converts addresses into file names and line numbers.
168 </para>
169 <indexterm zone="elfutils eu-addr2line">
170 <primary sortas="b-eu-addr2line">eu-addr2line</primary>
171 </indexterm>
172 </listitem>
173 </varlistentry>
174
175 <varlistentry id="eu-ar">
176 <term><command>eu-ar</command></term>
177 <listitem>
178 <para>
179 creates, modifies, and extracts from archives.
180 </para>
181 <indexterm zone="elfutils eu-ar">
182 <primary sortas="b-eu-ar">eu-ar</primary>
183 </indexterm>
184 </listitem>
185 </varlistentry>
186
187 <varlistentry id="eu-elfcmp">
188 <term><command>eu-elfcmp</command></term>
189 <listitem>
190 <para>
191 compares relevant parts of two ELF files for equality.
192 </para>
193 <indexterm zone="elfutils eu-elfcmp">
194 <primary sortas="b-eu-elfcmp">eu-elfcmp</primary>
195 </indexterm>
196 </listitem>
197 </varlistentry>
198
199 <varlistentry id="eu-elfcompress">
200 <term><command>eu-elfcompress</command></term>
201 <listitem>
202 <para>
203 compresses or decompresses sections in an ELF file.
204 </para>
205 <indexterm zone="elfutils eu-elfcompress">
206 <primary sortas="b-eu-elfcompress">eu-elfcompress</primary>
207 </indexterm>
208 </listitem>
209 </varlistentry>
210
211 <varlistentry id="eu-elflint">
212 <term><command>eu-elflint</command></term>
213 <listitem>
214 <para>
215 does pedantic checking of ELF files compliance with gABI/psABI spec.
216 </para>
217 <indexterm zone="elfutils eu-elflint">
218 <primary sortas="b-eu-elflint">eu-elflint</primary>
219 </indexterm>
220 </listitem>
221 </varlistentry>
222
223 <varlistentry id="eu-findtextrel">
224 <term><command>eu-findtextrel</command></term>
225 <listitem>
226 <para>
227 locates the source of text relocations in FILEs (a.out by default).
228 </para>
229 <indexterm zone="elfutils eu-findtextrel">
230 <primary sortas="b-eu-findtextrel">eu-findtextrel</primary>
231 </indexterm>
232 </listitem>
233 </varlistentry>
234
235<!--
236 <varlistentry id="eu-ld">
237 <term><command>eu-ld</command></term>
238 <listitem>
239 <para>
240 combines object and archive files.
241 </para>
242 <indexterm zone="elfutils eu-ld">
243 <primary sortas="b-eu-ld">eu-ld</primary>
244 </indexterm>
245 </listitem>
246 </varlistentry>
247-->
248
249 <varlistentry id="eu-nm">
250 <term><command>eu-nm</command></term>
251 <listitem>
252 <para>
253 lists symbols from FILEs (a.out by default).
254 </para>
255 <indexterm zone="elfutils eu-nm">
256 <primary sortas="b-eu-nm">eu-nm</primary>
257 </indexterm>
258 </listitem>
259 </varlistentry>
260
261 <varlistentry id="eu-objdump">
262 <term><command>eu-objdump</command></term>
263 <listitem>
264 <para>
265 shows information from FILEs (a.out by default).
266 </para>
267 <indexterm zone="elfutils eu-objdump">
268 <primary sortas="b-eu-objdump">eu-objdump</primary>
269 </indexterm>
270 </listitem>
271 </varlistentry>
272
273 <varlistentry id="eu-ranlib">
274 <term><command>eu-ranlib</command></term>
275 <listitem>
276 <para>
277 generates an index to speed up access to archives.
278 </para>
279 <indexterm zone="elfutils eu-ranlib">
280 <primary sortas="b-eu-ranlib">eu-ranlib</primary>
281 </indexterm>
282 </listitem>
283 </varlistentry>
284
285 <varlistentry id="eu-readelf">
286 <term><command>eu-readelf</command></term>
287 <listitem>
288 <para>
289 prints information from ELF files in human-readable form.
290 </para>
291 <indexterm zone="elfutils eu-readelf">
292 <primary sortas="b-eu-readelf">eu-readelf</primary>
293 </indexterm>
294 </listitem>
295 </varlistentry>
296
297 <varlistentry id="eu-size">
298 <term><command>eu-size</command></term>
299 <listitem>
300 <para>
301 lists section sizes of FILEs (a.out by default).
302 </para>
303 <indexterm zone="elfutils eu-size">
304 <primary sortas="b-eu-size">eu-size</primary>
305 </indexterm>
306 </listitem>
307 </varlistentry>
308
309 <varlistentry id="eu-stack">
310 <term><command>eu-stack</command></term>
311 <listitem>
312 <para>
313 prints a stack for each thread in a process or core file.
314 </para>
315 <indexterm zone="elfutils eu-stack">
316 <primary sortas="b-eu-stack">eu-stack</primary>
317 </indexterm>
318 </listitem>
319 </varlistentry>
320
321 <varlistentry id="eu-strings">
322 <term><command>eu-strings</command></term>
323 <listitem>
324 <para>
325 prints the strings of printable characters in files.
326 </para>
327 <indexterm zone="elfutils eu-strings">
328 <primary sortas="b-eu-strings">eu-strings</primary>
329 </indexterm>
330 </listitem>
331 </varlistentry>
332
333 <varlistentry id="eu-strip">
334 <term><command>eu-strip</command></term>
335 <listitem>
336 <para>
337 discards symbols from object files.
338 </para>
339 <indexterm zone="elfutils eu-strip">
340 <primary sortas="b-eu-strip">eu-strip</primary>
341 </indexterm>
342 </listitem>
343 </varlistentry>
344
345 <varlistentry id="eu-unstrip">
346 <term><command>eu-unstrip</command></term>
347 <listitem>
348 <para>
349 combines stripped files with separate symbols and debug information.
350 </para>
351 <indexterm zone="elfutils eu-unstrip">
352 <primary sortas="b-eu-unstrip">eu-unstrip</primary>
353 </indexterm>
354 </listitem>
355 </varlistentry>
356
357 </variablelist>
358
359 </sect2>
360
361</sect1>
Note: See TracBrowser for help on using the repository browser.