Add binutils 2.15.
[dragonfly.git] / contrib / binutils-2.15 / binutils / doc / addr2line.1
1 .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14
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 .fi
25 ..
26 .\" Set up some character translations and predefined strings.  \*(-- will
27 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
28 .\" double quote, and \*(R" will give a right double quote.  | will give a
29 .\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
30 .\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
31 .\" expand to `' in nroff, nothing in troff, for use with C<>.
32 .tr \(*W-|\(bv\*(Tr
33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
34 .ie n \{\
35 .    ds -- \(*W-
36 .    ds PI pi
37 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
38 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
39 .    ds L" ""
40 .    ds R" ""
41 .    ds C` ""
42 .    ds C' ""
43 'br\}
44 .el\{\
45 .    ds -- \|\(em\|
46 .    ds PI \(*p
47 .    ds L" ``
48 .    ds R" ''
49 'br\}
50 .\"
51 .\" If the F register is turned on, we'll generate index entries on stderr for
52 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
53 .\" entries marked with X<> in POD.  Of course, you'll have to process the
54 .\" output yourself in some meaningful fashion.
55 .if \nF \{\
56 .    de IX
57 .    tm Index:\\$1\t\\n%\t"\\$2"
58 ..
59 .    nr % 0
60 .    rr F
61 .\}
62 .\"
63 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
64 .\" way too many mistakes in technical documents.
65 .hy 0
66 .\"
67 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
68 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
69 .    \" fudge factors for nroff and troff
70 .if n \{\
71 .    ds #H 0
72 .    ds #V .8m
73 .    ds #F .3m
74 .    ds #[ \f1
75 .    ds #] \fP
76 .\}
77 .if t \{\
78 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
79 .    ds #V .6m
80 .    ds #F 0
81 .    ds #[ \&
82 .    ds #] \&
83 .\}
84 .    \" simple accents for nroff and troff
85 .if n \{\
86 .    ds ' \&
87 .    ds ` \&
88 .    ds ^ \&
89 .    ds , \&
90 .    ds ~ ~
91 .    ds /
92 .\}
93 .if t \{\
94 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
95 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
96 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
97 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
98 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
99 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
100 .\}
101 .    \" troff and (daisy-wheel) nroff accents
102 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
103 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
104 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
105 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
106 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
107 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
108 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
109 .ds ae a\h'-(\w'a'u*4/10)'e
110 .ds Ae A\h'-(\w'A'u*4/10)'E
111 .    \" corrections for vroff
112 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
113 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
114 .    \" for low resolution devices (crt and lpr)
115 .if \n(.H>23 .if \n(.V>19 \
116 \{\
117 .    ds : e
118 .    ds 8 ss
119 .    ds o a
120 .    ds d- d\h'-1'\(ga
121 .    ds D- D\h'-1'\(hy
122 .    ds th \o'bp'
123 .    ds Th \o'LP'
124 .    ds ae ae
125 .    ds Ae AE
126 .\}
127 .rm #[ #] #H #V #F C
128 .\" ========================================================================
129 .\"
130 .IX Title "ADDR2LINE 1"
131 .TH ADDR2LINE 1 "2004-04-09" "binutils-2.14.91" "GNU Development Tools"
132 .SH "NAME"
133 addr2line \- convert addresses into file names and line numbers.
134 .SH "SYNOPSIS"
135 .IX Header "SYNOPSIS"
136 addr2line [\fB\-b\fR \fIbfdname\fR|\fB\-\-target=\fR\fIbfdname\fR]
137           [\fB\-C\fR|\fB\-\-demangle\fR[=\fIstyle\fR]]
138           [\fB\-e\fR \fIfilename\fR|\fB\-\-exe=\fR\fIfilename\fR]
139           [\fB\-f\fR|\fB\-\-functions\fR] [\fB\-s\fR|\fB\-\-basename\fR]
140           [\fB\-H\fR|\fB\-\-help\fR] [\fB\-V\fR|\fB\-\-version\fR]
141           [addr addr ...]
142 .SH "DESCRIPTION"
143 .IX Header "DESCRIPTION"
144 \&\fBaddr2line\fR translates program addresses into file names and line
145 numbers.  Given an address and an executable, it uses the debugging
146 information in the executable to figure out which file name and line
147 number are associated with a given address.
148 .PP
149 The executable to use is specified with the \fB\-e\fR option.  The
150 default is the file \fIa.out\fR.
151 .PP
152 \&\fBaddr2line\fR has two modes of operation.
153 .PP
154 In the first, hexadecimal addresses are specified on the command line,
155 and \fBaddr2line\fR displays the file name and line number for each
156 address.
157 .PP
158 In the second, \fBaddr2line\fR reads hexadecimal addresses from
159 standard input, and prints the file name and line number for each
160 address on standard output.  In this mode, \fBaddr2line\fR may be used
161 in a pipe to convert dynamically chosen addresses.
162 .PP
163 The format of the output is \fB\s-1FILENAME:LINENO\s0\fR.  The file name and
164 line number for each address is printed on a separate line.  If the
165 \&\fB\-f\fR option is used, then each \fB\s-1FILENAME:LINENO\s0\fR line is
166 preceded by a \fB\s-1FUNCTIONNAME\s0\fR line which is the name of the function
167 containing the address.
168 .PP
169 If the file name or function name can not be determined,
170 \&\fBaddr2line\fR will print two question marks in their place.  If the
171 line number can not be determined, \fBaddr2line\fR will print 0.
172 .SH "OPTIONS"
173 .IX Header "OPTIONS"
174 The long and short forms of options, shown here as alternatives, are
175 equivalent.
176 .IP "\fB\-b\fR \fIbfdname\fR" 4
177 .IX Item "-b bfdname"
178 .PD 0
179 .IP "\fB\-\-target=\fR\fIbfdname\fR" 4
180 .IX Item "--target=bfdname"
181 .PD
182 Specify that the object-code format for the object files is
183 \&\fIbfdname\fR.
184 .IP "\fB\-C\fR" 4
185 .IX Item "-C"
186 .PD 0
187 .IP "\fB\-\-demangle[=\fR\fIstyle\fR\fB]\fR" 4
188 .IX Item "--demangle[=style]"
189 .PD
190 Decode (\fIdemangle\fR) low-level symbol names into user-level names.
191 Besides removing any initial underscore prepended by the system, this
192 makes \*(C+ function names readable.  Different compilers have different
193 mangling styles. The optional demangling style argument can be used to 
194 choose an appropriate demangling style for your compiler. 
195 .IP "\fB\-e\fR \fIfilename\fR" 4
196 .IX Item "-e filename"
197 .PD 0
198 .IP "\fB\-\-exe=\fR\fIfilename\fR" 4
199 .IX Item "--exe=filename"
200 .PD
201 Specify the name of the executable for which addresses should be
202 translated.  The default file is \fIa.out\fR.
203 .IP "\fB\-f\fR" 4
204 .IX Item "-f"
205 .PD 0
206 .IP "\fB\-\-functions\fR" 4
207 .IX Item "--functions"
208 .PD
209 Display function names as well as file and line number information.
210 .IP "\fB\-s\fR" 4
211 .IX Item "-s"
212 .PD 0
213 .IP "\fB\-\-basenames\fR" 4
214 .IX Item "--basenames"
215 .PD
216 Display only the base of each file name.
217 .SH "SEE ALSO"
218 .IX Header "SEE ALSO"
219 Info entries for \fIbinutils\fR.
220 .SH "COPYRIGHT"
221 .IX Header "COPYRIGHT"
222 Copyright (c) 1991, 92, 93, 94, 95, 96, 97, 98, 99, 2000,
223 2001, 2002, 2003 Free Software Foundation, Inc.
224 .PP
225 Permission is granted to copy, distribute and/or modify this document
226 under the terms of the \s-1GNU\s0 Free Documentation License, Version 1.1
227 or any later version published by the Free Software Foundation;
228 with no Invariant Sections, with no Front-Cover Texts, and with no
229 Back-Cover Texts.  A copy of the license is included in the
230 section entitled ``\s-1GNU\s0 Free Documentation License''.