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/llvm-upgrade.html"><b>llvm-upgrade</b></a> -
  42     upgrade LLVM assembly from previous version</li>
  43
  44 <li><a href="html/opt.html"><b>opt</b></a> -
  45     run a series of LLVM-to-LLVM optimizations on a bytecode file</li>
  46
  47 <li><a href="html/llc.html"><b>llc</b></a> -
  48     generate native machine code for a bytecode file</li>
  49
  50 <li><a href="html/lli.html"><b>lli</b></a> -
  51     directly run a program compiled to bytecode using a JIT compiler or
  52     interpreter</li>
  53
  54 <li><a href="html/llvm-link.html"><b>llvm-link</b></a> -
  55     link several bytecode files into one</li>
  56
  57 <li><a href="html/llvm-ar.html"><b>llvm-ar</b></a> -
  58     archive bytecode files</li>
  59
  60 <li><a href="html/llvm-ranlib.html"><b>llvm-ranlib</b></a> -
  61     create an index for archives made with llvm-ar</li>
  62
  63 <li><a href="html/llvm-nm.html"><b>llvm-nm</b></a> -
  64     print out the names and types of symbols in a bytecode file</li>
  65
  66 <li><a href="html/llvm-prof.html"><b>llvm-prof</b></a> -
  67     format raw `<tt>llvmprof.out</tt>' data into a human-readable report</li>
  68
  69 <li><a href="html/llvmc.html"><b>llvmc</b></a> -
  70   generic and configurable compiler driver</li>
  71
  72 <li><a href="html/llvm-ld.html"><b>llvm-ld</b></a> -
  73   general purpose linker with loadable runtime optimization support</li>
  74
  75 <li><a href="html/llvm-config.html"><b>llvm-config</b></a> -
  76   print out LLVM compilation options, libraries, etc. as configured.</li>
  77
  78   <li><a href="html/llvm2cpp.html"><b>llvm2cpp</b></a> - convert LLVM assembly
  79   into the corresponding LLVM C++ API calls to produce it</li>
  80 </ul>
  81
  82 </div>
  83
  84 <!-- *********************************************************************** -->
  85 <div class="doc_section">
  86   <a name="frontend">C, C++, and Stacker Front-end Commands</a>
  87 </div>
  88 <!-- *********************************************************************** -->
  89
  90 <div class="doc_text">
  91 <ul>
  92
  93 <li><a href="html/llvmgcc.html"><b>llvmgcc</b></a> -
  94     GCC-based C front-end for LLVM
  95
  96 <li><a href="html/llvmgxx.html"><b>llvmg++</b></a> -
  97     GCC-based C++ front-end for LLVM</li>
  98
  99 <li><a href="html/gccas.html"><b>gccas</b></a> -
 100     compile-time optimizer used by llvm-g++ and llvm-gcc</li>
 101
 102 <li><a href="html/gccld.html"><b>gccld</b></a> -
 103     linker and link-time optimizer used by llvm-g++ and llvm-gcc</li>
 104
 105 <li><a href="html/stkrc.html"><b>stkrc</b></a> -
 106     front-end compiler for the <a href="../Stacker.html">Stacker</a>
 107     language</li>
 108
 109 </ul>
 110
 111 </div>
 112
 113 <!-- *********************************************************************** -->
 114 <div class="doc_section">
 115   <a name="debug">Debugging Tools</a>
 116 </div>
 117 <!-- *********************************************************************** -->
 118
 119
 120 <div class="doc_text">
 121
 122 <ul>
 123
 124 <li><a href="html/bugpoint.html"><b>bugpoint</b></a> -
 125     automatic test-case reducer</li>
 126
 127 <li><a href="html/llvm-extract.html"><b>llvm-extract</b></a> -
 128     extract a function from an LLVM bytecode file</li>
 129
 130 <li><a href="html/llvm-bcanalyzer.html"><b>llvm-bcanalyzer</b></a> -
 131     bytecode analyzer (analyzes the binary encoding itself, not the program it
 132     represents)</li>
 133
 134 </ul>
 135 </div>
 136
 137 <!-- *********************************************************************** -->
 138 <div class="doc_section">
 139   <a name="internal">Internal Tools</a>
 140 </div>
 141 <!-- *********************************************************************** -->
 142
 143 <div class="doc_text">
 144 <ul>
 145
 146 <li><a href="html/tblgen.html"><b>tblgen</b></a> -
 147     target description reader and generator</li>
 148
 149 </ul>
 150 </div>
 151
 152 <!-- *********************************************************************** -->
 153
 154 <hr>
 155 <address>
 156   <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
 157   src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a>
 158   <a href="http://validator.w3.org/check/referer"><img
 159   src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!"></a>
 160
 161   <a href="http://llvm.org">LLVM Compiler Infrastructure</a><br>
 162   Last modified: $Date$
 163 </address>
 164
 165 </body>
 166 </html>