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-debuginfo-analyzer
  25    llvm-diff
  26    llvm-dis
  27    llvm-dwarfdump
  28    llvm-dwarfutil
  29    llvm-lib
  30    llvm-libtool-darwin
  31    llvm-link
  32    llvm-lipo
  33    llvm-mc
  34    llvm-mca
  35    llvm-opt-report
  36    llvm-otool
  37    llvm-profdata
  38    llvm-readobj
  39    llvm-reduce
  40    llvm-stress
  41    llvm-symbolizer
  42    opt
  43
  44 GNU binutils replacements
  45 ~~~~~~~~~~~~~~~~~~~~~~~~~
  46
  47 .. toctree::
  48    :maxdepth: 1
  49
  50    llvm-addr2line
  51    llvm-ar
  52    llvm-cxxfilt
  53    llvm-install-name-tool
  54    llvm-nm
  55    llvm-objcopy
  56    llvm-objdump
  57    llvm-ranlib
  58    llvm-readelf
  59    llvm-size
  60    llvm-strings
  61    llvm-strip
  62
  63 Debugging Tools
  64 ~~~~~~~~~~~~~~~
  65
  66 .. toctree::
  67    :maxdepth: 1
  68
  69    bugpoint
  70    llvm-extract
  71    llvm-bcanalyzer
  72
  73 Developer Tools
  74 ~~~~~~~~~~~~~~~
  75
  76 .. toctree::
  77    :maxdepth: 1
  78
  79    FileCheck
  80    tblgen
  81    clang-tblgen
  82    lldb-tblgen
  83    llvm-tblgen
  84    mlir-tblgen
  85    lit
  86    llvm-exegesis
  87    llvm-ifs
  88    llvm-locstats
  89    llvm-pdbutil
  90    llvm-profgen
  91    llvm-tli-checker
  92
  93 Remarks Tools
  94 ~~~~~~~~~~~~~~
  95
  96 .. toctree::
  97    :maxdepth: 1
  98
  99    llvm-remarkutil