blob: 2dae12bb7f6dd9afb6c60b9b6b5be825dd669ab5 [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
Sameer Arora6c43ed602020-07-01 14:41:07 -070017 dsymutil
Daniel Dunbar8f4a8a62012-05-08 16:50:35 +000018 llc
19 lli
Sameer Arora6c43ed602020-07-01 14:41:07 -070020 llvm-as
Daniel Dunbar8f4a8a62012-05-08 16:50:35 +000021 llvm-config
Sameer Arora6c43ed602020-07-01 14:41:07 -070022 llvm-cov
Richard Smith3164fcf2018-09-13 20:22:02 +000023 llvm-cxxmap
Daniel Dunbar8f4a8a62012-05-08 16:50:35 +000024 llvm-diff
Sameer Arora6c43ed602020-07-01 14:41:07 -070025 llvm-dis
26 llvm-dwarfdump
27 llvm-lib
28 llvm-libtool-darwin
29 llvm-link
30 llvm-lipo
31 llvm-mca
Duncan P. N. Exon Smith846a6272014-02-17 23:22:49 +000032 llvm-profdata
Sameer Arora6c43ed602020-07-01 14:41:07 -070033 llvm-readobj
Daniel Dunbar8f4a8a62012-05-08 16:50:35 +000034 llvm-stress
Alexey Samsonov2bc10122013-03-01 07:58:27 +000035 llvm-symbolizer
Sameer Arora6c43ed602020-07-01 14:41:07 -070036 opt
Daniel Dunbar8f4a8a62012-05-08 16:50:35 +000037
Jordan Rupprecht4c3722a2019-06-11 21:13:01 +000038GNU binutils replacements
39~~~~~~~~~~~~~~~~~~~~~~~~~
40
41.. toctree::
42 :maxdepth: 1
43
44 llvm-addr2line
45 llvm-ar
46 llvm-cxxfilt
Sameer Arorabb4b70f2020-06-12 07:39:46 -070047 llvm-install-name-tool
Jordan Rupprecht4c3722a2019-06-11 21:13:01 +000048 llvm-nm
49 llvm-objcopy
50 llvm-objdump
51 llvm-ranlib
52 llvm-readelf
53 llvm-size
54 llvm-strings
55 llvm-strip
56
Daniel Dunbar8f4a8a62012-05-08 16:50:35 +000057Debugging Tools
58~~~~~~~~~~~~~~~
59
60.. toctree::
61 :maxdepth: 1
62
63 bugpoint
64 llvm-extract
65 llvm-bcanalyzer
66
67Developer Tools
68~~~~~~~~~~~~~~~
69
70.. toctree::
71 :maxdepth: 1
72
73 FileCheck
74 tblgen
75 lit
76 llvm-build
Clement Courbetac74acd2018-04-04 11:37:06 +000077 llvm-exegesis
Zachary Turner460ed0a2017-08-11 19:00:22 +000078 llvm-pdbutil
Djordje Todorovic2ef18fb2019-10-02 07:00:01 +000079 llvm-locstats