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