binutils 2.20: Upgrade to version 2.20.1
[dragonfly.git] / gnu / usr.bin / binutils220 / cxxfilt / c++filt.1
1 .\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.05)
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.  \*(C+ will
29 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
30 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
31 .\" nothing in troff, for use with C<>.
32 .tr \(*W-
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 .\" Escape single quotes in literal strings from groff's Unicode transform.
52 .ie \n(.g .ds Aq \(aq
53 .el       .ds Aq '
54 .\"
55 .\" If the F register is turned on, we'll generate index entries on stderr for
56 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
57 .\" entries marked with X<> in POD.  Of course, you'll have to process the
58 .\" output yourself in some meaningful fashion.
59 .ie \nF \{\
60 .    de IX
61 .    tm Index:\\$1\t\\n%\t"\\$2"
62 ..
63 .    nr % 0
64 .    rr F
65 .\}
66 .el \{\
67 .    de IX
68 ..
69 .\}
70 .\"
71 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
72 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
73 .    \" fudge factors for nroff and troff
74 .if n \{\
75 .    ds #H 0
76 .    ds #V .8m
77 .    ds #F .3m
78 .    ds #[ \f1
79 .    ds #] \fP
80 .\}
81 .if t \{\
82 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
83 .    ds #V .6m
84 .    ds #F 0
85 .    ds #[ \&
86 .    ds #] \&
87 .\}
88 .    \" simple accents for nroff and troff
89 .if n \{\
90 .    ds ' \&
91 .    ds ` \&
92 .    ds ^ \&
93 .    ds , \&
94 .    ds ~ ~
95 .    ds /
96 .\}
97 .if t \{\
98 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
99 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
100 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
101 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
102 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
103 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
104 .\}
105 .    \" troff and (daisy-wheel) nroff accents
106 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
107 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
108 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
109 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
110 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
111 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
112 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
113 .ds ae a\h'-(\w'a'u*4/10)'e
114 .ds Ae A\h'-(\w'A'u*4/10)'E
115 .    \" corrections for vroff
116 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
117 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
118 .    \" for low resolution devices (crt and lpr)
119 .if \n(.H>23 .if \n(.V>19 \
120 \{\
121 .    ds : e
122 .    ds 8 ss
123 .    ds o a
124 .    ds d- d\h'-1'\(ga
125 .    ds D- D\h'-1'\(hy
126 .    ds th \o'bp'
127 .    ds Th \o'LP'
128 .    ds ae ae
129 .    ds Ae AE
130 .\}
131 .rm #[ #] #H #V #F C
132 .\" ========================================================================
133 .\"
134 .IX Title "C++FILT 1"
135 .TH C++FILT 1 "2009-10-16" "binutils-2.20" "GNU Development Tools"
136 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
137 .\" way too many mistakes in technical documents.
138 .if n .ad l
139 .nh
140 .SH "NAME"
141 c++filt \- Demangle C++ and Java symbols.
142 .SH "SYNOPSIS"
143 .IX Header "SYNOPSIS"
144 c++filt [\fB\-_\fR|\fB\-\-strip\-underscores\fR]
145         [\fB\-n\fR|\fB\-\-no\-strip\-underscores\fR]
146         [\fB\-p\fR|\fB\-\-no\-params\fR]
147         [\fB\-t\fR|\fB\-\-types\fR]
148         [\fB\-i\fR|\fB\-\-no\-verbose\fR]
149         [\fB\-s\fR \fIformat\fR|\fB\-\-format=\fR\fIformat\fR]
150         [\fB\-\-help\fR]  [\fB\-\-version\fR]  [\fIsymbol\fR...]
151 .SH "DESCRIPTION"
152 .IX Header "DESCRIPTION"
153 The \*(C+ and Java languages provide function overloading, which means
154 that you can write many functions with the same name, providing that
155 each function takes parameters of different types.  In order to be
156 able to distinguish these similarly named functions \*(C+ and Java
157 encode them into a low-level assembler name which uniquely identifies
158 each different version.  This process is known as \fImangling\fR. The
159 \&\fBc++filt\fR
160 [1]
161 program does the inverse mapping: it decodes (\fIdemangles\fR) low-level
162 names into user-level names so that they can be read.
163 .PP
164 Every alphanumeric word (consisting of letters, digits, underscores,
165 dollars, or periods) seen in the input is a potential mangled name.
166 If the name decodes into a \*(C+ name, the \*(C+ name replaces the
167 low-level name in the output, otherwise the original word is output.
168 In this way you can pass an entire assembler source file, containing
169 mangled names, through \fBc++filt\fR and see the same source file
170 containing demangled names.
171 .PP
172 You can also use \fBc++filt\fR to decipher individual symbols by
173 passing them on the command line:
174 .PP
175 .Vb 1
176 \&        c++filt <symbol>
177 .Ve
178 .PP
179 If no \fIsymbol\fR arguments are given, \fBc++filt\fR reads symbol
180 names from the standard input instead.  All the results are printed on
181 the standard output.  The difference between reading names from the
182 command line versus reading names from the standard input is that
183 command line arguments are expected to be just mangled names and no
184 checking is performed to separate them from surrounding text.  Thus
185 for example:
186 .PP
187 .Vb 1
188 \&        c++filt \-n _Z1fv
189 .Ve
190 .PP
191 will work and demangle the name to \*(L"f()\*(R" whereas:
192 .PP
193 .Vb 1
194 \&        c++filt \-n _Z1fv,
195 .Ve
196 .PP
197 will not work.  (Note the extra comma at the end of the mangled
198 name which makes it invalid).  This command however will work:
199 .PP
200 .Vb 1
201 \&        echo _Z1fv, | c++filt \-n
202 .Ve
203 .PP
204 and will display \*(L"f(),\*(R", i.e., the demangled name followed by a
205 trailing comma.  This behaviour is because when the names are read
206 from the standard input it is expected that they might be part of an
207 assembler source file where there might be extra, extraneous
208 characters trailing after a mangled name.  For example:
209 .PP
210 .Vb 1
211 \&            .type   _Z1fv, @function
212 .Ve
213 .SH "OPTIONS"
214 .IX Header "OPTIONS"
215 .IP "\fB\-_\fR" 4
216 .IX Item "-_"
217 .PD 0
218 .IP "\fB\-\-strip\-underscores\fR" 4
219 .IX Item "--strip-underscores"
220 .PD
221 On some systems, both the C and \*(C+ compilers put an underscore in front
222 of every name.  For example, the C name \f(CW\*(C`foo\*(C'\fR gets the low-level
223 name \f(CW\*(C`_foo\*(C'\fR.  This option removes the initial underscore.  Whether
224 \&\fBc++filt\fR removes the underscore by default is target dependent.
225 .IP "\fB\-n\fR" 4
226 .IX Item "-n"
227 .PD 0
228 .IP "\fB\-\-no\-strip\-underscores\fR" 4
229 .IX Item "--no-strip-underscores"
230 .PD
231 Do not remove the initial underscore.
232 .IP "\fB\-p\fR" 4
233 .IX Item "-p"
234 .PD 0
235 .IP "\fB\-\-no\-params\fR" 4
236 .IX Item "--no-params"
237 .PD
238 When demangling the name of a function, do not display the types of
239 the function's parameters.
240 .IP "\fB\-t\fR" 4
241 .IX Item "-t"
242 .PD 0
243 .IP "\fB\-\-types\fR" 4
244 .IX Item "--types"
245 .PD
246 Attempt to demangle types as well as function names.  This is disabled
247 by default since mangled types are normally only used internally in
248 the compiler, and they can be confused with non-mangled names.  For example,
249 a function called \*(L"a\*(R" treated as a mangled type name would be
250 demangled to \*(L"signed char\*(R".
251 .IP "\fB\-i\fR" 4
252 .IX Item "-i"
253 .PD 0
254 .IP "\fB\-\-no\-verbose\fR" 4
255 .IX Item "--no-verbose"
256 .PD
257 Do not include implementation details (if any) in the demangled
258 output.
259 .IP "\fB\-s\fR \fIformat\fR" 4
260 .IX Item "-s format"
261 .PD 0
262 .IP "\fB\-\-format=\fR\fIformat\fR" 4
263 .IX Item "--format=format"
264 .PD
265 \&\fBc++filt\fR can decode various methods of mangling, used by
266 different compilers.  The argument to this option selects which
267 method it uses:
268 .RS 4
269 .ie n .IP """auto""" 4
270 .el .IP "\f(CWauto\fR" 4
271 .IX Item "auto"
272 Automatic selection based on executable (the default method)
273 .ie n .IP """gnu""" 4
274 .el .IP "\f(CWgnu\fR" 4
275 .IX Item "gnu"
276 the one used by the \s-1GNU\s0 \*(C+ compiler (g++)
277 .ie n .IP """lucid""" 4
278 .el .IP "\f(CWlucid\fR" 4
279 .IX Item "lucid"
280 the one used by the Lucid compiler (lcc)
281 .ie n .IP """arm""" 4
282 .el .IP "\f(CWarm\fR" 4
283 .IX Item "arm"
284 the one specified by the \*(C+ Annotated Reference Manual
285 .ie n .IP """hp""" 4
286 .el .IP "\f(CWhp\fR" 4
287 .IX Item "hp"
288 the one used by the \s-1HP\s0 compiler (aCC)
289 .ie n .IP """edg""" 4
290 .el .IP "\f(CWedg\fR" 4
291 .IX Item "edg"
292 the one used by the \s-1EDG\s0 compiler
293 .ie n .IP """gnu\-v3""" 4
294 .el .IP "\f(CWgnu\-v3\fR" 4
295 .IX Item "gnu-v3"
296 the one used by the \s-1GNU\s0 \*(C+ compiler (g++) with the V3 \s-1ABI\s0.
297 .ie n .IP """java""" 4
298 .el .IP "\f(CWjava\fR" 4
299 .IX Item "java"
300 the one used by the \s-1GNU\s0 Java compiler (gcj)
301 .ie n .IP """gnat""" 4
302 .el .IP "\f(CWgnat\fR" 4
303 .IX Item "gnat"
304 the one used by the \s-1GNU\s0 Ada compiler (\s-1GNAT\s0).
305 .RE
306 .RS 4
307 .RE
308 .IP "\fB\-\-help\fR" 4
309 .IX Item "--help"
310 Print a summary of the options to \fBc++filt\fR and exit.
311 .IP "\fB\-\-version\fR" 4
312 .IX Item "--version"
313 Print the version number of \fBc++filt\fR and exit.
314 .IP "\fB@\fR\fIfile\fR" 4
315 .IX Item "@file"
316 Read command-line options from \fIfile\fR.  The options read are
317 inserted in place of the original @\fIfile\fR option.  If \fIfile\fR
318 does not exist, or cannot be read, then the option will be treated
319 literally, and not removed.
320 .Sp
321 Options in \fIfile\fR are separated by whitespace.  A whitespace
322 character may be included in an option by surrounding the entire
323 option in either single or double quotes.  Any character (including a
324 backslash) may be included by prefixing the character to be included
325 with a backslash.  The \fIfile\fR may itself contain additional
326 @\fIfile\fR options; any such options will be processed recursively.
327 .SH "FOOTNOTES"
328 .IX Header "FOOTNOTES"
329 .IP "1." 4
330 MS-DOS does not allow \f(CW\*(C`+\*(C'\fR characters in file names, so on
331 MS-DOS this program is named \fB\s-1CXXFILT\s0\fR.
332 .SH "SEE ALSO"
333 .IX Header "SEE ALSO"
334 the Info entries for \fIbinutils\fR.
335 .SH "COPYRIGHT"
336 .IX Header "COPYRIGHT"
337 Copyright (c) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
338 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 Free Software Foundation, Inc.
339 .PP
340 Permission is granted to copy, distribute and/or modify this document
341 under the terms of the \s-1GNU\s0 Free Documentation License, Version 1.3
342 or any later version published by the Free Software Foundation;
343 with no Invariant Sections, with no Front-Cover Texts, and with no
344 Back-Cover Texts.  A copy of the license is included in the
345 section entitled \*(L"\s-1GNU\s0 Free Documentation License\*(R".