Gitiles
Code Review Sign In
gerrit-public.fairphone.software / fp2-dev / platform / external / llvm / 9a4cb15ecabfd1d9b58ba9262fad749ac7ecff3d / . / docs / CommandGuide / index.html
blob: a411fea68bf4b28947552f04b7d267b14d31acc4 [file] [log] [blame]
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]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="/docs/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>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>
22
23</div>
24
25<!-- *********************************************************************** -->
26<div class="doc_section">
27 <a name="basic">Basic Commands</a>
28</div>
29<!-- *********************************************************************** -->
30
31<div class="doc_text">
32
33<ul>
34
Reid Spencer76f73d12007-08-05 23:43:44 +0000[diff] [blame]35<li><a href="/cmds/llvm-as.html"><b>llvm-as</b></a> -
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]36 assemble a human-readable .ll file into bytecode</li>
37
Reid Spencer76f73d12007-08-05 23:43:44 +0000[diff] [blame]38<li><a href="/cmds/llvm-dis.html"><b>llvm-dis</b></a> -
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]39 disassemble a bytecode file into a human-readable .ll file</li>
40
Reid Spencer76f73d12007-08-05 23:43:44 +0000[diff] [blame]41<li><a href="/cmds/opt.html"><b>opt</b></a> -
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]42 run a series of LLVM-to-LLVM optimizations on a bytecode file</li>
43
Reid Spencer76f73d12007-08-05 23:43:44 +0000[diff] [blame]44<li><a href="/cmds/llc.html"><b>llc</b></a> -
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]45 generate native machine code for a bytecode file</li>
46
Reid Spencer76f73d12007-08-05 23:43:44 +0000[diff] [blame]47<li><a href="/cmds/lli.html"><b>lli</b></a> -
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]48 directly run a program compiled to bytecode using a JIT compiler or
49 interpreter</li>
50
Reid Spencer76f73d12007-08-05 23:43:44 +0000[diff] [blame]51<li><a href="/cmds/llvm-link.html"><b>llvm-link</b></a> -
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]52 link several bytecode files into one</li>
53
Reid Spencer76f73d12007-08-05 23:43:44 +0000[diff] [blame]54<li><a href="/cmds/llvm-ar.html"><b>llvm-ar</b></a> -
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]55 archive bytecode files</li>
56
Reid Spencer76f73d12007-08-05 23:43:44 +0000[diff] [blame]57<li><a href="/cmds/llvm-ranlib.html"><b>llvm-ranlib</b></a> -
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]58 create an index for archives made with llvm-ar</li>
59
Reid Spencer76f73d12007-08-05 23:43:44 +0000[diff] [blame]60<li><a href="/cmds/llvm-nm.html"><b>llvm-nm</b></a> -
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]61 print out the names and types of symbols in a bytecode file</li>
62
Reid Spencer76f73d12007-08-05 23:43:44 +0000[diff] [blame]63<li><a href="/cmds/llvm-prof.html"><b>llvm-prof</b></a> -
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]64 format raw `<tt>llvmprof.out</tt>' data into a human-readable report</li>
65
Reid Spencer76f73d12007-08-05 23:43:44 +0000[diff] [blame]66<li><a href="/cmds/llvm-ld.html"><b>llvm-ld</b></a> -
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]67 general purpose linker with loadable runtime optimization support</li>
68
Reid Spencer76f73d12007-08-05 23:43:44 +0000[diff] [blame]69<li><a href="/cmds/llvm-config.html"><b>llvm-config</b></a> -
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]70 print out LLVM compilation options, libraries, etc. as configured.</li>
71
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]72</ul>
73
74</div>
75
76<!-- *********************************************************************** -->
77<div class="doc_section">
78 <a name="frontend">C, C++, and Stacker Front-end Commands</a>
79</div>
80<!-- *********************************************************************** -->
81
82<div class="doc_text">
83<ul>
84
Reid Spencer76f73d12007-08-05 23:43:44 +0000[diff] [blame]85<li><a href="/cmds/llvmgcc.html"><b>llvmgcc</b></a> -
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]86 GCC-based C front-end for LLVM
87
Reid Spencer76f73d12007-08-05 23:43:44 +0000[diff] [blame]88<li><a href="/cmds/llvmgxx.html"><b>llvmg++</b></a> -
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]89 GCC-based C++ front-end for LLVM</li>
90
Reid Spencer76f73d12007-08-05 23:43:44 +0000[diff] [blame]91<li><a href="/cmds/stkrc.html"><b>stkrc</b></a> -
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]92 front-end compiler for the <a href="../Stacker.html">Stacker</a>
93 language</li>
94
95</ul>
96
97</div>
98
99<!-- *********************************************************************** -->
100<div class="doc_section">
101 <a name="debug">Debugging Tools</a>
102</div>
103<!-- *********************************************************************** -->
104
105
106<div class="doc_text">
107
108<ul>
109
Reid Spencer76f73d12007-08-05 23:43:44 +0000[diff] [blame]110<li><a href="/cmds/bugpoint.html"><b>bugpoint</b></a> -
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]111 automatic test-case reducer</li>
112
Reid Spencer76f73d12007-08-05 23:43:44 +0000[diff] [blame]113<li><a href="/cmds/llvm-extract.html"><b>llvm-extract</b></a> -
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]114 extract a function from an LLVM bytecode file</li>
115
Reid Spencer76f73d12007-08-05 23:43:44 +0000[diff] [blame]116<li><a href="/cmds/llvm-bcanalyzer.html"><b>llvm-bcanalyzer</b></a> -
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]117 bytecode analyzer (analyzes the binary encoding itself, not the program it
118 represents)</li>
119
120</ul>
121</div>
122
123<!-- *********************************************************************** -->
124<div class="doc_section">
125 <a name="internal">Internal Tools</a>
126</div>
127<!-- *********************************************************************** -->
128
129<div class="doc_text">
130<ul>
131
Reid Spencer76f73d12007-08-05 23:43:44 +0000[diff] [blame]132<li><a href="/cmds/tblgen.html"><b>tblgen</b></a> -
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]133 target description reader and generator</li>
134
135</ul>
136</div>
137
138<!-- *********************************************************************** -->
139
140<hr>
141<address>
142 <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
143 src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a>
144 <a href="http://validator.w3.org/check/referer"><img
145 src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!"></a>
146
147 <a href="http://llvm.org">LLVM Compiler Infrastructure</a><br>
148 Last modified: $Date$
149</address>
150
151</body>
152</html>