llvm/docs/CommandGuide/index.html

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
                      "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
  <title>LLVM Command Guide</title>
  <link rel="stylesheet" href="../llvm.css" type="text/css">
</head>
<body>

<div class="doc_title">
  LLVM Command Guide
</div>

<div class="doc_text">

<p>These documents are HTML versions of the <a href="man/man1/">man pages</a>
for all of the LLVM tools.  These pages describe how to use the LLVM commands
and what their options are.  Note that these pages do not describe all of the 
options available for all tools.  To get a complete listing, pass the 
<tt>--help</tt> (general options) or <tt>--help-hidden</tt> (general+debugging
options) arguments to the tool you are interested in.</p>

</div>

<!-- *********************************************************************** -->
<div class="doc_section">
  <a name="basic">Basic Commands</a>
</div>
<!-- *********************************************************************** -->

<div class="doc_text">

<ul>

<li><a href="html/llvm-as.html"><b>llvm-as</b></a> - 
    assemble a human-readable .ll file into bytecode</li>

<li><a href="html/llvm-dis.html"><b>llvm-dis</b></a> -
    disassemble a bytecode file into a human-readable .ll file</li>

<li><a href="html/opt.html"><b>opt</b></a> -
    run a series of LLVM-to-LLVM optimizations on a bytecode file</li>

<li><a href="html/llc.html"><b>llc</b></a> - 
    generate native machine code for a bytecode file</li>

<li><a href="html/lli.html"><b>lli</b></a> - 
    directly run a program compiled to bytecode using a JIT compiler or 
    interpreter</li>

<li><a href="html/llvm-link.html"><b>llvm-link</b></A>
    link several bytecode files into one</li>

<li><a href="html/analyze.html"><b>analyze</b></a> -
    run LLVM analyses on a bytecode file and print the results</li>

<li><a href="html/llvm-nm.html"><b>llvm-nm</b></a>
    print out the names and types of symbols in a bytecode file</li>

<li><a href="html/llvm-prof.html"><b>llvm-prof</b></a> -
    format raw `<tt>llvmprof.out</tt>' data into a human-readable report</li>

</ul>

</div>

<!-- *********************************************************************** -->
<div class="doc_section">
  <a name="frontend">C, C++, and Stacker Front-end Commands</a>
</div>
<!-- *********************************************************************** -->

<div class="doc_text">
<ul>

<li><a href="html/llvmgcc.html"><b>llvmgcc</b></a> -
    GCC-based C front-end for LLVM

<li><a href="html/llvmgxx.html"><b>llvmg++</b></a> -
    GCC-based C++ front-end for LLVM</li>

<li><a href="html/gccas.html"><b>gccas</b></a> -
    compile-time optimizer used by llvm-g++ and llvm-gcc</li>

<li><a href="html/gccld.html"><b>gccld</b></a> -
    linker and link-time optimizer used by llvm-g++ and llvm-gcc</li>

<li><a href="html/stkrc.html"><b>stkrc</b></a> -
    front-end compiler for the <a href="../Stacker.html">Stacker</a> 
    language</li>

</ul>

</div>

<!-- *********************************************************************** -->
<div class="doc_section">
  <a name="debug">Debugging Tools</a>
</div>
<!-- *********************************************************************** -->


<div class="doc_text">

<ul>

<li><a href="html/bugpoint.html"><b>bugpoint</b></a> -
    automatic test-case reducer</li>

<li><a href="html/extract.html"><b>extract</b></a> -
    extract a function from an LLVM bytecode file</li>

<li><a href="html/llvm-bcanalyzer.html"><b>llvm-bcanalyzer</b></a> -
    bytecode analyzer (analyzes the binary encoding itself, not the program it
    represents)</li>

</ul>

</div>

<!-- *********************************************************************** -->

<hr>
<address>
  <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
  src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a>
  <a href="http://validator.w3.org/check/referer"><img
  src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!"></a>

  <a href="http://llvm.cs.uiuc.edu">LLVM Compiler Infrastructure</a><br>
  Last modified: $Date$
</address>

</body>
</html>