1
0
mirror of https://github.com/RPCS3/llvm-mirror.git synced 2024-11-22 10:42:39 +01:00
llvm-mirror/docs/CommandGuide/index.rst
Nico Weber 74a701ab05 [llvm-objdump] Add an llvm-otool tool
This implements an LLVM tool that's flag- and output-compatible
with macOS's `otool` -- except for bugs, but from testing with both
`otool` and `xcrun otool-classic`, llvm-otool matches vanilla
otool's behavior very well already. It's not 100% perfect, but
it's a very solid start.

This uses the same approach as llvm-objcopy: llvm-objdump uses
a different OptTable when it's invoked as llvm-otool. This
is possible thanks to D100433.

Differential Revision: https://reviews.llvm.org/D100583
2021-04-20 08:24:58 -04:00

85 lines
1.4 KiB
ReStructuredText

LLVM Command Guide
------------------
The following documents are command descriptions for all of the LLVM tools.
These pages describe how to use the LLVM commands and what their options are.
Note that these pages do not describe all of the options available for all
tools. To get a complete listing, pass the ``--help`` (general options) or
``--help-hidden`` (general and debugging options) arguments to the tool you are
interested in.
Basic Commands
~~~~~~~~~~~~~~
.. toctree::
:maxdepth: 1
dsymutil
llc
lli
llvm-as
llvm-config
llvm-cov
llvm-cxxmap
llvm-diff
llvm-dis
llvm-dwarfdump
llvm-lib
llvm-libtool-darwin
llvm-link
llvm-lipo
llvm-mca
llvm-otool
llvm-profdata
llvm-readobj
llvm-stress
llvm-symbolizer
opt
GNU binutils replacements
~~~~~~~~~~~~~~~~~~~~~~~~~
.. toctree::
:maxdepth: 1
llvm-addr2line
llvm-ar
llvm-cxxfilt
llvm-install-name-tool
llvm-nm
llvm-objcopy
llvm-objdump
llvm-ranlib
llvm-readelf
llvm-size
llvm-strings
llvm-strip
Debugging Tools
~~~~~~~~~~~~~~~
.. toctree::
:maxdepth: 1
bugpoint
llvm-extract
llvm-bcanalyzer
Developer Tools
~~~~~~~~~~~~~~~
.. toctree::
:maxdepth: 1
FileCheck
tblgen
clang-tblgen
lldb-tblgen
llvm-tblgen
mlir-tblgen
lit
llvm-exegesis
llvm-locstats
llvm-pdbutil
llvm-profgen