blob: 8a6edf575cb0cfb6df87463d46f6a620a59f7a8b [file] [log] [blame]
Daniel Dunbar8f4a8a62012-05-08 16:50:35 +00001LLVM 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 llvm-as
18 llvm-dis
19 opt
20 llc
21 lli
22 llvm-link
23 llvm-ar
Rafael Espindola3116f6e2015-07-17 18:49:26 +000024 llvm-lib
Daniel Dunbar8f4a8a62012-05-08 16:50:35 +000025 llvm-nm
Michael Trent4a685862018-08-08 14:39:22 +000026 llvm-objdump
Daniel Dunbar8f4a8a62012-05-08 16:50:35 +000027 llvm-config
Richard Smith3164fcf2018-09-13 20:22:02 +000028 llvm-cxxmap
Daniel Dunbar8f4a8a62012-05-08 16:50:35 +000029 llvm-diff
30 llvm-cov
Duncan P. N. Exon Smith846a6272014-02-17 23:22:49 +000031 llvm-profdata
Daniel Dunbar8f4a8a62012-05-08 16:50:35 +000032 llvm-stress
Alexey Samsonov2bc10122013-03-01 07:58:27 +000033 llvm-symbolizer
Igor Kudrin99f641c2019-04-19 10:17:52 +000034 llvm-addr2line
Alexey Samsonova47b11a2014-05-19 22:53:29 +000035 llvm-dwarfdump
Jonas Devliegherefb7bf1d2017-11-02 18:44:54 +000036 dsymutil
Andrea Di Biagioa2a940d2018-03-08 13:43:11 +000037 llvm-mca
Daniel Dunbar8f4a8a62012-05-08 16:50:35 +000038
39Debugging Tools
40~~~~~~~~~~~~~~~
41
42.. toctree::
43 :maxdepth: 1
44
45 bugpoint
46 llvm-extract
47 llvm-bcanalyzer
48
49Developer Tools
50~~~~~~~~~~~~~~~
51
52.. toctree::
53 :maxdepth: 1
54
55 FileCheck
56 tblgen
57 lit
58 llvm-build
Clement Courbetac74acd2018-04-04 11:37:06 +000059 llvm-exegesis
Zachary Turner460ed0a2017-08-11 19:00:22 +000060 llvm-pdbutil
Nico Rieck51432432013-04-11 00:05:57 +000061 llvm-readobj