blob: 52ad316459d4ca70dca7cd929f1a09825b7c4f3e [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
Rafael Espindola3116f6e2015-07-17 18:49:26 +000023 llvm-lib
Alexander Shaposhnikov85ea2de2019-06-07 22:03:02 +000024 llvm-lipo
Daniel Dunbar8f4a8a62012-05-08 16:50:35 +000025 llvm-config
Richard Smith3164fcf2018-09-13 20:22:02 +000026 llvm-cxxmap
Daniel Dunbar8f4a8a62012-05-08 16:50:35 +000027 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
Andrea Di Biagioa2a940d2018-03-08 13:43:11 +000034 llvm-mca
James Hendersonaa8753b2019-06-07 16:43:44 +000035 llvm-readobj
Daniel Dunbar8f4a8a62012-05-08 16:50:35 +000036
Jordan Rupprecht4c3722a2019-06-11 21:13:01 +000037GNU binutils replacements
38~~~~~~~~~~~~~~~~~~~~~~~~~
39
40.. toctree::
41 :maxdepth: 1
42
43 llvm-addr2line
44 llvm-ar
45 llvm-cxxfilt
46 llvm-nm
47 llvm-objcopy
48 llvm-objdump
49 llvm-ranlib
50 llvm-readelf
51 llvm-size
52 llvm-strings
53 llvm-strip
54
Daniel Dunbar8f4a8a62012-05-08 16:50:35 +000055Debugging Tools
56~~~~~~~~~~~~~~~
57
58.. toctree::
59 :maxdepth: 1
60
61 bugpoint
62 llvm-extract
63 llvm-bcanalyzer
64
65Developer Tools
66~~~~~~~~~~~~~~~
67
68.. toctree::
69 :maxdepth: 1
70
71 FileCheck
72 tblgen
73 lit
74 llvm-build
Clement Courbetac74acd2018-04-04 11:37:06 +000075 llvm-exegesis
Zachary Turner460ed0a2017-08-11 19:00:22 +000076 llvm-pdbutil