gnu/usr.bin/binutils222/cxxfilt/c++filt.1

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