Gitiles
Code Review Sign In
gerrit-public.fairphone.software / toolchain / llvm-project / a44099f02274dcff2aee9e47e826cc2a2dba3ca6 / . / llvm / docs / CommandGuide / index.html
blob: a411fea68bf4b28947552f04b7d267b14d31acc4 [file] [log] [blame]
Misha Brukmanb4107632004-07-01 16:04:49 +0000[diff] [blame]1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
2 "http://www.w3.org/TR/html4/strict.dtd">
John Criswell408128d2003-09-11 19:58:03 +0000[diff] [blame]3<html>
Misha Brukman47e7fd22003-10-31 00:39:28 +0000[diff] [blame]4<head>
5 <title>LLVM Command Guide</title>
Reid Spencere14b7332007-07-09 06:32:55 +0000[diff] [blame]6 <link rel="stylesheet" href="/docs/llvm.css" type="text/css">
Misha Brukman47e7fd22003-10-31 00:39:28 +0000[diff] [blame]7</head>
Misha Brukmanb4107632004-07-01 16:04:49 +0000[diff] [blame]8<body>
John Criswell408128d2003-09-11 19:58:03 +0000[diff] [blame]9
Misha Brukmanb4107632004-07-01 16:04:49 +0000[diff] [blame]10<div class="doc_title">
11 LLVM Command Guide
12</div>
John Criswell408128d2003-09-11 19:58:03 +0000[diff] [blame]13
Misha Brukmanb4107632004-07-01 16:04:49 +0000[diff] [blame]14<div class="doc_text">
John Criswell408128d2003-09-11 19:58:03 +0000[diff] [blame]15
Chris Lattner517d6502004-07-10 06:06:56 +0000[diff] [blame]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>
Chris Lattner46b359c2003-10-07 20:05:23 +0000[diff] [blame]22
Misha Brukmanb4107632004-07-01 16:04:49 +0000[diff] [blame]23</div>
John Criswell408128d2003-09-11 19:58:03 +0000[diff] [blame]24
Misha Brukmanb4107632004-07-01 16:04:49 +0000[diff] [blame]25<!-- *********************************************************************** -->
26<div class="doc_section">
27 <a name="basic">Basic Commands</a>
28</div>
29<!-- *********************************************************************** -->
John Criswell408128d2003-09-11 19:58:03 +0000[diff] [blame]30
Misha Brukmanb4107632004-07-01 16:04:49 +0000[diff] [blame]31<div class="doc_text">
John Criswell408128d2003-09-11 19:58:03 +0000[diff] [blame]32
Misha Brukmanb4107632004-07-01 16:04:49 +0000[diff] [blame]33<ul>
John Criswell408128d2003-09-11 19:58:03 +0000[diff] [blame]34
Reid Spencerade052e52007-08-05 23:43:44 +0000[diff] [blame]35<li><a href="/cmds/llvm-as.html"><b>llvm-as</b></a> -
Chris Lattner517d6502004-07-10 06:06:56 +0000[diff] [blame]36 assemble a human-readable .ll file into bytecode</li>
John Criswell408128d2003-09-11 19:58:03 +0000[diff] [blame]37
Reid Spencerade052e52007-08-05 23:43:44 +0000[diff] [blame]38<li><a href="/cmds/llvm-dis.html"><b>llvm-dis</b></a> -
Chris Lattner517d6502004-07-10 06:06:56 +0000[diff] [blame]39 disassemble a bytecode file into a human-readable .ll file</li>
Chris Lattnerd57aa5e82003-11-02 02:10:54 +0000[diff] [blame]40
Reid Spencerade052e52007-08-05 23:43:44 +0000[diff] [blame]41<li><a href="/cmds/opt.html"><b>opt</b></a> -
Chris Lattner517d6502004-07-10 06:06:56 +0000[diff] [blame]42 run a series of LLVM-to-LLVM optimizations on a bytecode file</li>
Chris Lattnerd57aa5e82003-11-02 02:10:54 +0000[diff] [blame]43
Reid Spencerade052e52007-08-05 23:43:44 +0000[diff] [blame]44<li><a href="/cmds/llc.html"><b>llc</b></a> -
Chris Lattner517d6502004-07-10 06:06:56 +0000[diff] [blame]45 generate native machine code for a bytecode file</li>
Chris Lattnerd57aa5e82003-11-02 02:10:54 +0000[diff] [blame]46
Reid Spencerade052e52007-08-05 23:43:44 +0000[diff] [blame]47<li><a href="/cmds/lli.html"><b>lli</b></a> -
Chris Lattner517d6502004-07-10 06:06:56 +0000[diff] [blame]48 directly run a program compiled to bytecode using a JIT compiler or
49 interpreter</li>
John Criswell408128d2003-09-11 19:58:03 +0000[diff] [blame]50
Reid Spencerade052e52007-08-05 23:43:44 +0000[diff] [blame]51<li><a href="/cmds/llvm-link.html"><b>llvm-link</b></a> -
Misha Brukmanb4107632004-07-01 16:04:49 +0000[diff] [blame]52 link several bytecode files into one</li>
John Criswella9060d82003-09-11 20:23:52 +0000[diff] [blame]53
Reid Spencerade052e52007-08-05 23:43:44 +0000[diff] [blame]54<li><a href="/cmds/llvm-ar.html"><b>llvm-ar</b></a> -
Reid Spencere4485002004-11-11 09:30:00 +0000[diff] [blame]55 archive bytecode files</li>
56
Reid Spencerade052e52007-08-05 23:43:44 +0000[diff] [blame]57<li><a href="/cmds/llvm-ranlib.html"><b>llvm-ranlib</b></a> -
Misha Brukmana8e17182004-11-15 19:53:43 +0000[diff] [blame]58 create an index for archives made with llvm-ar</li>
59
Reid Spencerade052e52007-08-05 23:43:44 +0000[diff] [blame]60<li><a href="/cmds/llvm-nm.html"><b>llvm-nm</b></a> -
Misha Brukmanb4107632004-07-01 16:04:49 +0000[diff] [blame]61 print out the names and types of symbols in a bytecode file</li>
John Criswella9060d82003-09-11 20:23:52 +0000[diff] [blame]62
Reid Spencerade052e52007-08-05 23:43:44 +0000[diff] [blame]63<li><a href="/cmds/llvm-prof.html"><b>llvm-prof</b></a> -
Chris Lattner517d6502004-07-10 06:06:56 +0000[diff] [blame]64 format raw `<tt>llvmprof.out</tt>' data into a human-readable report</li>
John Criswell1ce56bd2003-10-03 13:48:27 +0000[diff] [blame]65
Reid Spencerade052e52007-08-05 23:43:44 +0000[diff] [blame]66<li><a href="/cmds/llvm-ld.html"><b>llvm-ld</b></a> -
Reid Spencerf8685392004-11-29 04:32:37 +0000[diff] [blame]67 general purpose linker with loadable runtime optimization support</li>
68
Reid Spencerade052e52007-08-05 23:43:44 +0000[diff] [blame]69<li><a href="/cmds/llvm-config.html"><b>llvm-config</b></a> -
Reid Spencerf9aa6882006-05-30 19:56:31 +0000[diff] [blame]70 print out LLVM compilation options, libraries, etc. as configured.</li>
Reid Spencer95680d12006-03-24 00:03:37 +0000[diff] [blame]71
Misha Brukmanb4107632004-07-01 16:04:49 +0000[diff] [blame]72</ul>
John Criswell1ce56bd2003-10-03 13:48:27 +0000[diff] [blame]73
Misha Brukmanb4107632004-07-01 16:04:49 +0000[diff] [blame]74</div>
John Criswella9060d82003-09-11 20:23:52 +0000[diff] [blame]75
Misha Brukmanb4107632004-07-01 16:04:49 +0000[diff] [blame]76<!-- *********************************************************************** -->
77<div class="doc_section">
Chris Lattnerf61dbba2004-07-10 21:43:12 +0000[diff] [blame]78 <a name="frontend">C, C++, and Stacker Front-end Commands</a>
Misha Brukmanb4107632004-07-01 16:04:49 +0000[diff] [blame]79</div>
80<!-- *********************************************************************** -->
John Criswella9060d82003-09-11 20:23:52 +0000[diff] [blame]81
Misha Brukmanb4107632004-07-01 16:04:49 +0000[diff] [blame]82<div class="doc_text">
Misha Brukmanb4107632004-07-01 16:04:49 +0000[diff] [blame]83<ul>
Chris Lattner46b359c2003-10-07 20:05:23 +0000[diff] [blame]84
Reid Spencerade052e52007-08-05 23:43:44 +0000[diff] [blame]85<li><a href="/cmds/llvmgcc.html"><b>llvmgcc</b></a> -
Chris Lattner517d6502004-07-10 06:06:56 +0000[diff] [blame]86 GCC-based C front-end for LLVM
Misha Brukmanb4107632004-07-01 16:04:49 +0000[diff] [blame]87
Reid Spencerade052e52007-08-05 23:43:44 +0000[diff] [blame]88<li><a href="/cmds/llvmgxx.html"><b>llvmg++</b></a> -
Chris Lattner517d6502004-07-10 06:06:56 +0000[diff] [blame]89 GCC-based C++ front-end for LLVM</li>
Misha Brukmanb4107632004-07-01 16:04:49 +0000[diff] [blame]90
Reid Spencerade052e52007-08-05 23:43:44 +0000[diff] [blame]91<li><a href="/cmds/stkrc.html"><b>stkrc</b></a> -
Chris Lattnerf61dbba2004-07-10 21:43:12 +0000[diff] [blame]92 front-end compiler for the <a href="../Stacker.html">Stacker</a>
93 language</li>
94
Misha Brukmanb4107632004-07-01 16:04:49 +0000[diff] [blame]95</ul>
96
97</div>
98
99<!-- *********************************************************************** -->
100<div class="doc_section">
101 <a name="debug">Debugging Tools</a>
102</div>
103<!-- *********************************************************************** -->
Chris Lattner46b359c2003-10-07 20:05:23 +0000[diff] [blame]104
105
Misha Brukmanb4107632004-07-01 16:04:49 +0000[diff] [blame]106<div class="doc_text">
107
108<ul>
109
Reid Spencerade052e52007-08-05 23:43:44 +0000[diff] [blame]110<li><a href="/cmds/bugpoint.html"><b>bugpoint</b></a> -
Misha Brukmanb4107632004-07-01 16:04:49 +0000[diff] [blame]111 automatic test-case reducer</li>
112
Reid Spencerade052e52007-08-05 23:43:44 +0000[diff] [blame]113<li><a href="/cmds/llvm-extract.html"><b>llvm-extract</b></a> -
Misha Brukmanb4107632004-07-01 16:04:49 +0000[diff] [blame]114 extract a function from an LLVM bytecode file</li>
115
Reid Spencerade052e52007-08-05 23:43:44 +0000[diff] [blame]116<li><a href="/cmds/llvm-bcanalyzer.html"><b>llvm-bcanalyzer</b></a> -
Misha Brukman61a747f2004-07-01 16:59:05 +0000[diff] [blame]117 bytecode analyzer (analyzes the binary encoding itself, not the program it
118 represents)</li>
119
Misha Brukmanb4107632004-07-01 16:04:49 +0000[diff] [blame]120</ul>
Chris Lattner5d112312006-06-02 17:43:38 +0000[diff] [blame]121</div>
Misha Brukmanb4107632004-07-01 16:04:49 +0000[diff] [blame]122
Chris Lattner5d112312006-06-02 17:43:38 +0000[diff] [blame]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 Spencerade052e52007-08-05 23:43:44 +0000[diff] [blame]132<li><a href="/cmds/tblgen.html"><b>tblgen</b></a> -
Chris Lattner5d112312006-06-02 17:43:38 +0000[diff] [blame]133 target description reader and generator</li>
134
135</ul>
Misha Brukmanb4107632004-07-01 16:04:49 +0000[diff] [blame]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
Reid Spencer85d182f2006-03-14 05:42:07 +0000[diff] [blame]147 <a href="http://llvm.org">LLVM Compiler Infrastructure</a><br>
Misha Brukmanb4107632004-07-01 16:04:49 +0000[diff] [blame]148 Last modified: $Date$
149</address>
Chris Lattner46b359c2003-10-07 20:05:23 +0000[diff] [blame]150
Misha Brukman47e7fd22003-10-31 00:39:28 +0000[diff] [blame]151</body>
John Criswell408128d2003-09-11 19:58:03 +0000[diff] [blame]152</html>