blob: 3bcfa68c25990315060305cc02a2474d68a1bd07 [file] [log] [blame]
Eli Bendersky7f63f012013-03-19 16:04:19 +00001llvm-link - LLVM bitcode linker
2===============================
Daniel Dunbar3b709d52012-05-08 16:50:35 +00003
Daniel Dunbar3b709d52012-05-08 16:50:35 +00004SYNOPSIS
5--------
6
Dmitri Gribenkof2c87b12012-11-29 19:14:35 +00007:program:`llvm-link` [*options*] *filename ...*
Daniel Dunbar3b709d52012-05-08 16:50:35 +00008
9DESCRIPTION
10-----------
11
Dmitri Gribenkof2c87b12012-11-29 19:14:35 +000012:program:`llvm-link` takes several LLVM bitcode files and links them together
13into a single LLVM bitcode file. It writes the output file to standard output,
14unless the :option:`-o` option is used to specify a filename.
Daniel Dunbar3b709d52012-05-08 16:50:35 +000015
Daniel Dunbar3b709d52012-05-08 16:50:35 +000016OPTIONS
17-------
18
Dmitri Gribenkof2c87b12012-11-29 19:14:35 +000019.. option:: -f
Daniel Dunbar3b709d52012-05-08 16:50:35 +000020
Dmitri Gribenkof2c87b12012-11-29 19:14:35 +000021 Enable binary output on terminals. Normally, :program:`llvm-link` will refuse
22 to write raw bitcode output if the output stream is a terminal. With this
23 option, :program:`llvm-link` will write raw bitcode regardless of the output
24 device.
Daniel Dunbar3b709d52012-05-08 16:50:35 +000025
Dmitri Gribenkof2c87b12012-11-29 19:14:35 +000026.. option:: -o filename
Daniel Dunbar3b709d52012-05-08 16:50:35 +000027
Dmitri Gribenkof2c87b12012-11-29 19:14:35 +000028 Specify the output file name. If ``filename`` is "``-``", then
29 :program:`llvm-link` will write its output to standard output.
Daniel Dunbar3b709d52012-05-08 16:50:35 +000030
Dmitri Gribenkof2c87b12012-11-29 19:14:35 +000031.. option:: -S
Daniel Dunbar3b709d52012-05-08 16:50:35 +000032
33 Write output in LLVM intermediate language (instead of bitcode).
34
Dmitri Gribenkof2c87b12012-11-29 19:14:35 +000035.. option:: -d
Daniel Dunbar3b709d52012-05-08 16:50:35 +000036
Eli Bendersky7f63f012013-03-19 16:04:19 +000037 If specified, :program:`llvm-link` prints a human-readable version of the
38 output bitcode file to standard error.
Daniel Dunbar3b709d52012-05-08 16:50:35 +000039
Dmitri Gribenkof2c87b12012-11-29 19:14:35 +000040.. option:: -help
Daniel Dunbar3b709d52012-05-08 16:50:35 +000041
42 Print a summary of command line options.
43
Dmitri Gribenkof2c87b12012-11-29 19:14:35 +000044.. option:: -v
Daniel Dunbar3b709d52012-05-08 16:50:35 +000045
Dmitri Gribenkof2c87b12012-11-29 19:14:35 +000046 Verbose mode. Print information about what :program:`llvm-link` is doing.
47 This typically includes a message for each bitcode file linked in and for each
Daniel Dunbar3b709d52012-05-08 16:50:35 +000048 library found.
49
Daniel Dunbar3b709d52012-05-08 16:50:35 +000050EXIT STATUS
51-----------
52
Dmitri Gribenkof2c87b12012-11-29 19:14:35 +000053If :program:`llvm-link` succeeds, it will exit with 0. Otherwise, if an error
Daniel Dunbar3b709d52012-05-08 16:50:35 +000054occurs, it will exit with a non-zero value.
55
Daniel Dunbar3b709d52012-05-08 16:50:35 +000056