Add documentation for llvm-cov.
[oota-llvm.git] / docs / CommandGuide / index.html
index 022e9eefb3268ebc23be64692090df1a253eefdf..145569c96c6d5b294c213621093966e07abe948e 100644 (file)
-<!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="link.html"><b>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="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>
+
+<h1>
+  LLVM Command Guide
+</h1>
+
+<div>
+
+<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>
+
+<!-- *********************************************************************** -->
+<h2>
+  <a name="basic">Basic Commands</a>
+</h2>
+<!-- *********************************************************************** -->
+
+<div>
+
+<ul>
+
+<li><a href="/cmds/llvm-as.html"><b>llvm-as</b></a> -
+    assemble a human-readable .ll file into bytecode</li>
+
+<li><a href="/cmds/llvm-dis.html"><b>llvm-dis</b></a> -
+    disassemble a bytecode file into a human-readable .ll file</li>
+
+<li><a href="/cmds/opt.html"><b>opt</b></a> -
+    run a series of LLVM-to-LLVM optimizations on a bytecode file</li>
+
+<li><a href="/cmds/llc.html"><b>llc</b></a> -
+    generate native machine code for a bytecode file</li>
+
+<li><a href="/cmds/lli.html"><b>lli</b></a> -
+    directly run a program compiled to bytecode using a JIT compiler or
+    interpreter</li>
+
+<li><a href="/cmds/llvm-link.html"><b>llvm-link</b></a> -
+    link several bytecode files into one</li>
+
+<li><a href="/cmds/llvm-ar.html"><b>llvm-ar</b></a> -
+    archive bytecode files</li>
+
+<li><a href="/cmds/llvm-ranlib.html"><b>llvm-ranlib</b></a> -
+    create an index for archives made with llvm-ar</li>
+
+<li><a href="/cmds/llvm-nm.html"><b>llvm-nm</b></a> -
+    print out the names and types of symbols in a bytecode file</li>
+
+<li><a href="/cmds/llvm-prof.html"><b>llvm-prof</b></a> -
+    format raw `<tt>llvmprof.out</tt>' data into a human-readable report</li>
+
+<li><a href="/cmds/llvm-ld.html"><b>llvm-ld</b></a> -
+    general purpose linker with loadable runtime optimization support</li>
+
+<li><a href="/cmds/llvm-config.html"><b>llvm-config</b></a> -
+    print out LLVM compilation options, libraries, etc. as configured</li>
+
+<li><a href="/cmds/llvm-diff.html"><b>llvm-diff</b></a> -
+    structurally compare two modules</li>
+
+<li><a href="/cmds/llvm-cov.html"><b>llvm-cov</b></a> -
+    emit coverage information</li>
+
+</ul>
+
+</div>
+
+<!-- *********************************************************************** -->
+<h2>
+  <a name="debug">Debugging Tools</a>
+</h2>
+<!-- *********************************************************************** -->
+
+
+<div>
+
+<ul>
+
+<li><a href="/cmds/bugpoint.html"><b>bugpoint</b></a> -
+    automatic test-case reducer</li>
+
+<li><a href="/cmds/llvm-extract.html"><b>llvm-extract</b></a> -
+    extract a function from an LLVM bytecode file</li>
+
+<li><a href="/cmds/llvm-bcanalyzer.html"><b>llvm-bcanalyzer</b></a> -
+    bytecode analyzer (analyzes the binary encoding itself, not the program it
+    represents)</li>
+
+</ul>
+</div>
+
+<!-- *********************************************************************** -->
+<h2>
+  <a name="internal">Internal Tools</a>
+</h2>
+<!-- *********************************************************************** -->
+
+<div>
+<ul>
+
+<li><a href="/cmds/FileCheck.html"><b>FileCheck</b></a> -
+    Flexible file verifier used extensively by the testing harness</li>
+<li><a href="/cmds/tblgen.html"><b>tblgen</b></a> -
+    target description reader and generator</li>
+<li><a href="/cmds/lit.html"><b>lit</b></a> -
+    LLVM Integrated Tester, for running tests</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-blue" alt="Valid CSS"></a>
+  <a href="http://validator.w3.org/check/referer"><img
+  src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a>
+
+  <a href="http://llvm.org/">LLVM Compiler Infrastructure</a><br>
+  Last modified: $Date$
+</address>
+
+</body>
 </html>