blob: 805df00c1738cc019a2e0fa0c1ec55b65bfd09f1 [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
Daniel Dunbar8f4a8a62012-05-08 16:50:35 +000026 llvm-config
27 llvm-diff
28 llvm-cov
Duncan P. N. Exon Smith846a6272014-02-17 23:22:49 +000029 llvm-profdata
Daniel Dunbar8f4a8a62012-05-08 16:50:35 +000030 llvm-stress
Alexey Samsonov2bc10122013-03-01 07:58:27 +000031 llvm-symbolizer
Alexey Samsonova47b11a2014-05-19 22:53:29 +000032 llvm-dwarfdump
Jonas Devliegherefb7bf1d2017-11-02 18:44:54 +000033 dsymutil
Daniel Dunbar8f4a8a62012-05-08 16:50:35 +000034
35Debugging Tools
36~~~~~~~~~~~~~~~
37
38.. toctree::
39 :maxdepth: 1
40
41 bugpoint
42 llvm-extract
43 llvm-bcanalyzer
44
45Developer Tools
46~~~~~~~~~~~~~~~
47
48.. toctree::
49 :maxdepth: 1
50
51 FileCheck
52 tblgen
53 lit
54 llvm-build
Zachary Turner460ed0a2017-08-11 19:00:22 +000055 llvm-pdbutil
Nico Rieck51432432013-04-11 00:05:57 +000056 llvm-readobj