binutils/doc/cxxfilt.man

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