<div class="doc_text">
-<p>This document is the reference manual for the LLVM utilities. It will
-show you how to use the LLVM commands and what their options are. Note that in
-the descriptions below, `bytecode' and `program' refer to LLVM bytecode files
-and assembly programs, respectively.</p>
-
-<ul>
- <li><a href="#basic">Basic Commands</a></li>
- <li><a href="#frontend">C and C++ Frond-end Commands</a></li>
- <li><a href="#debug">Debugging commands</a></li>
-</ul>
+<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>
<ul>
-<li><a href="llvm-as.html"><b>llvm-as</b></a> -
- assemble a human-readable program into bytecode</li>
+<li><a href="html/llvm-as.html"><b>llvm-as</b></a> -
+ assemble a human-readable .ll file into bytecode</li>
-<li><a href="llvm-dis.html"><b>llvm-dis</b></a> -
- disassemble a bytecode file into human-readable form</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="analyze.html"><b>analyze</b></a> -
- analyze a program compiled to bytecode</li>
+<li><a href="html/llvm-upgrade.html"><b>llvm-upgrade</b></a> -
+ upgrade LLVM assembly from previous version</li>
-<li><a href="opt.html"><b>opt</b></a> -
- optimize a bytecode 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="llc.html"><b>llc</b></a> -
- compile a bytecode program into native machine code</li>
+<li><a href="html/llc.html"><b>llc</b></a> -
+ generate native machine code for a bytecode file</li>
-<li><a href="lli.html"><b>lli</b></a> -
- run a bytecode program using either an interpreter or a JIT compiler</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="llvm-link.html"><b>llvm-link</b></A>
+<li><a href="html/llvm-link.html"><b>llvm-link</b></a> -
link several bytecode files into one</li>
-<li><a href="llvm-nm.html"><b>llvm-nm</b></a>
+<li><a href="html/llvm-ar.html"><b>llvm-ar</b></a> -
+ archive bytecode files</li>
+
+<li><a href="html/llvm-ranlib.html"><b>llvm-ranlib</b></a> -
+ create an index for archives made with llvm-ar</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="llvm-prof.html"><b>llvm-prof</b></a> -
- transform raw `<tt>llvmprof.out</tt>' data into a human-readable report</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>
+
+<li><a href="html/llvmc.html"><b>llvmc</b></a> -
+ generic and configurable compiler driver</li>
+<li><a href="html/llvm-ld.html"><b>llvm-ld</b></a> -
+ general purpose linker with loadable runtime optimization support</li>
+
+<li><a href="html/llvm-config.html"><b>llvm-config</b></a> -
+ print out LLVM compilation options, libraries, etc. as configured.</li>
+
+ <li><a href="html/llvm2cpp.html"><b>llvm2cpp</b></a> - convert LLVM assembly
+ into the corresponding LLVM C++ API calls to produce it</li>
</ul>
</div>
<!-- *********************************************************************** -->
<div class="doc_section">
- <a name="frontend">C and C++ Front-end Commands</a>
+ <a name="frontend">C, C++, and Stacker Front-end Commands</a>
</div>
<!-- *********************************************************************** -->
<div class="doc_text">
-
<ul>
-<li><a href="llvmgcc.html"><b>llvmgcc</b></a> -
- GCC-based C front end for LLVM
+<li><a href="html/llvmgcc.html"><b>llvmgcc</b></a> -
+ GCC-based C front-end for LLVM
-<li><a href="llvmgxx.html"><b>llvmg++</b></a> -
- GCC-based C++ front end for LLVM</li>
+<li><a href="html/llvmgxx.html"><b>llvmg++</b></a> -
+ GCC-based C++ front-end for LLVM</li>
-<li><a href="gccas.html"><b>gccas</b></a> -
- optimizing assembler used by llvm-g++ and llvm-gcc</li>
-
-<li><a href="gccld.html"><b>gccld</b></a> -
- optimizing linker 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>
<ul>
-<li><a href="bugpoint.html"><b>bugpoint</b></a> -
+<li><a href="html/bugpoint.html"><b>bugpoint</b></a> -
automatic test-case reducer</li>
-<li><a href="extract.html"><b>extract</b></a> -
+<li><a href="html/llvm-extract.html"><b>llvm-extract</b></a> -
extract a function from an LLVM bytecode file</li>
-<li><a href="llvm-abcd.html"><b>llvm-abcd</b></a> -
+<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>
+<!-- *********************************************************************** -->
+<div class="doc_section">
+ <a name="internal">Internal Tools</a>
+</div>
+<!-- *********************************************************************** -->
+
+<div class="doc_text">
+<ul>
+
+<li><a href="html/tblgen.html"><b>tblgen</b></a> -
+ target description reader and generator</li>
+
+</ul>
</div>
<!-- *********************************************************************** -->
<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="mailto:criswell at cs dot uiuc dot edu">John Criswell</a><br>
- <a href="http://llvm.cs.uiuc.edu">LLVM Compiler Infrastructure</a><br>
+ <a href="http://llvm.org">LLVM Compiler Infrastructure</a><br>
Last modified: $Date$
</address>
projects / oota-llvm.git / blobdiff