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

blob: ebf09b46e50864b408a3e5815b5caf55cd56cde9 [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-dis 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-dis</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-dis</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-dis [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-dis</tt> command is the LLVM disassembler. It takes an LLVM
				20	bytecode file and converts it into LLVM assembly language or C source code with
				21	equivalent functionality.
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, <tt>llvm-dis</tt> reads its input from standard input.
John Criswell	6775392	2003-09-26 02:59:00 +0000	[diff] [blame]	25	<p>
				26
Chris Lattner	26814d0	2003-10-07 20:17:24 +0000	[diff] [blame]	27	The default output file for <tt>llvm-dis</tt> is determined by the following logic:
John Criswell	6775392	2003-09-26 02:59:00 +0000	[diff] [blame]	28	<ul>
				29	<li>
Chris Lattner	26814d0	2003-10-07 20:17:24 +0000	[diff] [blame]	30	If the input is standard input or the file -, then the output is
				31	standard output.
John Criswell	6775392	2003-09-26 02:59:00 +0000	[diff] [blame]	32	<p>
				33
				34	<li>
				35	If the input filename ends in .bc, then the output filename will be
				36	identical, except that the .bc suffix will be replaced by the .ll or .c
				37	suffix (for LLVM assembly language and C code, respectively).
				38	<p>
				39
				40	<li>
Chris Lattner	26814d0	2003-10-07 20:17:24 +0000	[diff] [blame]	41	If the input filename does not end in .bc, then the output filename will
				42	be identical to the input filename, except that the .ll or .c suffix
				43	will be appended to the filename (for LLVM assembly language and C code,
John Criswell	6775392	2003-09-26 02:59:00 +0000	[diff] [blame]	44	respectively).
				45	</ul>
				46
Chris Lattner	26814d0	2003-10-07 20:17:24 +0000	[diff] [blame]	47	<h3>OPTIONS</h3>
John Criswell	ecf32e5	2003-09-11 19:58:03 +0000	[diff] [blame]	48
				49	<ul>
				50	<li> -llvm
				51	<br>
Chris Lattner	26814d0	2003-10-07 20:17:24 +0000	[diff] [blame]	52	Instruct <tt>llvm-dis</tt> to generate LLVM assembly code in human
				53	readable format. This is the default behavior.
John Criswell	ecf32e5	2003-09-11 19:58:03 +0000	[diff] [blame]	54	<p>
				55
John Criswell	ecf32e5	2003-09-11 19:58:03 +0000	[diff] [blame]	56	<li> -f
				57	<br>
Chris Lattner	26814d0	2003-10-07 20:17:24 +0000	[diff] [blame]	58	Force overwrite. Normally, <tt>llvm-dis</tt> will refuse to overwrite
				59	an output file that already exists. With this option, <tt>llvm-dis</tt>
				60	will overwrite the output file.
John Criswell	ecf32e5	2003-09-11 19:58:03 +0000	[diff] [blame]	61	<p>
				62
				63	<li> -help
				64	<br>
				65	Print a summary of command line options.
				66	<p>
				67
				68	<li> -o <filename>
				69	<br>
Chris Lattner	26814d0	2003-10-07 20:17:24 +0000	[diff] [blame]	70	Specify the output filename. If filename is -, then the output is sent
				71	to standard output.
John Criswell	ecf32e5	2003-09-11 19:58:03 +0000	[diff] [blame]	72	<p>
				73
John Criswell	6775392	2003-09-26 02:59:00 +0000	[diff] [blame]	74	<li> -time-passes
John Criswell	ecf32e5	2003-09-11 19:58:03 +0000	[diff] [blame]	75	<br>
John Criswell	6775392	2003-09-26 02:59:00 +0000	[diff] [blame]	76	Record the amount of time needed for each pass and print it to standard
John Criswell	ecf32e5	2003-09-11 19:58:03 +0000	[diff] [blame]	77	error.
				78	<p>
				79	</ul>
				80
Chris Lattner	26814d0	2003-10-07 20:17:24 +0000	[diff] [blame]	81	<h3>EXIT STATUS</h3>
John Criswell	ecf32e5	2003-09-11 19:58:03 +0000	[diff] [blame]	82
Chris Lattner	26814d0	2003-10-07 20:17:24 +0000	[diff] [blame]	83	If <tt>llvm-dis</tt> succeeds, it will exit with 0. Otherwise, if an error
				84	occurs, it will exit with a non-zero value.
John Criswell	ecf32e5	2003-09-11 19:58:03 +0000	[diff] [blame]	85
Chris Lattner	26814d0	2003-10-07 20:17:24 +0000	[diff] [blame]	86	<h3>SEE ALSO</h3>
				87
				88	<a href="llvm-as.html"><tt>llvm-as</tt></a>
John Criswell	ecf32e5	2003-09-11 19:58:03 +0000	[diff] [blame]	89
				90	<HR>
Chris Lattner	08a04fd	2003-10-07 20:12:05 +0000	[diff] [blame]	91	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]	92	</body>
				93	</html>
				94