docs/CommandGuide/index.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
   2                       "http://www.w3.org/TR/html4/strict.dtd">
   3 <html>
   4 <head>
   5   <title>LLVM Command Guide</title>
   6   <link rel="stylesheet" href="../llvm.css" type="text/css">
   7 </head>
   8 <body>
   9
  10 <div class="doc_title">
  11   LLVM Command Guide
  12 </div>
  13
  14 <div class="doc_text">
  15
  16 <p>These documents are HTML versions of the <a href="man/man1/">man pages</a>
  17 for all of the LLVM tools.  These pages describe how to use the LLVM commands
  18 and what their options are.  Note that these pages do not describe all of the
  19 options available for all tools.  To get a complete listing, pass the
  20 <tt>--help</tt> (general options) or <tt>--help-hidden</tt> (general+debugging
  21 options) arguments to the tool you are interested in.</p>
  22
  23 </div>
  24
  25 <!-- *********************************************************************** -->
  26 <div class="doc_section">
  27   <a name="basic">Basic Commands</a>
  28 </div>
  29 <!-- *********************************************************************** -->
  30
  31 <div class="doc_text">
  32
  33 <ul>
  34
  35 <li><a href="html/llvm-as.html"><b>llvm-as</b></a> -
  36     assemble a human-readable .ll file into bytecode</li>
  37
  38 <li><a href="html/llvm-dis.html"><b>llvm-dis</b></a> -
  39     disassemble a bytecode file into a human-readable .ll file</li>
  40
  41 <li><a href="html/opt.html"><b>opt</b></a> -
  42     run a series of LLVM-to-LLVM optimizations on a bytecode file</li>
  43
  44 <li><a href="html/llc.html"><b>llc</b></a> -
  45     generate native machine code for a bytecode file</li>
  46
  47 <li><a href="html/lli.html"><b>lli</b></a> -
  48     directly run a program compiled to bytecode using a JIT compiler or
  49     interpreter</li>
  50
  51 <li><a href="html/llvm-link.html"><b>llvm-link</b></a> -
  52     link several bytecode files into one</li>
  53
  54 <li><a href="html/llvm-ar.html"><b>llvm-ar</b></a> -
  55     archive bytecode files</li>
  56
  57 <li><a href="html/llvm-ranlib.html"><b>llvm-ranlib</b></a> -
  58     create an index for archives made with llvm-ar</li>
  59
  60 <li><a href="html/llvm-nm.html"><b>llvm-nm</b></a> -
  61     print out the names and types of symbols in a bytecode file</li>
  62
  63 <li><a href="html/llvm-prof.html"><b>llvm-prof</b></a> -
  64     format raw `<tt>llvmprof.out</tt>' data into a human-readable report</li>
  65
  66 <li><a href="html/llvmc.html"><b>llvmc</b></a> -
  67   generic and configurable compiler driver</li>
  68
  69 <li><a href="html/llvm-ld.html"><b>llvm-ld</b></a> -
  70   general purpose linker with loadable runtime optimization support</li>
  71
  72 <li><a href="html/llvm-config.html"><b>llvm-config</b></a> -
  73   print out LLVM compilation options, libraries, etc. as configured.</li>
  74
  75   <li><a href="html/llvm2cpp.html"><b>llvm2cpp</b></a> - convert LLVM assembly
  76   into the corresponding LLVM C++ API calls to produce it</li>
  77 </ul>
  78
  79 </div>
  80
  81 <!-- *********************************************************************** -->
  82 <div class="doc_section">
  83   <a name="frontend">C, C++, and Stacker Front-end Commands</a>
  84 </div>
  85 <!-- *********************************************************************** -->
  86
  87 <div class="doc_text">
  88 <ul>
  89
  90 <li><a href="html/llvmgcc.html"><b>llvmgcc</b></a> -
  91     GCC-based C front-end for LLVM
  92
  93 <li><a href="html/llvmgxx.html"><b>llvmg++</b></a> -
  94     GCC-based C++ front-end for LLVM</li>
  95
  96 <li><a href="html/gccas.html"><b>gccas</b></a> -
  97     compile-time optimizer used by llvm-g++ and llvm-gcc</li>
  98
  99 <li><a href="html/gccld.html"><b>gccld</b></a> -
 100     linker and link-time optimizer used by llvm-g++ and llvm-gcc</li>
 101
 102 <li><a href="html/stkrc.html"><b>stkrc</b></a> -
 103     front-end compiler for the <a href="../Stacker.html">Stacker</a>
 104     language</li>
 105
 106 </ul>
 107
 108 </div>
 109
 110 <!-- *********************************************************************** -->
 111 <div class="doc_section">
 112   <a name="debug">Debugging Tools</a>
 113 </div>
 114 <!-- *********************************************************************** -->
 115
 116
 117 <div class="doc_text">
 118
 119 <ul>
 120
 121 <li><a href="html/bugpoint.html"><b>bugpoint</b></a> -
 122     automatic test-case reducer</li>
 123
 124 <li><a href="html/llvm-extract.html"><b>llvm-extract</b></a> -
 125     extract a function from an LLVM bytecode file</li>
 126
 127 <li><a href="html/llvm-bcanalyzer.html"><b>llvm-bcanalyzer</b></a> -
 128     bytecode analyzer (analyzes the binary encoding itself, not the program it
 129     represents)</li>
 130
 131 </ul>
 132 </div>
 133
 134 <!-- *********************************************************************** -->
 135 <div class="doc_section">
 136   <a name="internal">Internal Tools</a>
 137 </div>
 138 <!-- *********************************************************************** -->
 139
 140 <div class="doc_text">
 141 <ul>
 142
 143 <li><a href="html/tblgen.html"><b>tblgen</b></a> -
 144     target description reader and generator</li>
 145
 146 </ul>
 147 </div>
 148
 149 <!-- *********************************************************************** -->
 150
 151 <hr>
 152 <address>
 153   <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
 154   src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a>
 155   <a href="http://validator.w3.org/check/referer"><img
 156   src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!"></a>
 157
 158   <a href="http://llvm.org">LLVM Compiler Infrastructure</a><br>
 159   Last modified: $Date$
 160 </address>
 161
 162 </body>
 163 </html>