docs/CommandGuide/llvm-link.rst

   1 llvm-link - LLVM bitcode linker
   2 ===============================
   3
   4 .. program:: llvm-link
   5
   6 SYNOPSIS
   7 --------
   8
   9 :program:`llvm-link` [*options*] *filename ...*
  10
  11 DESCRIPTION
  12 -----------
  13
  14 :program:`llvm-link` takes several LLVM bitcode files and links them together
  15 into a single LLVM bitcode file.  It writes the output file to standard output,
  16 unless the :option:`-o` option is used to specify a filename.
  17
  18 OPTIONS
  19 -------
  20
  21 .. option:: -f
  22
  23  Enable binary output on terminals.  Normally, :program:`llvm-link` will refuse
  24  to write raw bitcode output if the output stream is a terminal. With this
  25  option, :program:`llvm-link` will write raw bitcode regardless of the output
  26  device.
  27
  28 .. option:: -o filename
  29
  30  Specify the output file name.  If ``filename`` is "``-``", then
  31  :program:`llvm-link` will write its output to standard output.
  32
  33 .. option:: -S
  34
  35  Write output in LLVM intermediate language (instead of bitcode).
  36
  37 .. option:: -d
  38
  39  If specified, :program:`llvm-link` prints a human-readable version of the
  40  output bitcode file to standard error.
  41
  42 .. option:: -help
  43
  44  Print a summary of command line options.
  45
  46 .. option:: -v
  47
  48  Verbose mode.  Print information about what :program:`llvm-link` is doing.
  49  This typically includes a message for each bitcode file linked in and for each
  50  library found.
  51
  52 EXIT STATUS
  53 -----------
  54
  55 If :program:`llvm-link` succeeds, it will exit with 0.  Otherwise, if an error
  56 occurs, it will exit with a non-zero value.