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="llvm-as.html"><b>llvm-as</b></a> -
  36     assemble a human-readable .ll file into bytecode</li>
  37
  38 <li><a href="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="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="llc.html"><b>llc</b></a> -
  45     generate native machine code for a bytecode file</li>
  46
  47 <li><a href="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="llvm-link.html"><b>llvm-link</b></a> -
  52     link several bytecode files into one</li>
  53
  54 <li><a href="analyze.html"><b>analyze</b></a> -
  55     run LLVM analyses on a bytecode file and print the results</li>
  56
  57 <li><a href="llvm-ar.html"><b>llvm-ar</b></a> -
  58     archive bytecode files</li>
  59
  60 <li><a href="llvm-ranlib.html"><b>llvm-ranlib</b></a> -
  61     create an index for archives made with llvm-ar</li>
  62
  63 <li><a href="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="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="llvmc.html"><b>llvmc</b></a> -
  70   generic and configurable compiler driver</li>
  71
  72 <li><a href="llvm-ld.html"><b>llvm-ld</b></a> -
  73   general purpose linker with loadable runtime optimization support</li>
  74
  75 </ul>
  76
  77 </div>
  78
  79 <!-- *********************************************************************** -->
  80 <div class="doc_section">
  81   <a name="frontend">C, C++, and Stacker Front-end Commands</a>
  82 </div>
  83 <!-- *********************************************************************** -->
  84
  85 <div class="doc_text">
  86 <ul>
  87
  88 <li><a href="llvmgcc.html"><b>llvmgcc</b></a> -
  89     GCC-based C front-end for LLVM
  90
  91 <li><a href="llvmgxx.html"><b>llvmg++</b></a> -
  92     GCC-based C++ front-end for LLVM</li>
  93
  94 <li><a href="gccas.html"><b>gccas</b></a> -
  95     compile-time optimizer used by llvm-g++ and llvm-gcc</li>
  96
  97 <li><a href="gccld.html"><b>gccld</b></a> -
  98     linker and link-time optimizer used by llvm-g++ and llvm-gcc</li>
  99
 100 <li><a href="stkrc.html"><b>stkrc</b></a> -
 101     front-end compiler for the <a href="../Stacker.html">Stacker</a>
 102     language</li>
 103
 104 </ul>
 105
 106 </div>
 107
 108 <!-- *********************************************************************** -->
 109 <div class="doc_section">
 110   <a name="debug">Debugging Tools</a>
 111 </div>
 112 <!-- *********************************************************************** -->
 113
 114
 115 <div class="doc_text">
 116
 117 <ul>
 118
 119 <li><a href="bugpoint.html"><b>bugpoint</b></a> -
 120     automatic test-case reducer</li>
 121
 122 <li><a href="extract.html"><b>extract</b></a> -
 123     extract a function from an LLVM bytecode file</li>
 124
 125 <li><a href="llvm-bcanalyzer.html"><b>llvm-bcanalyzer</b></a> -
 126     bytecode analyzer (analyzes the binary encoding itself, not the program it
 127     represents)</li>
 128
 129 </ul>
 130
 131 </div>
 132
 133 <!-- *********************************************************************** -->
 134
 135 <hr>
 136 <address>
 137   <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
 138   src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a>
 139   <a href="http://validator.w3.org/check/referer"><img
 140   src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!"></a>
 141
 142   <a href="http://llvm.cs.uiuc.edu">LLVM Compiler Infrastructure</a><br>
 143   Last modified: $Date$
 144 </address>
 145
 146 </body>
 147 </html>