llvm.org GIT mirror llvm / 9762cf4
[docs][llvm-cxxfilt] Write llvm-cxxfilt documentation There was a stub for llvm-cxxfilt, but it didn't describe the options. Additionally, it was in markdown, which was causing issues, so as discussed in https://reviews.llvm.org/D63211, this change replaces the existing stub with an RST file. Reviewed by: MaskRay, mattd Differential Revision: https://reviews.llvm.org/D63722 git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@364287 91177308-0d34-0410-b5e6-96231b3b80d8 James Henderson a month ago
2 changed file(s) with 79 addition(s) and 10 deletion(s). Raw diff Collapse all Expand all
+0
-10
docs/CommandGuide/llvm-cxxfilt.md less more
None # llvm-cxxfilt - a symbol demangler
1
2 ## SYNOPSIS
3
4 **llvm-cxxfilt** [*options*]
5
6 ## DESCRIPTION
7
8 **llvm-cxxfilt** is symbol demangler that can be used as a replacement for the
9 GNU **c++filt** tool.
0 llvm-cxxfilt - LLVM symbol name demangler
1 =========================================
2
3 SYNOPSIS
4 --------
5
6 :program:`llvm-cxxfilt` [*options*] [*mangled names...*]
7
8 DESCRIPTION
9 -----------
10
11 :program:`llvm-cxxfilt` is a symbol demangler that can be used as a replacement
12 for the GNU :program:`c++filt` tool. It takes a series of symbol names and
13 prints their demangled form on the standard output stream. If a name cannot be
14 demangled, it is simply printed as is.
15
16 If no names are specified on the command-line, names are read interactively from
17 the standard input stream. When reading names from standard input, each input
18 line is split on characters that are not part of valid Itanium name manglings,
19 i.e. characters that are not alphanumeric, '.', '$', or '_'. Separators between
20 names are copied to the output as is.
21
22 EXAMPLE
23 -------
24
25 .. code-block:: console
26
27 $ llvm-cxxfilt _Z3foov _Z3bari not_mangled
28 foo()
29 bar(int)
30 not_mangled
31 $ cat input.txt
32 | _Z3foov *** _Z3bari *** not_mangled |
33 $ llvm-cxxfilt < input.txt
34 | foo() *** bar(int) *** not_mangled |
35
36 OPTIONS
37 -------
38
39 .. option:: --format=, -s
40
41 Mangling scheme to assume. Valid values are ``auto`` (default, auto-detect the
42 style) and ``gnu`` (assume GNU/Itanium style).
43
44 .. option:: --help, -h
45
46 Print a summary of command line options.
47
48 .. option:: --help-list
49
50 Print an uncategorized summary of command line options.
51
52 .. option:: --strip-underscore, -_
53
54 Discard a single leading underscore, if present, from each input name before
55 demangling.
56
57 .. option:: --types, -t
58
59 Attempt to demangle names as type names as well as function names.
60
61 .. option:: --version
62
63 Display the version of this program.
64
65 .. option:: @
66
67 Read command-line options from response file ``.
68
69 EXIT STATUS
70 -----------
71
72 :program:`llvm-cxxfilt` returns 0 unless it encounters a usage error, in which
73 case a non-zero exit code is returned.
74
75 SEE ALSO
76 --------
77
78 :manpage:`llvm-nm(1)`