Initial bulk commit for "Git on MSys"
[msysgit/historical-msysgit.git] / mingw / man / man1 / addr2line.1
bloba839d1a3f086dcb8ff762b18eb4f18aa462b2a62
1 .\" Automatically generated by Pod::Man version 1.15
2 .\" Thu Jan 19 19:57:47 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 "ADDR2LINE 1"
140 .TH ADDR2LINE 1 "binutils-2.16.91" "2006-01-19" "GNU Development Tools"
142 .SH "NAME"
143 addr2line \- convert addresses into file names and line numbers.
144 .SH "SYNOPSIS"
145 .IX Header "SYNOPSIS"
146 addr2line [\fB\-b\fR \fIbfdname\fR|\fB\*(--target=\fR\fIbfdname\fR]
147           [\fB\-C\fR|\fB\*(--demangle\fR[=\fIstyle\fR]]
148           [\fB\-e\fR \fIfilename\fR|\fB\*(--exe=\fR\fIfilename\fR]
149           [\fB\-f\fR|\fB\*(--functions\fR] [\fB\-s\fR|\fB\*(--basename\fR]
150           [\fB\-i\fR|\fB\*(--inlines\fR]
151           [\fB\-H\fR|\fB\*(--help\fR] [\fB\-V\fR|\fB\*(--version\fR]
152           [addr addr ...]
153 .SH "DESCRIPTION"
154 .IX Header "DESCRIPTION"
155 \&\fBaddr2line\fR translates program addresses into file names and line
156 numbers.  Given an address and an executable, it uses the debugging
157 information in the executable to figure out which file name and line
158 number are associated with a given address.
160 The executable to use is specified with the \fB\-e\fR option.  The
161 default is the file \fIa.out\fR.
163 \&\fBaddr2line\fR has two modes of operation.
165 In the first, hexadecimal addresses are specified on the command line,
166 and \fBaddr2line\fR displays the file name and line number for each
167 address.
169 In the second, \fBaddr2line\fR reads hexadecimal addresses from
170 standard input, and prints the file name and line number for each
171 address on standard output.  In this mode, \fBaddr2line\fR may be used
172 in a pipe to convert dynamically chosen addresses.
174 The format of the output is \fB\s-1FILENAME:LINENO\s0\fR.  The file name and
175 line number for each address is printed on a separate line.  If the
176 \&\fB\-f\fR option is used, then each \fB\s-1FILENAME:LINENO\s0\fR line is
177 preceded by a \fB\s-1FUNCTIONNAME\s0\fR line which is the name of the function
178 containing the address.
180 If the file name or function name can not be determined,
181 \&\fBaddr2line\fR will print two question marks in their place.  If the
182 line number can not be determined, \fBaddr2line\fR will print 0.
183 .SH "OPTIONS"
184 .IX Header "OPTIONS"
185 The long and short forms of options, shown here as alternatives, are
186 equivalent.
187 .Ip "\fB\-b\fR \fIbfdname\fR" 4
188 .IX Item "-b bfdname"
189 .PD 0
190 .Ip "\fB\*(--target=\fR\fIbfdname\fR" 4
191 .IX Item "target=bfdname"
193 Specify that the object-code format for the object files is
194 \&\fIbfdname\fR.
195 .Ip "\fB\-C\fR" 4
196 .IX Item "-C"
197 .PD 0
198 .Ip "\fB\*(--demangle[=\fR\fIstyle\fR\fB]\fR" 4
199 .IX Item "demangle[=style]"
201 Decode (\fIdemangle\fR) low-level symbol names into user-level names.
202 Besides removing any initial underscore prepended by the system, this
203 makes \*(C+ function names readable.  Different compilers have different
204 mangling styles. The optional demangling style argument can be used to 
205 choose an appropriate demangling style for your compiler. 
206 .Ip "\fB\-e\fR \fIfilename\fR" 4
207 .IX Item "-e filename"
208 .PD 0
209 .Ip "\fB\*(--exe=\fR\fIfilename\fR" 4
210 .IX Item "exe=filename"
212 Specify the name of the executable for which addresses should be
213 translated.  The default file is \fIa.out\fR.
214 .Ip "\fB\-f\fR" 4
215 .IX Item "-f"
216 .PD 0
217 .Ip "\fB\*(--functions\fR" 4
218 .IX Item "functions"
220 Display function names as well as file and line number information.
221 .Ip "\fB\-s\fR" 4
222 .IX Item "-s"
223 .PD 0
224 .Ip "\fB\*(--basenames\fR" 4
225 .IX Item "basenames"
227 Display only the base of each file name.
228 .Ip "\fB\-i\fR" 4
229 .IX Item "-i"
230 .PD 0
231 .Ip "\fB\*(--inlines\fR" 4
232 .IX Item "inlines"
234 If the address belongs to a function that was inlined, the source
235 information for all enclosing scopes back to the first non-inlined
236 function will also be printed.  For example, if \f(CW\*(C`main\*(C'\fR inlines
237 \&\f(CW\*(C`callee1\*(C'\fR which inlines \f(CW\*(C`callee2\*(C'\fR, and address is from
238 \&\f(CW\*(C`callee2\*(C'\fR, the source information for \f(CW\*(C`callee1\*(C'\fR and \f(CW\*(C`main\*(C'\fR
239 will also be printed.
240 .Ip "\fB@\fR\fIfile\fR" 4
241 .IX Item "@file"
242 Read command-line options from \fIfile\fR.  The options read are
243 inserted in place of the original @\fIfile\fR option.  If \fIfile\fR
244 does not exist, or cannot be read, then the option will be treated
245 literally, and not removed.  
247 Options in \fIfile\fR are separated by whitespace.  A whitespace
248 character may be included in an option by surrounding the entire
249 option in either single or double quotes.  Any character (including a
250 backslash) may be included by prefixing the character to be included
251 with a backslash.  The \fIfile\fR may itself contain additional
252 @\fIfile\fR options; any such options will be processed recursively.
253 .SH "SEE ALSO"
254 .IX Header "SEE ALSO"
255 Info entries for \fIbinutils\fR.
256 .SH "COPYRIGHT"
257 .IX Header "COPYRIGHT"
258 Copyright (c) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
259 2000, 2001, 2002, 2003, 2004, 2005 Free Software Foundation, Inc.
261 Permission is granted to copy, distribute and/or modify this document
262 under the terms of the \s-1GNU\s0 Free Documentation License, Version 1.1
263 or any later version published by the Free Software Foundation;
264 with no Invariant Sections, with no Front-Cover Texts, and with no
265 Back-Cover Texts.  A copy of the license is included in the
266 section entitled \*(L"\s-1GNU\s0 Free Documentation License\*(R".