llvm-6502/docs/CommandGuide/opt.html

<html>
<title>LLVM: opt tool</title>

<body bgcolor=white>

<center><h1>LLVM: <tt>opt</tt> tool</h1></center>
<HR>

<h3>NAME</h3>
<tt>opt</tt>

<h3>SYNOPSIS</h3>
<tt>opt [options] [filename]</tt>

<h3>DESCRIPTION</h3>

The <tt>opt</tt> command is the modular LLVM optimizer.  It takes LLVM bytecode
as input, runs the specified optimizations on it, and then outputs the optimized
LLVM bytecode.
<p>

The optimizations available via <tt>opt</tt> depend upon what libraries were
linked into it as well as any additional libraries that have been loaded with
the <tt>-load</tt> option.  Use the <tt>-help</tt> option to determine what
optimizations you can use.
<p>

If no filename is specified on the command line, <tt>opt</tt> reads its input
from standard input.
<p>

If an output filename is not specified with the <tt>-o</tt> option, <tt>opt</tt>
writes its output to the standard output.


<h3>OPTIONS</h3>

<ul>
	<li> -f
	<br>
	Force overwrite.  Normally, <tt>opt</tt> will refuse to overwrite an
	output file that already exists.  With this option, <tt>opt</tt> will
	overwrite the output file and replace it with new bytecode.
	<p>

	<li> -help
	<br>
	Print a summary of command line options.
	<p>

	<li> -o &lt;filename&gt;
	<br>
	Specify the output filename.
	<p>

	<li> -stats
	<br>
	Print statistics.
	<p>

	<li> -time-passes
	<br>
	Record the amount of time needed for each pass and print it to standard
	error.
	<p>

	<li> -debug
	<br>
	If this is a debug build, this option will enable debug printouts from
	passes which use the <tt>DEBUG</tt> macro.  See the <a
	href="../ProgrammersManual.html#DEBUG">Programmer's Manual</a> for more
	information.
	<p>
<!--
	<li> -internalize-public-api-file &lt;filename&gt;
	<br>
	Preserve the symbol names listed in the file filename.
	<p>

	<li> -internalize-public-api-list=&lt;list&gt;
	<br>
	Perserve the symbol names specified.
	<p>
-->

	<li> -q
	<br>
	Quiet mode.  Do not print messages on whether the program was modified.
	<p>

	<li> -load &lt;plugin&gt;
	<br>
	Load the dynamic object &lt;plugin&gt;.  This object should register new
	optimization passes.  Once loaded, the object will add new command line
	options to enable various optimizations.  To see the new complete list
	of optimizations, use the -help and -load options together:
	<p>
	<tt>opt -load  &lt;plugin&gt; -help</tt>
	<p>

	<li> -p
	<br>
	Print module after each transformation.
	<p>
</ul>

<h3>EXIT STATUS</h3>

If <tt>opt</tt> succeeds, it will exit with 0.  Otherwise, if an error occurs,
it will exit with a non-zero value.

<h3>SEE ALSO</h3>

<a href="analyze.html"><tt>analyze</tt></a>

<HR>
Maintained by the <a href="http://llvm.cs.uiuc.edu">LLVM Team</a>.
</body>
</html>
Adding a skeleton for the LLVM Command Guide. Hopefully the group as a whole will update this into a real guide. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@8483 91177308-0d34-0410-b5e6-96231b3b80d8 2003-09-11 19:58:03 +00:00			`<html>`
TTify, add links between pages git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@8939 91177308-0d34-0410-b5e6-96231b3b80d8 2003-10-07 20:17:24 +00:00			`<title>LLVM: opt tool</title>`
Adding a skeleton for the LLVM Command Guide. Hopefully the group as a whole will update this into a real guide. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@8483 91177308-0d34-0410-b5e6-96231b3b80d8 2003-09-11 19:58:03 +00:00
Consistently set the background color Change the footer to include "maintained by" git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@8938 91177308-0d34-0410-b5e6-96231b3b80d8 2003-10-07 20:12:05 +00:00			`<body bgcolor=white>`
Adding a skeleton for the LLVM Command Guide. Hopefully the group as a whole will update this into a real guide. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@8483 91177308-0d34-0410-b5e6-96231b3b80d8 2003-09-11 19:58:03 +00:00
TTify, add links between pages git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@8939 91177308-0d34-0410-b5e6-96231b3b80d8 2003-10-07 20:17:24 +00:00			`<center><h1>LLVM: <tt>opt</tt> tool</h1></center>`
Adding a skeleton for the LLVM Command Guide. Hopefully the group as a whole will update this into a real guide. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@8483 91177308-0d34-0410-b5e6-96231b3b80d8 2003-09-11 19:58:03 +00:00			`<HR>`

TTify, add links between pages git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@8939 91177308-0d34-0410-b5e6-96231b3b80d8 2003-10-07 20:17:24 +00:00			`<h3>NAME</h3>`
			`<tt>opt</tt>`
