| Reid Spencer | 37d813d | 2004-11-12 00:18:35 +0000 | [diff] [blame] | 1 | =pod |
| 2 | |
| 3 | =head1 NAME |
| 4 | |
| 5 | llvm-ranlib - Generate index for LLVM archive |
| 6 | |
| 7 | =head1 SYNOPSIS |
| 8 | |
| 9 | B<llvm-ranlib> [--version] [--help] <archive-file> |
| 10 | |
| 11 | =head1 DESCRIPTION |
| 12 | |
| 13 | The B<llvm-ranlib> command is similar to the common Unix utility, C<ranlib>. It |
| 14 | adds or updates the symbol table in an LLVM archive file. Note that using the |
| 15 | B<llvm-ar> modifier F<s> is usually more efficient than running B<llvm-ranlib> |
| 16 | which is only provided only for completness and compatibility. Unlike other |
| 17 | implementations of C<ranlib>, B<llvm-ranlib> indexes LLVM bytecode files, not |
| 18 | native object modules. You can list the contents of the symbol table with the |
| 19 | C<llvm-nm -s> command. |
| 20 | |
| 21 | =head1 OPTIONS |
| 22 | |
| 23 | =over |
| 24 | |
| 25 | =item F<archive-file> |
| 26 | |
| 27 | Specifies the archive-file to which the symbol table is added or updated. |
| 28 | |
| 29 | =item F<--version> |
| 30 | |
| 31 | Print the version of B<llvm-ranlib> and exit without building a symbol table. |
| 32 | |
| 33 | =item F<--help> |
| 34 | |
| 35 | Print usage help for B<llvm-ranlib> and exit without building a symbol table. |
| 36 | |
| 37 | =back |
| 38 | |
| 39 | =head1 EXIT STATUS |
| 40 | |
| 41 | If B<llvm-ranlib> succeeds, it will exit with 0. If an error occurs, a non-zero |
| 42 | exit code will be returned. |
| 43 | |
| 44 | =head1 SEE ALSO |
| 45 | |
| Chris Lattner | 0a3aac2 | 2005-05-13 20:08:34 +0000 | [diff] [blame] | 46 | L<llvm-ar|llvm-ar>, ranlib(1) |
| Reid Spencer | 37d813d | 2004-11-12 00:18:35 +0000 | [diff] [blame] | 47 | |
| 48 | =head1 AUTHORS |
| 49 | |
| Reid Spencer | cd143fc | 2006-03-14 05:42:07 +0000 | [diff] [blame] | 50 | Maintained by the LLVM Team (L<http://llvm.org>). |
| Reid Spencer | 37d813d | 2004-11-12 00:18:35 +0000 | [diff] [blame] | 51 | |
| 52 | =cut |