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

   1 .\" $FreeBSD$
   2 .\" Automatically generated by Pod::Man 2.23 (Pod::Simple 3.14)
   3 .\"
   4 .\" Standard preamble:
   5 .\" ========================================================================
   6 .de Sp \" Vertical space (when we can't use .PP)
   7 .if t .sp .5v
   8 .if n .sp
   9 ..
  10 .de Vb \" Begin verbatim text
  11 .ft CW
  12 .nf
  13 .ne \\$1
  14 ..
  15 .de Ve \" End verbatim text
  16 .ft R
  17 .fi
  18 ..
  19 .\" Set up some character translations and predefined strings.  \*(-- will
  20 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  21 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
  22 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
  23 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
  24 .\" nothing in troff, for use with C<>.
  25 .tr \(*W-
  26 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  27 .ie n \{\
  28 .    ds -- \(*W-
  29 .    ds PI pi
  30 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  31 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  32 .    ds L" ""
  33 .    ds R" ""
  34 .    ds C` ""
  35 .    ds C' ""
  36 'br\}
  37 .el\{\
  38 .    ds -- \|\(em\|
  39 .    ds PI \(*p
  40 .    ds L" ``
  41 .    ds R" ''
  42 'br\}
  43 .\"
  44 .\" Escape single quotes in literal strings from groff's Unicode transform.
  45 .ie \n(.g .ds Aq \(aq
  46 .el       .ds Aq '
  47 .\"
  48 .\" If the F register is turned on, we'll generate index entries on stderr for
  49 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
  50 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  51 .\" output yourself in some meaningful fashion.
  52 .ie \nF \{\
  53 .    de IX
  54 .    tm Index:\\$1\t\\n%\t"\\$2"
  55 ..
  56 .    nr % 0
  57 .    rr F
  58 .\}
  59 .el \{\
  60 .    de IX
  61 ..
  62 .\}
  63 .\"
  64 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  65 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  66 .    \" fudge factors for nroff and troff
  67 .if n \{\
  68 .    ds #H 0
  69 .    ds #V .8m
  70 .    ds #F .3m
  71 .    ds #[ \f1
  72 .    ds #] \fP
  73 .\}
  74 .if t \{\
  75 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  76 .    ds #V .6m
  77 .    ds #F 0
  78 .    ds #[ \&
  79 .    ds #] \&
  80 .\}
  81 .    \" simple accents for nroff and troff
  82 .if n \{\
  83 .    ds ' \&
  84 .    ds ` \&
  85 .    ds ^ \&
  86 .    ds , \&
  87 .    ds ~ ~
  88 .    ds /
  89 .\}
  90 .if t \{\
  91 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  92 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  93 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  94 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  95 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
  96 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
  97 .\}
  98 .    \" troff and (daisy-wheel) nroff accents
  99 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 100 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 101 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 102 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 103 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 104 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 105 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 106 .ds ae a\h'-(\w'a'u*4/10)'e
 107 .ds Ae A\h'-(\w'A'u*4/10)'E
 108 .    \" corrections for vroff
 109 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 110 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 111 .    \" for low resolution devices (crt and lpr)
 112 .if \n(.H>23 .if \n(.V>19 \
 113 \{\
 114 .    ds : e
 115 .    ds 8 ss
 116 .    ds o a
 117 .    ds d- d\h'-1'\(ga
 118 .    ds D- D\h'-1'\(hy
 119 .    ds th \o'bp'
 120 .    ds Th \o'LP'
 121 .    ds ae ae
 122 .    ds Ae AE
 123 .\}
 124 .rm #[ #] #H #V #F C
 125 .\" ========================================================================
 126 .\"
 127 .IX Title "LLVM-LINK 1"
 128 .TH LLVM-LINK 1 "2012-04-05" "LLVM 3.1" "LLVM Command Guide"
 129 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 130 .\" way too many mistakes in technical documents.
 131 .if n .ad l
 132 .nh
 133 .SH "NAME"
 134 llvm\-link \- LLVM linker
 135 .SH "SYNOPSIS"
 136 .IX Header "SYNOPSIS"
 137 \&\fBllvm-link\fR [\fIoptions\fR] \fIfilename ...\fR
 138 .SH "DESCRIPTION"
 139 .IX Header "DESCRIPTION"
 140 \&\fBllvm-link\fR takes several \s-1LLVM\s0 bitcode files and links them together into a
 141 single \s-1LLVM\s0 bitcode file.  It writes the output file to standard output, unless
 142 the \fB\-o\fR option is used to specify a filename.
 143 .PP
 144 \&\fBllvm-link\fR attempts to load the input files from the current directory.  If
 145 that fails, it looks for each file in each of the directories specified by the
 146 \&\fB\-L\fR options on the command line.  The library search paths are global; each
 147 one is searched for every input file if necessary.  The directories are searched
 148 in the order they were specified on the command line.
 149 .SH "OPTIONS"
 150 .IX Header "OPTIONS"
 151 .IP "\fB\-L\fR \fIdirectory\fR" 4
 152 .IX Item "-L directory"
 153 Add the specified \fIdirectory\fR to the library search path.  When looking for
 154 libraries, \fBllvm-link\fR will look in path name for libraries.  This option can be
 155 specified multiple times; \fBllvm-link\fR will search inside these directories in
 156 the order in which they were specified on the command line.
 157 .IP "\fB\-f\fR" 4
 158 .IX Item "-f"
 159 Enable binary output on terminals.  Normally, \fBllvm-link\fR will refuse to
 160 write raw bitcode output if the output stream is a terminal. With this option,
 161 \&\fBllvm-link\fR will write raw bitcode regardless of the output device.
 162 .IP "\fB\-o\fR \fIfilename\fR" 4
 163 .IX Item "-o filename"
 164 Specify the output file name.  If \fIfilename\fR is \f(CW\*(C`\-\*(C'\fR, then \fBllvm-link\fR will
 165 write its output to standard output.
 166 .IP "\fB\-S\fR" 4
 167 .IX Item "-S"
 168 Write output in \s-1LLVM\s0 intermediate language (instead of bitcode).
 169 .IP "\fB\-d\fR" 4
 170 .IX Item "-d"
 171 If specified, \fBllvm-link\fR prints a human-readable version of the output
 172 bitcode file to standard error.
 173 .IP "\fB\-help\fR" 4
 174 .IX Item "-help"
 175 Print a summary of command line options.
 176 .IP "\fB\-v\fR" 4
 177 .IX Item "-v"
 178 Verbose mode.  Print information about what \fBllvm-link\fR is doing.  This
 179 typically includes a message for each bitcode file linked in and for each
 180 library found.
 181 .SH "EXIT STATUS"
 182 .IX Header "EXIT STATUS"
 183 If \fBllvm-link\fR succeeds, it will exit with 0.  Otherwise, if an error
 184 occurs, it will exit with a non-zero value.
 185 .SH "SEE ALSO"
 186 .IX Header "SEE ALSO"
 187 gccld
 188 .SH "AUTHORS"
 189 .IX Header "AUTHORS"
 190 Maintained by the \s-1LLVM\s0 Team (<http://llvm.org/>).