Fix a ton of comment typos found by codespell. Patch by
[oota-llvm.git] / docs / CommandGuide / llvm-dis.pod
1 =pod
2
3 =head1 NAME
4
5 llvm-dis - LLVM disassembler
6
7 =head1 SYNOPSIS
8
9 B<llvm-dis> [I<options>] [I<filename>]
10
11 =head1 DESCRIPTION
12
13 The B<llvm-dis> command is the LLVM disassembler.  It takes an LLVM
14 bitcode file and converts it into human-readable LLVM assembly language.
15
16 If filename is omitted or specified as C<->, B<llvm-dis> reads its
17 input from standard input.
18
19 If the input is being read from standard input, then B<llvm-dis>
20 will send its output to standard output by default.  Otherwise, the
21 output will be written to a file named after the input file, with
22 a C<.ll> suffix added (any existing C<.bc> suffix will first be
23 removed).  You can override the choice of output file using the
24 B<-o> option.
25
26 =head1 OPTIONS
27
28 =over
29
30 =item B<-f>
31
32 Enable binary output on terminals.  Normally, B<llvm-dis> will refuse to
33 write raw bitcode output if the output stream is a terminal. With this option,
34 B<llvm-dis> will write raw bitcode regardless of the output device.
35
36 =item B<-help>
37
38 Print a summary of command line options.
39
40 =item B<-o> F<filename>
41
42 Specify the output file name.  If F<filename> is -, then the output is sent
43 to standard output.
44
45 =back
46
47 =head1 EXIT STATUS
48
49 If B<llvm-dis> succeeds, it will exit with 0.  Otherwise, if an error
50 occurs, it will exit with a non-zero value.
51
52 =head1 SEE ALSO
53
54 L<llvm-as|llvm-as>
55
56 =head1 AUTHORS
57
58 Maintained by the LLVM Team (L<http://llvm.org/>).
59
60 =cut