blob: a12bfd25e7ae164f0fd382b6929f2d59a0222b94 [file] [log] [blame]
John Criswellecf32e52003-09-11 19:58:03 +00001<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html>
Misha Brukmanc6ad94c2003-10-31 00:39:28 +00003<head>
4 <title>LLVM Command Guide</title>
5</head>
John Criswellecf32e52003-09-11 19:58:03 +00006
Misha Brukmanc6ad94c2003-10-31 00:39:28 +00007<body bgcolor=white>
John Criswellecf32e52003-09-11 19:58:03 +00008
Misha Brukmanc6ad94c2003-10-31 00:39:28 +00009<center><h1>LLVM Command Guide<br></h1></center>
John Criswellecf32e52003-09-11 19:58:03 +000010
Misha Brukmanc6ad94c2003-10-31 00:39:28 +000011This document is the reference manual for the LLVM utilities. It will
12show you how to use the LLVM commands and what all of their options
13are.
Chris Lattnerd053efd2003-10-07 20:05:23 +000014
15<table width=100% border=0>
Chris Lattner651fbec2003-10-07 20:35:55 +000016<tr><td valign=top width=50%>
Chris Lattnerd053efd2003-10-07 20:05:23 +000017
Misha Brukmanc6ad94c2003-10-31 00:39:28 +000018<!--===============================================================-->
19<center><h2><a name="llvmcmds">Basic Commands</a><hr></h2></center>
20<!--===============================================================-->
John Criswellecf32e52003-09-11 19:58:03 +000021
Misha Brukmanc6ad94c2003-10-31 00:39:28 +000022<dl compact>
23 <dt><A href="llvm-as.html"><b>llvm-as</b></A>
24 <dd>
25 Assemble a human-readable LLVM program into LLVM bytecode.
26 <p>
John Criswellecf32e52003-09-11 19:58:03 +000027
Misha Brukmanc6ad94c2003-10-31 00:39:28 +000028 <dt><A href="llvm-dis.html"><b>llvm-dis</b></A>
29 <dd>
30 Disassemble an LLVM bytecode file into human-readable form.
31 <p>
John Criswellecf32e52003-09-11 19:58:03 +000032
Misha Brukmanc6ad94c2003-10-31 00:39:28 +000033 <dt><A href="analyze.html"><b>analyze</b></A>
34 <dd>
35 Analyze an LLVM bytecode file.
36 <p>
John Criswellecf32e52003-09-11 19:58:03 +000037
Misha Brukmanc6ad94c2003-10-31 00:39:28 +000038 <dt><A href="opt.html"><b>opt</b></A>
39 <dd>
40 Optimize an LLVM bytecode file.
41 <p>
John Criswellecf32e52003-09-11 19:58:03 +000042
Misha Brukmanc6ad94c2003-10-31 00:39:28 +000043 <dt><A href="llc.html"><b>llc</b></A>
44 <dd>
45 Compile an LLVM bytecode program into native machine code.
John Criswellecf32e52003-09-11 19:58:03 +000046
Misha Brukmanc6ad94c2003-10-31 00:39:28 +000047 <dt><A href="lli.html"><b>lli</b></A>
48 <dd>
49 Run an LLVM bytecode program using either an interpreter or a
50 JIT compiler.
51 <p>
Chris Lattnere66e73a2003-11-02 02:10:54 +000052
53 <dt><A href="llvm-link.html"><b>llvm-link</b></A>
54 <dd>
55 Link several LLVM bytecode files together into one LLVM
56 bytecode file.
57 <p>
58
59 <dt><A href="llvm-nm.html"><b>llvm-nm</b></A>
60 <dd>
61 Print out the names and types of symbols in an LLVM bytecode file.
62 <p>
63
64 <dt><A href="llvm-prof.html"><b>llvm-prof</b></A>
65 <dd>
66 Transform raw '<tt>llvmprof.out</tt>' data into a human readable report.
67 <p>
Misha Brukmanc6ad94c2003-10-31 00:39:28 +000068</dl>
John Criswellecf32e52003-09-11 19:58:03 +000069
Chris Lattner651fbec2003-10-07 20:35:55 +000070</td><td valign=top width=50%>
John Criswell32003302003-09-11 20:23:52 +000071
Misha Brukmanc6ad94c2003-10-31 00:39:28 +000072<!--===============================================================-->
73<center><h2><a name="llvmcmds">C and C++ Front-end Commands</a><hr></h2></center>
74<!--===============================================================-->
John Criswell32003302003-09-11 20:23:52 +000075
Misha Brukmanc6ad94c2003-10-31 00:39:28 +000076<dl compact>
77 <dt><A href="llvmgcc.html"><b>llvmgcc</b></A>
78 <dd>
79 GCC-based C front end for LLVM.
80 <p>
John Criswellaa5ff242003-10-03 13:48:27 +000081
Misha Brukmanc6ad94c2003-10-31 00:39:28 +000082 <dt><A href="llvmgxx.html"><b>llvmg++</b></A>
83 <dd>
84 GCC-based C++ front end for LLVM.
85 <p>
John Criswellaa5ff242003-10-03 13:48:27 +000086
Misha Brukmanc6ad94c2003-10-31 00:39:28 +000087 <dt><A href="gccas.html"><b>gccas</b></A>
88 <dd>
89 LLVM assembler used by GCC and other native compiler tools.
90 <p>
John Criswell32003302003-09-11 20:23:52 +000091
Misha Brukmanc6ad94c2003-10-31 00:39:28 +000092 <dt><A href="gccld.html"><b>gccld</b></A>
93 <dd>
94 LLVM linker used by GCC and other native compiler tools.
95</dl>
John Criswell32003302003-09-11 20:23:52 +000096
Misha Brukmanc6ad94c2003-10-31 00:39:28 +000097<!--===============================================================-->
98<center><h2><a name="llvmcmds">Debugging Tools</a><hr></h2></center>
99<!--===============================================================-->
Chris Lattnerd053efd2003-10-07 20:05:23 +0000100
Misha Brukmanc6ad94c2003-10-31 00:39:28 +0000101<dl compact>
102 <dt><A href="bugpoint.html"><b>bugpoint</b></A>
103 <dd>
104 Trace an LLVM bytecode program and reduce its failure to a
105 simple testcase.
106 <p>
Chris Lattnerd053efd2003-10-07 20:05:23 +0000107
Misha Brukmanc6ad94c2003-10-31 00:39:28 +0000108 <dt><A href="extract.html"><b>extract</b></A>
109 <dd>
110 Extract a function from an LLVM bytecode file.
111</dl>
Chris Lattnerd053efd2003-10-07 20:05:23 +0000112</td></tr></table>
113
114
115<hr><font size=-1>
116Maintained by the
117<a href="http://llvm.cs.uiuc.edu">LLVM Team</a>.<br>
Misha Brukmanc6ad94c2003-10-31 00:39:28 +0000118Last modified: $Date$
Chris Lattnerd053efd2003-10-07 20:05:23 +0000119</font>
120
Misha Brukmanc6ad94c2003-10-31 00:39:28 +0000121</body>
John Criswellecf32e52003-09-11 19:58:03 +0000122</html>