usr.bin/clang/llvm-link/llvm-link.1

   1 .\" $FreeBSD$
   2 .TH "LLVM-LINK" "1" "2012-08-16" "3.2" "LLVM"
   3 .SH NAME
   4 llvm-link \- LLVM linker
   5 .
   6 .nr rst2man-indent-level 0
   7 .
   8 .de1 rstReportMargin
   9 \\$1 \\n[an-margin]
  10 level \\n[rst2man-indent-level]
  11 level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
  12 -
  13 \\n[rst2man-indent0]
  14 \\n[rst2man-indent1]
  15 \\n[rst2man-indent2]
  16 ..
  17 .de1 INDENT
  18 .\" .rstReportMargin pre:
  19 . RS \\$1
  20 . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
  21 . nr rst2man-indent-level +1
  22 .\" .rstReportMargin post:
  23 ..
  24 .de UNINDENT
  25 . RE
  26 .\" indent \\n[an-margin]
  27 .\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
  28 .nr rst2man-indent-level -1
  29 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
  30 .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
  31 ..
  32 .\" Man page generated from reStructuredText.
  33 .
  34 .SH SYNOPSIS
  35 .sp
  36 \fBllvm\-link\fP [\fIoptions\fP] \fIfilename ...\fP
  37 .SH DESCRIPTION
  38 .sp
  39 \fBllvm\-link\fP takes several LLVM bitcode files and links them together into a
  40 single LLVM bitcode file.  It writes the output file to standard output, unless
  41 the \fB\-o\fP option is used to specify a filename.
  42 .sp
  43 \fBllvm\-link\fP attempts to load the input files from the current directory.  If
  44 that fails, it looks for each file in each of the directories specified by the
  45 \fB\-L\fP options on the command line.  The library search paths are global; each
  46 one is searched for every input file if necessary.  The directories are searched
  47 in the order they were specified on the command line.
  48 .SH OPTIONS
  49 .sp
  50 \fB\-L\fP \fIdirectory\fP
  51 .INDENT 0.0
  52 .INDENT 3.5
  53 Add the specified \fIdirectory\fP to the library search path.  When looking for
  54 libraries, \fBllvm\-link\fP will look in path name for libraries.  This option can be
  55 specified multiple times; \fBllvm\-link\fP will search inside these directories in
  56 the order in which they were specified on the command line.
  57 .UNINDENT
  58 .UNINDENT
  59 .sp
  60 \fB\-f\fP
  61 .INDENT 0.0
  62 .INDENT 3.5
  63 Enable binary output on terminals.  Normally, \fBllvm\-link\fP will refuse to
  64 write raw bitcode output if the output stream is a terminal. With this option,
  65 \fBllvm\-link\fP will write raw bitcode regardless of the output device.
  66 .UNINDENT
  67 .UNINDENT
  68 .sp
  69 \fB\-o\fP \fIfilename\fP
  70 .INDENT 0.0
  71 .INDENT 3.5
  72 Specify the output file name.  If \fIfilename\fP is \fB\-\fP, then \fBllvm\-link\fP will
  73 write its output to standard output.
  74 .UNINDENT
  75 .UNINDENT
  76 .sp
  77 \fB\-S\fP
  78 .INDENT 0.0
  79 .INDENT 3.5
  80 Write output in LLVM intermediate language (instead of bitcode).
  81 .UNINDENT
  82 .UNINDENT
  83 .sp
  84 \fB\-d\fP
  85 .INDENT 0.0
  86 .INDENT 3.5
  87 If specified, \fBllvm\-link\fP prints a human\-readable version of the output
  88 bitcode file to standard error.
  89 .UNINDENT
  90 .UNINDENT
  91 .sp
  92 \fB\-help\fP
  93 .INDENT 0.0
  94 .INDENT 3.5
  95 Print a summary of command line options.
  96 .UNINDENT
  97 .UNINDENT
  98 .sp
  99 \fB\-v\fP
 100 .INDENT 0.0
 101 .INDENT 3.5
 102 Verbose mode.  Print information about what \fBllvm\-link\fP is doing.  This
 103 typically includes a message for each bitcode file linked in and for each
 104 library found.
 105 .UNINDENT
 106 .UNINDENT
 107 .SH EXIT STATUS
 108 .sp
 109 If \fBllvm\-link\fP succeeds, it will exit with 0.  Otherwise, if an error
 110 occurs, it will exit with a non\-zero value.
 111 .SH SEE ALSO
 112 .sp
 113 gccld|gccld
 114 .SH AUTHOR
 115 Maintained by The LLVM Team (http://llvm.org/).
 116 .SH COPYRIGHT
 117 2012, LLVM Project
 118 .\" Generated by docutils manpage writer.
 119 .