docs/CommandGuide/llvm-link.pod

   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 Enable binary output on terminals.  Normally, B<llvm-link> will refuse to
  37 write raw bitcode output if the output stream is a terminal. With this option,
  38 B<llvm-link> will write raw bitcode regardless of the output device.
  39
  40 =item B<-o> F<filename>
  41
  42 Specify the output file name.  If F<filename> is C<->, then B<llvm-link> will
  43 write its output to standard output.
  44
  45 =item B<-S>
  46
  47 Write output in LLVM intermediate language (instead of bitcode).
  48
  49 =item B<-d>
  50
  51 If specified, B<llvm-link> prints a human-readable version of the output
  52 bitcode file to standard error.
  53
  54 =item B<-help>
  55
  56 Print a summary of command line options.
  57
  58 =item B<-v>
  59
  60 Verbose mode.  Print information about what B<llvm-link> is doing.  This
  61 typically includes a message for each bitcode file linked in and for each
  62 library found.
  63
  64 =back
  65
  66 =head1 EXIT STATUS
  67
  68 If B<llvm-link> succeeds, it will exit with 0.  Otherwise, if an error
  69 occurs, it will exit with a non-zero value.
  70
  71 =head1 SEE ALSO
  72
  73 L<gccld|gccld>
  74
  75 =head1 AUTHORS
  76
  77 Maintained by the LLVM Team (L<http://llvm.org/>).
  78
  79 =cut