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