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

blob: 5cb575cd1fcc623b5013a932344fb89afcbcb627 [file] [log] [blame]

John Criswell	ecf32e5	2003-09-11 19:58:03 +0000	[diff] [blame]	1	<html>
				2	<title>
Chris Lattner	ee43b69	2003-09-25 19:50:05 +0000	[diff] [blame]	3	LLVM: llvm-as tool
John Criswell	ecf32e5	2003-09-11 19:58:03 +0000	[diff] [blame]	4	</title>
				5
Chris Lattner	08a04fd	2003-10-07 20:12:05 +0000	[diff] [blame]	6	<body bgcolor=white>
John Criswell	ecf32e5	2003-09-11 19:58:03 +0000	[diff] [blame]	7
Chris Lattner	26814d0	2003-10-07 20:17:24 +0000	[diff] [blame]	8	<center><h1>LLVM: <tt>llvm-as</tt> tool</h1></center>
John Criswell	ecf32e5	2003-09-11 19:58:03 +0000	[diff] [blame]	9	<HR>
				10
Chris Lattner	26814d0	2003-10-07 20:17:24 +0000	[diff] [blame]	11	<h3>NAME</h3>
				12	<tt>llvm-as</tt>
John Criswell	ecf32e5	2003-09-11 19:58:03 +0000	[diff] [blame]	13
Chris Lattner	26814d0	2003-10-07 20:17:24 +0000	[diff] [blame]	14	<h3>SYNOPSIS</h3>
				15	<tt>llvm-as [options] [filename]</tt>
John Criswell	ecf32e5	2003-09-11 19:58:03 +0000	[diff] [blame]	16
Chris Lattner	26814d0	2003-10-07 20:17:24 +0000	[diff] [blame]	17	<h3>DESCRIPTION</h3>
John Criswell	ecf32e5	2003-09-11 19:58:03 +0000	[diff] [blame]	18
Chris Lattner	26814d0	2003-10-07 20:17:24 +0000	[diff] [blame]	19	The <tt>llvm-as</tt> command is the LLVM assembler. It reads a file containing
				20	human readable LLVM assembly language, translates it to LLVM bytecode, and
				21	writes the result into a file or to standard output.
John Criswell	6775392	2003-09-26 02:59:00 +0000	[diff] [blame]	22	<p>
John Criswell	ecf32e5	2003-09-11 19:58:03 +0000	[diff] [blame]	23
Chris Lattner	26814d0	2003-10-07 20:17:24 +0000	[diff] [blame]	24	If filename is omitted or is -, then <tt>llvm-as</tt> reads its input from
				25	standard input.
John Criswell	6775392	2003-09-26 02:59:00 +0000	[diff] [blame]	26	<p>
				27
Chris Lattner	26814d0	2003-10-07 20:17:24 +0000	[diff] [blame]	28	If an output file is not specified with the <tt>-o</tt> option, then
				29	<tt>llvm-as</tt> sends its output to a file or standard output by the following
				30	logic:
John Criswell	6775392	2003-09-26 02:59:00 +0000	[diff] [blame]	31
				32	<ul>
				33	<li>
				34	If the input is standard input, then the output is standard output.
				35	<p>
				36
				37	<li>
				38	If the input is a file that ends with .ll, then the output file is of
				39	the same name, except that the suffix is changed to .bc.
				40	<p>
				41
				42	<li>
				43	If the input is a file that does not end with the .ll suffix, then the
Chris Lattner	26814d0	2003-10-07 20:17:24 +0000	[diff] [blame]	44	output file has the same name as the input file, except that the .bc
				45	suffix is appended.
John Criswell	6775392	2003-09-26 02:59:00 +0000	[diff] [blame]	46	<p>
				47	</ul>
John Criswell	ecf32e5	2003-09-11 19:58:03 +0000	[diff] [blame]	48
Chris Lattner	26814d0	2003-10-07 20:17:24 +0000	[diff] [blame]	49	<h3>OPTIONS</h3>
John Criswell	ecf32e5	2003-09-11 19:58:03 +0000	[diff] [blame]	50
				51	<ul>
				52	<li> -f
				53	<br>
Chris Lattner	26814d0	2003-10-07 20:17:24 +0000	[diff] [blame]	54	Force overwrite. Normally, <tt>llvm-as</tt> will refuse to overwrite an
				55	output file that already exists. With this option, <tt>llvm-as</tt>
				56	will overwrite the output file and replace it with new bytecode.
John Criswell	ecf32e5	2003-09-11 19:58:03 +0000	[diff] [blame]	57	<p>
				58
				59	<li> -help
				60	<br>
				61	Print a summary of command line options.
				62	<p>
				63
				64	<li> -o <filename>
				65	<br>
Chris Lattner	26814d0	2003-10-07 20:17:24 +0000	[diff] [blame]	66	Specify the output filename. If filename is -, then <tt>llvm-as</tt>
				67	sends its output to standard output.
John Criswell	ecf32e5	2003-09-11 19:58:03 +0000	[diff] [blame]	68	<p>
				69
				70	<li> -stats
				71	<br>
				72	Print statistics.
				73	<p>
				74
				75	<li> -time-passes
				76	<br>
				77	Record the amount of time needed for each pass and print it to standard
				78	error.
				79	<p>
				80	</ul>
				81
Chris Lattner	26814d0	2003-10-07 20:17:24 +0000	[diff] [blame]	82	<h3>EXIT STATUS</h3>
John Criswell	ecf32e5	2003-09-11 19:58:03 +0000	[diff] [blame]	83
Chris Lattner	26814d0	2003-10-07 20:17:24 +0000	[diff] [blame]	84	If <tt>llvm-as</tt> succeeds, it will exit with 0. Otherwise, if an error
				85	occurs, it will exit with a non-zero value.
John Criswell	ecf32e5	2003-09-11 19:58:03 +0000	[diff] [blame]	86
Chris Lattner	26814d0	2003-10-07 20:17:24 +0000	[diff] [blame]	87	<h3>SEE ALSO</h3>
				88
				89	<a href="llvm-dis.html"><tt>llvm-dis</tt></a>
				90	<a href="gccas.html"><tt>gccas</tt></a>
				91
John Criswell	ecf32e5	2003-09-11 19:58:03 +0000	[diff] [blame]	92
				93	<HR>
Chris Lattner	08a04fd	2003-10-07 20:12:05 +0000	[diff] [blame]	94	Maintained by the <a href="http://llvm.cs.uiuc.edu">LLVM Team</a>.
John Criswell	ecf32e5	2003-09-11 19:58:03 +0000	[diff] [blame]	95	</body>
				96	</html>
				97