usr.bin/clang/llvm-cxxfilt/llvm-cxxfilt.1

   1 .\" $FreeBSD$
   2 .\" Man page generated from reStructuredText.
   3 .
   4 .TH "LLVM-CXXFILT" "1" "2020-06-26" "10" "LLVM"
   5 .SH NAME
   6 llvm-cxxfilt \- LLVM symbol name demangler
   7 .
   8 .nr rst2man-indent-level 0
   9 .
  10 .de1 rstReportMargin
  11 \\$1 \\n[an-margin]
  12 level \\n[rst2man-indent-level]
  13 level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
  14 -
  15 \\n[rst2man-indent0]
  16 \\n[rst2man-indent1]
  17 \\n[rst2man-indent2]
  18 ..
  19 .de1 INDENT
  20 .\" .rstReportMargin pre:
  21 . RS \\$1
  22 . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
  23 . nr rst2man-indent-level +1
  24 .\" .rstReportMargin post:
  25 ..
  26 .de UNINDENT
  27 . RE
  28 .\" indent \\n[an-margin]
  29 .\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
  30 .nr rst2man-indent-level -1
  31 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
  32 .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
  33 ..
  34 .SH SYNOPSIS
  35 .sp
  36 \fBllvm\-cxxfilt\fP [\fIoptions\fP] [\fImangled names...\fP]
  37 .SH DESCRIPTION
  38 .sp
  39 \fBllvm\-cxxfilt\fP is a symbol demangler that can be used as a replacement
  40 for the GNU \fBc++filt\fP tool. It takes a series of symbol names and
  41 prints their demangled form on the standard output stream. If a name cannot be
  42 demangled, it is simply printed as is.
  43 .sp
  44 If no names are specified on the command\-line, names are read interactively from
  45 the standard input stream. When reading names from standard input, each input
  46 line is split on characters that are not part of valid Itanium name manglings,
  47 i.e. characters that are not alphanumeric, \(aq.\(aq, \(aq$\(aq, or \(aq_\(aq. Separators between
  48 names are copied to the output as is.
  49 .SH EXAMPLE
  50 .INDENT 0.0
  51 .INDENT 3.5
  52 .sp
  53 .nf
  54 .ft C
  55 $ llvm\-cxxfilt _Z3foov _Z3bari not_mangled
  56 foo()
  57 bar(int)
  58 not_mangled
  59 $ cat input.txt
  60 | _Z3foov *** _Z3bari *** not_mangled |
  61 $ llvm\-cxxfilt < input.txt
  62 | foo() *** bar(int) *** not_mangled |
  63 .ft P
  64 .fi
  65 .UNINDENT
  66 .UNINDENT
  67 .SH OPTIONS
  68 .INDENT 0.0
  69 .TP
  70 .B \-\-format=<value>, \-s
  71 Mangling scheme to assume. Valid values are \fBauto\fP (default, auto\-detect the
  72 style) and \fBgnu\fP (assume GNU/Itanium style).
  73 .UNINDENT
  74 .INDENT 0.0
  75 .TP
  76 .B \-\-help, \-h
  77 Print a summary of command line options.
  78 .UNINDENT
  79 .INDENT 0.0
  80 .TP
  81 .B \-\-help\-list
  82 Print an uncategorized summary of command line options.
  83 .UNINDENT
  84 .INDENT 0.0
  85 .TP
  86 .B \-\-strip\-underscore, \-_
  87 Discard a single leading underscore, if present, from each input name before
  88 demangling.
  89 .UNINDENT
  90 .INDENT 0.0
  91 .TP
  92 .B \-\-types, \-t
  93 Attempt to demangle names as type names as well as function names.
  94 .UNINDENT
  95 .INDENT 0.0
  96 .TP
  97 .B \-\-version
  98 Display the version of the \fBllvm\-cxxfilt\fP executable.
  99 .UNINDENT
 100 .INDENT 0.0
 101 .TP
 102 .B @<FILE>
 103 Read command\-line options from response file \fI<FILE>\fP\&.
 104 .UNINDENT
 105 .SH EXIT STATUS
 106 .sp
 107 \fBllvm\-cxxfilt\fP returns 0 unless it encounters a usage error, in which
 108 case a non\-zero exit code is returned.
 109 .SH SEE ALSO
 110 .sp
 111 \fBllvm\-nm(1)\fP
 112 .SH AUTHOR
 113 Maintained by the LLVM Team (https://llvm.org/).
 114 .SH COPYRIGHT
 115 2003-2020, LLVM Project
 116 .\" Generated by docutils manpage writer.
 117 .