Merge branch 'vendor/GCC44'
[dragonfly.git] / contrib / binutils-2.22 / binutils / doc / readelf.1
1 .\" Automatically generated by Pod::Man 2.23 (Pod::Simple 3.14)
2 .\"
3 .\" Standard preamble:
4 .\" ========================================================================
5 .de Sp \" Vertical space (when we can't use .PP)
6 .if t .sp .5v
7 .if n .sp
8 ..
9 .de Vb \" Begin verbatim text
10 .ft CW
11 .nf
12 .ne \\$1
13 ..
14 .de Ve \" End verbatim text
15 .ft R
16 .fi
17 ..
18 .\" Set up some character translations and predefined strings.  \*(-- will
19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
20 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
21 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
22 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
23 .\" nothing in troff, for use with C<>.
24 .tr \(*W-
25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
26 .ie n \{\
27 .    ds -- \(*W-
28 .    ds PI pi
29 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
30 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
31 .    ds L" ""
32 .    ds R" ""
33 .    ds C` ""
34 .    ds C' ""
35 'br\}
36 .el\{\
37 .    ds -- \|\(em\|
38 .    ds PI \(*p
39 .    ds L" ``
40 .    ds R" ''
41 'br\}
42 .\"
43 .\" Escape single quotes in literal strings from groff's Unicode transform.
44 .ie \n(.g .ds Aq \(aq
45 .el       .ds Aq '
46 .\"
47 .\" If the F register is turned on, we'll generate index entries on stderr for
48 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
49 .\" entries marked with X<> in POD.  Of course, you'll have to process the
50 .\" output yourself in some meaningful fashion.
51 .ie \nF \{\
52 .    de IX
53 .    tm Index:\\$1\t\\n%\t"\\$2"
54 ..
55 .    nr % 0
56 .    rr F
57 .\}
58 .el \{\
59 .    de IX
60 ..
61 .\}
62 .\"
63 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
64 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
65 .    \" fudge factors for nroff and troff
66 .if n \{\
67 .    ds #H 0
68 .    ds #V .8m
69 .    ds #F .3m
70 .    ds #[ \f1
71 .    ds #] \fP
72 .\}
73 .if t \{\
74 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
75 .    ds #V .6m
76 .    ds #F 0
77 .    ds #[ \&
78 .    ds #] \&
79 .\}
80 .    \" simple accents for nroff and troff
81 .if n \{\
82 .    ds ' \&
83 .    ds ` \&
84 .    ds ^ \&
85 .    ds , \&
86 .    ds ~ ~
87 .    ds /
88 .\}
89 .if t \{\
90 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
91 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
92 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
93 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
94 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
95 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
96 .\}
97 .    \" troff and (daisy-wheel) nroff accents
98 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
99 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
100 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
101 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
102 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
103 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
104 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
105 .ds ae a\h'-(\w'a'u*4/10)'e
106 .ds Ae A\h'-(\w'A'u*4/10)'E
107 .    \" corrections for vroff
108 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
109 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
110 .    \" for low resolution devices (crt and lpr)
111 .if \n(.H>23 .if \n(.V>19 \
112 \{\
113 .    ds : e
114 .    ds 8 ss
115 .    ds o a
116 .    ds d- d\h'-1'\(ga
117 .    ds D- D\h'-1'\(hy
118 .    ds th \o'bp'
119 .    ds Th \o'LP'
120 .    ds ae ae
121 .    ds Ae AE
122 .\}
123 .rm #[ #] #H #V #F C
124 .\" ========================================================================
125 .\"
126 .IX Title "READELF 1"
127 .TH READELF 1 "2011-11-21" "binutils-2.21.90" "GNU Development Tools"
128 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
129 .\" way too many mistakes in technical documents.
130 .if n .ad l
131 .nh
132 .SH "NAME"
133 readelf \- Displays information about ELF files.
134 .SH "SYNOPSIS"
135 .IX Header "SYNOPSIS"
136 readelf [\fB\-a\fR|\fB\-\-all\fR]
137         [\fB\-h\fR|\fB\-\-file\-header\fR]
138         [\fB\-l\fR|\fB\-\-program\-headers\fR|\fB\-\-segments\fR]
139         [\fB\-S\fR|\fB\-\-section\-headers\fR|\fB\-\-sections\fR]
140         [\fB\-g\fR|\fB\-\-section\-groups\fR]
141         [\fB\-t\fR|\fB\-\-section\-details\fR]
142         [\fB\-e\fR|\fB\-\-headers\fR]
143         [\fB\-s\fR|\fB\-\-syms\fR|\fB\-\-symbols\fR]
144         [\fB\-\-dyn\-syms\fR]
145         [\fB\-n\fR|\fB\-\-notes\fR]
146         [\fB\-r\fR|\fB\-\-relocs\fR]
147         [\fB\-u\fR|\fB\-\-unwind\fR]
148         [\fB\-d\fR|\fB\-\-dynamic\fR]
149         [\fB\-V\fR|\fB\-\-version\-info\fR]
150         [\fB\-A\fR|\fB\-\-arch\-specific\fR]
151         [\fB\-D\fR|\fB\-\-use\-dynamic\fR]
152         [\fB\-x\fR <number or name>|\fB\-\-hex\-dump=\fR<number or name>]
153         [\fB\-p\fR <number or name>|\fB\-\-string\-dump=\fR<number or name>]
154         [\fB\-R\fR <number or name>|\fB\-\-relocated\-dump=\fR<number or name>]
155         [\fB\-c\fR|\fB\-\-archive\-index\fR]
156         [\fB\-w[lLiaprmfFsoRt]\fR|
157          \fB\-\-debug\-dump\fR[=rawline,=decodedline,=info,=abbrev,=pubnames,=aranges,=macro,=frames,=frames\-interp,=str,=loc,=Ranges,=pubtypes,=trace_info,=trace_abbrev,=trace_aranges,=gdb_index]]
158         [\fB\-\-dwarf\-depth=\fR\fIn\fR]
159         [\fB\-\-dwarf\-start=\fR\fIn\fR]
160         [\fB\-I\fR|\fB\-\-histogram\fR]
161         [\fB\-v\fR|\fB\-\-version\fR]
162         [\fB\-W\fR|\fB\-\-wide\fR]
163         [\fB\-H\fR|\fB\-\-help\fR]
164         \fIelffile\fR...
165 .SH "DESCRIPTION"
166 .IX Header "DESCRIPTION"
167 \&\fBreadelf\fR displays information about one or more \s-1ELF\s0 format object
168 files.  The options control what particular information to display.
169 .PP
170 \&\fIelffile\fR... are the object files to be examined.  32\-bit and
171 64\-bit \s-1ELF\s0 files are supported, as are archives containing \s-1ELF\s0 files.
172 .PP
173 This program performs a similar function to \fBobjdump\fR but it
174 goes into more detail and it exists independently of the \s-1BFD\s0
175 library, so if there is a bug in \s-1BFD\s0 then readelf will not be
176 affected.
177 .SH "OPTIONS"
178 .IX Header "OPTIONS"
179 The long and short forms of options, shown here as alternatives, are
180 equivalent.  At least one option besides \fB\-v\fR or \fB\-H\fR must be
181 given.
182 .IP "\fB\-a\fR" 4
183 .IX Item "-a"
184 .PD 0
185 .IP "\fB\-\-all\fR" 4
186 .IX Item "--all"
187 .PD
188 Equivalent to specifying \fB\-\-file\-header\fR,
189 \&\fB\-\-program\-headers\fR, \fB\-\-sections\fR, \fB\-\-symbols\fR,
190 \&\fB\-\-relocs\fR, \fB\-\-dynamic\fR, \fB\-\-notes\fR and
191 \&\fB\-\-version\-info\fR.
192 .IP "\fB\-h\fR" 4
193 .IX Item "-h"
194 .PD 0
195 .IP "\fB\-\-file\-header\fR" 4
196 .IX Item "--file-header"
197 .PD
198 Displays the information contained in the \s-1ELF\s0 header at the start of the
199 file.
200 .IP "\fB\-l\fR" 4
201 .IX Item "-l"
202 .PD 0
203 .IP "\fB\-\-program\-headers\fR" 4
204 .IX Item "--program-headers"
205 .IP "\fB\-\-segments\fR" 4
206 .IX Item "--segments"
207 .PD
208 Displays the information contained in the file's segment headers, if it
209 has any.
210 .IP "\fB\-S\fR" 4
211 .IX Item "-S"
212 .PD 0
213 .IP "\fB\-\-sections\fR" 4
214 .IX Item "--sections"
215 .IP "\fB\-\-section\-headers\fR" 4
216 .IX Item "--section-headers"
217 .PD
218 Displays the information contained in the file's section headers, if it
219 has any.
220 .IP "\fB\-g\fR" 4
221 .IX Item "-g"
222 .PD 0
223 .IP "\fB\-\-section\-groups\fR" 4
224 .IX Item "--section-groups"
225 .PD
226 Displays the information contained in the file's section groups, if it
227 has any.
228 .IP "\fB\-t\fR" 4
229 .IX Item "-t"
230 .PD 0
231 .IP "\fB\-\-section\-details\fR" 4
232 .IX Item "--section-details"
233 .PD
234 Displays the detailed section information. Implies \fB\-S\fR.
235 .IP "\fB\-s\fR" 4
236 .IX Item "-s"
237 .PD 0
238 .IP "\fB\-\-symbols\fR" 4
239 .IX Item "--symbols"
240 .IP "\fB\-\-syms\fR" 4
241 .IX Item "--syms"
242 .PD
243 Displays the entries in symbol table section of the file, if it has one.
244 .IP "\fB\-\-dyn\-syms\fR" 4
245 .IX Item "--dyn-syms"
246 Displays the entries in dynamic symbol table section of the file, if it
247 has one.
248 .IP "\fB\-e\fR" 4
249 .IX Item "-e"
250 .PD 0
251 .IP "\fB\-\-headers\fR" 4
252 .IX Item "--headers"
253 .PD
254 Display all the headers in the file.  Equivalent to \fB\-h \-l \-S\fR.
255 .IP "\fB\-n\fR" 4
256 .IX Item "-n"
257 .PD 0
258 .IP "\fB\-\-notes\fR" 4
259 .IX Item "--notes"
260 .PD
261 Displays the contents of the \s-1NOTE\s0 segments and/or sections, if any.
262 .IP "\fB\-r\fR" 4
263 .IX Item "-r"
264 .PD 0
265 .IP "\fB\-\-relocs\fR" 4
266 .IX Item "--relocs"
267 .PD
268 Displays the contents of the file's relocation section, if it has one.
269 .IP "\fB\-u\fR" 4
270 .IX Item "-u"
271 .PD 0
272 .IP "\fB\-\-unwind\fR" 4
273 .IX Item "--unwind"
274 .PD
275 Displays the contents of the file's unwind section, if it has one.  Only
276 the unwind sections for \s-1IA64\s0 \s-1ELF\s0 files, as well as \s-1ARM\s0 unwind tables
277 (\f(CW\*(C`.ARM.exidx\*(C'\fR / \f(CW\*(C`.ARM.extab\*(C'\fR) are currently supported.
278 .IP "\fB\-d\fR" 4
279 .IX Item "-d"
280 .PD 0
281 .IP "\fB\-\-dynamic\fR" 4
282 .IX Item "--dynamic"
283 .PD
284 Displays the contents of the file's dynamic section, if it has one.
285 .IP "\fB\-V\fR" 4
286 .IX Item "-V"
287 .PD 0
288 .IP "\fB\-\-version\-info\fR" 4
289 .IX Item "--version-info"
290 .PD
291 Displays the contents of the version sections in the file, it they
292 exist.
293 .IP "\fB\-A\fR" 4
294 .IX Item "-A"
295 .PD 0
296 .IP "\fB\-\-arch\-specific\fR" 4
297 .IX Item "--arch-specific"
298 .PD
299 Displays architecture-specific information in the file, if there
300 is any.
301 .IP "\fB\-D\fR" 4
302 .IX Item "-D"
303 .PD 0
304 .IP "\fB\-\-use\-dynamic\fR" 4
305 .IX Item "--use-dynamic"
306 .PD
307 When displaying symbols, this option makes \fBreadelf\fR use the
308 symbol hash tables in the file's dynamic section, rather than the
309 symbol table sections.
310 .IP "\fB\-x <number or name>\fR" 4
311 .IX Item "-x <number or name>"
312 .PD 0
313 .IP "\fB\-\-hex\-dump=<number or name>\fR" 4
314 .IX Item "--hex-dump=<number or name>"
315 .PD
316 Displays the contents of the indicated section as a hexadecimal bytes.
317 A number identifies a particular section by index in the section table;
318 any other string identifies all sections with that name in the object file.
319 .IP "\fB\-R <number or name>\fR" 4
320 .IX Item "-R <number or name>"
321 .PD 0
322 .IP "\fB\-\-relocated\-dump=<number or name>\fR" 4
323 .IX Item "--relocated-dump=<number or name>"
324 .PD
325 Displays the contents of the indicated section as a hexadecimal
326 bytes.  A number identifies a particular section by index in the
327 section table; any other string identifies all sections with that name
328 in the object file.  The contents of the section will be relocated
329 before they are displayed.
330 .IP "\fB\-p <number or name>\fR" 4
331 .IX Item "-p <number or name>"
332 .PD 0
333 .IP "\fB\-\-string\-dump=<number or name>\fR" 4
334 .IX Item "--string-dump=<number or name>"
335 .PD
336 Displays the contents of the indicated section as printable strings.
337 A number identifies a particular section by index in the section table;
338 any other string identifies all sections with that name in the object file.
339 .IP "\fB\-c\fR" 4
340 .IX Item "-c"
341 .PD 0
342 .IP "\fB\-\-archive\-index\fR" 4
343 .IX Item "--archive-index"
344 .PD
345 Displays the file symbol index infomation contained in the header part
346 of binary archives.  Performs the same function as the \fBt\fR
347 command to \fBar\fR, but without using the \s-1BFD\s0 library.
348 .IP "\fB\-w[lLiaprmfFsoRt]\fR" 4
349 .IX Item "-w[lLiaprmfFsoRt]"
350 .PD 0
351 .IP "\fB\-\-debug\-dump[=rawline,=decodedline,=info,=abbrev,=pubnames,=aranges,=macro,=frames,=frames\-interp,=str,=loc,=Ranges,=pubtypes,=trace_info,=trace_abbrev,=trace_aranges,=gdb_index]\fR" 4
352 .IX Item "--debug-dump[=rawline,=decodedline,=info,=abbrev,=pubnames,=aranges,=macro,=frames,=frames-interp,=str,=loc,=Ranges,=pubtypes,=trace_info,=trace_abbrev,=trace_aranges,=gdb_index]"
353 .PD
354 Displays the contents of the debug sections in the file, if any are
355 present.  If one of the optional letters or words follows the switch
356 then only data found in those specific sections will be dumped.
357 .Sp
358 Note that there is no single letter option to display the content of
359 trace sections or .gdb_index.
360 .Sp
361 Note: the \fB=decodedline\fR option will display the interpreted
362 contents of a .debug_line section whereas the \fB=rawline\fR option
363 dumps the contents in a raw format.
364 .Sp
365 Note: the \fB=frames\-interp\fR option will display the interpreted
366 contents of a .debug_frame section whereas the \fB=frames\fR option
367 dumps the contents in a raw format.
368 .Sp
369 Note: the output from the \fB=info\fR option can also be affected
370 by the options \fB\-\-dwarf\-depth\fR and \fB\-\-dwarf\-start\fR.
371 .IP "\fB\-\-dwarf\-depth=\fR\fIn\fR" 4
372 .IX Item "--dwarf-depth=n"
373 Limit the dump of the \f(CW\*(C`.debug_info\*(C'\fR section to \fIn\fR children.
374 This is only useful with \fB\-\-debug\-dump=info\fR.  The default is
375 to print all DIEs; the special value 0 for \fIn\fR will also have this
376 effect.
377 .Sp
378 With a non-zero value for \fIn\fR, DIEs at or deeper than \fIn\fR
379 levels will not be printed.  The range for \fIn\fR is zero-based.
380 .IP "\fB\-\-dwarf\-start=\fR\fIn\fR" 4
381 .IX Item "--dwarf-start=n"
382 Print only DIEs beginning with the \s-1DIE\s0 numbered \fIn\fR.  This is only
383 useful with \fB\-\-debug\-dump=info\fR.
384 .Sp
385 If specified, this option will suppress printing of any header
386 information and all DIEs before the \s-1DIE\s0 numbered \fIn\fR.  Only
387 siblings and children of the specified \s-1DIE\s0 will be printed.
388 .Sp
389 This can be used in conjunction with \fB\-\-dwarf\-depth\fR.
390 .IP "\fB\-I\fR" 4
391 .IX Item "-I"
392 .PD 0
393 .IP "\fB\-\-histogram\fR" 4
394 .IX Item "--histogram"
395 .PD
396 Display a histogram of bucket list lengths when displaying the contents
397 of the symbol tables.
398 .IP "\fB\-v\fR" 4
399 .IX Item "-v"
400 .PD 0
401 .IP "\fB\-\-version\fR" 4
402 .IX Item "--version"
403 .PD
404 Display the version number of readelf.
405 .IP "\fB\-W\fR" 4
406 .IX Item "-W"
407 .PD 0
408 .IP "\fB\-\-wide\fR" 4
409 .IX Item "--wide"
410 .PD
411 Don't break output lines to fit into 80 columns. By default
412 \&\fBreadelf\fR breaks section header and segment listing lines for
413 64\-bit \s-1ELF\s0 files, so that they fit into 80 columns. This option causes
414 \&\fBreadelf\fR to print each section header resp. each segment one a
415 single line, which is far more readable on terminals wider than 80 columns.
416 .IP "\fB\-H\fR" 4
417 .IX Item "-H"
418 .PD 0
419 .IP "\fB\-\-help\fR" 4
420 .IX Item "--help"
421 .PD
422 Display the command line options understood by \fBreadelf\fR.
423 .IP "\fB@\fR\fIfile\fR" 4
424 .IX Item "@file"
425 Read command-line options from \fIfile\fR.  The options read are
426 inserted in place of the original @\fIfile\fR option.  If \fIfile\fR
427 does not exist, or cannot be read, then the option will be treated
428 literally, and not removed.
429 .Sp
430 Options in \fIfile\fR are separated by whitespace.  A whitespace
431 character may be included in an option by surrounding the entire
432 option in either single or double quotes.  Any character (including a
433 backslash) may be included by prefixing the character to be included
434 with a backslash.  The \fIfile\fR may itself contain additional
435 @\fIfile\fR options; any such options will be processed recursively.
436 .SH "SEE ALSO"
437 .IX Header "SEE ALSO"
438 \&\fIobjdump\fR\|(1), and the Info entries for \fIbinutils\fR.
439 .SH "COPYRIGHT"
440 .IX Header "COPYRIGHT"
441 Copyright (c) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
442 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011
443 Free Software Foundation, Inc.
444 .PP
445 Permission is granted to copy, distribute and/or modify this document
446 under the terms of the \s-1GNU\s0 Free Documentation License, Version 1.3
447 or any later version published by the Free Software Foundation;
448 with no Invariant Sections, with no Front-Cover Texts, and with no
449 Back-Cover Texts.  A copy of the license is included in the
450 section entitled \*(L"\s-1GNU\s0 Free Documentation License\*(R".