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