xref: /llvm-project/llvm/docs/CommandGuide/index.rst (revision ef403f9a64f33ae3b1ad51bf67476391d18ff390)
1LLVM Command Guide
2------------------
3
4The following documents are command descriptions for all of the LLVM tools.
5These pages describe how to use the LLVM commands and what their options are.
6Note that these pages do not describe all of the options available for all
7tools. To get a complete listing, pass the ``--help`` (general options) or
8``--help-hidden`` (general and debugging options) arguments to the tool you are
9interested in.
10
11Basic Commands
12~~~~~~~~~~~~~~
13
14.. toctree::
15   :maxdepth: 1
16
17   dsymutil
18   llc
19   lli
20   llvm-as
21   llvm-cgdata
22   llvm-config
23   llvm-cov
24   llvm-cxxmap
25   llvm-debuginfo-analyzer
26   llvm-diff
27   llvm-dis
28   llvm-dwarfdump
29   llvm-dwarfutil
30   llvm-lib
31   llvm-libtool-darwin
32   llvm-link
33   llvm-lipo
34   llvm-mc
35   llvm-mca
36   llvm-opt-report
37   llvm-otool
38   llvm-profdata
39   llvm-readobj
40   llvm-reduce
41   llvm-stress
42   llvm-symbolizer
43   opt
44
45GNU binutils replacements
46~~~~~~~~~~~~~~~~~~~~~~~~~
47
48.. toctree::
49   :maxdepth: 1
50
51   llvm-addr2line
52   llvm-ar
53   llvm-cxxfilt
54   llvm-install-name-tool
55   llvm-nm
56   llvm-objcopy
57   llvm-objdump
58   llvm-ranlib
59   llvm-readelf
60   llvm-size
61   llvm-strings
62   llvm-strip
63
64Debugging Tools
65~~~~~~~~~~~~~~~
66
67.. toctree::
68   :maxdepth: 1
69
70   bugpoint
71   llvm-extract
72   llvm-bcanalyzer
73
74Developer Tools
75~~~~~~~~~~~~~~~
76
77.. toctree::
78   :maxdepth: 1
79
80   FileCheck
81   tblgen
82   clang-tblgen
83   lldb-tblgen
84   llvm-tblgen
85   mlir-tblgen
86   lit
87   llvm-exegesis
88   llvm-ifs
89   llvm-locstats
90   llvm-pdbutil
91   llvm-profgen
92   llvm-tli-checker
93
94Remarks Tools
95~~~~~~~~~~~~~~
96
97.. toctree::
98   :maxdepth: 1
99
100   llvm-remarkutil
101