Update list of passes and buglist.
[oota-llvm.git] / docs / CommandGuide / llvm-dis.html
index 079933c5bf162a6bb0015905fa6c234755d30236..7211206d300ff5aa744213c16a45a8fb46b020b5 100644 (file)
@@ -1,56 +1,68 @@
 <html>
 <title>
-llvm-dis
+LLVM: llvm-dis tool
 </title>
 
-<body>
+<body bgcolor=white>
 
-<center>
-<h1>Low Level Virtual Machine</h1>
-</center>
+<center><h1>LLVM: <tt>llvm-dis</tt> tool</h1></center>
 <HR>
 
-<h3>
-NAME
-</h3>
+<h3>NAME</h3>
+<tt>llvm-dis</tt>
 
-llvm-dis
+<h3>SYNOPSIS</h3>
+<tt>llvm-dis [options] [filename]</tt>
 
-<h3>
-SYNOPSIS
-</h3>
+<h3>DESCRIPTION</h3>
 
-llvm-dis [options] &lt; filename&gt;
-<h3>
-DESCRIPTION
-</h3>
+The <tt>llvm-dis</tt> command is the LLVM disassembler.  It takes an LLVM
+bytecode file and converts it into LLVM assembly language or C source code with
+equivalent functionality.
+<p>
 
-The llvm-dis command is the LLVM disassembler.  It takes an LLVM bytecode file
-and converts it into one of several human readable formats.
+If filename is omitted, <tt>llvm-dis</tt> reads its input from standard input.
+<p>
 
-By default, llvm-dis places its output in filename.ll, removing the .bc suffix
-if it exists.
-<h3>
-OPTIONS
-</h3>
+The default output file for <tt>llvm-dis</tt> is determined by the following logic:
+<ul>
+       <li>
+       If the input is standard input or the file -, then the output is
+       standard output.
+       <p>
+
+       <li>
+       If the input filename ends in .bc, then the output filename will be
+       identical, except that the .bc suffix will be replaced by the .ll or .c
+       suffix (for LLVM assembly language and C code, respectively).
+       <p>
+
+       <li>
+       If the input filename does not end in .bc, then the output filename will
+       be identical to the input filename, except that the .ll or .c suffix
+       will be appended to the filename (for LLVM assembly language and C code,
+       respectively).
+</ul>
+
+<h3>OPTIONS</h3>
 
 <ul>
        <li> -llvm
        <br>
-       Instruct llvm-dis to generate LLVM assembly code in human readable
-       format.  This is the default behavior.
+       Instruct <tt>llvm-dis</tt> to generate LLVM assembly code in human
+       readable format.  This is the default behavior.
        <p>
 
        <li> -c
        <br>
-       Instruct llvm-dis to generate C source code.
+       Instruct <tt>llvm-dis</tt> to generate C source code.
        <p>
 
        <li> -f
        <br>
-       Force overwrite.  Normally, llvm-dis will refuse to overwrite an output
-       file that already exists.  With this option, llvm-dis will overwrite the
-       output file.
+       Force overwrite.  Normally, <tt>llvm-dis</tt> will refuse to overwrite
+       an output file that already exists.  With this option, <tt>llvm-dis</tt>
+       will overwrite the output file.
        <p>
 
        <li> -help
@@ -60,30 +72,28 @@ OPTIONS
 
        <li> -o &lt;filename&gt;
        <br>
-       Specify the output filename.
+       Specify the output filename.  If filename is -, then the output is sent
+       to standard output.
        <p>
 
-       <li> -time-pdisses
+       <li> -time-passes
        <br>
-       Record the amount of time needed for each pdiss and print it to standard
+       Record the amount of time needed for each pass and print it to standard
        error.
        <p>
 </ul>
 
-<h3>
-EXIT STATUS
-</h3>
+<h3>EXIT STATUS</h3>
+
+If <tt>llvm-dis</tt> succeeds, it will exit with 0.  Otherwise, if an error
+occurs, it will exit with a non-zero value.
 
-If llvm-dis succeeds, it will exit with 0.  Otherwise, if an error occurs, it
-will exit with a non-zero value.
+<h3>SEE ALSO</h3>
 
-<h3>
-SEE ALSO
-</h3>
-llvm-dis
+<a href="llvm-as.html"><tt>llvm-as</tt></a>
 
 <HR>
-<a href="http://llvm.cs.uiuc.edu">LLVM Team</a>
+Maintained by the <a href="http://llvm.cs.uiuc.edu">LLVM Team</a>.
 </body>
 </html>