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