Eli Bendersky | f78a978 | 2013-03-19 16:04:19 +0000 | [diff] [blame] | 1 | llvm-link - LLVM bitcode linker |
| 2 | =============================== |
Daniel Dunbar | 8f4a8a6 | 2012-05-08 16:50:35 +0000 | [diff] [blame] | 3 | |
James Henderson | a056684 | 2019-06-27 13:24:46 +0000 | [diff] [blame] | 4 | .. program:: llvm-link |
| 5 | |
Daniel Dunbar | 8f4a8a6 | 2012-05-08 16:50:35 +0000 | [diff] [blame] | 6 | SYNOPSIS |
| 7 | -------- |
| 8 | |
Dmitri Gribenko | 59aeece | 2012-11-29 19:14:35 +0000 | [diff] [blame] | 9 | :program:`llvm-link` [*options*] *filename ...* |
Daniel Dunbar | 8f4a8a6 | 2012-05-08 16:50:35 +0000 | [diff] [blame] | 10 | |
| 11 | DESCRIPTION |
| 12 | ----------- |
| 13 | |
Dmitri Gribenko | 59aeece | 2012-11-29 19:14:35 +0000 | [diff] [blame] | 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. |
Daniel Dunbar | 8f4a8a6 | 2012-05-08 16:50:35 +0000 | [diff] [blame] | 17 | |
Daniel Dunbar | 8f4a8a6 | 2012-05-08 16:50:35 +0000 | [diff] [blame] | 18 | OPTIONS |
| 19 | ------- |
| 20 | |
Dmitri Gribenko | 59aeece | 2012-11-29 19:14:35 +0000 | [diff] [blame] | 21 | .. option:: -f |
Daniel Dunbar | 8f4a8a6 | 2012-05-08 16:50:35 +0000 | [diff] [blame] | 22 | |
Dmitri Gribenko | 59aeece | 2012-11-29 19:14:35 +0000 | [diff] [blame] | 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. |
Daniel Dunbar | 8f4a8a6 | 2012-05-08 16:50:35 +0000 | [diff] [blame] | 27 | |
Dmitri Gribenko | 59aeece | 2012-11-29 19:14:35 +0000 | [diff] [blame] | 28 | .. option:: -o filename |
Daniel Dunbar | 8f4a8a6 | 2012-05-08 16:50:35 +0000 | [diff] [blame] | 29 | |
Dmitri Gribenko | 59aeece | 2012-11-29 19:14:35 +0000 | [diff] [blame] | 30 | Specify the output file name. If ``filename`` is "``-``", then |
| 31 | :program:`llvm-link` will write its output to standard output. |
Daniel Dunbar | 8f4a8a6 | 2012-05-08 16:50:35 +0000 | [diff] [blame] | 32 | |
Dmitri Gribenko | 59aeece | 2012-11-29 19:14:35 +0000 | [diff] [blame] | 33 | .. option:: -S |
Daniel Dunbar | 8f4a8a6 | 2012-05-08 16:50:35 +0000 | [diff] [blame] | 34 | |
| 35 | Write output in LLVM intermediate language (instead of bitcode). |
| 36 | |
Dmitri Gribenko | 59aeece | 2012-11-29 19:14:35 +0000 | [diff] [blame] | 37 | .. option:: -d |
Daniel Dunbar | 8f4a8a6 | 2012-05-08 16:50:35 +0000 | [diff] [blame] | 38 | |
Eli Bendersky | f78a978 | 2013-03-19 16:04:19 +0000 | [diff] [blame] | 39 | If specified, :program:`llvm-link` prints a human-readable version of the |
| 40 | output bitcode file to standard error. |
Daniel Dunbar | 8f4a8a6 | 2012-05-08 16:50:35 +0000 | [diff] [blame] | 41 | |
Dmitri Gribenko | 59aeece | 2012-11-29 19:14:35 +0000 | [diff] [blame] | 42 | .. option:: -help |
Daniel Dunbar | 8f4a8a6 | 2012-05-08 16:50:35 +0000 | [diff] [blame] | 43 | |
| 44 | Print a summary of command line options. |
| 45 | |
Dmitri Gribenko | 59aeece | 2012-11-29 19:14:35 +0000 | [diff] [blame] | 46 | .. option:: -v |
Daniel Dunbar | 8f4a8a6 | 2012-05-08 16:50:35 +0000 | [diff] [blame] | 47 | |
Dmitri Gribenko | 59aeece | 2012-11-29 19:14:35 +0000 | [diff] [blame] | 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 |
Daniel Dunbar | 8f4a8a6 | 2012-05-08 16:50:35 +0000 | [diff] [blame] | 50 | library found. |
| 51 | |
Daniel Dunbar | 8f4a8a6 | 2012-05-08 16:50:35 +0000 | [diff] [blame] | 52 | EXIT STATUS |
| 53 | ----------- |
| 54 | |
Dmitri Gribenko | 59aeece | 2012-11-29 19:14:35 +0000 | [diff] [blame] | 55 | If :program:`llvm-link` succeeds, it will exit with 0. Otherwise, if an error |
Daniel Dunbar | 8f4a8a6 | 2012-05-08 16:50:35 +0000 | [diff] [blame] | 56 | occurs, it will exit with a non-zero value. |