Gitiles
Code Review Sign In
gerrit-public.fairphone.software / fp2-dev / platform / external / llvm / e2c3a49c8029ebd9ef530101cc24c66562e3dff5 / . / docs / CommandGuide / llvm-link.pod
blob: 8d06cc9d9d9fc29b117e3d54ea56a65122c96984 [file] [log] [blame]
Brian Gaeke407d7c82004-06-02 20:55:52 +0000[diff] [blame]1=pod
2
3=head1 NAME
4
5llvm-link - LLVM linker
6
7=head1 SYNOPSIS
8
Misha Brukmanc08937a2004-07-02 16:06:19 +0000[diff] [blame]9B<llvm-link> [I<options>] I<filename ...>
Brian Gaeke407d7c82004-06-02 20:55:52 +0000[diff] [blame]10
11=head1 DESCRIPTION
12
Gabor Greif3bd6e0d2007-07-09 11:24:05 +0000[diff] [blame]13B<llvm-link> takes several LLVM bitcode files and links them together into a
14single LLVM bitcode file. It writes the output file to standard output, unless
Misha Brukman98fcc882004-11-15 20:36:39 +0000[diff] [blame]15the B<-o> option is used to specify a filename.
Brian Gaeke407d7c82004-06-02 20:55:52 +0000[diff] [blame]16
Misha Brukman98fcc882004-11-15 20:36:39 +0000[diff] [blame]17B<llvm-link> attempts to load the input files from the current directory. If
18that fails, it looks for each file in each of the directories specified by the
19B<-L> options on the command line. The library search paths are global; each
20one is searched for every input file if necessary. The directories are searched
21in the order they were specified on the command line.
Brian Gaeke407d7c82004-06-02 20:55:52 +0000[diff] [blame]22
23=head1 OPTIONS
24
25=over
26
27=item B<-L> F<directory>
28
29Add the specified F<directory> to the library search path. When looking for
Reid Spencer35931ae2007-07-09 06:06:45 +0000[diff] [blame]30libraries, B<llvm-link> will look in path name for libraries. This option can be
Brian Gaeke407d7c82004-06-02 20:55:52 +0000[diff] [blame]31specified multiple times; B<llvm-link> will search inside these directories in
32the order in which they were specified on the command line.
33
34=item B<-f>
35
Dan Gohman0cabaa52009-08-25 15:54:01 +0000[diff] [blame]36Enable binary output on terminals. Normally, B<llvm-link> will refuse to
37write raw bitcode output if the output stream is a terminal. With this option,
38B<llvm-link> will write raw bitcode regardless of the output device.
Brian Gaeke407d7c82004-06-02 20:55:52 +0000[diff] [blame]39
40=item B<-o> F<filename>
41
42Specify the output file name. If F<filename> is C<->, then B<llvm-link> will
43write its output to standard output.
44
Dan Gohmana93f30e2009-09-15 15:35:07 +0000[diff] [blame]45=item B<-S>
46
47Write output in LLVM intermediate language (instead of bitcode).
48
Brian Gaeke407d7c82004-06-02 20:55:52 +0000[diff] [blame]49=item B<-d>
50
51If specified, B<llvm-link> prints a human-readable version of the output
Gabor Greif3bd6e0d2007-07-09 11:24:05 +0000[diff] [blame]52bitcode file to standard error.
Brian Gaeke407d7c82004-06-02 20:55:52 +0000[diff] [blame]53
Duncan Sands7e7ae5a2010-02-18 14:08:13 +0000[diff] [blame]54=item B<-help>
Brian Gaeke407d7c82004-06-02 20:55:52 +0000[diff] [blame]55
56Print a summary of command line options.
57
58=item B<-v>
59
60Verbose mode. Print information about what B<llvm-link> is doing. This
Gabor Greif3bd6e0d2007-07-09 11:24:05 +0000[diff] [blame]61typically includes a message for each bitcode file linked in and for each
Brian Gaeke407d7c82004-06-02 20:55:52 +0000[diff] [blame]62library found.
63
64=back
65
66=head1 EXIT STATUS
67
68If B<llvm-link> succeeds, it will exit with 0. Otherwise, if an error
69occurs, it will exit with a non-zero value.
70
71=head1 SEE ALSO
72
Misha Brukman55157ff2004-11-15 20:32:58 +0000[diff] [blame]73L<gccld|gccld>
Brian Gaeke407d7c82004-06-02 20:55:52 +0000[diff] [blame]74
75=head1 AUTHORS
76
Reid Spencercd143fc2006-03-14 05:42:07 +0000[diff] [blame]77Maintained by the LLVM Team (L<http://llvm.org>).
Brian Gaeke407d7c82004-06-02 20:55:52 +0000[diff] [blame]78
79=cut