Add an !eq() operator to TableGen. It operates on strings only.
[oota-llvm.git] / docs / CommandGuide / index.html
index d549d3a22adae1377ed078c357d27cb0bf29ba21..9516d075b3c277f45248886cc853c19d3c91c3c2 100644 (file)
@@ -3,7 +3,7 @@
 <html>
 <head>
   <title>LLVM Command Guide</title>
-  <link rel="stylesheet" href="../llvm.css" type="text/css">
+  <link rel="stylesheet" href="/docs/llvm.css" type="text/css">
 </head>
 <body>
 
 
 <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>
 
@@ -36,32 +32,45 @@ and assembly programs, respectively.</p>
 
 <ul>
 
-<li><a href="html/llvm-as.html"><b>llvm-as</b></a> - 
-    assemble a human-readable program into bytecode</li>
+<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> -
-    disassemble a bytecode file into human-readable form</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="html/analyze.html"><b>analyze</b></a> -
-    analyze a program compiled to bytecode</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="html/opt.html"><b>opt</b></a> -
-    optimize 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="html/llc.html"><b>llc</b></a> - 
-    compile a bytecode program into native machine code</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="html/lli.html"><b>lli</b></a> - 
-    run a bytecode program using either an interpreter or a JIT compiler</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/llvm-nm.html"><b>llvm-nm</b></a>
+<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="html/llvm-prof.html"><b>llvm-prof</b></a> -
-    transform raw `<tt>llvmprof.out</tt>' data into a human-readable report</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/llvmc.html"><b>llvmc</b></a> -
+    a generic customizable compiler driver</li>
 
 </ul>
 
@@ -74,20 +83,13 @@ and assembly programs, respectively.</p>
 <!-- *********************************************************************** -->
 
 <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> -
-    optimizing assembler used by llvm-g++ and llvm-gcc</li>
+<li><a href="/cmds/llvmgcc.html"><b>llvm-gcc</b></a> -
+    GCC-based C front-end for LLVM
 
-<li><a href="html/gccld.html"><b>gccld</b></a> -
-    optimizing linker used by llvm-g++ and llvm-gcc</li>
+<li><a href="/cmds/llvmgxx.html"><b>llvm-g++</b></a> -
+    GCC-based C++ front-end for LLVM</li>
 
 </ul>
 
@@ -104,18 +106,36 @@ and assembly programs, respectively.</p>
 
 <ul>
 
-<li><a href="html/bugpoint.html"><b>bugpoint</b></a> -
+<li><a href="/cmds/bugpoint.html"><b>bugpoint</b></a> -
     automatic test-case reducer</li>
 
-<li><a href="html/extract.html"><b>extract</b></a> -
+<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/llvm-bcanalyzer.html"><b>llvm-bcanalyzer</b></a> -
+<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="internal">Internal Tools</a>
+</div>
+<!-- *********************************************************************** -->
 
+<div class="doc_text">
+<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>
 
 <!-- *********************************************************************** -->
@@ -123,11 +143,11 @@ and assembly programs, respectively.</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.cs.uiuc.edu">LLVM Compiler Infrastructure</a><br>
+  <a href="http://llvm.org">LLVM Compiler Infrastructure</a><br>
   Last modified: $Date$
 </address>