Blame - docs/CommandGuide/llvm-link.html - platform/external/llvm

blob: ff980c2241d6084a461a289b51445f2c5c83341f [file] [log] [blame]

John Criswell	58ebcd0	2003-09-17 14:11:24 +0000	[diff] [blame]	1	<html>
				2	<title>
Chris Lattner	ee43b69	2003-09-25 19:50:05 +0000	[diff] [blame]	3	LLVM: llvm-link tool
John Criswell	58ebcd0	2003-09-17 14:11:24 +0000	[diff] [blame]	4	</title>
				5
Chris Lattner	bf6f438	2003-10-07 20:09:21 +0000	[diff] [blame]	6	<body bgcolor=white>
John Criswell	58ebcd0	2003-09-17 14:11:24 +0000	[diff] [blame]	7
Chris Lattner	bf6f438	2003-10-07 20:09:21 +0000	[diff] [blame]	8	<center><h1>LLVM: <tt>llvm-link</tt> tool</h1></center>
John Criswell	58ebcd0	2003-09-17 14:11:24 +0000	[diff] [blame]	9	<HR>
				10
Chris Lattner	bf6f438	2003-10-07 20:09:21 +0000	[diff] [blame]	11	<h3>NAME</h3>
				12	<tt>llvm-link</tt>
John Criswell	58ebcd0	2003-09-17 14:11:24 +0000	[diff] [blame]	13
Chris Lattner	bf6f438	2003-10-07 20:09:21 +0000	[diff] [blame]	14	<h3>SYNOPSIS</h3>
				15	<tt>llvm-link [options] <filename> [filename ...]</tt>
John Criswell	58ebcd0	2003-09-17 14:11:24 +0000	[diff] [blame]	16
Chris Lattner	bf6f438	2003-10-07 20:09:21 +0000	[diff] [blame]	17	<h3>DESCRIPTION</h3>
John Criswell	58ebcd0	2003-09-17 14:11:24 +0000	[diff] [blame]	18
Chris Lattner	bf6f438	2003-10-07 20:09:21 +0000	[diff] [blame]	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.
John Criswell	6243534	2003-09-26 16:32:00 +0000	[diff] [blame]	22	<p>
				23
Chris Lattner	bf6f438	2003-10-07 20:09:21 +0000	[diff] [blame]	24	The <tt>llvm-link</tt> command attempts to load the input files from the current
Brian Gaeke	e08ad2e	2003-10-19 18:09:24 +0000	[diff] [blame^]	25	directory. If that fails, it looks for each file in each of the
Chris Lattner	bf6f438	2003-10-07 20:09:21 +0000	[diff] [blame]	26	directories specified by the -L options on the command line. The library search
Brian Gaeke	e08ad2e	2003-10-19 18:09:24 +0000	[diff] [blame^]	27	paths are global; each one is searched for every input file if necessary. The
Chris Lattner	bf6f438	2003-10-07 20:09:21 +0000	[diff] [blame]	28	directories are searched in the order they were specified on the command line.
John Criswell	58ebcd0	2003-09-17 14:11:24 +0000	[diff] [blame]	29
				30	<h3>
				31	OPTIONS
				32	</h3>
				33
				34	<ul>
John Criswell	6243534	2003-09-26 16:32:00 +0000	[diff] [blame]	35	<li>-L <directory>
John Criswell	58ebcd0	2003-09-17 14:11:24 +0000	[diff] [blame]	36	<br>
Chris Lattner	8bf3385	2003-10-07 16:36:25 +0000	[diff] [blame]	37	Add the specified directory to the library search path. When looking
Chris Lattner	bf6f438	2003-10-07 20:09:21 +0000	[diff] [blame]	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.
John Criswell	58ebcd0	2003-09-17 14:11:24 +0000	[diff] [blame]	42	<p>
				43
				44	<li>-f
				45	<br>
Chris Lattner	bf6f438	2003-10-07 20:09:21 +0000	[diff] [blame]	46	Overwrite output files. By default, <tt>llvm-link</tt> will not
				47	overwrite an output file if it alreadys exists.
John Criswell	58ebcd0	2003-09-17 14:11:24 +0000	[diff] [blame]	48	<p>
				49
				50	<li>-o <filename>
				51	<br>
Chris Lattner	bf6f438	2003-10-07 20:09:21 +0000	[diff] [blame]	52	Output filename. If filename is -, then <tt>llvm-link</tt> will write
				53	its output to standard output.
John Criswell	58ebcd0	2003-09-17 14:11:24 +0000	[diff] [blame]	54	<p>
				55
John Criswell	6243534	2003-09-26 16:32:00 +0000	[diff] [blame]	56	<li>-d
				57	<br>
Brian Gaeke	e08ad2e	2003-10-19 18:09:24 +0000	[diff] [blame^]	58	If specified, <tt>llvm-link</tt> prints a human-readable version of the
Chris Lattner	bf6f438	2003-10-07 20:09:21 +0000	[diff] [blame]	59	output bytecode file to standard error.
John Criswell	6243534	2003-09-26 16:32:00 +0000	[diff] [blame]	60	<p>
				61
				62	<li>-help
John Criswell	58ebcd0	2003-09-17 14:11:24 +0000	[diff] [blame]	63	<br>
				64	Print a summary of command line options.
				65	<p>
				66
John Criswell	6243534	2003-09-26 16:32:00 +0000	[diff] [blame]	67	<li>-v
John Criswell	58ebcd0	2003-09-17 14:11:24 +0000	[diff] [blame]	68	<br>
Chris Lattner	bf6f438	2003-10-07 20:09:21 +0000	[diff] [blame]	69	Verbose mode. Print information about what <tt>llvm-link</tt> is doing.
Brian Gaeke	e08ad2e	2003-10-19 18:09:24 +0000	[diff] [blame^]	70	This typically includes a message for each bytecode file linked in
				71	and for each library found.
John Criswell	58ebcd0	2003-09-17 14:11:24 +0000	[diff] [blame]	72	</ul>
				73
				74	<h3>
				75	EXIT STATUS
				76	</h3>
				77
Chris Lattner	bf6f438	2003-10-07 20:09:21 +0000	[diff] [blame]	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.
John Criswell	58ebcd0	2003-09-17 14:11:24 +0000	[diff] [blame]	80
Chris Lattner	bf6f438	2003-10-07 20:09:21 +0000	[diff] [blame]	81	<h3>SEE ALSO</h3>
				82	<a href="gccld.html"><tt>gccld</tt></a>
John Criswell	58ebcd0	2003-09-17 14:11:24 +0000	[diff] [blame]	83
				84	<HR>
Chris Lattner	bf6f438	2003-10-07 20:09:21 +0000	[diff] [blame]	85	Maintained by the <a href="http://llvm.cs.uiuc.edu">LLVM Team</a>.
John Criswell	58ebcd0	2003-09-17 14:11:24 +0000	[diff] [blame]	86	</body>
				87	</html>
				88