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