Add documentation for llvm-cov.
[oota-llvm.git] / docs / CommandGuide / index.html
index 74a70dc883a6fed1d8e0c661082545eeaada6ea0..145569c96c6d5b294c213621093966e07abe948e 100644 (file)
 </head>
 <body>
 
-<div class="doc_title">
+<h1>
   LLVM Command Guide
-</div>
+</h1>
 
-<div class="doc_text">
+<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
+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">
+<h2>
   <a name="basic">Basic Commands</a>
-</div>
+</h2>
 <!-- *********************************************************************** -->
 
-<div class="doc_text">
+<div>
 
 <ul>
 
-<li><a href="html/llvm-as.html"><b>llvm-as</b></a> - 
+<li><a href="/cmds/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> -
+<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="html/opt.html"><b>opt</b></a> -
+<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="html/llc.html"><b>llc</b></a> - 
+<li><a href="/cmds/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 
+<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="html/llvm-link.html"><b>llvm-link</b></a> -
+<li><a href="/cmds/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-ar.html"><b>llvm-ar</b></a> - 
+<li><a href="/cmds/llvm-ar.html"><b>llvm-ar</b></a> -
     archive bytecode files</li>
 
-<li><a href="html/llvm-ranlib.html"><b>llvm-ranlib</b></a> - 
+<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="html/llvm-nm.html"><b>llvm-nm</b></a> -
+<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="html/llvm-prof.html"><b>llvm-prof</b></a> -
+<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="html/llvmc.html"><b>llvmc</b></a> -
-  generic and configurable compiler driver</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="html/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="html/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>
 
-  <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>
+<h2>
+  <a name="debug">Debugging Tools</a>
+</h2>
 <!-- *********************************************************************** -->
 
-<div class="doc_text">
-<ul>
 
-<li><a href="html/llvmgcc.html"><b>llvmgcc</b></a> -
-    GCC-based C front-end for LLVM
+<div>
 
-<li><a href="html/llvmgxx.html"><b>llvmg++</b></a> -
-    GCC-based C++ front-end for LLVM</li>
+<ul>
 
-<li><a href="html/gccas.html"><b>gccas</b></a> -
-    compile-time optimizer used by llvm-g++ and llvm-gcc</li>
+<li><a href="/cmds/bugpoint.html"><b>bugpoint</b></a> -
+    automatic test-case reducer</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="/cmds/llvm-extract.html"><b>llvm-extract</b></a> -
+    extract a function from an LLVM bytecode file</li>
 
-<li><a href="html/stkrc.html"><b>stkrc</b></a> -
-    front-end compiler for the <a href="../Stacker.html">Stacker</a> 
-    language</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>
 
 <!-- *********************************************************************** -->
-<div class="doc_section">
-  <a name="debug">Debugging Tools</a>
-</div>
+<h2>
+  <a name="internal">Internal Tools</a>
+</h2>
 <!-- *********************************************************************** -->
 
-
-<div class="doc_text">
-
+<div>
 <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>
+<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>
 
 <!-- *********************************************************************** -->
@@ -140,11 +127,11 @@ options) arguments to the tool you are interested in.</p>
 <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>
+  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" alt="Valid HTML 4.01!"></a>
+  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>
+  <a href="http://llvm.org/">LLVM Compiler Infrastructure</a><br>
   Last modified: $Date$
 </address>