Home | History | Annotate | Download | only in CommandGuide
      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 <h1>
     11   LLVM Command Guide
     12 </h1>
     13 
     14 <div>
     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 <h2>
     27   <a name="basic">Basic Commands</a>
     28 </h2>
     29 <!-- *********************************************************************** -->
     30 
     31 <div>
     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 <li><a href="/cmds/llvm-diff.html"><b>llvm-diff</b></a> -
     73     structurally compare two modules</li>
     74 
     75 </ul>
     76 
     77 </div>
     78 
     79 <!-- *********************************************************************** -->
     80 <h2>
     81   <a name="debug">Debugging Tools</a>
     82 </h2>
     83 <!-- *********************************************************************** -->
     84 
     85 
     86 <div>
     87 
     88 <ul>
     89 
     90 <li><a href="/cmds/bugpoint.html"><b>bugpoint</b></a> -
     91     automatic test-case reducer</li>
     92 
     93 <li><a href="/cmds/llvm-extract.html"><b>llvm-extract</b></a> -
     94     extract a function from an LLVM bytecode file</li>
     95 
     96 <li><a href="/cmds/llvm-bcanalyzer.html"><b>llvm-bcanalyzer</b></a> -
     97     bytecode analyzer (analyzes the binary encoding itself, not the program it
     98     represents)</li>
     99 
    100 </ul>
    101 </div>
    102 
    103 <!-- *********************************************************************** -->
    104 <h2>
    105   <a name="internal">Internal Tools</a>
    106 </h2>
    107 <!-- *********************************************************************** -->
    108 
    109 <div>
    110 <ul>
    111 
    112 <li><a href="/cmds/FileCheck.html"><b>FileCheck</b></a> -
    113     Flexible file verifier used extensively by the testing harness</li>
    114 <li><a href="/cmds/tblgen.html"><b>tblgen</b></a> -
    115     target description reader and generator</li>
    116 <li><a href="/cmds/lit.html"><b>lit</b></a> -
    117     LLVM Integrated Tester, for running tests</li>
    118 
    119 </ul>
    120 </div>
    121 
    122 <!-- *********************************************************************** -->
    123 
    124 <hr>
    125 <address>
    126   <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
    127   src="http://jigsaw.w3.org/css-validator/images/vcss-blue" alt="Valid CSS"></a>
    128   <a href="http://validator.w3.org/check/referer"><img
    129   src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a>
    130 
    131   <a href="http://llvm.org/">LLVM Compiler Infrastructure</a><br>
    132   Last modified: $Date: 2011-09-20 14:24:04 -0400 (Tue, 20 Sep 2011) $
    133 </address>
    134 
    135 </body>
    136 </html>
    137