Adding a skeleton for the LLVM Command Guide. Hopefully the group as a whole will update this into a real guide. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@8483 91177308-0d34-0410-b5e6-96231b3b80d8 2003-09-11 19:58:03 +00:00
TTify, add links between pages git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@8939 91177308-0d34-0410-b5e6-96231b3b80d8 2003-10-07 20:17:24 +00:00			`<h3>SYNOPSIS</h3>`
			`<tt>opt [options] [filename]</tt>`
Adding a skeleton for the LLVM Command Guide. Hopefully the group as a whole will update this into a real guide. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@8483 91177308-0d34-0410-b5e6-96231b3b80d8 2003-09-11 19:58:03 +00:00
TTify, add links between pages git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@8939 91177308-0d34-0410-b5e6-96231b3b80d8 2003-10-07 20:17:24 +00:00			`<h3>DESCRIPTION</h3>`
Adding a skeleton for the LLVM Command Guide. Hopefully the group as a whole will update this into a real guide. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@8483 91177308-0d34-0410-b5e6-96231b3b80d8 2003-09-11 19:58:03 +00:00
TTify, add links between pages git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@8939 91177308-0d34-0410-b5e6-96231b3b80d8 2003-10-07 20:17:24 +00:00			`The <tt>opt</tt> command is the modular LLVM optimizer. It takes LLVM bytecode`
			`as input, runs the specified optimizations on it, and then outputs the optimized`
			`LLVM bytecode.`
Added information on how input and output files are selected. Added information on where files are located by llvm-link. Added missing options. Re-worded some stuff so that it (hopefully) sounds better. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@8723 91177308-0d34-0410-b5e6-96231b3b80d8 2003-09-26 16:32:00 +00:00			`<p>`
Adding a skeleton for the LLVM Command Guide. Hopefully the group as a whole will update this into a real guide. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@8483 91177308-0d34-0410-b5e6-96231b3b80d8 2003-09-11 19:58:03 +00:00
TTify, add links between pages git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@8939 91177308-0d34-0410-b5e6-96231b3b80d8 2003-10-07 20:17:24 +00:00			`The optimizations available via <tt>opt</tt> depend upon what libraries were`
			`linked into it as well as any additional libraries that have been loaded with`
			`the <tt>-load</tt> option. Use the <tt>-help</tt> option to determine what`
			`optimizations you can use.`
Added information on how input and output files are selected. Added information on where files are located by llvm-link. Added missing options. Re-worded some stuff so that it (hopefully) sounds better. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@8723 91177308-0d34-0410-b5e6-96231b3b80d8 2003-09-26 16:32:00 +00:00			`<p>`
Adding a skeleton for the LLVM Command Guide. Hopefully the group as a whole will update this into a real guide. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@8483 91177308-0d34-0410-b5e6-96231b3b80d8 2003-09-11 19:58:03 +00:00
TTify, add links between pages git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@8939 91177308-0d34-0410-b5e6-96231b3b80d8 2003-10-07 20:17:24 +00:00			`If no filename is specified on the command line, <tt>opt</tt> reads its input`
			`from standard input.`
Added information on how input and output files are selected. Added information on where files are located by llvm-link. Added missing options. Re-worded some stuff so that it (hopefully) sounds better. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@8723 91177308-0d34-0410-b5e6-96231b3b80d8 2003-09-26 16:32:00 +00:00			`<p>`

TTify, add links between pages git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@8939 91177308-0d34-0410-b5e6-96231b3b80d8 2003-10-07 20:17:24 +00:00			`If an output filename is not specified with the <tt>-o</tt> option, <tt>opt</tt>`
			`writes its output to the standard output.`


			`<h3>OPTIONS</h3>`
Adding a skeleton for the LLVM Command Guide. Hopefully the group as a whole will update this into a real guide. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@8483 91177308-0d34-0410-b5e6-96231b3b80d8 2003-09-11 19:58:03 +00:00
			`<ul>`
			`<li> -f`
			`<br>`
TTify, add links between pages git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@8939 91177308-0d34-0410-b5e6-96231b3b80d8 2003-10-07 20:17:24 +00:00			`Force overwrite. Normally, <tt>opt</tt> will refuse to overwrite an`
			`output file that already exists. With this option, <tt>opt</tt> will`
			`overwrite the output file and replace it with new bytecode.`
Adding a skeleton for the LLVM Command Guide. Hopefully the group as a whole will update this into a real guide. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@8483 91177308-0d34-0410-b5e6-96231b3b80d8 2003-09-11 19:58:03 +00:00			`<p>`

			`<li> -help`
			`<br>`
			`Print a summary of command line options.`
			`<p>`

			`<li> -o <filename>`
			`<br>`
			`Specify the output filename.`
			`<p>`

			`<li> -stats`
			`<br>`
			`Print statistics.`
			`<p>`

			`<li> -time-passes`
			`<br>`
			`Record the amount of time needed for each pass and print it to standard`
			`error.`
			`<p>`

