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