docs/CommandGuide/llvm-dis.html

   1 <html>
   2 <title>
   3 LLVM: llvm-dis tool
   4 </title>
   5
   6 <body bgcolor=white>
   7
   8 <center><h1>LLVM: <tt>llvm-dis</tt> tool</h1></center>
   9 <HR>
  10
  11 <h3>NAME</h3>
  12 <tt>llvm-dis</tt>
  13
  14 <h3>SYNOPSIS</h3>
  15 <tt>llvm-dis [options] [filename]</tt>
  16
  17 <h3>DESCRIPTION</h3>
  18
  19 The <tt>llvm-dis</tt> command is the LLVM disassembler.  It takes an LLVM
  20 bytecode file and converts it into LLVM assembly language or C source code with
  21 equivalent functionality.
  22 <p>
  23
  24 If filename is omitted, <tt>llvm-dis</tt> reads its input from standard input.
  25 <p>
  26
  27 The default output file for <tt>llvm-dis</tt> is determined by the following logic:
  28 <ul>
  29         <li>
  30         If the input is standard input or the file -, then the output is
  31         standard output.
  32         <p>
  33
  34         <li>
  35         If the input filename ends in .bc, then the output filename will be
  36         identical, except that the .bc suffix will be replaced by the .ll or .c
  37         suffix (for LLVM assembly language and C code, respectively).
  38         <p>
  39
  40         <li>
  41         If the input filename does not end in .bc, then the output filename will
  42         be identical to the input filename, except that the .ll or .c suffix
  43         will be appended to the filename (for LLVM assembly language and C code,
  44         respectively).
  45 </ul>
  46
  47 <h3>OPTIONS</h3>
  48
  49 <ul>
  50         <li> -llvm
  51         <br>
  52         Instruct <tt>llvm-dis</tt> to generate LLVM assembly code in human
  53         readable format.  This is the default behavior.
  54         <p>
  55
  56         <li> -c
  57         <br>
  58         Instruct <tt>llvm-dis</tt> to generate C source code.
  59         <p>
  60
  61         <li> -f
  62         <br>
  63         Force overwrite.  Normally, <tt>llvm-dis</tt> will refuse to overwrite
  64         an output file that already exists.  With this option, <tt>llvm-dis</tt>
  65         will overwrite the output file.
  66         <p>
  67
  68         <li> -help
  69         <br>
  70         Print a summary of command line options.
  71         <p>
  72
  73         <li> -o &lt;filename&gt;
  74         <br>
  75         Specify the output filename.  If filename is -, then the output is sent
  76         to standard output.
  77         <p>
  78
  79         <li> -time-passes
  80         <br>
  81         Record the amount of time needed for each pass and print it to standard
  82         error.
  83         <p>
  84 </ul>
  85
  86 <h3>EXIT STATUS</h3>
  87
  88 If <tt>llvm-dis</tt> succeeds, it will exit with 0.  Otherwise, if an error
  89 occurs, it will exit with a non-zero value.
  90
  91 <h3>SEE ALSO</h3>
  92
  93 <a href="llvm-as.html"><tt>llvm-as</tt></a>
  94
  95 <HR>
  96 Maintained by the <a href="http://llvm.cs.uiuc.edu">LLVM Team</a>.
  97 </body>
  98 </html>
  99