1=pod
2
3=head1 NAME
4
5llvm-as - LLVM assembler
6
7=head1 SYNOPSIS
8
9B<llvm-as> [I<options>] [I<filename>]
10
11=head1 DESCRIPTION
12
13B<llvm-as> is the LLVM assembler.  It reads a file containing human-readable
14LLVM assembly language, translates it to LLVM bitcode, and writes the result
15into a file or to standard output.
16
17If F<filename> is omitted or is C<->, then B<llvm-as> reads its input from
18standard input.
19
20If an output file is not specified with the B<-o> option, then
21B<llvm-as> sends its output to a file or standard output by following
22these rules:
23
24=over
25
26=item *
27
28If the input is standard input, then the output is standard output.
29
30=item *
31
32If the input is a file that ends with C<.ll>, then the output file is of
33the same name, except that the suffix is changed to C<.bc>.
34
35=item *
36
37If the input is a file that does not end with the C<.ll> suffix, then the
38output file has the same name as the input file, except that the C<.bc>
39suffix is appended.
40
41=back
42
43=head1 OPTIONS
44
45=over
46
47=item B<-f>
48
49Enable binary output on terminals.  Normally, B<llvm-as> will refuse to
50write raw bitcode output if the output stream is a terminal. With this option,
51B<llvm-as> will write raw bitcode regardless of the output device.
52
53=item B<-help>
54
55Print a summary of command line options.
56
57=item B<-o> F<filename>
58
59Specify the output file name.  If F<filename> is C<->, then B<llvm-as>
60sends its output to standard output.
61
62=back
63
64=head1 EXIT STATUS
65
66If B<llvm-as> succeeds, it will exit with 0.  Otherwise, if an error
67occurs, it will exit with a non-zero value.
68
69=head1 SEE ALSO
70
71L<llvm-dis|llvm-dis>, L<gccas|gccas>
72
73=head1 AUTHORS
74
75Maintained by the LLVM Team (L<http://llvm.org/>).
76
77=cut
78