blob: a96d668f3fed29ecf06e929b18bb29d2be78e077 [file] [log] [blame]
Eli Benderskyf78a9782013-03-19 16:04:19 +00001llvm-link - LLVM bitcode linker
2===============================
Daniel Dunbar8f4a8a62012-05-08 16:50:35 +00003
James Hendersona0566842019-06-27 13:24:46 +00004.. program:: llvm-link
5
Daniel Dunbar8f4a8a62012-05-08 16:50:35 +00006SYNOPSIS
7--------
8
Dmitri Gribenko59aeece2012-11-29 19:14:35 +00009:program:`llvm-link` [*options*] *filename ...*
Daniel Dunbar8f4a8a62012-05-08 16:50:35 +000010
11DESCRIPTION
12-----------
13
Dmitri Gribenko59aeece2012-11-29 19:14:35 +000014:program:`llvm-link` takes several LLVM bitcode files and links them together
15into a single LLVM bitcode file. It writes the output file to standard output,
16unless the :option:`-o` option is used to specify a filename.
Daniel Dunbar8f4a8a62012-05-08 16:50:35 +000017
Daniel Dunbar8f4a8a62012-05-08 16:50:35 +000018OPTIONS
19-------
20
Dmitri Gribenko59aeece2012-11-29 19:14:35 +000021.. option:: -f
Daniel Dunbar8f4a8a62012-05-08 16:50:35 +000022
Dmitri Gribenko59aeece2012-11-29 19:14:35 +000023 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.
Daniel Dunbar8f4a8a62012-05-08 16:50:35 +000027
Dmitri Gribenko59aeece2012-11-29 19:14:35 +000028.. option:: -o filename
Daniel Dunbar8f4a8a62012-05-08 16:50:35 +000029
Dmitri Gribenko59aeece2012-11-29 19:14:35 +000030 Specify the output file name. If ``filename`` is "``-``", then
31 :program:`llvm-link` will write its output to standard output.
Daniel Dunbar8f4a8a62012-05-08 16:50:35 +000032
Dmitri Gribenko59aeece2012-11-29 19:14:35 +000033.. option:: -S
Daniel Dunbar8f4a8a62012-05-08 16:50:35 +000034
35 Write output in LLVM intermediate language (instead of bitcode).
36
Dmitri Gribenko59aeece2012-11-29 19:14:35 +000037.. option:: -d
Daniel Dunbar8f4a8a62012-05-08 16:50:35 +000038
Eli Benderskyf78a9782013-03-19 16:04:19 +000039 If specified, :program:`llvm-link` prints a human-readable version of the
40 output bitcode file to standard error.
Daniel Dunbar8f4a8a62012-05-08 16:50:35 +000041
Dmitri Gribenko59aeece2012-11-29 19:14:35 +000042.. option:: -help
Daniel Dunbar8f4a8a62012-05-08 16:50:35 +000043
44 Print a summary of command line options.
45
Dmitri Gribenko59aeece2012-11-29 19:14:35 +000046.. option:: -v
Daniel Dunbar8f4a8a62012-05-08 16:50:35 +000047
Dmitri Gribenko59aeece2012-11-29 19:14:35 +000048 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
Daniel Dunbar8f4a8a62012-05-08 16:50:35 +000050 library found.
51
Daniel Dunbar8f4a8a62012-05-08 16:50:35 +000052EXIT STATUS
53-----------
54
Dmitri Gribenko59aeece2012-11-29 19:14:35 +000055If :program:`llvm-link` succeeds, it will exit with 0. Otherwise, if an error
Daniel Dunbar8f4a8a62012-05-08 16:50:35 +000056occurs, it will exit with a non-zero value.