[llvm-exegesis] [NFC] Fixing typo.
[llvm-complete.git] / docs / CommandGuide / llvm-dis.rst
blob85cdca85ecdfdc5adf842d6f4df70e9b7234108a
1 llvm-dis - LLVM disassembler
2 ============================
5 SYNOPSIS
6 --------
9 **llvm-dis** [*options*] [*filename*]
12 DESCRIPTION
13 -----------
16 The **llvm-dis** command is the LLVM disassembler.  It takes an LLVM
17 bitcode file and converts it into human-readable LLVM assembly language.
19 If filename is omitted or specified as ``-``, **llvm-dis** reads its
20 input from standard input.
22 If the input is being read from standard input, then **llvm-dis**
23 will send its output to standard output by default.  Otherwise, the
24 output will be written to a file named after the input file, with
25 a ``.ll`` suffix added (any existing ``.bc`` suffix will first be
26 removed).  You can override the choice of output file using the
27 **-o** option.
30 OPTIONS
31 -------
35 **-f**
37  Enable binary output on terminals.  Normally, **llvm-dis** will refuse to
38  write raw bitcode output if the output stream is a terminal. With this option,
39  **llvm-dis** will write raw bitcode regardless of the output device.
43 **-help**
45  Print a summary of command line options.
49 **-o** *filename*
51  Specify the output file name.  If *filename* is -, then the output is sent
52  to standard output.
57 EXIT STATUS
58 -----------
61 If **llvm-dis** succeeds, it will exit with 0.  Otherwise, if an error
62 occurs, it will exit with a non-zero value.
65 SEE ALSO
66 --------
69 llvm-as|llvm-as