Gitiles
Code Review Sign In
gerrit-public.fairphone.software / toolchain / llvm-project / 8feb9d67e8f6cc26d13a39c3b4007e956d577c06 / . / llvm / docs / CommandGuide / index.html
blob: 5cac65cd0b723fbc01583f2f73775bd0c3856ae9 [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/llvm-upgrade.html"><b>llvm-upgrade</b></a> -
Reid Spencer963bdf32006-12-02 16:35:42 +0000[diff] [blame]42 upgrade LLVM assembly from previous version</li>
43
Reid Spencerade052e52007-08-05 23:43:44 +0000[diff] [blame]44<li><a href="/cmds/opt.html"><b>opt</b></a> -
Chris Lattner517d6502004-07-10 06:06:56 +0000[diff] [blame]45 run a series of LLVM-to-LLVM optimizations on 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/llc.html"><b>llc</b></a> -
Chris Lattner517d6502004-07-10 06:06:56 +0000[diff] [blame]48 generate native machine code for a bytecode file</li>
Chris Lattnerd57aa5e82003-11-02 02:10:54 +0000[diff] [blame]49
Reid Spencerade052e52007-08-05 23:43:44 +0000[diff] [blame]50<li><a href="/cmds/lli.html"><b>lli</b></a> -
Chris Lattner517d6502004-07-10 06:06:56 +0000[diff] [blame]51 directly run a program compiled to bytecode using a JIT compiler or
52 interpreter</li>
John Criswell408128d2003-09-11 19:58:03 +0000[diff] [blame]53
Reid Spencerade052e52007-08-05 23:43:44 +0000[diff] [blame]54<li><a href="/cmds/llvm-link.html"><b>llvm-link</b></a> -
Misha Brukmanb4107632004-07-01 16:04:49 +0000[diff] [blame]55 link several bytecode files into one</li>
John Criswella9060d82003-09-11 20:23:52 +0000[diff] [blame]56
Reid Spencerade052e52007-08-05 23:43:44 +0000[diff] [blame]57<li><a href="/cmds/llvm-ar.html"><b>llvm-ar</b></a> -
Reid Spencere4485002004-11-11 09:30:00 +0000[diff] [blame]58 archive bytecode files</li>
59
Reid Spencerade052e52007-08-05 23:43:44 +0000[diff] [blame]60<li><a href="/cmds/llvm-ranlib.html"><b>llvm-ranlib</b></a> -
Misha Brukmana8e17182004-11-15 19:53:43 +0000[diff] [blame]61 create an index for archives made with llvm-ar</li>
62
Reid Spencerade052e52007-08-05 23:43:44 +0000[diff] [blame]63<li><a href="/cmds/llvm-nm.html"><b>llvm-nm</b></a> -
Misha Brukmanb4107632004-07-01 16:04:49 +0000[diff] [blame]64 print out the names and types of symbols in a bytecode file</li>
John Criswella9060d82003-09-11 20:23:52 +0000[diff] [blame]65
Reid Spencerade052e52007-08-05 23:43:44 +0000[diff] [blame]66<li><a href="/cmds/llvm-prof.html"><b>llvm-prof</b></a> -
Chris Lattner517d6502004-07-10 06:06:56 +0000[diff] [blame]67 format raw `<tt>llvmprof.out</tt>' data into a human-readable report</li>
John Criswell1ce56bd2003-10-03 13:48:27 +0000[diff] [blame]68
Reid Spencerade052e52007-08-05 23:43:44 +0000[diff] [blame]69<li><a href="/cmds/llvmc.html"><b>llvmc</b></a> -
Reid Spencerf8685392004-11-29 04:32:37 +0000[diff] [blame]70 generic and configurable compiler driver</li>
71
Reid Spencerade052e52007-08-05 23:43:44 +0000[diff] [blame]72<li><a href="/cmds/llvm-ld.html"><b>llvm-ld</b></a> -
Reid Spencerf8685392004-11-29 04:32:37 +0000[diff] [blame]73 general purpose linker with loadable runtime optimization support</li>
74
Reid Spencerade052e52007-08-05 23:43:44 +0000[diff] [blame]75<li><a href="/cmds/llvm-config.html"><b>llvm-config</b></a> -
Reid Spencerf9aa6882006-05-30 19:56:31 +0000[diff] [blame]76 print out LLVM compilation options, libraries, etc. as configured.</li>
Reid Spencer95680d12006-03-24 00:03:37 +0000[diff] [blame]77
Reid Spencerade052e52007-08-05 23:43:44 +0000[diff] [blame]78 <li><a href="/cmds/llvm2cpp.html"><b>llvm2cpp</b></a> - convert LLVM assembly
Reid Spencerf9aa6882006-05-30 19:56:31 +0000[diff] [blame]79 into the corresponding LLVM C++ API calls to produce it</li>
Misha Brukmanb4107632004-07-01 16:04:49 +0000[diff] [blame]80</ul>
John Criswell1ce56bd2003-10-03 13:48:27 +0000[diff] [blame]81
Misha Brukmanb4107632004-07-01 16:04:49 +0000[diff] [blame]82</div>
John Criswella9060d82003-09-11 20:23:52 +0000[diff] [blame]83
Misha Brukmanb4107632004-07-01 16:04:49 +0000[diff] [blame]84<!-- *********************************************************************** -->
85<div class="doc_section">
Chris Lattnerf61dbba2004-07-10 21:43:12 +0000[diff] [blame]86 <a name="frontend">C, C++, and Stacker Front-end Commands</a>
Misha Brukmanb4107632004-07-01 16:04:49 +0000[diff] [blame]87</div>
88<!-- *********************************************************************** -->
John Criswella9060d82003-09-11 20:23:52 +0000[diff] [blame]89
Misha Brukmanb4107632004-07-01 16:04:49 +0000[diff] [blame]90<div class="doc_text">
Misha Brukmanb4107632004-07-01 16:04:49 +0000[diff] [blame]91<ul>
Chris Lattner46b359c2003-10-07 20:05:23 +0000[diff] [blame]92
Reid Spencerade052e52007-08-05 23:43:44 +0000[diff] [blame]93<li><a href="/cmds/llvmgcc.html"><b>llvmgcc</b></a> -
Chris Lattner517d6502004-07-10 06:06:56 +0000[diff] [blame]94 GCC-based C front-end for LLVM
Misha Brukmanb4107632004-07-01 16:04:49 +0000[diff] [blame]95
Reid Spencerade052e52007-08-05 23:43:44 +0000[diff] [blame]96<li><a href="/cmds/llvmgxx.html"><b>llvmg++</b></a> -
Chris Lattner517d6502004-07-10 06:06:56 +0000[diff] [blame]97 GCC-based C++ front-end for LLVM</li>
Misha Brukmanb4107632004-07-01 16:04:49 +0000[diff] [blame]98
Reid Spencerade052e52007-08-05 23:43:44 +0000[diff] [blame]99<li><a href="/cmds/stkrc.html"><b>stkrc</b></a> -
Chris Lattnerf61dbba2004-07-10 21:43:12 +0000[diff] [blame]100 front-end compiler for the <a href="../Stacker.html">Stacker</a>
101 language</li>
102
Misha Brukmanb4107632004-07-01 16:04:49 +0000[diff] [blame]103</ul>
104
105</div>
106
107<!-- *********************************************************************** -->
108<div class="doc_section">
109 <a name="debug">Debugging Tools</a>
110</div>
111<!-- *********************************************************************** -->
Chris Lattner46b359c2003-10-07 20:05:23 +0000[diff] [blame]112
113
Misha Brukmanb4107632004-07-01 16:04:49 +0000[diff] [blame]114<div class="doc_text">
115
116<ul>
117
Reid Spencerade052e52007-08-05 23:43:44 +0000[diff] [blame]118<li><a href="/cmds/bugpoint.html"><b>bugpoint</b></a> -
Misha Brukmanb4107632004-07-01 16:04:49 +0000[diff] [blame]119 automatic test-case reducer</li>
120
Reid Spencerade052e52007-08-05 23:43:44 +0000[diff] [blame]121<li><a href="/cmds/llvm-extract.html"><b>llvm-extract</b></a> -
Misha Brukmanb4107632004-07-01 16:04:49 +0000[diff] [blame]122 extract a function from an LLVM bytecode file</li>
123
Reid Spencerade052e52007-08-05 23:43:44 +0000[diff] [blame]124<li><a href="/cmds/llvm-bcanalyzer.html"><b>llvm-bcanalyzer</b></a> -
Misha Brukman61a747f2004-07-01 16:59:05 +0000[diff] [blame]125 bytecode analyzer (analyzes the binary encoding itself, not the program it
126 represents)</li>
127
Misha Brukmanb4107632004-07-01 16:04:49 +0000[diff] [blame]128</ul>
Chris Lattner5d112312006-06-02 17:43:38 +0000[diff] [blame]129</div>
Misha Brukmanb4107632004-07-01 16:04:49 +0000[diff] [blame]130
Chris Lattner5d112312006-06-02 17:43:38 +0000[diff] [blame]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 Spencerade052e52007-08-05 23:43:44 +0000[diff] [blame]140<li><a href="/cmds/tblgen.html"><b>tblgen</b></a> -
Chris Lattner5d112312006-06-02 17:43:38 +0000[diff] [blame]141 target description reader and generator</li>
142
143</ul>
Misha Brukmanb4107632004-07-01 16:04:49 +0000[diff] [blame]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
Reid Spencer85d182f2006-03-14 05:42:07 +0000[diff] [blame]155 <a href="http://llvm.org">LLVM Compiler Infrastructure</a><br>
Misha Brukmanb4107632004-07-01 16:04:49 +0000[diff] [blame]156 Last modified: $Date$
157</address>
Chris Lattner46b359c2003-10-07 20:05:23 +0000[diff] [blame]158
Misha Brukman47e7fd22003-10-31 00:39:28 +0000[diff] [blame]159</body>
John Criswell408128d2003-09-11 19:58:03 +0000[diff] [blame]160</html>