Automate generate on man pages
[deliverable/binutils-gdb.git] / binutils / readelf.1
CommitLineData
0285c67d
NC
1.rn '' }`
2''' $RCSfile$$Revision$$Date$
3'''
4''' $Log$
5''' Revision 1.1 2001/03/25 20:32:25 nickc
6''' Automate generate on man pages
7'''
8'''
9.de Sh
10.br
11.if t .Sp
12.ne 5
13.PP
14\fB\\$1\fR
15.PP
16..
17.de Sp
18.if t .sp .5v
19.if n .sp
20..
21.de Ip
22.br
23.ie \\n(.$>=3 .ne \\$3
24.el .ne 3
25.IP "\\$1" \\$2
26..
27.de Vb
28.ft CW
29.nf
30.ne \\$1
31..
32.de Ve
33.ft R
34
35.fi
36..
37'''
38'''
39''' Set up \*(-- to give an unbreakable dash;
40''' string Tr holds user defined translation string.
41''' Bell System Logo is used as a dummy character.
42'''
43.tr \(*W-|\(bv\*(Tr
44.ie n \{\
45.ds -- \(*W-
46.ds PI pi
47.if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
48.if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
49.ds L" ""
50.ds R" ""
51''' \*(M", \*(S", \*(N" and \*(T" are the equivalent of
52''' \*(L" and \*(R", except that they are used on ".xx" lines,
53''' such as .IP and .SH, which do another additional levels of
54''' double-quote interpretation
55.ds M" """
56.ds S" """
57.ds N" """""
58.ds T" """""
59.ds L' '
60.ds R' '
61.ds M' '
62.ds S' '
63.ds N' '
64.ds T' '
65'br\}
66.el\{\
67.ds -- \(em\|
68.tr \*(Tr
69.ds L" ``
70.ds R" ''
71.ds M" ``
72.ds S" ''
73.ds N" ``
74.ds T" ''
75.ds L' `
76.ds R' '
77.ds M' `
78.ds S' '
79.ds N' `
80.ds T' '
81.ds PI \(*p
82'br\}
83.\" If the F register is turned on, we'll generate
84.\" index entries out stderr for the following things:
85.\" TH Title
86.\" SH Header
87.\" Sh Subsection
88.\" Ip Item
89.\" X<> Xref (embedded
90.\" Of course, you have to process the output yourself
91.\" in some meaninful fashion.
92.if \nF \{
93.de IX
94.tm Index:\\$1\t\\n%\t"\\$2"
95..
96.nr % 0
97.rr F
98.\}
99.TH READELF.1 1 "binutils-2.11.90" "23/Mar/101" "GNU"
100.UC
101.if n .hy 0
102.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
103.de CQ \" put $1 in typewriter font
104.ft CW
105'if n "\c
106'if t \\&\\$1\c
107'if n \\&\\$1\c
108'if n \&"
109\\&\\$2 \\$3 \\$4 \\$5 \\$6 \\$7
110'.ft R
111..
112.\" @(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2
113. \" AM - accent mark definitions
114.bd B 3
115. \" fudge factors for nroff and troff
116.if n \{\
117. ds #H 0
118. ds #V .8m
119. ds #F .3m
120. ds #[ \f1
121. ds #] \fP
122.\}
123.if t \{\
124. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
125. ds #V .6m
126. ds #F 0
127. ds #[ \&
128. ds #] \&
129.\}
130. \" simple accents for nroff and troff
131.if n \{\
132. ds ' \&
133. ds ` \&
134. ds ^ \&
135. ds , \&
136. ds ~ ~
137. ds ? ?
138. ds ! !
139. ds /
140. ds q
141.\}
142.if t \{\
143. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
144. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
145. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
146. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
147. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
148. ds ? \s-2c\h'-\w'c'u*7/10'\u\h'\*(#H'\zi\d\s+2\h'\w'c'u*8/10'
149. ds ! \s-2\(or\s+2\h'-\w'\(or'u'\v'-.8m'.\v'.8m'
150. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
151. ds q o\h'-\w'o'u*8/10'\s-4\v'.4m'\z\(*i\v'-.4m'\s+4\h'\w'o'u*8/10'
152.\}
153. \" troff and (daisy-wheel) nroff accents
154.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
155.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
156.ds v \\k:\h'-(\\n(.wu*9/10-\*(#H)'\v'-\*(#V'\*(#[\s-4v\s0\v'\*(#V'\h'|\\n:u'\*(#]
157.ds _ \\k:\h'-(\\n(.wu*9/10-\*(#H+(\*(#F*2/3))'\v'-.4m'\z\(hy\v'.4m'\h'|\\n:u'
158.ds . \\k:\h'-(\\n(.wu*8/10)'\v'\*(#V*4/10'\z.\v'-\*(#V*4/10'\h'|\\n:u'
159.ds 3 \*(#[\v'.2m'\s-2\&3\s0\v'-.2m'\*(#]
160.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
161.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
162.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
163.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
164.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
165.ds ae a\h'-(\w'a'u*4/10)'e
166.ds Ae A\h'-(\w'A'u*4/10)'E
167.ds oe o\h'-(\w'o'u*4/10)'e
168.ds Oe O\h'-(\w'O'u*4/10)'E
169. \" corrections for vroff
170.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
171.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
172. \" for low resolution devices (crt and lpr)
173.if \n(.H>23 .if \n(.V>19 \
174\{\
175. ds : e
176. ds 8 ss
177. ds v \h'-1'\o'\(aa\(ga'
178. ds _ \h'-1'^
179. ds . \h'-1'.
180. ds 3 3
181. ds o a
182. ds d- d\h'-1'\(ga
183. ds D- D\h'-1'\(hy
184. ds th \o'bp'
185. ds Th \o'LP'
186. ds ae ae
187. ds Ae AE
188. ds oe oe
189. ds Oe OE
190.\}
191.rm #[ #] #H #V #F C
192.SH "NAME"
193readelf \- Displays information about ELF files.
194.SH "SYNOPSIS"
195readelf [ \-a | --all ]
196 [ \-h | --file-header]
197 [ \-l | --program-headers | --segments]
198 [ \-S | --section-headers | --sections]
199 [ \-e | --headers]
200 [ \-s | --syms | --symbols]
201 [ \-n | --notes]
202 [ \-r | --relocs]
203 [ \-u | --unwind]
204 [ \-d | --dynamic]
205 [ \-V | --version-info]
206 [ \-D | --use-dynamic]
207 [ \-x <number> | --hex-dump=<number>]
208 [ \-w[liaprf] | --debug-dump[=info,=line,=abbrev,=pubnames,=ranges,=frames]]
209 [ --histogram]
210 [ \-v | --version]
211 [ \-H | --help]
212 \fIelffile\fR...
213.SH "DESCRIPTION"
214\f(CWreadelf\fR displays information about one or more ELF format object
215files. The options control what particular information to display.
216.PP
217\fIelffile\fR... are the object files to be examined. At the
218moment, \f(CWreadelf\fR does not support examining archives, nor does it
219support examing 64 bit ELF files.
220.SH "OPTIONS"
221The long and short forms of options, shown here as alternatives, are
222equivalent. At least one option besides \fB\-v\fR or \fB\-H\fR must be
223given.
224.Ip "\f(CW-a\fR" 4
225.Ip "\f(CW--all\fR" 4
226Equivalent to specifiying \fB--file-header\fR,
227\fB--program-headers\fR, \fB--sections\fR, \fB--symbols\fR,
228\fB--relocs\fR, \fB--dynamic\fR, \fB--notes\fR and
229\fB--version-info\fR.
230.Ip "\f(CW-h\fR" 4
231.Ip "\f(CW--file-header\fR" 4
232Displays the information contained in the \s-1ELF\s0 header at the start of the
233file.
234.Ip "\f(CW-l\fR" 4
235.Ip "\f(CW--program-headers\fR" 4
236.Ip "\f(CW--segments\fR" 4
237Displays the information contained in the file's segment headers, if it
238has any.
239.Ip "\f(CW-S\fR" 4
240.Ip "\f(CW--sections\fR" 4
241.Ip "\f(CW--section-headers\fR" 4
242Displays the information contained in the file's section headers, if it
243has any.
244.Ip "\f(CW-s\fR" 4
245.Ip "\f(CW--symbols\fR" 4
246.Ip "\f(CW--syms\fR" 4
247Displays the entries in symbol table section of the file, if it has one.
248.Ip "\f(CW-e\fR" 4
249.Ip "\f(CW--headers\fR" 4
250Display all the headers in the file. Equivalent to \fB\-h \-l \-S\fR.
251.Ip "\f(CW-n\fR" 4
252.Ip "\f(CW--notes\fR" 4
253Displays the contents of the \s-1NOTE\s0 segment, if it exists.
254.Ip "\f(CW-r\fR" 4
255.Ip "\f(CW--relocs\fR" 4
256Displays the contents of the file's relocation section, if it has one.
257.Ip "\f(CW-u\fR" 4
258.Ip "\f(CW--unwind\fR" 4
259Displays the contents of the file's unwind section, if it has one. Only
260the unwind sections for \s-1IA64\s0 \s-1ELF\s0 files are currently supported.
261.Ip "\f(CW-d\fR" 4
262.Ip "\f(CW--dynamic\fR" 4
263Displays the contents of the file's dynamic section, if it has one.
264.Ip "\f(CW-V\fR" 4
265.Ip "\f(CW--version-info\fR" 4
266Displays the contents of the version sections in the file, it they
267exist.
268.Ip "\f(CW-D\fR" 4
269.Ip "\f(CW--use-dynamic\fR" 4
270When displaying symbols, this option makes \f(CWreadelf\fR use the
271symbol table in the file's dynamic section, rather than the one in the
272symbols section.
273.Ip "\f(CW-x <number>\fR" 4
274.Ip "\f(CW--hex-dump=<number>\fR" 4
275Displays the contents of the indicated section as a hexadecimal dump.
276.Ip "\f(CW-w[liaprf]\fR" 4
277.Ip "\f(CW--debug-dump[=line,=info,=abbrev,=pubnames,=ranges,=frames]\fR" 4
278Displays the contents of the debug sections in the file, if any are
279present. If one of the optional letters or words follows the switch
280then only data found in those specific sections will be dumped.
281.Ip "\f(CW--histogram\fR" 4
282Display a histogram of bucket list lengths when displaying the contents
283of the symbol tables.
284.Ip "\f(CW-v\fR" 4
285.Ip "\f(CW--version\fR" 4
286Display the version number of readelf.
287.Ip "\f(CW-H\fR" 4
288.Ip "\f(CW--help\fR" 4
289Display the command line options understood by \f(CWreadelf\fR.
290.SH "SEE ALSO"
291\fIobjdump\fR\|(1), and the Info entries for \fIbinutils\fR.
292.SH "COPYRIGHT"
293Copyright (c) 1991, 92, 93, 94, 95, 96, 97, 98, 99, 2000, 2001 Free Software Foundation, Inc.
294.PP
295Permission is granted to copy, distribute and/or modify this document
296under the terms of the GNU Free Documentation License, Version 1.1
297or any later version published by the Free Software Foundation;
298with no Invariant Sections, with no Front-Cover Texts, and with no
299Back-Cover Texts. A copy of the license is included in the
300section entitled \*(L"GNU Free Documentation License\*(R".
301
302.rn }` ''
303.IX Title "READELF.1 1"
304.IX Name "readelf - Displays information about ELF files."
305
306.IX Header "NAME"
307
308.IX Header "SYNOPSIS"
309
310.IX Header "DESCRIPTION"
311
312.IX Header "OPTIONS"
313
314.IX Item "\f(CW-a\fR"
315
316.IX Item "\f(CW--all\fR"
317
318.IX Item "\f(CW-h\fR"
319
320.IX Item "\f(CW--file-header\fR"
321
322.IX Item "\f(CW-l\fR"
323
324.IX Item "\f(CW--program-headers\fR"
325
326.IX Item "\f(CW--segments\fR"
327
328.IX Item "\f(CW-S\fR"
329
330.IX Item "\f(CW--sections\fR"
331
332.IX Item "\f(CW--section-headers\fR"
333
334.IX Item "\f(CW-s\fR"
335
336.IX Item "\f(CW--symbols\fR"
337
338.IX Item "\f(CW--syms\fR"
339
340.IX Item "\f(CW-e\fR"
341
342.IX Item "\f(CW--headers\fR"
343
344.IX Item "\f(CW-n\fR"
345
346.IX Item "\f(CW--notes\fR"
347
348.IX Item "\f(CW-r\fR"
349
350.IX Item "\f(CW--relocs\fR"
351
352.IX Item "\f(CW-u\fR"
353
354.IX Item "\f(CW--unwind\fR"
355
356.IX Item "\f(CW-d\fR"
357
358.IX Item "\f(CW--dynamic\fR"
359
360.IX Item "\f(CW-V\fR"
361
362.IX Item "\f(CW--version-info\fR"
363
364.IX Item "\f(CW-D\fR"
365
366.IX Item "\f(CW--use-dynamic\fR"
367
368.IX Item "\f(CW-x <number>\fR"
369
370.IX Item "\f(CW--hex-dump=<number>\fR"
371
372.IX Item "\f(CW-w[liaprf]\fR"
373
374.IX Item "\f(CW--debug-dump[=line,=info,=abbrev,=pubnames,=ranges,=frames]\fR"
375
376.IX Item "\f(CW--histogram\fR"
377
378.IX Item "\f(CW-v\fR"
379
380.IX Item "\f(CW--version\fR"
381
382.IX Item "\f(CW-H\fR"
383
384.IX Item "\f(CW--help\fR"
385
386.IX Header "SEE ALSO"
387
388.IX Header "COPYRIGHT"
389
This page took 0.040975 seconds and 4 git commands to generate.