Merge branch 'vendor/GCC50'
[dragonfly.git] / contrib / binutils-2.24 / binutils / doc / addr2line.1
1 .\" Automatically generated by Pod::Man 2.23 (Pod::Simple 3.14)
2 .\"
3 .\" Standard preamble:
4 .\" ========================================================================
5 .de Sp \" Vertical space (when we can't use .PP)
6 .if t .sp .5v
7 .if n .sp
8 ..
9 .de Vb \" Begin verbatim text
10 .ft CW
11 .nf
12 .ne \\$1
13 ..
14 .de Ve \" End verbatim text
15 .ft R
16 .fi
17 ..
18 .\" Set up some character translations and predefined strings.  \*(-- will
19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
20 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
21 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
22 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
23 .\" nothing in troff, for use with C<>.
24 .tr \(*W-
25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
26 .ie n \{\
27 .    ds -- \(*W-
28 .    ds PI pi
29 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
30 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
31 .    ds L" ""
32 .    ds R" ""
33 .    ds C` ""
34 .    ds C' ""
35 'br\}
36 .el\{\
37 .    ds -- \|\(em\|
38 .    ds PI \(*p
39 .    ds L" ``
40 .    ds R" ''
41 'br\}
42 .\"
43 .\" Escape single quotes in literal strings from groff's Unicode transform.
44 .ie \n(.g .ds Aq \(aq
45 .el       .ds Aq '
46 .\"
47 .\" If the F register is turned on, we'll generate index entries on stderr for
48 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
49 .\" entries marked with X<> in POD.  Of course, you'll have to process the
50 .\" output yourself in some meaningful fashion.
51 .ie \nF \{\
52 .    de IX
53 .    tm Index:\\$1\t\\n%\t"\\$2"
54 ..
55 .    nr % 0
56 .    rr F
57 .\}
58 .el \{\
59 .    de IX
60 ..
61 .\}
62 .\"
63 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
64 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
65 .    \" fudge factors for nroff and troff
66 .if n \{\
67 .    ds #H 0
68 .    ds #V .8m
69 .    ds #F .3m
70 .    ds #[ \f1
71 .    ds #] \fP
72 .\}
73 .if t \{\
74 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
75 .    ds #V .6m
76 .    ds #F 0
77 .    ds #[ \&
78 .    ds #] \&
79 .\}
80 .    \" simple accents for nroff and troff
81 .if n \{\
82 .    ds ' \&
83 .    ds ` \&
84 .    ds ^ \&
85 .    ds , \&
86 .    ds ~ ~
87 .    ds /
88 .\}
89 .if t \{\
90 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
91 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
92 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
93 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
94 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
95 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
96 .\}
97 .    \" troff and (daisy-wheel) nroff accents
98 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
99 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
100 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
101 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
102 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
103 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
104 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
105 .ds ae a\h'-(\w'a'u*4/10)'e
106 .ds Ae A\h'-(\w'A'u*4/10)'E
107 .    \" corrections for vroff
108 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
109 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
110 .    \" for low resolution devices (crt and lpr)
111 .if \n(.H>23 .if \n(.V>19 \
112 \{\
113 .    ds : e
114 .    ds 8 ss
115 .    ds o a
116 .    ds d- d\h'-1'\(ga
117 .    ds D- D\h'-1'\(hy
118 .    ds th \o'bp'
119 .    ds Th \o'LP'
120 .    ds ae ae
121 .    ds Ae AE
122 .\}
123 .rm #[ #] #H #V #F C
124 .\" ========================================================================
125 .\"
126 .IX Title "ADDR2LINE 1"
127 .TH ADDR2LINE 1 "2013-11-18" "binutils-2.23.91" "GNU Development Tools"
128 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
129 .\" way too many mistakes in technical documents.
130 .if n .ad l
131 .nh
132 .SH "NAME"
133 addr2line \- convert addresses into file names and line numbers.
134 .SH "SYNOPSIS"
135 .IX Header "SYNOPSIS"
136 addr2line [\fB\-a\fR|\fB\-\-addresses\fR]
137           [\fB\-b\fR \fIbfdname\fR|\fB\-\-target=\fR\fIbfdname\fR]
138           [\fB\-C\fR|\fB\-\-demangle\fR[=\fIstyle\fR]]
139           [\fB\-e\fR \fIfilename\fR|\fB\-\-exe=\fR\fIfilename\fR]
140           [\fB\-f\fR|\fB\-\-functions\fR] [\fB\-s\fR|\fB\-\-basename\fR]
141           [\fB\-i\fR|\fB\-\-inlines\fR]
142           [\fB\-p\fR|\fB\-\-pretty\-print\fR]
143           [\fB\-j\fR|\fB\-\-section=\fR\fIname\fR]
144           [\fB\-H\fR|\fB\-\-help\fR] [\fB\-V\fR|\fB\-\-version\fR]
145           [addr addr ...]
146 .SH "DESCRIPTION"
147 .IX Header "DESCRIPTION"
148 \&\fBaddr2line\fR translates addresses into file names and line numbers.
149 Given an address in an executable or an offset in a section of a relocatable
150 object, it uses the debugging information to figure out which file name and
151 line number are associated with it.
152 .PP
153 The executable or relocatable object to use is specified with the \fB\-e\fR
154 option.  The default is the file \fIa.out\fR.  The section in the relocatable
155 object to use is specified with the \fB\-j\fR option.
156 .PP
157 \&\fBaddr2line\fR has two modes of operation.
158 .PP
159 In the first, hexadecimal addresses are specified on the command line,
160 and \fBaddr2line\fR displays the file name and line number for each
161 address.
162 .PP
163 In the second, \fBaddr2line\fR reads hexadecimal addresses from
164 standard input, and prints the file name and line number for each
165 address on standard output.  In this mode, \fBaddr2line\fR may be used
166 in a pipe to convert dynamically chosen addresses.
167 .PP
168 The format of the output is \fB\s-1FILENAME:LINENO\s0\fR.  The file name and
169 line number for each input address is printed on separate lines.
170 .PP
171 If the \fB\-f\fR option is used, then each \fB\s-1FILENAME:LINENO\s0\fR
172 line is preceded by \fB\s-1FUNCTIONNAME\s0\fR which is the name of the
173 function containing the address.
174 .PP
175 If the \fB\-i\fR option is used and the code at the given address is
176 present there because of inlining by the compiler then the
177 \&\fB{\s-1FUNCTIONNAME\s0} \s-1FILENAME:LINENO\s0\fR information for the inlining
178 function will be displayed afterwards.  This continues recursively
179 until there is no more inlining to report.
180 .PP
181 If the \fB\-a\fR option is used then the output is prefixed by the
182 input address.
183 .PP
184 If the \fB\-p\fR option is used then the output for each input
185 address is displayed on one, possibly quite long, line.  If
186 \&\fB\-p\fR is not used then the output is broken up into multiple
187 lines, based on the paragraphs above.
188 .PP
189 If the file name or function name can not be determined,
190 \&\fBaddr2line\fR will print two question marks in their place.  If the
191 line number can not be determined, \fBaddr2line\fR will print 0.
192 .SH "OPTIONS"
193 .IX Header "OPTIONS"
194 The long and short forms of options, shown here as alternatives, are
195 equivalent.
196 .IP "\fB\-a\fR" 4
197 .IX Item "-a"
198 .PD 0
199 .IP "\fB\-\-addresses\fR" 4
200 .IX Item "--addresses"
201 .PD
202 Display the address before the function name, file and line number
203 information.  The address is printed with a \fB0x\fR prefix to easily
204 identify it.
205 .IP "\fB\-b\fR \fIbfdname\fR" 4
206 .IX Item "-b bfdname"
207 .PD 0
208 .IP "\fB\-\-target=\fR\fIbfdname\fR" 4
209 .IX Item "--target=bfdname"
210 .PD
211 Specify that the object-code format for the object files is
212 \&\fIbfdname\fR.
213 .IP "\fB\-C\fR" 4
214 .IX Item "-C"
215 .PD 0
216 .IP "\fB\-\-demangle[=\fR\fIstyle\fR\fB]\fR" 4
217 .IX Item "--demangle[=style]"
218 .PD
219 Decode (\fIdemangle\fR) low-level symbol names into user-level names.
220 Besides removing any initial underscore prepended by the system, this
221 makes \*(C+ function names readable.  Different compilers have different
222 mangling styles. The optional demangling style argument can be used to
223 choose an appropriate demangling style for your compiler.
224 .IP "\fB\-e\fR \fIfilename\fR" 4
225 .IX Item "-e filename"
226 .PD 0
227 .IP "\fB\-\-exe=\fR\fIfilename\fR" 4
228 .IX Item "--exe=filename"
229 .PD
230 Specify the name of the executable for which addresses should be
231 translated.  The default file is \fIa.out\fR.
232 .IP "\fB\-f\fR" 4
233 .IX Item "-f"
234 .PD 0
235 .IP "\fB\-\-functions\fR" 4
236 .IX Item "--functions"
237 .PD
238 Display function names as well as file and line number information.
239 .IP "\fB\-s\fR" 4
240 .IX Item "-s"
241 .PD 0
242 .IP "\fB\-\-basenames\fR" 4
243 .IX Item "--basenames"
244 .PD
245 Display only the base of each file name.
246 .IP "\fB\-i\fR" 4
247 .IX Item "-i"
248 .PD 0
249 .IP "\fB\-\-inlines\fR" 4
250 .IX Item "--inlines"
251 .PD
252 If the address belongs to a function that was inlined, the source
253 information for all enclosing scopes back to the first non-inlined
254 function will also be printed.  For example, if \f(CW\*(C`main\*(C'\fR inlines
255 \&\f(CW\*(C`callee1\*(C'\fR which inlines \f(CW\*(C`callee2\*(C'\fR, and address is from
256 \&\f(CW\*(C`callee2\*(C'\fR, the source information for \f(CW\*(C`callee1\*(C'\fR and \f(CW\*(C`main\*(C'\fR
257 will also be printed.
258 .IP "\fB\-j\fR" 4
259 .IX Item "-j"
260 .PD 0
261 .IP "\fB\-\-section\fR" 4
262 .IX Item "--section"
263 .PD
264 Read offsets relative to the specified section instead of absolute addresses.
265 .IP "\fB\-p\fR" 4
266 .IX Item "-p"
267 .PD 0
268 .IP "\fB\-\-pretty\-print\fR" 4
269 .IX Item "--pretty-print"
270 .PD
271 Make the output more human friendly: each location are printed on one line.
272 If option \fB\-i\fR is specified, lines for all enclosing scopes are
273 prefixed with \fB(inlined by)\fR.
274 .IP "\fB@\fR\fIfile\fR" 4
275 .IX Item "@file"
276 Read command-line options from \fIfile\fR.  The options read are
277 inserted in place of the original @\fIfile\fR option.  If \fIfile\fR
278 does not exist, or cannot be read, then the option will be treated
279 literally, and not removed.
280 .Sp
281 Options in \fIfile\fR are separated by whitespace.  A whitespace
282 character may be included in an option by surrounding the entire
283 option in either single or double quotes.  Any character (including a
284 backslash) may be included by prefixing the character to be included
285 with a backslash.  The \fIfile\fR may itself contain additional
286 @\fIfile\fR options; any such options will be processed recursively.
287 .SH "SEE ALSO"
288 .IX Header "SEE ALSO"
289 Info entries for \fIbinutils\fR.
290 .SH "COPYRIGHT"
291 .IX Header "COPYRIGHT"
292 Copyright (c) 1991\-2013 Free Software Foundation, Inc.
293 .PP
294 Permission is granted to copy, distribute and/or modify this document
295 under the terms of the \s-1GNU\s0 Free Documentation License, Version 1.3
296 or any later version published by the Free Software Foundation;
297 with no Invariant Sections, with no Front-Cover Texts, and with no
298 Back-Cover Texts.  A copy of the license is included in the
299 section entitled \*(L"\s-1GNU\s0 Free Documentation License\*(R".