llvm/docs/CommandGuide/index.rst

   1 LLVM Command Guide
   2 ------------------
   3
   4 The following documents are command descriptions for all of the LLVM tools.
   5 These pages describe how to use the LLVM commands and what their options are.
   6 Note that these pages do not describe all of the options available for all
   7 tools. To get a complete listing, pass the ``--help`` (general options) or
   8 ``--help-hidden`` (general and debugging options) arguments to the tool you are
   9 interested in.
  10
  11 Basic Commands
  12 ~~~~~~~~~~~~~~
  13
  14 .. toctree::
  15    :maxdepth: 1
  16
  17    dsymutil
  18    llc
  19    lli
  20    llvm-as
  21    llvm-config
  22    llvm-cov
  23    llvm-cxxmap
  24    llvm-diff
  25    llvm-dis
  26    llvm-dwarfdump
  27    llvm-lib
  28    llvm-libtool-darwin
  29    llvm-link
  30    llvm-lipo
  31    llvm-mca
  32    llvm-otool
  33    llvm-profdata
  34    llvm-readobj
  35    llvm-stress
  36    llvm-symbolizer
  37    opt
  38
  39 GNU binutils replacements
  40 ~~~~~~~~~~~~~~~~~~~~~~~~~
  41
  42 .. toctree::
  43    :maxdepth: 1
  44
  45    llvm-addr2line
  46    llvm-ar
  47    llvm-cxxfilt
  48    llvm-install-name-tool
  49    llvm-nm
  50    llvm-objcopy
  51    llvm-objdump
  52    llvm-ranlib
  53    llvm-readelf
  54    llvm-size
  55    llvm-strings
  56    llvm-strip
  57
  58 Debugging Tools
  59 ~~~~~~~~~~~~~~~
  60
  61 .. toctree::
  62    :maxdepth: 1
  63
  64    bugpoint
  65    llvm-extract
  66    llvm-bcanalyzer
  67
  68 Developer Tools
  69 ~~~~~~~~~~~~~~~
  70
  71 .. toctree::
  72    :maxdepth: 1
  73
  74    FileCheck
  75    tblgen
  76    clang-tblgen
  77    lldb-tblgen
  78    llvm-tblgen
  79    mlir-tblgen
  80    lit
  81    llvm-exegesis
  82    llvm-locstats
  83    llvm-pdbutil
  84    llvm-profgen