This is more of an "llvm team" thing by now
[oota-llvm.git] / docs / CommandGuide / index.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
2                       "http://www.w3.org/TR/html4/strict.dtd">
3 <html>
4 <head>
5   <title>LLVM Command Guide</title>
6   <link rel="stylesheet" href="../llvm.css" type="text/css">
7 </head>
8 <body>
9
10 <div class="doc_title">
11   LLVM Command Guide
12 </div>
13
14 <div class="doc_text">
15
16 <p>This document is the reference manual for the LLVM utilities.  It will
17 show you how to use the LLVM commands and what their options are.  Note that in
18 the descriptions below, `bytecode' and `program' refer to LLVM bytecode files
19 and assembly programs, respectively.</p>
20
21 <ul>
22   <li><a href="#basic">Basic Commands</a></li>
23   <li><a href="#frontend">C and C++ Frond-end Commands</a></li>
24   <li><a href="#debug">Debugging commands</a></li>
25 </ul>
26
27 </div>
28
29 <!-- *********************************************************************** -->
30 <div class="doc_section">
31   <a name="basic">Basic Commands</a>
32 </div>
33 <!-- *********************************************************************** -->
34
35 <div class="doc_text">
36
37 <ul>
38
39 <li><a href="llvm-as.html"><b>llvm-as</b></a> - 
40     assemble a human-readable program into bytecode</li>
41
42 <li><a href="llvm-dis.html"><b>llvm-dis</b></a> -
43     disassemble a bytecode file into human-readable form</li>
44
45 <li><a href="analyze.html"><b>analyze</b></a> -
46     analyze a program compiled to bytecode</li>
47
48 <li><a href="opt.html"><b>opt</b></a> -
49     optimize a bytecode file</li>
50
51 <li><a href="llc.html"><b>llc</b></a> - 
52     compile a bytecode program into native machine code</li>
53
54 <li><a href="lli.html"><b>lli</b></a> - 
55     run a bytecode program using either an interpreter or a JIT compiler</li>
56
57 <li><a href="llvm-link.html"><b>llvm-link</b></A>
58     link several bytecode files into one</li>
59
60 <li><a href="llvm-nm.html"><b>llvm-nm</b></a>
61     print out the names and types of symbols in a bytecode file</li>
62
63 <li><a href="llvm-prof.html"><b>llvm-prof</b></a> -
64     transform raw `<tt>llvmprof.out</tt>' data into a human-readable report</li>
65
66 </ul>
67
68 </div>
69
70 <!-- *********************************************************************** -->
71 <div class="doc_section">
72   <a name="frontend">C and C++ Front-end Commands</a>
73 </div>
74 <!-- *********************************************************************** -->
75
76 <div class="doc_text">
77
78 <ul>
79
80 <li><a href="llvmgcc.html"><b>llvmgcc</b></a> -
81     GCC-based C front end for LLVM
82
83 <li><a href="llvmgxx.html"><b>llvmg++</b></a> -
84     GCC-based C++ front end for LLVM</li>
85
86 <li><a href="gccas.html"><b>gccas</b></a> -
87     optimizing assembler used by llvm-g++ and llvm-gcc</li>
88
89 <li><a href="gccld.html"><b>gccld</b></a> -
90     optimizing linker used by llvm-g++ and llvm-gcc</li>
91
92 </ul>
93
94 </div>
95
96 <!-- *********************************************************************** -->
97 <div class="doc_section">
98   <a name="debug">Debugging Tools</a>
99 </div>
100 <!-- *********************************************************************** -->
101
102
103 <div class="doc_text">
104
105 <ul>
106
107 <li><a href="bugpoint.html"><b>bugpoint</b></a> -
108     automatic test-case reducer</li>
109
110 <li><a href="extract.html"><b>extract</b></a> -
111     extract a function from an LLVM bytecode file</li>
112
113 <li><a href="llvm-abcd.html"><b>llvm-abcd</b></a> -
114     bytecode analyzer (analyzes the binary encoding itself, not the program it
115     represents)</li>
116
117 </ul>
118
119 </div>
120
121 <!-- *********************************************************************** -->
122
123 <hr>
124 <address>
125   <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
126   src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a>
127   <a href="http://validator.w3.org/check/referer"><img
128   src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!"></a>
129
130   <a href="http://llvm.cs.uiuc.edu">LLVM Compiler Infrastructure</a><br>
131   Last modified: $Date$
132 </address>
133
134 </body>
135 </html>