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/llvm-upgrade.html"><b>llvm-upgrade</b></a> -
  42     upgrade LLVM assembly from previous version</li>
  43
  44 <li><a href="/cmds/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="/cmds/llc.html"><b>llc</b></a> -
  48     generate native machine code for a bytecode file</li>
  49
  50 <li><a href="/cmds/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="/cmds/llvm-link.html"><b>llvm-link</b></a> -
  55     link several bytecode files into one</li>
  56
  57 <li><a href="/cmds/llvm-ar.html"><b>llvm-ar</b></a> -
  58     archive bytecode files</li>
  59
  60 <li><a href="/cmds/llvm-ranlib.html"><b>llvm-ranlib</b></a> -
  61     create an index for archives made with llvm-ar</li>
  62
  63 <li><a href="/cmds/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="/cmds/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="/cmds/llvmc.html"><b>llvmc</b></a> -
  70   generic and configurable compiler driver</li>
  71
  72 <li><a href="/cmds/llvm-ld.html"><b>llvm-ld</b></a> -
  73   general purpose linker with loadable runtime optimization support</li>
  74
  75 <li><a href="/cmds/llvm-config.html"><b>llvm-config</b></a> -
  76   print out LLVM compilation options, libraries, etc. as configured.</li>
  77
  78   <li><a href="/cmds/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="/cmds/llvmgcc.html"><b>llvmgcc</b></a> -
  94     GCC-based C front-end for LLVM
  95
  96 <li><a href="/cmds/llvmgxx.html"><b>llvmg++</b></a> -
  97     GCC-based C++ front-end for LLVM</li>
  98
  99 <li><a href="/cmds/stkrc.html"><b>stkrc</b></a> -
 100     front-end compiler for the <a href="../Stacker.html">Stacker</a>
 101     language</li>
 102
 103 </ul>
 104
 105 </div>
 106
 107 <!-- *********************************************************************** -->
 108 <div class="doc_section">
 109   <a name="debug">Debugging Tools</a>
 110 </div>
 111 <!-- *********************************************************************** -->
 112
 113
 114 <div class="doc_text">
 115
 116 <ul>
 117
 118 <li><a href="/cmds/bugpoint.html"><b>bugpoint</b></a> -
 119     automatic test-case reducer</li>
 120
 121 <li><a href="/cmds/llvm-extract.html"><b>llvm-extract</b></a> -
 122     extract a function from an LLVM bytecode file</li>
 123
 124 <li><a href="/cmds/llvm-bcanalyzer.html"><b>llvm-bcanalyzer</b></a> -
 125     bytecode analyzer (analyzes the binary encoding itself, not the program it
 126     represents)</li>
 127
 128 </ul>
 129 </div>
 130
 131 <!-- *********************************************************************** -->
 132 <div class="doc_section">
 133   <a name="internal">Internal Tools</a>
 134 </div>
 135 <!-- *********************************************************************** -->
 136
 137 <div class="doc_text">
 138 <ul>
 139
 140 <li><a href="/cmds/tblgen.html"><b>tblgen</b></a> -
 141     target description reader and generator</li>
 142
 143 </ul>
 144 </div>
 145
 146 <!-- *********************************************************************** -->
 147
 148 <hr>
 149 <address>
 150   <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
 151   src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a>
 152   <a href="http://validator.w3.org/check/referer"><img
 153   src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!"></a>
 154
 155   <a href="http://llvm.org">LLVM Compiler Infrastructure</a><br>
 156   Last modified: $Date$
 157 </address>
 158
 159 </body>
 160 </html>