| .\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28) |
| .\" |
| .\" Standard preamble: |
| .\" ======================================================================== |
| .de Sp \" Vertical space (when we can't use .PP) |
| .if t .sp .5v |
| .if n .sp |
| .. |
| .de Vb \" Begin verbatim text |
| .ft CW |
| .nf |
| .ne \\$1 |
| .. |
| .de Ve \" End verbatim text |
| .ft R |
| .fi |
| .. |
| .\" Set up some character translations and predefined strings. \*(-- will |
| .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left |
| .\" double quote, and \*(R" will give a right double quote. \*(C+ will |
| .\" give a nicer C++. Capital omega is used to do unbreakable dashes and |
| .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, |
| .\" nothing in troff, for use with C<>. |
| .tr \(*W- |
| .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' |
| .ie n \{\ |
| . ds -- \(*W- |
| . ds PI pi |
| . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch |
| . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch |
| . ds L" "" |
| . ds R" "" |
| . ds C` "" |
| . ds C' "" |
| 'br\} |
| .el\{\ |
| . ds -- \|\(em\| |
| . ds PI \(*p |
| . ds L" `` |
| . ds R" '' |
| . ds C` |
| . ds C' |
| 'br\} |
| .\" |
| .\" Escape single quotes in literal strings from groff's Unicode transform. |
| .ie \n(.g .ds Aq \(aq |
| .el .ds Aq ' |
| .\" |
| .\" If the F register is turned on, we'll generate index entries on stderr for |
| .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index |
| .\" entries marked with X<> in POD. Of course, you'll have to process the |
| .\" output yourself in some meaningful fashion. |
| .\" |
| .\" Avoid warning from groff about undefined register 'F'. |
| .de IX |
| .. |
| .nr rF 0 |
| .if \n(.g .if rF .nr rF 1 |
| .if (\n(rF:(\n(.g==0)) \{ |
| . if \nF \{ |
| . de IX |
| . tm Index:\\$1\t\\n%\t"\\$2" |
| .. |
| . if !\nF==2 \{ |
| . nr % 0 |
| . nr F 2 |
| . \} |
| . \} |
| .\} |
| .rr rF |
| .\" |
| .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). |
| .\" Fear. Run. Save yourself. No user-serviceable parts. |
| . \" fudge factors for nroff and troff |
| .if n \{\ |
| . ds #H 0 |
| . ds #V .8m |
| . ds #F .3m |
| . ds #[ \f1 |
| . ds #] \fP |
| .\} |
| .if t \{\ |
| . ds #H ((1u-(\\\\n(.fu%2u))*.13m) |
| . ds #V .6m |
| . ds #F 0 |
| . ds #[ \& |
| . ds #] \& |
| .\} |
| . \" simple accents for nroff and troff |
| .if n \{\ |
| . ds ' \& |
| . ds ` \& |
| . ds ^ \& |
| . ds , \& |
| . ds ~ ~ |
| . ds / |
| .\} |
| .if t \{\ |
| . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" |
| . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' |
| . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' |
| . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' |
| . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' |
| . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' |
| .\} |
| . \" troff and (daisy-wheel) nroff accents |
| .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' |
| .ds 8 \h'\*(#H'\(*b\h'-\*(#H' |
| .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] |
| .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' |
| .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' |
| .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] |
| .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] |
| .ds ae a\h'-(\w'a'u*4/10)'e |
| .ds Ae A\h'-(\w'A'u*4/10)'E |
| . \" corrections for vroff |
| .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' |
| .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' |
| . \" for low resolution devices (crt and lpr) |
| .if \n(.H>23 .if \n(.V>19 \ |
| \{\ |
| . ds : e |
| . ds 8 ss |
| . ds o a |
| . ds d- d\h'-1'\(ga |
| . ds D- D\h'-1'\(hy |
| . ds th \o'bp' |
| . ds Th \o'LP' |
| . ds ae ae |
| . ds Ae AE |
| .\} |
| .rm #[ #] #H #V #F C |
| .\" ======================================================================== |
| .\" |
| .IX Title "C++FILT 1" |
| .TH C++FILT 1 "2014-08-01" "binutils-2.24.0" "GNU Development Tools" |
| .\" For nroff, turn off justification. Always turn off hyphenation; it makes |
| .\" way too many mistakes in technical documents. |
| .if n .ad l |
| .nh |
| .SH "NAME" |
| c++filt \- Demangle C++ and Java symbols. |
| .SH "SYNOPSIS" |
| .IX Header "SYNOPSIS" |
| c++filt [\fB\-_\fR|\fB\-\-strip\-underscore\fR] |
| [\fB\-n\fR|\fB\-\-no\-strip\-underscore\fR] |
| [\fB\-p\fR|\fB\-\-no\-params\fR] |
| [\fB\-t\fR|\fB\-\-types\fR] |
| [\fB\-i\fR|\fB\-\-no\-verbose\fR] |
| [\fB\-s\fR \fIformat\fR|\fB\-\-format=\fR\fIformat\fR] |
| [\fB\-\-help\fR] [\fB\-\-version\fR] [\fIsymbol\fR...] |
| .SH "DESCRIPTION" |
| .IX Header "DESCRIPTION" |
| The \*(C+ and Java languages provide function overloading, which means |
| that you can write many functions with the same name, providing that |
| each function takes parameters of different types. In order to be |
| able to distinguish these similarly named functions \*(C+ and Java |
| encode them into a low-level assembler name which uniquely identifies |
| each different version. This process is known as \fImangling\fR. The |
| \&\fBc++filt\fR |
| [1] |
| program does the inverse mapping: it decodes (\fIdemangles\fR) low-level |
| names into user-level names so that they can be read. |
| .PP |
| Every alphanumeric word (consisting of letters, digits, underscores, |
| dollars, or periods) seen in the input is a potential mangled name. |
| If the name decodes into a \*(C+ name, the \*(C+ name replaces the |
| low-level name in the output, otherwise the original word is output. |
| In this way you can pass an entire assembler source file, containing |
| mangled names, through \fBc++filt\fR and see the same source file |
| containing demangled names. |
| .PP |
| You can also use \fBc++filt\fR to decipher individual symbols by |
| passing them on the command line: |
| .PP |
| .Vb 1 |
| \& c++filt <symbol> |
| .Ve |
| .PP |
| If no \fIsymbol\fR arguments are given, \fBc++filt\fR reads symbol |
| names from the standard input instead. All the results are printed on |
| the standard output. The difference between reading names from the |
| command line versus reading names from the standard input is that |
| command line arguments are expected to be just mangled names and no |
| checking is performed to separate them from surrounding text. Thus |
| for example: |
| .PP |
| .Vb 1 |
| \& c++filt \-n _Z1fv |
| .Ve |
| .PP |
| will work and demangle the name to \*(L"f()\*(R" whereas: |
| .PP |
| .Vb 1 |
| \& c++filt \-n _Z1fv, |
| .Ve |
| .PP |
| will not work. (Note the extra comma at the end of the mangled |
| name which makes it invalid). This command however will work: |
| .PP |
| .Vb 1 |
| \& echo _Z1fv, | c++filt \-n |
| .Ve |
| .PP |
| and will display \*(L"f(),\*(R", i.e., the demangled name followed by a |
| trailing comma. This behaviour is because when the names are read |
| from the standard input it is expected that they might be part of an |
| assembler source file where there might be extra, extraneous |
| characters trailing after a mangled name. For example: |
| .PP |
| .Vb 1 |
| \& .type _Z1fv, @function |
| .Ve |
| .SH "OPTIONS" |
| .IX Header "OPTIONS" |
| .IP "\fB\-_\fR" 4 |
| .IX Item "-_" |
| .PD 0 |
| .IP "\fB\-\-strip\-underscore\fR" 4 |
| .IX Item "--strip-underscore" |
| .PD |
| On some systems, both the C and \*(C+ compilers put an underscore in front |
| of every name. For example, the C name \f(CW\*(C`foo\*(C'\fR gets the low-level |
| name \f(CW\*(C`_foo\*(C'\fR. This option removes the initial underscore. Whether |
| \&\fBc++filt\fR removes the underscore by default is target dependent. |
| .IP "\fB\-n\fR" 4 |
| .IX Item "-n" |
| .PD 0 |
| .IP "\fB\-\-no\-strip\-underscore\fR" 4 |
| .IX Item "--no-strip-underscore" |
| .PD |
| Do not remove the initial underscore. |
| .IP "\fB\-p\fR" 4 |
| .IX Item "-p" |
| .PD 0 |
| .IP "\fB\-\-no\-params\fR" 4 |
| .IX Item "--no-params" |
| .PD |
| When demangling the name of a function, do not display the types of |
| the function's parameters. |
| .IP "\fB\-t\fR" 4 |
| .IX Item "-t" |
| .PD 0 |
| .IP "\fB\-\-types\fR" 4 |
| .IX Item "--types" |
| .PD |
| Attempt to demangle types as well as function names. This is disabled |
| by default since mangled types are normally only used internally in |
| the compiler, and they can be confused with non-mangled names. For example, |
| a function called \*(L"a\*(R" treated as a mangled type name would be |
| demangled to \*(L"signed char\*(R". |
| .IP "\fB\-i\fR" 4 |
| .IX Item "-i" |
| .PD 0 |
| .IP "\fB\-\-no\-verbose\fR" 4 |
| .IX Item "--no-verbose" |
| .PD |
| Do not include implementation details (if any) in the demangled |
| output. |
| .IP "\fB\-s\fR \fIformat\fR" 4 |
| .IX Item "-s format" |
| .PD 0 |
| .IP "\fB\-\-format=\fR\fIformat\fR" 4 |
| .IX Item "--format=format" |
| .PD |
| \&\fBc++filt\fR can decode various methods of mangling, used by |
| different compilers. The argument to this option selects which |
| method it uses: |
| .RS 4 |
| .ie n .IP """auto""" 4 |
| .el .IP "\f(CWauto\fR" 4 |
| .IX Item "auto" |
| Automatic selection based on executable (the default method) |
| .ie n .IP """gnu""" 4 |
| .el .IP "\f(CWgnu\fR" 4 |
| .IX Item "gnu" |
| the one used by the \s-1GNU \*(C+\s0 compiler (g++) |
| .ie n .IP """lucid""" 4 |
| .el .IP "\f(CWlucid\fR" 4 |
| .IX Item "lucid" |
| the one used by the Lucid compiler (lcc) |
| .ie n .IP """arm""" 4 |
| .el .IP "\f(CWarm\fR" 4 |
| .IX Item "arm" |
| the one specified by the \*(C+ Annotated Reference Manual |
| .ie n .IP """hp""" 4 |
| .el .IP "\f(CWhp\fR" 4 |
| .IX Item "hp" |
| the one used by the \s-1HP\s0 compiler (aCC) |
| .ie n .IP """edg""" 4 |
| .el .IP "\f(CWedg\fR" 4 |
| .IX Item "edg" |
| the one used by the \s-1EDG\s0 compiler |
| .ie n .IP """gnu\-v3""" 4 |
| .el .IP "\f(CWgnu\-v3\fR" 4 |
| .IX Item "gnu-v3" |
| the one used by the \s-1GNU \*(C+\s0 compiler (g++) with the V3 \s-1ABI.\s0 |
| .ie n .IP """java""" 4 |
| .el .IP "\f(CWjava\fR" 4 |
| .IX Item "java" |
| the one used by the \s-1GNU\s0 Java compiler (gcj) |
| .ie n .IP """gnat""" 4 |
| .el .IP "\f(CWgnat\fR" 4 |
| .IX Item "gnat" |
| the one used by the \s-1GNU\s0 Ada compiler (\s-1GNAT\s0). |
| .RE |
| .RS 4 |
| .RE |
| .IP "\fB\-\-help\fR" 4 |
| .IX Item "--help" |
| Print a summary of the options to \fBc++filt\fR and exit. |
| .IP "\fB\-\-version\fR" 4 |
| .IX Item "--version" |
| Print the version number of \fBc++filt\fR and exit. |
| .IP "\fB@\fR\fIfile\fR" 4 |
| .IX Item "@file" |
| Read command-line options from \fIfile\fR. The options read are |
| inserted in place of the original @\fIfile\fR option. If \fIfile\fR |
| does not exist, or cannot be read, then the option will be treated |
| literally, and not removed. |
| .Sp |
| Options in \fIfile\fR are separated by whitespace. A whitespace |
| character may be included in an option by surrounding the entire |
| option in either single or double quotes. Any character (including a |
| backslash) may be included by prefixing the character to be included |
| with a backslash. The \fIfile\fR may itself contain additional |
| @\fIfile\fR options; any such options will be processed recursively. |
| .SH "FOOTNOTES" |
| .IX Header "FOOTNOTES" |
| .IP "1." 4 |
| MS-DOS does not allow \f(CW\*(C`+\*(C'\fR characters in file names, so on |
| MS-DOS this program is named \fB\s-1CXXFILT\s0\fR. |
| .SH "SEE ALSO" |
| .IX Header "SEE ALSO" |
| the Info entries for \fIbinutils\fR. |
| .SH "COPYRIGHT" |
| .IX Header "COPYRIGHT" |
| Copyright (c) 1991\-2013 Free Software Foundation, Inc. |
| .PP |
| Permission is granted to copy, distribute and/or modify this document |
| under the terms of the \s-1GNU\s0 Free Documentation License, Version 1.3 |
| or any later version published by the Free Software Foundation; |
| with no Invariant Sections, with no Front-Cover Texts, and with no |
| Back-Cover Texts. A copy of the license is included in the |
| section entitled \*(L"\s-1GNU\s0 Free Documentation License\*(R". |
