Documentation for llvm-link: reformat

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@168924 91177308-0d34-0410-b5e6-96231b3b80d8
This commit is contained in:
Dmitri Gribenko
2012-11-29 19:14:35 +00:00
parent 596e474101
commit f2c87b1c05

View File

@@ -1,96 +1,74 @@
llvm-link - LLVM linker llvm-link - LLVM linker
======================= =======================
SYNOPSIS SYNOPSIS
-------- --------
:program:`llvm-link` [*options*] *filename ...*
**llvm-link** [*options*] *filename ...*
DESCRIPTION DESCRIPTION
----------- -----------
:program:`llvm-link` takes several LLVM bitcode files and links them together
into a single LLVM bitcode file. It writes the output file to standard output,
unless the :option:`-o` option is used to specify a filename.
**llvm-link** takes several LLVM bitcode files and links them together into a :program:`llvm-link` attempts to load the input files from the current
single LLVM bitcode file. It writes the output file to standard output, unless directory. If that fails, it looks for each file in each of the directories
the **-o** option is used to specify a filename. specified by the :option:`-L` options on the command line. The library search
paths are global; each one is searched for every input file if necessary. The
**llvm-link** attempts to load the input files from the current directory. If directories are searched in the order they were specified on the command line.
that fails, it looks for each file in each of the directories specified by the
**-L** options on the command line. The library search paths are global; each
one is searched for every input file if necessary. The directories are searched
in the order they were specified on the command line.
OPTIONS OPTIONS
------- -------
.. option:: -L directory
Add the specified ``directory`` to the library search path. When looking for
libraries, :program:`llvm-link` will look in path name for libraries. This
option can be specified multiple times; :program:`llvm-link` will search
inside these directories in the order in which they were specified on the
command line.
**-L** *directory* .. option:: -f
Add the specified *directory* to the library search path. When looking for Enable binary output on terminals. Normally, :program:`llvm-link` will refuse
libraries, **llvm-link** will look in path name for libraries. This option can be to write raw bitcode output if the output stream is a terminal. With this
specified multiple times; **llvm-link** will search inside these directories in option, :program:`llvm-link` will write raw bitcode regardless of the output
the order in which they were specified on the command line. device.
.. option:: -o filename
Specify the output file name. If ``filename`` is "``-``", then
:program:`llvm-link` will write its output to standard output.
**-f** .. option:: -S
Enable binary output on terminals. Normally, **llvm-link** will refuse to
write raw bitcode output if the output stream is a terminal. With this option,
**llvm-link** will write raw bitcode regardless of the output device.
**-o** *filename*
Specify the output file name. If *filename* is ``-``, then **llvm-link** will
write its output to standard output.
**-S**
Write output in LLVM intermediate language (instead of bitcode). Write output in LLVM intermediate language (instead of bitcode).
.. option:: -d
If specified, :program:`llvm-link` prints a human-readable version of the output
**-d**
If specified, **llvm-link** prints a human-readable version of the output
bitcode file to standard error. bitcode file to standard error.
.. option:: -help
**-help**
Print a summary of command line options. Print a summary of command line options.
.. option:: -v
Verbose mode. Print information about what :program:`llvm-link` is doing.
**-v** This typically includes a message for each bitcode file linked in and for each
Verbose mode. Print information about what **llvm-link** is doing. This
typically includes a message for each bitcode file linked in and for each
library found. library found.
EXIT STATUS EXIT STATUS
----------- -----------
If :program:`llvm-link` succeeds, it will exit with 0. Otherwise, if an error
If **llvm-link** succeeds, it will exit with 0. Otherwise, if an error
occurs, it will exit with a non-zero value. occurs, it will exit with a non-zero value.
SEE ALSO SEE ALSO
-------- --------
gccld
gccld|gccld