blob: 9108ae6a96b9c8345983056686b24b61032e3788 [file] [log] [blame]
Daniel Dunbar3b709d52012-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 Espindola6624afc2015-07-17 18:49:26 +000024 llvm-lib
Daniel Dunbar3b709d52012-05-08 16:50:35 +000025 llvm-nm
Michael Trentc1affcd2018-08-08 14:39:22 +000026 llvm-objdump
Daniel Dunbar3b709d52012-05-08 16:50:35 +000027 llvm-config
Richard Smith61be1ad2018-09-13 20:22:02 +000028 llvm-cxxmap
Daniel Dunbar3b709d52012-05-08 16:50:35 +000029 llvm-diff
30 llvm-cov
Duncan P. N. Exon Smithddc5a012014-02-17 23:22:49 +000031 llvm-profdata
Daniel Dunbar3b709d52012-05-08 16:50:35 +000032 llvm-stress
Alexey Samsonov14809fd2013-03-01 07:58:27 +000033 llvm-symbolizer
Alexey Samsonovdf0d63d2014-05-19 22:53:29 +000034 llvm-dwarfdump
Jonas Devlieghere2f759d42017-11-02 18:44:54 +000035 dsymutil
Andrea Di Biagio017ddc22018-03-08 13:43:11 +000036 llvm-mca
Daniel Dunbar3b709d52012-05-08 16:50:35 +000037
38Debugging Tools
39~~~~~~~~~~~~~~~
40
41.. toctree::
42 :maxdepth: 1
43
44 bugpoint
45 llvm-extract
46 llvm-bcanalyzer
47
48Developer Tools
49~~~~~~~~~~~~~~~
50
51.. toctree::
52 :maxdepth: 1
53
54 FileCheck
55 tblgen
56 lit
57 llvm-build
Clement Courbetfd68be22018-04-04 11:37:06 +000058 llvm-exegesis
Zachary Turner88fcc3a2017-08-11 19:00:22 +000059 llvm-pdbutil
Nico Rieck70c2b882013-04-11 00:05:57 +000060 llvm-readobj