Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / llvm / f3ff76bb917617e35d3b31ce29259a403afd4acc / . / docs / CommandGuide / index.html
blob: ab27e5d469cb717a4e18268d72659cb017546ce6 [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/llvmc.html"><b>llvmc</b></a> -
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]67 generic and configurable compiler driver</li>
68
Reid Spencer76f73d12007-08-05 23:43:44 +0000[diff] [blame]69<li><a href="/cmds/llvm-ld.html"><b>llvm-ld</b></a> -
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]70 general purpose linker with loadable runtime optimization support</li>
71
Reid Spencer76f73d12007-08-05 23:43:44 +0000[diff] [blame]72<li><a href="/cmds/llvm-config.html"><b>llvm-config</b></a> -
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]73 print out LLVM compilation options, libraries, etc. as configured.</li>
74
Reid Spencer76f73d12007-08-05 23:43:44 +0000[diff] [blame]75 <li><a href="/cmds/llvm2cpp.html"><b>llvm2cpp</b></a> - convert LLVM assembly
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]76 into the corresponding LLVM C++ API calls to produce it</li>
77</ul>
78
79</div>
80
81<!-- *********************************************************************** -->
82<div class="doc_section">
83 <a name="frontend">C, C++, and Stacker Front-end Commands</a>
84</div>
85<!-- *********************************************************************** -->
86
87<div class="doc_text">
88<ul>
89
Reid Spencer76f73d12007-08-05 23:43:44 +0000[diff] [blame]90<li><a href="/cmds/llvmgcc.html"><b>llvmgcc</b></a> -
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]91 GCC-based C front-end for LLVM
92
Reid Spencer76f73d12007-08-05 23:43:44 +0000[diff] [blame]93<li><a href="/cmds/llvmgxx.html"><b>llvmg++</b></a> -
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]94 GCC-based C++ front-end for LLVM</li>
95
Reid Spencer76f73d12007-08-05 23:43:44 +0000[diff] [blame]96<li><a href="/cmds/stkrc.html"><b>stkrc</b></a> -
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]97 front-end compiler for the <a href="../Stacker.html">Stacker</a>
98 language</li>
99
100</ul>
101
102</div>
103
104<!-- *********************************************************************** -->
105<div class="doc_section">
106 <a name="debug">Debugging Tools</a>
107</div>
108<!-- *********************************************************************** -->
109
110
111<div class="doc_text">
112
113<ul>
114
Reid Spencer76f73d12007-08-05 23:43:44 +0000[diff] [blame]115<li><a href="/cmds/bugpoint.html"><b>bugpoint</b></a> -
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]116 automatic test-case reducer</li>
117
Reid Spencer76f73d12007-08-05 23:43:44 +0000[diff] [blame]118<li><a href="/cmds/llvm-extract.html"><b>llvm-extract</b></a> -
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]119 extract a function from an LLVM bytecode file</li>
120
Reid Spencer76f73d12007-08-05 23:43:44 +0000[diff] [blame]121<li><a href="/cmds/llvm-bcanalyzer.html"><b>llvm-bcanalyzer</b></a> -
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]122 bytecode analyzer (analyzes the binary encoding itself, not the program it
123 represents)</li>
124
125</ul>
126</div>
127
128<!-- *********************************************************************** -->
129<div class="doc_section">
130 <a name="internal">Internal Tools</a>
131</div>
132<!-- *********************************************************************** -->
133
134<div class="doc_text">
135<ul>
136
Reid Spencer76f73d12007-08-05 23:43:44 +0000[diff] [blame]137<li><a href="/cmds/tblgen.html"><b>tblgen</b></a> -
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]138 target description reader and generator</li>
139
140</ul>
141</div>
142
143<!-- *********************************************************************** -->
144
145<hr>
146<address>
147 <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
148 src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a>
149 <a href="http://validator.w3.org/check/referer"><img
150 src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!"></a>
151
152 <a href="http://llvm.org">LLVM Compiler Infrastructure</a><br>
153 Last modified: $Date$
154</address>
155
156</body>
157</html>