Work around MinGW mangling of "host:/path"
[msysgit/historical-msysgit.git] / mingw / man / man1 / readelf.1
blob51de000711b8940a7c2e12efddb9d408c7ab3430
1 .\" Automatically generated by Pod::Man version 1.15
2 .\" Thu Jan 19 19:58:34 2006
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
14 .de Sp \" Vertical space (when we can't use .PP)
15 .if t .sp .5v
16 .if n .sp
18 .de Ip \" List item
19 .br
20 .ie \\n(.$>=3 .ne \\$3
21 .el .ne 3
22 .IP "\\$1" \\$2
24 .de Vb \" Begin verbatim text
25 .ft CW
26 .nf
27 .ne \\$1
29 .de Ve \" End verbatim text
30 .ft R
32 .fi
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"
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 /
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'
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 \
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
136 .rm #[ #] #H #V #F C
137 .\" ======================================================================
139 .IX Title "READELF 1"
140 .TH READELF 1 "binutils-2.16.91" "2006-01-19" "GNU Development Tools"
142 .SH "NAME"
143 readelf \- Displays information about \s-1ELF\s0 files.
144 .SH "SYNOPSIS"
145 .IX Header "SYNOPSIS"
146 readelf [\fB\-a\fR|\fB\*(--all\fR] 
147         [\fB\-h\fR|\fB\*(--file-header\fR]
148         [\fB\-l\fR|\fB\*(--program-headers\fR|\fB\*(--segments\fR]
149         [\fB\-S\fR|\fB\*(--section-headers\fR|\fB\*(--sections\fR]
150         [\fB\-g\fR|\fB\*(--section-groups\fR]
151         [\fB\-t\fR|\fB\*(--section-details\fR]
152         [\fB\-e\fR|\fB\*(--headers\fR]
153         [\fB\-s\fR|\fB\*(--syms\fR|\fB\*(--symbols\fR]
154         [\fB\-n\fR|\fB\*(--notes\fR]
155         [\fB\-r\fR|\fB\*(--relocs\fR]
156         [\fB\-u\fR|\fB\*(--unwind\fR]
157         [\fB\-d\fR|\fB\*(--dynamic\fR]
158         [\fB\-V\fR|\fB\*(--version-info\fR]
159         [\fB\-A\fR|\fB\*(--arch-specific\fR]
160         [\fB\-D\fR|\fB\*(--use-dynamic\fR]
161         [\fB\-x\fR <number or name>|\fB\*(--hex-dump=\fR<number or name>]
162         [\fB\-w[liaprmfFsoR]\fR|
163          \fB\*(--debug-dump\fR[=line,=info,=abbrev,=pubnames,=aranges,=macro,=frames,=frames-interp,=str,=loc,=Ranges]]
164         [\fB\-I\fR|\fB\-histogram\fR]
165         [\fB\-v\fR|\fB\*(--version\fR]
166         [\fB\-W\fR|\fB\*(--wide\fR]
167         [\fB\-H\fR|\fB\*(--help\fR]
168         \fIelffile\fR...
169 .SH "DESCRIPTION"
170 .IX Header "DESCRIPTION"
171 \&\fBreadelf\fR displays information about one or more \s-1ELF\s0 format object
172 files.  The options control what particular information to display.
174 \&\fIelffile\fR... are the object files to be examined.  32\-bit and
175 64\-bit \s-1ELF\s0 files are supported, as are archives containing \s-1ELF\s0 files.
177 This program performs a similar function to \fBobjdump\fR but it
178 goes into more detail and it exists independently of the \s-1BFD\s0
179 library, so if there is a bug in \s-1BFD\s0 then readelf will not be
180 affected.
181 .SH "OPTIONS"
182 .IX Header "OPTIONS"
183 The long and short forms of options, shown here as alternatives, are
184 equivalent.  At least one option besides \fB\-v\fR or \fB\-H\fR must be
185 given. 
186 .Ip "\fB\-a\fR" 4
187 .IX Item "-a"
188 .PD 0
189 .Ip "\fB\*(--all\fR" 4
190 .IX Item "all"
192 Equivalent to specifiying \fB\*(--file-header\fR,
193 \&\fB\*(--program-headers\fR, \fB\*(--sections\fR, \fB\*(--symbols\fR,
194 \&\fB\*(--relocs\fR, \fB\*(--dynamic\fR, \fB\*(--notes\fR and
195 \&\fB\*(--version-info\fR. 
196 .Ip "\fB\-h\fR" 4
197 .IX Item "-h"
198 .PD 0
199 .Ip "\fB\*(--file-header\fR" 4
200 .IX Item "file-header"
202 Displays the information contained in the \s-1ELF\s0 header at the start of the
203 file.
204 .Ip "\fB\-l\fR" 4
205 .IX Item "-l"
206 .PD 0
207 .Ip "\fB\*(--program-headers\fR" 4
208 .IX Item "program-headers"
209 .Ip "\fB\*(--segments\fR" 4
210 .IX Item "segments"
212 Displays the information contained in the file's segment headers, if it
213 has any.
214 .Ip "\fB\-S\fR" 4
215 .IX Item "-S"
216 .PD 0
217 .Ip "\fB\*(--sections\fR" 4
218 .IX Item "sections"
219 .Ip "\fB\*(--section-headers\fR" 4
220 .IX Item "section-headers"
222 Displays the information contained in the file's section headers, if it
223 has any.
224 .Ip "\fB\-g\fR" 4
225 .IX Item "-g"
226 .PD 0
227 .Ip "\fB\*(--section-groups\fR" 4
228 .IX Item "section-groups"
230 Displays the information contained in the file's section groups, if it
231 has any.
232 .Ip "\fB\-t\fR" 4
233 .IX Item "-t"
234 .PD 0
235 .Ip "\fB\*(--section-details\fR" 4
236 .IX Item "section-details"
238 Displays the detailed section information. Implies \fB\-S\fR.
239 .Ip "\fB\-s\fR" 4
240 .IX Item "-s"
241 .PD 0
242 .Ip "\fB\*(--symbols\fR" 4
243 .IX Item "symbols"
244 .Ip "\fB\*(--syms\fR" 4
245 .IX Item "syms"
247 Displays the entries in symbol table section of the file, if it 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"
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"
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"
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"
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 are currently supported.
277 .Ip "\fB\-d\fR" 4
278 .IX Item "-d"
279 .PD 0
280 .Ip "\fB\*(--dynamic\fR" 4
281 .IX Item "dynamic"
283 Displays the contents of the file's dynamic section, if it has one.
284 .Ip "\fB\-V\fR" 4
285 .IX Item "-V"
286 .PD 0
287 .Ip "\fB\*(--version-info\fR" 4
288 .IX Item "version-info"
290 Displays the contents of the version sections in the file, it they
291 exist.
292 .Ip "\fB\-A\fR" 4
293 .IX Item "-A"
294 .PD 0
295 .Ip "\fB\*(--arch-specific\fR" 4
296 .IX Item "arch-specific"
298 Displays architecture-specific information in the file, if there
299 is any.
300 .Ip "\fB\-D\fR" 4
301 .IX Item "-D"
302 .PD 0
303 .Ip "\fB\*(--use-dynamic\fR" 4
304 .IX Item "use-dynamic"
306 When displaying symbols, this option makes \fBreadelf\fR use the
307 symbol table in the file's dynamic section, rather than the one in the
308 symbols section.
309 .Ip "\fB\-x <number or name>\fR" 4
310 .IX Item "-x <number or name>"
311 .PD 0
312 .Ip "\fB\*(--hex-dump=<number or name>\fR" 4
313 .IX Item "hex-dump=<number or name>"
315 Displays the contents of the indicated section as a hexadecimal dump.
316 A number identifies a particular section by index in the section table;
317 any other string identifies all sections with that name in the object file.
318 .Ip "\fB\-w[liaprmfFsoR]\fR" 4
319 .IX Item "-w[liaprmfFsoR]"
320 .PD 0
321 .Ip "\fB\*(--debug-dump[=line,=info,=abbrev,=pubnames,=aranges,=macro,=frames,=frames-interp,=str,=loc,=Ranges]\fR" 4
322 .IX Item "debug-dump[=line,=info,=abbrev,=pubnames,=aranges,=macro,=frames,=frames-interp,=str,=loc,=Ranges]"
324 Displays the contents of the debug sections in the file, if any are
325 present.  If one of the optional letters or words follows the switch
326 then only data found in those specific sections will be dumped.
327 .Ip "\fB\-I\fR" 4
328 .IX Item "-I"
329 .PD 0
330 .Ip "\fB\*(--histogram\fR" 4
331 .IX Item "histogram"
333 Display a histogram of bucket list lengths when displaying the contents
334 of the symbol tables.
335 .Ip "\fB\-v\fR" 4
336 .IX Item "-v"
337 .PD 0
338 .Ip "\fB\*(--version\fR" 4
339 .IX Item "version"
341 Display the version number of readelf.
342 .Ip "\fB\-W\fR" 4
343 .IX Item "-W"
344 .PD 0
345 .Ip "\fB\*(--wide\fR" 4
346 .IX Item "wide"
348 Don't break output lines to fit into 80 columns. By default
349 \&\fBreadelf\fR breaks section header and segment listing lines for
350 64\-bit \s-1ELF\s0 files, so that they fit into 80 columns. This option causes
351 \&\fBreadelf\fR to print each section header resp. each segment one a
352 single line, which is far more readable on terminals wider than 80 columns.
353 .Ip "\fB\-H\fR" 4
354 .IX Item "-H"
355 .PD 0
356 .Ip "\fB\*(--help\fR" 4
357 .IX Item "help"
359 Display the command line options understood by \fBreadelf\fR.
360 .Ip "\fB@\fR\fIfile\fR" 4
361 .IX Item "@file"
362 Read command-line options from \fIfile\fR.  The options read are
363 inserted in place of the original @\fIfile\fR option.  If \fIfile\fR
364 does not exist, or cannot be read, then the option will be treated
365 literally, and not removed.  
367 Options in \fIfile\fR are separated by whitespace.  A whitespace
368 character may be included in an option by surrounding the entire
369 option in either single or double quotes.  Any character (including a
370 backslash) may be included by prefixing the character to be included
371 with a backslash.  The \fIfile\fR may itself contain additional
372 @\fIfile\fR options; any such options will be processed recursively.
373 .SH "SEE ALSO"
374 .IX Header "SEE ALSO"
375 \&\fIobjdump\fR\|(1), and the Info entries for \fIbinutils\fR.
376 .SH "COPYRIGHT"
377 .IX Header "COPYRIGHT"
378 Copyright (c) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
379 2000, 2001, 2002, 2003, 2004, 2005 Free Software Foundation, Inc.
381 Permission is granted to copy, distribute and/or modify this document
382 under the terms of the \s-1GNU\s0 Free Documentation License, Version 1.1
383 or any later version published by the Free Software Foundation;
384 with no Invariant Sections, with no Front-Cover Texts, and with no
385 Back-Cover Texts.  A copy of the license is included in the
386 section entitled \*(L"\s-1GNU\s0 Free Documentation License\*(R".