| Dan Gohman | f17a25c | 2007-07-18 16:29:46 +0000 | [diff] [blame^] | 1 | =pod |
| 2 | |
| 3 | =head1 NAME |
| 4 | |
| 5 | llvm-link - LLVM linker |
| 6 | |
| 7 | =head1 SYNOPSIS |
| 8 | |
| 9 | B<llvm-link> [I<options>] I<filename ...> |
| 10 | |
| 11 | =head1 DESCRIPTION |
| 12 | |
| 13 | B<llvm-link> takes several LLVM bitcode files and links them together into a |
| 14 | single LLVM bitcode file. It writes the output file to standard output, unless |
| 15 | the B<-o> option is used to specify a filename. |
| 16 | |
| 17 | B<llvm-link> attempts to load the input files from the current directory. If |
| 18 | that fails, it looks for each file in each of the directories specified by the |
| 19 | B<-L> options on the command line. The library search paths are global; each |
| 20 | one is searched for every input file if necessary. The directories are searched |
| 21 | in the order they were specified on the command line. |
| 22 | |
| 23 | =head1 OPTIONS |
| 24 | |
| 25 | =over |
| 26 | |
| 27 | =item B<-L> F<directory> |
| 28 | |
| 29 | Add the specified F<directory> to the library search path. When looking for |
| 30 | libraries, B<llvm-link> will look in path name for libraries. This option can be |
| 31 | specified multiple times; B<llvm-link> will search inside these directories in |
| 32 | the order in which they were specified on the command line. |
| 33 | |
| 34 | =item B<-f> |
| 35 | |
| 36 | Overwrite output files. By default, B<llvm-link> will not overwrite an output |
| 37 | file if it already exists. |
| 38 | |
| 39 | =item B<-o> F<filename> |
| 40 | |
| 41 | Specify the output file name. If F<filename> is C<->, then B<llvm-link> will |
| 42 | write its output to standard output. |
| 43 | |
| 44 | =item B<-d> |
| 45 | |
| 46 | If specified, B<llvm-link> prints a human-readable version of the output |
| 47 | bitcode file to standard error. |
| 48 | |
| 49 | =item B<--help> |
| 50 | |
| 51 | Print a summary of command line options. |
| 52 | |
| 53 | =item B<-v> |
| 54 | |
| 55 | Verbose mode. Print information about what B<llvm-link> is doing. This |
| 56 | typically includes a message for each bitcode file linked in and for each |
| 57 | library found. |
| 58 | |
| 59 | =back |
| 60 | |
| 61 | =head1 EXIT STATUS |
| 62 | |
| 63 | If B<llvm-link> succeeds, it will exit with 0. Otherwise, if an error |
| 64 | occurs, it will exit with a non-zero value. |
| 65 | |
| 66 | =head1 SEE ALSO |
| 67 | |
| 68 | L<gccld|gccld> |
| 69 | |
| 70 | =head1 AUTHORS |
| 71 | |
| 72 | Maintained by the LLVM Team (L<http://llvm.org>). |
| 73 | |
| 74 | =cut |