diff options
author | Ken Raeburn <raeburn@cygnus> | 1994-06-03 21:35:55 +0000 |
---|---|---|
committer | Ken Raeburn <raeburn@cygnus> | 1994-06-03 21:35:55 +0000 |
commit | faa70c355347fd07c43390300a7e12ade66d5de4 (patch) | |
tree | 7a9b325866235cdef1c5808654e5c330f7531e83 /binutils/cxxfilt.man | |
parent | baed44cd14abcae7603f16b2b8c865e714dc0f6b (diff) | |
download | gdb-faa70c355347fd07c43390300a7e12ade66d5de4.zip gdb-faa70c355347fd07c43390300a7e12ade66d5de4.tar.gz gdb-faa70c355347fd07c43390300a7e12ade66d5de4.tar.bz2 |
actually do c++filt.1 -> cxxfilt.man renaming on trunk...
Diffstat (limited to 'binutils/cxxfilt.man')
-rw-r--r-- | binutils/cxxfilt.man | 114 |
1 files changed, 114 insertions, 0 deletions
diff --git a/binutils/cxxfilt.man b/binutils/cxxfilt.man new file mode 100644 index 0000000..a4d5d45 --- /dev/null +++ b/binutils/cxxfilt.man @@ -0,0 +1,114 @@ +.\" Copyright (c) 1991 Free Software Foundation +.\" See section COPYING for conditions for redistribution +.TH @PROGRAM@ 1 "June 1993" "cygnus support" "GNU Development Tools" +.de BP +.sp +.ti \-.2i +\(** +.. + +.SH NAME +@PROGRAM@ \- demangle C++ symbols + +.SH SYNOPSIS +.hy 0 +.na +.TP +.B @PROGRAM@ +.RB "[\|" \-_ | \-\-strip-underscores "\|]" +.RB "[\|" "\-s {gnu,lucid,arm} " | " \-\-format={gnu,lucid,arm}" "\|]" +.RB "[\|" \-\-help "\|]" +.RB "[\|" \-\-version "\|]" +.RB "[\|" symbol "...\|]" +.SH DESCRIPTION +The C++ language provides function overloading, which means that you can +write many functions with the same name (providing each takes parameters +of different types). All C++ function names are encoded into a +low-level assembly label (this process is known as +.I mangling\c +). The +.B @PROGRAM@ +program does the inverse mapping: it decodes (\fIdemangles\fR) +low-level names into user-level names so that the linker can keep +these overloaded functions from clashing. +.PP +Every alphanumeric word (consisting of letters, digits, underscores, +dollars, or periods) seen in the input is a potential label. If the +label decodes into a C++ name, the C++ name replaces the low-level +name in the output. +.PP +You can use +.B @PROGRAM@ +to decipher individual symbols by specifying these symbols on the +command line. +.PP +If no +.B symbol +arguments are given, +.B @PROGRAM@ +reads symbol names from the standard input and writes the demangled +names to the standard output. All results are printed on the standard +output. +.SH OPTIONS +.TP +.B \-_ +.TP +.B \-\-strip\-underscores +On some systems, both the C and C++ compilers put an +underscore in front of every name. For example, the C name +.B foo +gets the low-level name +.BR _foo . +This option removes the leading underscore. + +.TP +.B "\-s {gnu,lucid,arm}" +.TP +.B \-\-format={gnu,lucid,arm} +GNU +.B nm +can decode three different methods of mangling, used by different C++ +compilers. This option selects which method it uses: the one used by +the GNU compiler, the one used by the Lucid compiler, or the one +specified by the C++ Annotated Reference Manual. The default is the +GNU style. + +.TP +.B \-\-help +Print a summary of the options to +.B @PROGRAM@ +and exit. + +.TP +.B \-\-version +Print the version number of +.B @PROGRAM@ +and exit. + +.SH "SEE ALSO" +.RB "`\|" binutils "\|'" +entry in +.B +info\c +\&; +.I +The GNU Binary Utilities\c +\&, Roland H. Pesch (June 1993). + +.SH COPYING +Copyright (c) 1993 Free Software Foundation, Inc. +.PP +Permission is granted to make and distribute verbatim copies of +this manual provided the copyright notice and this permission notice +are preserved on all copies. +.PP +Permission is granted to copy and distribute modified versions of this +manual under the conditions for verbatim copying, provided that the +entire resulting derived work is distributed under the terms of a +permission notice identical to this one. +.PP +Permission is granted to copy and distribute translations of this +manual into another language, under the above conditions for modified +versions, except that this permission notice may be included in +translations approved by the Free Software Foundation instead of in +the original English. |