xref: /openbsd-src/gnu/llvm/llvm/docs/CommandGuide/llvm-cxxfilt.rst (revision 24bb5fcea3ed904bc467217bdaadb5dfc618d5bf)
1llvm-cxxfilt - LLVM symbol name demangler
2=========================================
3
4.. program:: llvm-cxxfilt
5
6SYNOPSIS
7--------
8
9:program:`llvm-cxxfilt` [*options*] [*mangled names...*]
10
11DESCRIPTION
12-----------
13
14:program:`llvm-cxxfilt` is a symbol demangler that can be used as a replacement
15for the GNU :program:`c++filt` tool. It takes a series of symbol names and
16prints their demangled form on the standard output stream. If a name cannot be
17demangled, it is simply printed as is.
18
19If no names are specified on the command-line, names are read interactively from
20the standard input stream. When reading names from standard input, each input
21line is split on characters that are not part of valid Itanium name manglings,
22i.e. characters that are not alphanumeric, '.', '$', or '_'. Separators between
23names are copied to the output as is.
24
25EXAMPLE
26-------
27
28.. code-block:: console
29
30  $ llvm-cxxfilt _Z3foov _Z3bari not_mangled
31  foo()
32  bar(int)
33  not_mangled
34  $ cat input.txt
35  | _Z3foov *** _Z3bari *** not_mangled |
36  $ llvm-cxxfilt < input.txt
37  | foo() *** bar(int) *** not_mangled |
38
39OPTIONS
40-------
41
42.. option:: --format=<value>, -s
43
44  Mangling scheme to assume. Valid values are ``auto`` (default, auto-detect the
45  style) and ``gnu`` (assume GNU/Itanium style).
46
47.. option:: --help, -h
48
49  Print a summary of command line options.
50
51.. option:: --help-list
52
53  Print an uncategorized summary of command line options.
54
55.. option:: --no-strip-underscore, -n
56
57  Do not strip a leading underscore. This is the default for all platforms
58  except Mach-O based hosts.
59
60.. option:: --strip-underscore, -_
61
62  Strip a single leading underscore, if present, from each input name before
63  demangling. On by default on Mach-O based platforms.
64
65.. option:: --types, -t
66
67  Attempt to demangle names as type names as well as function names.
68
69.. option:: --version
70
71  Display the version of the :program:`llvm-cxxfilt` executable.
72
73.. option:: @<FILE>
74
75 Read command-line options from response file `<FILE>`.
76
77EXIT STATUS
78-----------
79
80:program:`llvm-cxxfilt` returns 0 unless it encounters a usage error, in which
81case a non-zero exit code is returned.
82
83SEE ALSO
84--------
85
86:manpage:`llvm-nm(1)`
87