remove options specific to the -internalize pass, add the -debug option git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@8924 91177308-0d34-0410-b5e6-96231b3b80d8 2003-10-07 16:33:42 +00:00			`<li> -debug`
			`<br>`
			`If this is a debug build, this option will enable debug printouts from`
			`passes which use the <tt>DEBUG</tt> macro. See the <a`
			`href="../ProgrammersManual.html#DEBUG">Programmer's Manual</a> for more`
			`information.`
			`<p>`
			`<!--`
Adding a skeleton for the LLVM Command Guide. Hopefully the group as a whole will update this into a real guide. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@8483 91177308-0d34-0410-b5e6-96231b3b80d8 2003-09-11 19:58:03 +00:00			`<li> -internalize-public-api-file <filename>`
			`<br>`
			`Preserve the symbol names listed in the file filename.`
			`<p>`

			`<li> -internalize-public-api-list=<list>`
			`<br>`
			`Perserve the symbol names specified.`
			`<p>`
remove options specific to the -internalize pass, add the -debug option git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@8924 91177308-0d34-0410-b5e6-96231b3b80d8 2003-10-07 16:33:42 +00:00			`-->`
Adding a skeleton for the LLVM Command Guide. Hopefully the group as a whole will update this into a real guide. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@8483 91177308-0d34-0410-b5e6-96231b3b80d8 2003-09-11 19:58:03 +00:00
			`<li> -q`
			`<br>`
			`Quiet mode. Do not print messages on whether the program was modified.`
			`<p>`

Clarified the extension to shared library objects. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@10978 91177308-0d34-0410-b5e6-96231b3b80d8 2004-01-26 21:26:54 +00:00			`<li> -load <plugin>`
Adding a skeleton for the LLVM Command Guide. Hopefully the group as a whole will update this into a real guide. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@8483 91177308-0d34-0410-b5e6-96231b3b80d8 2003-09-11 19:58:03 +00:00			`<br>`
Clarified the extension to shared library objects. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@10978 91177308-0d34-0410-b5e6-96231b3b80d8 2004-01-26 21:26:54 +00:00			`Load the dynamic object <plugin>. This object should register new`
Adding a skeleton for the LLVM Command Guide. Hopefully the group as a whole will update this into a real guide. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@8483 91177308-0d34-0410-b5e6-96231b3b80d8 2003-09-11 19:58:03 +00:00			`optimization passes. Once loaded, the object will add new command line`
			`options to enable various optimizations. To see the new complete list`
			`of optimizations, use the -help and -load options together:`
			`<p>`
Clarified the extension to shared library objects. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@10978 91177308-0d34-0410-b5e6-96231b3b80d8 2004-01-26 21:26:54 +00:00			`<tt>opt -load <plugin> -help</tt>`
Adding a skeleton for the LLVM Command Guide. Hopefully the group as a whole will update this into a real guide. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@8483 91177308-0d34-0410-b5e6-96231b3b80d8 2003-09-11 19:58:03 +00:00			`<p>`

			`<li> -p`
			`<br>`
			`Print module after each transformation.`
			`<p>`
			`</ul>`

TTify, add links between pages git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@8939 91177308-0d34-0410-b5e6-96231b3b80d8 2003-10-07 20:17:24 +00:00			`<h3>EXIT STATUS</h3>`

			`If <tt>opt</tt> succeeds, it will exit with 0. Otherwise, if an error occurs,`
			`it will exit with a non-zero value.`
Adding a skeleton for the LLVM Command Guide. Hopefully the group as a whole will update this into a real guide. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@8483 91177308-0d34-0410-b5e6-96231b3b80d8 2003-09-11 19:58:03 +00:00
TTify, add links between pages git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@8939 91177308-0d34-0410-b5e6-96231b3b80d8 2003-10-07 20:17:24 +00:00			`<h3>SEE ALSO</h3>`
Adding a skeleton for the LLVM Command Guide. Hopefully the group as a whole will update this into a real guide. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@8483 91177308-0d34-0410-b5e6-96231b3b80d8 2003-09-11 19:58:03 +00:00
TTify, add links between pages git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@8939 91177308-0d34-0410-b5e6-96231b3b80d8 2003-10-07 20:17:24 +00:00			`<a href="analyze.html"><tt>analyze</tt></a>`
Adding a skeleton for the LLVM Command Guide. Hopefully the group as a whole will update this into a real guide. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@8483 91177308-0d34-0410-b5e6-96231b3b80d8 2003-09-11 19:58:03 +00:00
			`<HR>`
Consistently set the background color Change the footer to include "maintained by" git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@8938 91177308-0d34-0410-b5e6-96231b3b80d8 2003-10-07 20:12:05 +00:00			`Maintained by the <a href="http://llvm.cs.uiuc.edu">LLVM Team</a>.`
Adding a skeleton for the LLVM Command Guide. Hopefully the group as a whole will update this into a real guide. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@8483 91177308-0d34-0410-b5e6-96231b3b80d8 2003-09-11 19:58:03 +00:00			`</body>`
			`</html>`