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