-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
+ "http://www.w3.org/TR/html4/strict.dtd">
<html>
- <head>
- <title>LLVM Command Guide</title>
- </head>
-
- <body bgcolor=white>
-
- <center><h1>LLVM Command Guide<br></h1></center>
-
- <!--===============================================================-->
- <h2><a name="a">Overview</a><hr></h2>
- <!--===============================================================-->
-
- This document is the reference manual for the LLVM utilities. It will
- show you how to use the LLVM commands and what all of their options
- are.
-
- <!--===============================================================-->
- <h2><a name="llvmcmds">LLVM Base Commands</a><hr></h2>
- <!--===============================================================-->
-
- <dl compact>
- <dt><A href="llvmas.html"><b>llvm-as</b></A>
- <dd>
- Assemble a human-readable LLVM program into LLVM bytecode.
- <p>
-
- <dt><A href="llvmdis.html"><b>llvm-dis</b></A>
- <dd>
- Disassemble an LLVM bytecode file into human-readable form.
- <p>
-
- <dt><A href="analyze.html"><b>analyze</b></A>
- <dd>
- Analyze an LLVM bytecode file.
- <p>
-
- <dt><A href="opt.html"><b>opt</b></A>
- <dd>
- Optimize an LLVM bytecode file.
- <p>
-
- <dt><A href="llvmlink.html"><b>llvm-link</b></A>
- <dd>
- Link several LLVM bytecode files together into one LLVM
- bytecode file.
- <p>
-
- <dt><A href="llc.html"><b>llc</b></A>
- <dd>
- Compile an LLVM bytecode program into native machine code.
-
- <dt><A href="lli.html"><b>lli</b></A>
- <dd>
- Run an LLVM bytecode program using either an interpreter or a
- JIT compiler.
- <p>
- </dl>
-
- <!--===============================================================-->
- <h2><a name="llvmcmds">LLVM Debugging Tools</a><hr></h2>
- <!--===============================================================-->
-
- <dl compact>
- <dt><A href="bugpoint.html"><b>bugpoint</b></A>
- <dd>
- Trace an LLVM bytecode program and reduce its failure to a
- simple testcase.
- <p>
-
- <dt><A href="extract.html"><b>extract</b></A>
- <dd>
- Extract a function from an LLVM bytecode file.
- </dl>
-
- <!--===============================================================-->
- <h2><a name="llvmcmds">LLVM GCC Support Commands</a><hr></h2>
- <!--===============================================================-->
-
- <dl compact>
- <dt><A href="llvmgcc.html"><b>llvmgcc</b></A>
- <dd>
- GCC-based C front end for LLVM.
- <p>
-
- <dt><A href="llvmgxx.html"><b>llvmg++</b></A>
- <dd>
- GCC-based C++ front end for LLVM.
- <p>
-
- <dt><A href="gccas.html"><b>gccas</b></A>
- <dd>
- LLVM assembler used by GCC and other native compiler tools.
- <p>
-
- <dt><A href="gccld.html"><b>gccld</b></A>
- <dd>
- LLVM linker used by GCC and other native compiler tools.
- </dl>
-
- </body>
+<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/llvm-upgrade.html"><b>llvm-upgrade</b></a> -
+ upgrade LLVM assembly from previous version</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/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="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, 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/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/llvm-extract.html"><b>llvm-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>
+
+<!-- *********************************************************************** -->
+<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>
+
+<!-- *********************************************************************** -->
+
+<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.org">LLVM Compiler Infrastructure</a><br>
+ Last modified: $Date$
+</address>
+
+</body>
</html>
projects / oota-llvm.git / blobdiff