| Reid Spencer | f02edd2 | 2006-12-02 16:36:48 +0000 | [diff] [blame] | 1 | =pod |
| 2 | |
| 3 | =head1 NAME |
| 4 | |
| 5 | llvm-upgrade - LLVM assembly upgrader |
| 6 | |
| 7 | =head1 SYNOPSIS |
| 8 | |
| 9 | B<llvm-upgrade> [I<options>] [I<filename>] |
| 10 | |
| 11 | =head1 DESCRIPTION |
| 12 | |
| 13 | B<llvm-upgrade> is the LLVM assembly upgrader. It reads a file containing |
| 14 | human-readable LLVM assembly language, and upgrades that assembly to the current |
| 15 | version of LLVM. If the input is in the form currently accepted by LLVM, then |
| 16 | no upgrades are performed. |
| 17 | |
| 18 | The expected usage of this tool is as a filter, like this: |
| 19 | |
| 20 | =over |
| 21 | |
| 22 | B<llvm-1.9/bin/llvm-dis < 1.9.bc | llvm-upgrade | llvm-2.0/bin/llvm-as -o 2.0.bc> |
| 23 | |
| 24 | =back |
| 25 | |
| 26 | If F<filename> is omitted or is C<->, then B<llvm-upgrade> reads its input from |
| 27 | standard input. |
| 28 | |
| 29 | If an output file is not specified with the B<-o> option, then |
| 30 | B<llvm-upgrade> sends its output to standard output. |
| 31 | |
| 32 | =head1 OPTIONS |
| 33 | |
| 34 | =over |
| 35 | |
| 36 | =item B<-f> |
| 37 | |
| 38 | Force overwrite. Normally, B<llvm-upgrade> will refuse to overwrite an |
| 39 | output file that already exists. With this option, B<llvm-upgrade> |
| 40 | will overwrite the output file. |
| 41 | |
| 42 | =item B<--help> |
| 43 | |
| 44 | Print a summary of command line options. |
| 45 | |
| 46 | =item B<-o> F<filename> |
| 47 | |
| 48 | Specify the output file name. If F<filename> is C<->, then B<llvm-upgrade> |
| 49 | sends its output to standard output. |
| 50 | |
| 51 | =back |
| 52 | |
| 53 | =head1 EXIT STATUS |
| 54 | |
| 55 | If B<llvm-upgrade> succeeds, it will exit with 0. Otherwise, if an error |
| 56 | occurs, it will exit with a non-zero value. |
| 57 | |
| 58 | =head1 SEE ALSO |
| 59 | |
| 60 | L<llvm-as|llvm-as>, L<llvm-dis|llvm-dis> |
| 61 | |
| 62 | =head1 AUTHORS |
| 63 | |
| 64 | Maintained by the LLVM Team (L<http://llvm.org>). |
| 65 | |
| 66 | =cut |