Update list of passes and buglist.
[oota-llvm.git] / docs / CommandGuide / llvm-link.html
1 <html>
2 <title>
3 LLVM: llvm-link tool
4 </title>
5
6 <body bgcolor=white>
7
8 <center><h1>LLVM: <tt>llvm-link</tt> tool</h1></center>
9 <HR>
10
11 <h3>NAME</h3>
12 <tt>llvm-link</tt>
13
14 <h3>SYNOPSIS</h3>
15 <tt>llvm-link [options] &lt;filename&gt; [filename ...]</tt>
16
17 <h3>DESCRIPTION</h3>
18
19 The <tt>llvm-link</tt> command takes several LLVM bytecode files and links them
20 together into a single LLVM bytecode file.  It writes the output file to
21 standard output, unless the -o option is used to specify a filename.
22 <p>
23
24 The <tt>llvm-link</tt> command attempts to load the input files from the current
25 directory.  If that fails, it looks for each file in each of the
26 directories specified by the -L options on the command line.  The library search
27 paths are global; each one is searched for every input file if necessary.  The
28 directories are searched in the order they were specified on the command line.
29
30 <h3>
31 OPTIONS
32 </h3>
33
34 <ul>
35         <li>-L &lt;directory&gt;
36         <br>
37         Add the specified directory to the library search path.  When looking
38         for libraries, <tt>llvm-link</tt> will look in pathname for libraries.
39         This option can be specified multiple times; <tt>llvm-link</tt> will
40         search inside these directories in the order in which they were
41         specified on the command line.
42         <p>
43
44         <li>-f
45         <br>
46         Overwrite output files.  By default, <tt>llvm-link</tt> will not
47         overwrite an output file if it alreadys exists.
48         <p>
49
50         <li>-o &lt;filename&gt;
51         <br>
52         Output filename.  If filename is -, then <tt>llvm-link</tt> will write
53         its output to standard output.
54         <p>
55
56         <li>-d
57         <br>
58         If specified, <tt>llvm-link</tt> prints a human-readable version of the
59         output bytecode file to standard error.
60         <p>
61
62         <li>-help
63         <br>
64         Print a summary of command line options.
65         <p>
66
67         <li>-v
68         <br>
69         Verbose mode.  Print information about what <tt>llvm-link</tt> is doing.
70     This typically includes a message for each bytecode file linked in
71     and for each library found.
72 </ul>
73
74 <h3>
75 EXIT STATUS
76 </h3>
77
78 If <tt>llvm-link</tt> succeeds, it will exit with 0.  Otherwise, if an error
79 occurs, it will exit with a non-zero value.
80
81 <h3>SEE ALSO</h3>
82 <a href="gccld.html"><tt>gccld</tt></a>
83
84 <HR>
85 Maintained by the <a href="http://llvm.cs.uiuc.edu">LLVM Team</a>.
86 </body>
87 </html>
88