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/analyze.html"><b>analyze</b></a> -
  55     run LLVM analyses on a bytecode file and print the results</li>
  56
  57 <li><a href="html/llvm-nm.html"><b>llvm-nm</b></a>
  58     print out the names and types of symbols in a bytecode file</li>
  59
  60 <li><a href="html/llvm-prof.html"><b>llvm-prof</b></a> -
  61     format raw `<tt>llvmprof.out</tt>' data into a human-readable report</li>
  62
  63 </ul>
  64
  65 </div>
  66
  67 <!-- *********************************************************************** -->
  68 <div class="doc_section">
  69   <a name="frontend">C, C++, and Stacker Front-end Commands</a>
  70 </div>
  71 <!-- *********************************************************************** -->
  72
  73 <div class="doc_text">
  74 <ul>
  75
  76 <li><a href="html/llvmgcc.html"><b>llvmgcc</b></a> -
  77     GCC-based C front-end for LLVM
  78
  79 <li><a href="html/llvmgxx.html"><b>llvmg++</b></a> -
  80     GCC-based C++ front-end for LLVM</li>
  81
  82 <li><a href="html/gccas.html"><b>gccas</b></a> -
  83     compile-time optimizer used by llvm-g++ and llvm-gcc</li>
  84
  85 <li><a href="html/gccld.html"><b>gccld</b></a> -
  86     linker and link-time optimizer used by llvm-g++ and llvm-gcc</li>
  87
  88 <li><a href="html/stkrc.html"><b>stkrc</b></a> -
  89     front-end compiler for the <a href="../Stacker.html">Stacker</a>
  90     language</li>
  91
  92 </ul>
  93
  94 </div>
  95
  96 <!-- *********************************************************************** -->
  97 <div class="doc_section">
  98   <a name="debug">Debugging Tools</a>
  99 </div>
 100 <!-- *********************************************************************** -->
 101
 102
 103 <div class="doc_text">
 104
 105 <ul>
 106
 107 <li><a href="html/bugpoint.html"><b>bugpoint</b></a> -
 108     automatic test-case reducer</li>
 109
 110 <li><a href="html/extract.html"><b>extract</b></a> -
 111     extract a function from an LLVM bytecode file</li>
 112
 113 <li><a href="html/llvm-bcanalyzer.html"><b>llvm-bcanalyzer</b></a> -
 114     bytecode analyzer (analyzes the binary encoding itself, not the program it
 115     represents)</li>
 116
 117 </ul>
 118
 119 </div>
 120
 121 <!-- *********************************************************************** -->
 122
 123 <hr>
 124 <address>
 125   <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
 126   src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a>
 127   <a href="http://validator.w3.org/check/referer"><img
 128   src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!"></a>
 129
 130   <a href="http://llvm.cs.uiuc.edu">LLVM Compiler Infrastructure</a><br>
 131   Last modified: $Date$
 132 </address>
 133
 134 </body>
 135 </html>