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