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    llvm-as
  18    llvm-dis
  19    opt
  20    llc
  21    lli
  22    llvm-link
  23    llvm-lib
  24    llvm-lipo
  25    llvm-config
  26    llvm-cxxmap
  27    llvm-diff
  28    llvm-cov
  29    llvm-profdata
  30    llvm-stress
  31    llvm-symbolizer
  32    llvm-dwarfdump
  33    dsymutil
  34    llvm-mca
  35    llvm-readobj
  36
  37 GNU 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
  55 Debugging Tools
  56 ~~~~~~~~~~~~~~~
  57
  58 .. toctree::
  59    :maxdepth: 1
  60
  61    bugpoint
  62    llvm-extract
  63    llvm-bcanalyzer
  64
  65 Developer Tools
  66 ~~~~~~~~~~~~~~~
  67
  68 .. toctree::
  69    :maxdepth: 1
  70
  71    FileCheck
  72    tblgen
  73    lit
  74    llvm-build
  75    llvm-exegesis
  76    llvm-pdbutil