Gitiles
Code Review Sign In
gerrit-public.fairphone.software / toolchain / llvm-project / 3776794cc5f48d78b2ee0708b134e27c06bcc9a3 / . / llvm / docs / CommandGuide / index.html
blob: 30d0486f456ef0fa0348ad0eee7b32c22ddac668 [file] [log] [blame]
Misha Brukmanb4107632004-07-01 16:04:49 +0000[diff] [blame]1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
2 "http://www.w3.org/TR/html4/strict.dtd">
John Criswell408128d2003-09-11 19:58:03 +0000[diff] [blame]3<html>
Misha Brukman47e7fd22003-10-31 00:39:28 +0000[diff] [blame]4<head>
5 <title>LLVM Command Guide</title>
Misha Brukmanb4107632004-07-01 16:04:49 +0000[diff] [blame]6 <link rel="stylesheet" href="../llvm.css" type="text/css">
Misha Brukman47e7fd22003-10-31 00:39:28 +0000[diff] [blame]7</head>
Misha Brukmanb4107632004-07-01 16:04:49 +0000[diff] [blame]8<body>
John Criswell408128d2003-09-11 19:58:03 +0000[diff] [blame]9
Misha Brukmanb4107632004-07-01 16:04:49 +0000[diff] [blame]10<div class="doc_title">
11 LLVM Command Guide
12</div>
John Criswell408128d2003-09-11 19:58:03 +0000[diff] [blame]13
Misha Brukmanb4107632004-07-01 16:04:49 +0000[diff] [blame]14<div class="doc_text">
John Criswell408128d2003-09-11 19:58:03 +0000[diff] [blame]15
Chris Lattner517d6502004-07-10 06:06:56 +0000[diff] [blame]16<p>These documents are HTML versions of the <a href="man/man1/">man pages</a>
17for all of the LLVM tools. These pages describe how to use the LLVM commands
18and what their options are. Note that these pages do not describe all of the
19options available for all tools. To get a complete listing, pass the
20<tt>--help</tt> (general options) or <tt>--help-hidden</tt> (general+debugging
21options) arguments to the tool you are interested in.</p>
Chris Lattner46b359c2003-10-07 20:05:23 +0000[diff] [blame]22
Misha Brukmanb4107632004-07-01 16:04:49 +0000[diff] [blame]23</div>
John Criswell408128d2003-09-11 19:58:03 +0000[diff] [blame]24
Misha Brukmanb4107632004-07-01 16:04:49 +0000[diff] [blame]25<!-- *********************************************************************** -->
26<div class="doc_section">
27 <a name="basic">Basic Commands</a>
28</div>
29<!-- *********************************************************************** -->
John Criswell408128d2003-09-11 19:58:03 +0000[diff] [blame]30
Misha Brukmanb4107632004-07-01 16:04:49 +0000[diff] [blame]31<div class="doc_text">
John Criswell408128d2003-09-11 19:58:03 +0000[diff] [blame]32
Misha Brukmanb4107632004-07-01 16:04:49 +0000[diff] [blame]33<ul>
John Criswell408128d2003-09-11 19:58:03 +0000[diff] [blame]34
Misha Brukmancbbf9a12004-07-02 15:46:55 +0000[diff] [blame]35<li><a href="html/llvm-as.html"><b>llvm-as</b></a> -
Chris Lattner517d6502004-07-10 06:06:56 +0000[diff] [blame]36 assemble a human-readable .ll file into bytecode</li>
John Criswell408128d2003-09-11 19:58:03 +0000[diff] [blame]37
Misha Brukmancbbf9a12004-07-02 15:46:55 +0000[diff] [blame]38<li><a href="html/llvm-dis.html"><b>llvm-dis</b></a> -
Chris Lattner517d6502004-07-10 06:06:56 +0000[diff] [blame]39 disassemble a bytecode file into a human-readable .ll file</li>
Chris Lattnerd57aa5e82003-11-02 02:10:54 +0000[diff] [blame]40
Misha Brukmancbbf9a12004-07-02 15:46:55 +0000[diff] [blame]41<li><a href="html/opt.html"><b>opt</b></a> -
Chris Lattner517d6502004-07-10 06:06:56 +0000[diff] [blame]42 run a series of LLVM-to-LLVM optimizations on a bytecode file</li>
Chris Lattnerd57aa5e82003-11-02 02:10:54 +0000[diff] [blame]43
Misha Brukmancbbf9a12004-07-02 15:46:55 +0000[diff] [blame]44<li><a href="html/llc.html"><b>llc</b></a> -
Chris Lattner517d6502004-07-10 06:06:56 +0000[diff] [blame]45 generate native machine code for a bytecode file</li>
Chris Lattnerd57aa5e82003-11-02 02:10:54 +0000[diff] [blame]46
Misha Brukmancbbf9a12004-07-02 15:46:55 +0000[diff] [blame]47<li><a href="html/lli.html"><b>lli</b></a> -
Chris Lattner517d6502004-07-10 06:06:56 +0000[diff] [blame]48 directly run a program compiled to bytecode using a JIT compiler or
49 interpreter</li>
John Criswell408128d2003-09-11 19:58:03 +0000[diff] [blame]50
Misha Brukmana8e17182004-11-15 19:53:43 +0000[diff] [blame]51<li><a href="html/llvm-link.html"><b>llvm-link</b></a> -
Misha Brukmanb4107632004-07-01 16:04:49 +0000[diff] [blame]52 link several bytecode files into one</li>
John Criswella9060d82003-09-11 20:23:52 +0000[diff] [blame]53
Chris Lattner517d6502004-07-10 06:06:56 +0000[diff] [blame]54<li><a href="html/analyze.html"><b>analyze</b></a> -
55 run LLVM analyses on a bytecode file and print the results</li>
56
Reid Spencere4485002004-11-11 09:30:00 +0000[diff] [blame]57<li><a href="html/llvm-ar.html"><b>llvm-ar</b></a> -
58 archive bytecode files</li>
59
Misha Brukmana8e17182004-11-15 19:53:43 +0000[diff] [blame]60<li><a href="html/llvm-ranlib.html"><b>llvm-ranlib</b></a> -
61 create an index for archives made with llvm-ar</li>
62
63<li><a href="html/llvm-nm.html"><b>llvm-nm</b></a> -
Misha Brukmanb4107632004-07-01 16:04:49 +0000[diff] [blame]64 print out the names and types of symbols in a bytecode file</li>
John Criswella9060d82003-09-11 20:23:52 +0000[diff] [blame]65
Misha Brukmancbbf9a12004-07-02 15:46:55 +0000[diff] [blame]66<li><a href="html/llvm-prof.html"><b>llvm-prof</b></a> -
Chris Lattner517d6502004-07-10 06:06:56 +0000[diff] [blame]67 format raw `<tt>llvmprof.out</tt>' data into a human-readable report</li>
John Criswell1ce56bd2003-10-03 13:48:27 +0000[diff] [blame]68
Misha Brukmanb4107632004-07-01 16:04:49 +0000[diff] [blame]69</ul>
John Criswell1ce56bd2003-10-03 13:48:27 +0000[diff] [blame]70
Misha Brukmanb4107632004-07-01 16:04:49 +0000[diff] [blame]71</div>
John Criswella9060d82003-09-11 20:23:52 +0000[diff] [blame]72
Misha Brukmanb4107632004-07-01 16:04:49 +0000[diff] [blame]73<!-- *********************************************************************** -->
74<div class="doc_section">
Chris Lattnerf61dbba2004-07-10 21:43:12 +0000[diff] [blame]75 <a name="frontend">C, C++, and Stacker Front-end Commands</a>
Misha Brukmanb4107632004-07-01 16:04:49 +0000[diff] [blame]76</div>
77<!-- *********************************************************************** -->
John Criswella9060d82003-09-11 20:23:52 +0000[diff] [blame]78
Misha Brukmanb4107632004-07-01 16:04:49 +0000[diff] [blame]79<div class="doc_text">
Misha Brukmanb4107632004-07-01 16:04:49 +0000[diff] [blame]80<ul>
Chris Lattner46b359c2003-10-07 20:05:23 +0000[diff] [blame]81
Misha Brukmancbbf9a12004-07-02 15:46:55 +0000[diff] [blame]82<li><a href="html/llvmgcc.html"><b>llvmgcc</b></a> -
Chris Lattner517d6502004-07-10 06:06:56 +0000[diff] [blame]83 GCC-based C front-end for LLVM
Misha Brukmanb4107632004-07-01 16:04:49 +0000[diff] [blame]84
Misha Brukmancbbf9a12004-07-02 15:46:55 +0000[diff] [blame]85<li><a href="html/llvmgxx.html"><b>llvmg++</b></a> -
Chris Lattner517d6502004-07-10 06:06:56 +0000[diff] [blame]86 GCC-based C++ front-end for LLVM</li>
Misha Brukmanb4107632004-07-01 16:04:49 +0000[diff] [blame]87
Misha Brukmancbbf9a12004-07-02 15:46:55 +0000[diff] [blame]88<li><a href="html/gccas.html"><b>gccas</b></a> -
Chris Lattner517d6502004-07-10 06:06:56 +0000[diff] [blame]89 compile-time optimizer used by llvm-g++ and llvm-gcc</li>
Misha Brukmanb4107632004-07-01 16:04:49 +0000[diff] [blame]90
Misha Brukmancbbf9a12004-07-02 15:46:55 +0000[diff] [blame]91<li><a href="html/gccld.html"><b>gccld</b></a> -
Chris Lattner517d6502004-07-10 06:06:56 +0000[diff] [blame]92 linker and link-time optimizer used by llvm-g++ and llvm-gcc</li>
Misha Brukmanb4107632004-07-01 16:04:49 +0000[diff] [blame]93
Chris Lattnerf61dbba2004-07-10 21:43:12 +0000[diff] [blame]94<li><a href="html/stkrc.html"><b>stkrc</b></a> -
95 front-end compiler for the <a href="../Stacker.html">Stacker</a>
96 language</li>
97
Misha Brukmanb4107632004-07-01 16:04:49 +0000[diff] [blame]98</ul>
99
100</div>
101
102<!-- *********************************************************************** -->
103<div class="doc_section">
104 <a name="debug">Debugging Tools</a>
105</div>
106<!-- *********************************************************************** -->
Chris Lattner46b359c2003-10-07 20:05:23 +0000[diff] [blame]107
108
Misha Brukmanb4107632004-07-01 16:04:49 +0000[diff] [blame]109<div class="doc_text">
110
111<ul>
112
Misha Brukmancbbf9a12004-07-02 15:46:55 +0000[diff] [blame]113<li><a href="html/bugpoint.html"><b>bugpoint</b></a> -
Misha Brukmanb4107632004-07-01 16:04:49 +0000[diff] [blame]114 automatic test-case reducer</li>
115
Misha Brukmancbbf9a12004-07-02 15:46:55 +0000[diff] [blame]116<li><a href="html/extract.html"><b>extract</b></a> -
Misha Brukmanb4107632004-07-01 16:04:49 +0000[diff] [blame]117 extract a function from an LLVM bytecode file</li>
118
Misha Brukmancbbf9a12004-07-02 15:46:55 +0000[diff] [blame]119<li><a href="html/llvm-bcanalyzer.html"><b>llvm-bcanalyzer</b></a> -
Misha Brukman61a747f2004-07-01 16:59:05 +0000[diff] [blame]120 bytecode analyzer (analyzes the binary encoding itself, not the program it
121 represents)</li>
122
Misha Brukmanb4107632004-07-01 16:04:49 +0000[diff] [blame]123</ul>
124
125</div>
126
127<!-- *********************************************************************** -->
128
129<hr>
130<address>
131 <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
132 src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a>
133 <a href="http://validator.w3.org/check/referer"><img
134 src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!"></a>
135
Misha Brukmanb4107632004-07-01 16:04:49 +0000[diff] [blame]136 <a href="http://llvm.cs.uiuc.edu">LLVM Compiler Infrastructure</a><br>
137 Last modified: $Date$
138</address>
Chris Lattner46b359c2003-10-07 20:05:23 +0000[diff] [blame]139
Misha Brukman47e7fd22003-10-31 00:39:28 +0000[diff] [blame]140</body>
John Criswell408128d2003-09-11 19:58:03 +0000[diff] [blame]141</html>