docs/CommandGuide/llvm-link.rst

   1 llvm-link - LLVM linker
   2 =======================
   3
   4 SYNOPSIS
   5 --------
   6
   7 :program:`llvm-link` [*options*] *filename ...*
   8
   9 DESCRIPTION
  10 -----------
  11
  12 :program:`llvm-link` takes several LLVM bitcode files and links them together
  13 into a single LLVM bitcode file.  It writes the output file to standard output,
  14 unless the :option:`-o` option is used to specify a filename.
  15
  16 :program:`llvm-link` attempts to load the input files from the current
  17 directory.  If that fails, it looks for each file in each of the directories
  18 specified by the :option:`-L` options on the command line.  The library search
  19 paths are global; each one is searched for every input file if necessary.  The
  20 directories are searched in the order they were specified on the command line.
  21
  22 OPTIONS
  23 -------
  24
  25 .. option:: -L directory
  26
  27  Add the specified ``directory`` to the library search path.  When looking for
  28  libraries, :program:`llvm-link` will look in path name for libraries.  This
  29  option can be specified multiple times; :program:`llvm-link` will search
  30  inside these directories in the order in which they were specified on the
  31  command line.
  32
  33 .. option:: -f
  34
  35  Enable binary output on terminals.  Normally, :program:`llvm-link` will refuse
  36  to write raw bitcode output if the output stream is a terminal. With this
  37  option, :program:`llvm-link` will write raw bitcode regardless of the output
  38  device.
  39
  40 .. option:: -o filename
  41
  42  Specify the output file name.  If ``filename`` is "``-``", then
  43  :program:`llvm-link` will write its output to standard output.
  44
  45 .. option:: -S
  46
  47  Write output in LLVM intermediate language (instead of bitcode).
  48
  49 .. option:: -d
  50
  51  If specified, :program:`llvm-link` prints a human-readable version of the output
  52  bitcode file to standard error.
  53
  54 .. option:: -help
  55
  56  Print a summary of command line options.
  57
  58 .. option:: -v
  59
  60  Verbose mode.  Print information about what :program:`llvm-link` is doing.
  61  This typically includes a message for each bitcode file linked in and for each
  62  library found.
  63
  64 EXIT STATUS
  65 -----------
  66
  67 If :program:`llvm-link` succeeds, it will exit with 0.  Otherwise, if an error
  68 occurs, it will exit with a non-zero value.
  69
  70 SEE ALSO
  71 --------
  72
  73 gccld
  74