Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / llvm / 901b5750b2af095bb0e359f4d2c3debef3ad57e6 / . / docs / CommandGuide / index.html
blob: 9516d075b3c277f45248886cc853c19d3c91c3c2 [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
Mikhail Glushenkovd3f4b242008-11-25 21:38:38 +0000[diff] [blame]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
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]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
Mikhail Glushenkovd3f4b242008-11-25 21:38:38 +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
Mikhail Glushenkovd3f4b242008-11-25 21:38:38 +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
Mikhail Glushenkovd3f4b242008-11-25 21:38:38 +0000[diff] [blame]47<li><a href="/cmds/lli.html"><b>lli</b></a> -
48 directly run a program compiled to bytecode using a JIT compiler or
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]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
Mikhail Glushenkovd3f4b242008-11-25 21:38:38 +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
Mikhail Glushenkovd3f4b242008-11-25 21:38:38 +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> -
Misha Brukmanb401d442008-12-11 17:12:52 +0000[diff] [blame]67 general purpose linker with loadable runtime optimization support</li>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]68
Mikhail Glushenkovd3f4b242008-11-25 21:38:38 +0000[diff] [blame]69<li><a href="/cmds/llvm-config.html"><b>llvm-config</b></a> -
Misha Brukmanb401d442008-12-11 17:12:52 +0000[diff] [blame]70 print out LLVM compilation options, libraries, etc. as configured</li>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]71
Misha Brukmanb401d442008-12-11 17:12:52 +0000[diff] [blame]72<li><a href="/cmds/llvmc.html"><b>llvmc</b></a> -
73 a generic customizable compiler driver</li>
Mikhail Glushenkovd3f4b242008-11-25 21:38:38 +0000[diff] [blame]74
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]75</ul>
76
77</div>
78
79<!-- *********************************************************************** -->
80<div class="doc_section">
Chris Lattnereeb63302008-08-06 05:57:58 +0000[diff] [blame]81 <a name="frontend">C and C++ Front-end Commands</a>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]82</div>
83<!-- *********************************************************************** -->
84
85<div class="doc_text">
86<ul>
87
Chris Lattnerb71250f2008-08-06 05:56:52 +0000[diff] [blame]88<li><a href="/cmds/llvmgcc.html"><b>llvm-gcc</b></a> -
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]89 GCC-based C front-end for LLVM
90
Chris Lattnerb71250f2008-08-06 05:56:52 +0000[diff] [blame]91<li><a href="/cmds/llvmgxx.html"><b>llvm-g++</b></a> -
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]92 GCC-based C++ front-end for LLVM</li>
93
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]94</ul>
95
96</div>
97
98<!-- *********************************************************************** -->
99<div class="doc_section">
100 <a name="debug">Debugging Tools</a>
101</div>
102<!-- *********************************************************************** -->
103
104
105<div class="doc_text">
106
107<ul>
108
Reid Spencer76f73d12007-08-05 23:43:44 +0000[diff] [blame]109<li><a href="/cmds/bugpoint.html"><b>bugpoint</b></a> -
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]110 automatic test-case reducer</li>
111
Reid Spencer76f73d12007-08-05 23:43:44 +0000[diff] [blame]112<li><a href="/cmds/llvm-extract.html"><b>llvm-extract</b></a> -
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]113 extract a function from an LLVM bytecode file</li>
114
Reid Spencer76f73d12007-08-05 23:43:44 +0000[diff] [blame]115<li><a href="/cmds/llvm-bcanalyzer.html"><b>llvm-bcanalyzer</b></a> -
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]116 bytecode analyzer (analyzes the binary encoding itself, not the program it
117 represents)</li>
118
119</ul>
120</div>
121
122<!-- *********************************************************************** -->
123<div class="doc_section">
124 <a name="internal">Internal Tools</a>
125</div>
126<!-- *********************************************************************** -->
127
128<div class="doc_text">
129<ul>
130
Chris Lattner7d2189d2009-08-15 15:38:11 +0000[diff] [blame]131<li><a href="/cmds/FileCheck.html"><b>FileCheck</b></a> -
132 Flexible file verifier used extensively by the testing harness</li>
Reid Spencer76f73d12007-08-05 23:43:44 +0000[diff] [blame]133<li><a href="/cmds/tblgen.html"><b>tblgen</b></a> -
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]134 target description reader and generator</li>
Daniel Dunbara4e49652009-10-19 03:54:13 +0000[diff] [blame]135<li><a href="/cmds/lit.html"><b>lit</b></a> -
136 LLVM Integrated Tester, for running tests</li>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]137
138</ul>
139</div>
140
141<!-- *********************************************************************** -->
142
143<hr>
144<address>
145 <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
Misha Brukmanb401d442008-12-11 17:12:52 +0000[diff] [blame]146 src="http://jigsaw.w3.org/css-validator/images/vcss-blue" alt="Valid CSS"></a>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]147 <a href="http://validator.w3.org/check/referer"><img
Misha Brukmanb401d442008-12-11 17:12:52 +0000[diff] [blame]148 src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]149
150 <a href="http://llvm.org">LLVM Compiler Infrastructure</a><br>
151 Last modified: $Date$
152</address>
153
154</body>
155</html>