blob: 295966c40e87fdf96fb506990431e07adb528377 [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.
Chris Lattner8522e382003-11-30 05:46:14 +000046 <p>
John Criswellecf32e52003-09-11 19:58:03 +000047
Misha Brukmanc6ad94c2003-10-31 00:39:28 +000048 <dt><A href="lli.html"><b>lli</b></A>
49 <dd>
50 Run an LLVM bytecode program using either an interpreter or a
51 JIT compiler.
52 <p>
Chris Lattnere66e73a2003-11-02 02:10:54 +000053
54 <dt><A href="llvm-link.html"><b>llvm-link</b></A>
55 <dd>
56 Link several LLVM bytecode files together into one LLVM
57 bytecode file.
58 <p>
59
60 <dt><A href="llvm-nm.html"><b>llvm-nm</b></A>
61 <dd>
62 Print out the names and types of symbols in an LLVM bytecode file.
63 <p>
64
65 <dt><A href="llvm-prof.html"><b>llvm-prof</b></A>
66 <dd>
67 Transform raw '<tt>llvmprof.out</tt>' data into a human readable report.
68 <p>
Misha Brukmanc6ad94c2003-10-31 00:39:28 +000069</dl>
John Criswellecf32e52003-09-11 19:58:03 +000070
Chris Lattner651fbec2003-10-07 20:35:55 +000071</td><td valign=top width=50%>
John Criswell32003302003-09-11 20:23:52 +000072
Misha Brukmanc6ad94c2003-10-31 00:39:28 +000073<!--===============================================================-->
74<center><h2><a name="llvmcmds">C and C++ Front-end Commands</a><hr></h2></center>
75<!--===============================================================-->
John Criswell32003302003-09-11 20:23:52 +000076
Misha Brukmanc6ad94c2003-10-31 00:39:28 +000077<dl compact>
78 <dt><A href="llvmgcc.html"><b>llvmgcc</b></A>
79 <dd>
80 GCC-based C front end for LLVM.
81 <p>
John Criswellaa5ff242003-10-03 13:48:27 +000082
Misha Brukmanc6ad94c2003-10-31 00:39:28 +000083 <dt><A href="llvmgxx.html"><b>llvmg++</b></A>
84 <dd>
85 GCC-based C++ front end for LLVM.
86 <p>
John Criswellaa5ff242003-10-03 13:48:27 +000087
Misha Brukmanc6ad94c2003-10-31 00:39:28 +000088 <dt><A href="gccas.html"><b>gccas</b></A>
89 <dd>
90 LLVM assembler used by GCC and other native compiler tools.
91 <p>
John Criswell32003302003-09-11 20:23:52 +000092
Misha Brukmanc6ad94c2003-10-31 00:39:28 +000093 <dt><A href="gccld.html"><b>gccld</b></A>
94 <dd>
95 LLVM linker used by GCC and other native compiler tools.
96</dl>
John Criswell32003302003-09-11 20:23:52 +000097
Misha Brukmanc6ad94c2003-10-31 00:39:28 +000098<!--===============================================================-->
99<center><h2><a name="llvmcmds">Debugging Tools</a><hr></h2></center>
100<!--===============================================================-->
Chris Lattnerd053efd2003-10-07 20:05:23 +0000101
Misha Brukmanc6ad94c2003-10-31 00:39:28 +0000102<dl compact>
103 <dt><A href="bugpoint.html"><b>bugpoint</b></A>
104 <dd>
105 Trace an LLVM bytecode program and reduce its failure to a
106 simple testcase.
107 <p>
Chris Lattnerd053efd2003-10-07 20:05:23 +0000108
Misha Brukmanc6ad94c2003-10-31 00:39:28 +0000109 <dt><A href="extract.html"><b>extract</b></A>
110 <dd>
111 Extract a function from an LLVM bytecode file.
112</dl>
Chris Lattnerd053efd2003-10-07 20:05:23 +0000113</td></tr></table>
114
115
116<hr><font size=-1>
117Maintained by the
118<a href="http://llvm.cs.uiuc.edu">LLVM Team</a>.<br>
Misha Brukmanc6ad94c2003-10-31 00:39:28 +0000119Last modified: $Date$
Chris Lattnerd053efd2003-10-07 20:05:23 +0000120</font>
121
Misha Brukmanc6ad94c2003-10-31 00:39:28 +0000122</body>
John Criswellecf32e52003-09-11 19:58:03 +0000123</html>