Merge from vendor branch GCC:
[dragonfly.git] / contrib / binutils / binutils / doc / readelf.1
1 .\" Automatically generated by Pod::Man v1.3, Pod::Parser v1.13
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
25 .fi
26 ..
27 .\" Set up some character translations and predefined strings.  \*(-- will
28 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
29 .\" double quote, and \*(R" will give a right double quote.  | will give a
30 .\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
31 .\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
32 .\" expand to `' in nroff, nothing in troff, for use with C<>.
33 .tr \(*W-|\(bv\*(Tr
34 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
35 .ie n \{\
36 .    ds -- \(*W-
37 .    ds PI pi
38 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
39 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
40 .    ds L" ""
41 .    ds R" ""
42 .    ds C` ""
43 .    ds C' ""
44 'br\}
45 .el\{\
46 .    ds -- \|\(em\|
47 .    ds PI \(*p
48 .    ds L" ``
49 .    ds R" ''
50 'br\}
51 .\"
52 .\" If the F register is turned on, we'll generate index entries on stderr for
53 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
54 .\" entries marked with X<> in POD.  Of course, you'll have to process the
55 .\" output yourself in some meaningful fashion.
56 .if \nF \{\
57 .    de IX
58 .    tm Index:\\$1\t\\n%\t"\\$2"
59 ..
60 .    nr % 0
61 .    rr F
62 .\}
63 .\"
64 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
65 .\" way too many mistakes in technical documents.
66 .hy 0
67 .\"
68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
69 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
70 .    \" fudge factors for nroff and troff
71 .if n \{\
72 .    ds #H 0
73 .    ds #V .8m
74 .    ds #F .3m
75 .    ds #[ \f1
76 .    ds #] \fP
77 .\}
78 .if t \{\
79 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
80 .    ds #V .6m
81 .    ds #F 0
82 .    ds #[ \&
83 .    ds #] \&
84 .\}
85 .    \" simple accents for nroff and troff
86 .if n \{\
87 .    ds ' \&
88 .    ds ` \&
89 .    ds ^ \&
90 .    ds , \&
91 .    ds ~ ~
92 .    ds /
93 .\}
94 .if t \{\
95 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
96 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
97 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
98 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
99 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
100 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
101 .\}
102 .    \" troff and (daisy-wheel) nroff accents
103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
110 .ds ae a\h'-(\w'a'u*4/10)'e
111 .ds Ae A\h'-(\w'A'u*4/10)'E
112 .    \" corrections for vroff
113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
115 .    \" for low resolution devices (crt and lpr)
116 .if \n(.H>23 .if \n(.V>19 \
117 \{\
118 .    ds : e
119 .    ds 8 ss
120 .    ds o a
121 .    ds d- d\h'-1'\(ga
122 .    ds D- D\h'-1'\(hy
123 .    ds th \o'bp'
124 .    ds Th \o'LP'
125 .    ds ae ae
126 .    ds Ae AE
127 .\}
128 .rm #[ #] #H #V #F C
129 .\" ========================================================================
130 .\"
131 .IX Title "READELF 1"
132 .TH READELF 1 "2002-05-14" "binutils-2.12.1" "GNU Development Tools"
133 .UC
134 .SH "NAME"
135 readelf \- Displays information about \s-1ELF\s0 files.
136 .SH "SYNOPSIS"
137 .IX Header "SYNOPSIS"
138 readelf [\fB\-a\fR|\fB\-\-all\fR] 
139         [\fB\-h\fR|\fB\-\-file\-header\fR]
140         [\fB\-l\fR|\fB\-\-program\-headers\fR|\fB\-\-segments\fR]
141         [\fB\-S\fR|\fB\-\-section\-headers\fR|\fB\-\-sections\fR]
142         [\fB\-e\fR|\fB\-\-headers\fR]
143         [\fB\-s\fR|\fB\-\-syms\fR|\fB\-\-symbols\fR]
144         [\fB\-n\fR|\fB\-\-notes\fR]
145         [\fB\-r\fR|\fB\-\-relocs\fR]
146         [\fB\-u\fR|\fB\-\-unwind\fR]
147         [\fB\-d\fR|\fB\-\-dynamic\fR]
148         [\fB\-V\fR|\fB\-\-version\-info\fR]
149         [\fB\-D\fR|\fB\-\-use\-dynamic\fR]
150         [\fB\-x\fR <number>|\fB\-\-hex\-dump=\fR<number>]
151         [\fB\-w[liaprmfs]\fR|\fB\-\-debug\-dump\fR[=line,=info,=abbrev,=pubnames,=ranges,=macro,=frames,=str]]
152         [\fB\-histogram\fR]
153         [\fB\-v\fR|\fB\-\-version\fR]
154         [\fB\-W\fR|\fB\-\-wide\fR]
155         [\fB\-H\fR|\fB\-\-help\fR]
156         \fIelffile\fR...
157 .SH "DESCRIPTION"
158 .IX Header "DESCRIPTION"
159 \&\fBreadelf\fR displays information about one or more \s-1ELF\s0 format object
160 files.  The options control what particular information to display.
161 .PP
162 \&\fIelffile\fR... are the object files to be examined.  At the
163 moment, \fBreadelf\fR does not support examining archives, nor does it
164 support examing 64 bit \s-1ELF\s0 files.
165 .SH "OPTIONS"
166 .IX Header "OPTIONS"
167 The long and short forms of options, shown here as alternatives, are
168 equivalent.  At least one option besides \fB\-v\fR or \fB\-H\fR must be
169 given. 
170 .IP "\fB\-a\fR" 4
171 .IX Item "-a"
172 .PD 0
173 .IP "\fB\-\-all\fR" 4
174 .IX Item "--all"
175 .PD
176 Equivalent to specifiying \fB\-\-file\-header\fR,
177 \&\fB\-\-program\-headers\fR, \fB\-\-sections\fR, \fB\-\-symbols\fR,
178 \&\fB\-\-relocs\fR, \fB\-\-dynamic\fR, \fB\-\-notes\fR and
179 \&\fB\-\-version\-info\fR. 
180 .IP "\fB\-h\fR" 4
181 .IX Item "-h"
182 .PD 0
183 .IP "\fB\-\-file\-header\fR" 4
184 .IX Item "--file-header"
185 .PD
186 Displays the information contained in the \s-1ELF\s0 header at the start of the
187 file.
188 .IP "\fB\-l\fR" 4
189 .IX Item "-l"
190 .PD 0
191 .IP "\fB\-\-program\-headers\fR" 4
192 .IX Item "--program-headers"
193 .IP "\fB\-\-segments\fR" 4
194 .IX Item "--segments"
195 .PD
196 Displays the information contained in the file's segment headers, if it
197 has any.
198 .IP "\fB\-S\fR" 4
199 .IX Item "-S"
200 .PD 0
201 .IP "\fB\-\-sections\fR" 4
202 .IX Item "--sections"
203 .IP "\fB\-\-section\-headers\fR" 4
204 .IX Item "--section-headers"
205 .PD
206 Displays the information contained in the file's section headers, if it
207 has any.
208 .IP "\fB\-s\fR" 4
209 .IX Item "-s"
210 .PD 0
211 .IP "\fB\-\-symbols\fR" 4
212 .IX Item "--symbols"
213 .IP "\fB\-\-syms\fR" 4
214 .IX Item "--syms"
215 .PD
216 Displays the entries in symbol table section of the file, if it has one.
217 .IP "\fB\-e\fR" 4
218 .IX Item "-e"
219 .PD 0
220 .IP "\fB\-\-headers\fR" 4
221 .IX Item "--headers"
222 .PD
223 Display all the headers in the file.  Equivalent to \fB\-h \-l \-S\fR.
224 .IP "\fB\-n\fR" 4
225 .IX Item "-n"
226 .PD 0
227 .IP "\fB\-\-notes\fR" 4
228 .IX Item "--notes"
229 .PD
230 Displays the contents of the \s-1NOTE\s0 segment, if it exists.
231 .IP "\fB\-r\fR" 4
232 .IX Item "-r"
233 .PD 0
234 .IP "\fB\-\-relocs\fR" 4
235 .IX Item "--relocs"
236 .PD
237 Displays the contents of the file's relocation section, if it has one.
238 .IP "\fB\-u\fR" 4
239 .IX Item "-u"
240 .PD 0
241 .IP "\fB\-\-unwind\fR" 4
242 .IX Item "--unwind"
243 .PD
244 Displays the contents of the file's unwind section, if it has one.  Only
245 the unwind sections for \s-1IA64\s0 \s-1ELF\s0 files are currently supported.
246 .IP "\fB\-d\fR" 4
247 .IX Item "-d"
248 .PD 0
249 .IP "\fB\-\-dynamic\fR" 4
250 .IX Item "--dynamic"
251 .PD
252 Displays the contents of the file's dynamic section, if it has one.
253 .IP "\fB\-V\fR" 4
254 .IX Item "-V"
255 .PD 0
256 .IP "\fB\-\-version\-info\fR" 4
257 .IX Item "--version-info"
258 .PD
259 Displays the contents of the version sections in the file, it they
260 exist.
261 .IP "\fB\-D\fR" 4
262 .IX Item "-D"
263 .PD 0
264 .IP "\fB\-\-use\-dynamic\fR" 4
265 .IX Item "--use-dynamic"
266 .PD
267 When displaying symbols, this option makes \fBreadelf\fR use the
268 symbol table in the file's dynamic section, rather than the one in the
269 symbols section.
270 .IP "\fB\-x <number>\fR" 4
271 .IX Item "-x <number>"
272 .PD 0
273 .IP "\fB\-\-hex\-dump=<number>\fR" 4
274 .IX Item "--hex-dump=<number>"
275 .PD
276 Displays the contents of the indicated section as a hexadecimal dump.
277 .IP "\fB\-w[liaprmfs]\fR" 4
278 .IX Item "-w[liaprmfs]"
279 .PD 0
280 .IP "\fB\-\-debug\-dump[=line,=info,=abbrev,=pubnames,=ranges,=macro,=frames,=str]\fR" 4
281 .IX Item "--debug-dump[=line,=info,=abbrev,=pubnames,=ranges,=macro,=frames,=str]"
282 .PD
283 Displays the contents of the debug sections in the file, if any are
284 present.  If one of the optional letters or words follows the switch
285 then only data found in those specific sections will be dumped.
286 .IP "\fB\-\-histogram\fR" 4
287 .IX Item "--histogram"
288 Display a histogram of bucket list lengths when displaying the contents
289 of the symbol tables.
290 .IP "\fB\-v\fR" 4
291 .IX Item "-v"
292 .PD 0
293 .IP "\fB\-\-version\fR" 4
294 .IX Item "--version"
295 .PD
296 Display the version number of readelf.
297 .IP "\fB\-W\fR" 4
298 .IX Item "-W"
299 .PD 0
300 .IP "\fB\-\-wide\fR" 4
301 .IX Item "--wide"
302 .PD
303 Don't break output lines to fit into 80 columns. By default
304 \&\fBreadelf\fR breaks section header and segment listing lines for
305 64\-bit \s-1ELF\s0 files, so that they fit into 80 columns. This option causes
306 \&\fBreadelf\fR to print each section header resp. each segment one a
307 single line, which is far more readable on terminals wider than 80 columns.
308 .IP "\fB\-H\fR" 4
309 .IX Item "-H"
310 .PD 0
311 .IP "\fB\-\-help\fR" 4
312 .IX Item "--help"
313 .PD
314 Display the command line options understood by \fBreadelf\fR.
315 .SH "SEE ALSO"
316 .IX Header "SEE ALSO"
317 \&\fIobjdump\fR\|(1), and the Info entries for \fIbinutils\fR.
318 .SH "COPYRIGHT"
319 .IX Header "COPYRIGHT"
320 Copyright (c) 1991, 92, 93, 94, 95, 96, 97, 98, 99, 2000, 2001, 2002 Free Software Foundation, Inc.
321 .PP
322 Permission is granted to copy, distribute and/or modify this document
323 under the terms of the \s-1GNU\s0 Free Documentation License, Version 1.1
324 or any later version published by the Free Software Foundation;
325 with no Invariant Sections, with no Front-Cover Texts, and with no
326 Back-Cover Texts.  A copy of the license is included in the
327 section entitled \*(L"\s-1GNU\s0 Free Documentation License\*(R".