Gitiles
Code Review Sign In
gerrit-public.fairphone.software / fp2-dev / platform / external / llvm / 0c628c2617a2c25cabea6d1cb8bd13b79b3cb15a / . / docs / CommandGuide / index.html
blob: 8854fbbebe6b8001f50117fda03ced2277853686 [file] [log] [blame]
Misha Brukman38ca9be2004-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 Criswellecf32e52003-09-11 19:58:03 +0000[diff] [blame]3<html>
Misha Brukmanc6ad94c2003-10-31 00:39:28 +0000[diff] [blame]4<head>
5 <title>LLVM Command Guide</title>
mike-me2c3a492010-05-07 00:28:04 +0000[diff] [blame]6 <link rel="stylesheet" href="/docs/llvm.css" type="text/css">
Misha Brukmanc6ad94c2003-10-31 00:39:28 +0000[diff] [blame]7</head>
Misha Brukman38ca9be2004-07-01 16:04:49 +0000[diff] [blame]8<body>
John Criswellecf32e52003-09-11 19:58:03 +0000[diff] [blame]9
Misha Brukman38ca9be2004-07-01 16:04:49 +0000[diff] [blame]10<div class="doc_title">
11 LLVM Command Guide
12</div>
John Criswellecf32e52003-09-11 19:58:03 +0000[diff] [blame]13
Misha Brukman38ca9be2004-07-01 16:04:49 +0000[diff] [blame]14<div class="doc_text">
John Criswellecf32e52003-09-11 19:58:03 +0000[diff] [blame]15
Chris Lattner1a5a79c2004-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
Mikhail Glushenkova606d1f2008-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
Duncan Sands7e7ae5a2010-02-18 14:08:13 +0000[diff] [blame]20<tt>-help</tt> (general options) or <tt>-help-hidden</tt> (general+debugging
Chris Lattner1a5a79c2004-07-10 06:06:56 +0000[diff] [blame]21options) arguments to the tool you are interested in.</p>
Chris Lattnerd053efd2003-10-07 20:05:23 +0000[diff] [blame]22
Misha Brukman38ca9be2004-07-01 16:04:49 +0000[diff] [blame]23</div>
John Criswellecf32e52003-09-11 19:58:03 +0000[diff] [blame]24
Tanya Lattner10934e82010-05-11 16:47:42 +0000[diff] [blame]25<!-- *********************************************************************** -->
Misha Brukman38ca9be2004-07-01 16:04:49 +0000[diff] [blame]26<div class="doc_section">
27 <a name="basic">Basic Commands</a>
28</div>
29<!-- *********************************************************************** -->
John Criswellecf32e52003-09-11 19:58:03 +0000[diff] [blame]30
Misha Brukman38ca9be2004-07-01 16:04:49 +0000[diff] [blame]31<div class="doc_text">
John Criswellecf32e52003-09-11 19:58:03 +0000[diff] [blame]32
Misha Brukman38ca9be2004-07-01 16:04:49 +0000[diff] [blame]33<ul>
John Criswellecf32e52003-09-11 19:58:03 +0000[diff] [blame]34
mike-me2c3a492010-05-07 00:28:04 +0000[diff] [blame]35<li><a href="/cmds/llvm-as.html"><b>llvm-as</b></a> -
Chris Lattner1a5a79c2004-07-10 06:06:56 +0000[diff] [blame]36 assemble a human-readable .ll file into bytecode</li>
John Criswellecf32e52003-09-11 19:58:03 +0000[diff] [blame]37
mike-me2c3a492010-05-07 00:28:04 +0000[diff] [blame]38<li><a href="/cmds/llvm-dis.html"><b>llvm-dis</b></a> -
Chris Lattner1a5a79c2004-07-10 06:06:56 +0000[diff] [blame]39 disassemble a bytecode file into a human-readable .ll file</li>
Chris Lattnere66e73a2003-11-02 02:10:54 +0000[diff] [blame]40
mike-me2c3a492010-05-07 00:28:04 +0000[diff] [blame]41<li><a href="/cmds/opt.html"><b>opt</b></a> -
Chris Lattner1a5a79c2004-07-10 06:06:56 +0000[diff] [blame]42 run a series of LLVM-to-LLVM optimizations on a bytecode file</li>
Chris Lattnere66e73a2003-11-02 02:10:54 +0000[diff] [blame]43
mike-me2c3a492010-05-07 00:28:04 +0000[diff] [blame]44<li><a href="/cmds/llc.html"><b>llc</b></a> -
Chris Lattner1a5a79c2004-07-10 06:06:56 +0000[diff] [blame]45 generate native machine code for a bytecode file</li>
Chris Lattnere66e73a2003-11-02 02:10:54 +0000[diff] [blame]46
mike-me2c3a492010-05-07 00:28:04 +0000[diff] [blame]47<li><a href="/cmds/lli.html"><b>lli</b></a> -
Mikhail Glushenkova606d1f2008-11-25 21:38:38 +0000[diff] [blame]48 directly run a program compiled to bytecode using a JIT compiler or
Chris Lattner1a5a79c2004-07-10 06:06:56 +0000[diff] [blame]49 interpreter</li>
John Criswellecf32e52003-09-11 19:58:03 +0000[diff] [blame]50
mike-me2c3a492010-05-07 00:28:04 +0000[diff] [blame]51<li><a href="/cmds/llvm-link.html"><b>llvm-link</b></a> -
Misha Brukman38ca9be2004-07-01 16:04:49 +0000[diff] [blame]52 link several bytecode files into one</li>
John Criswell32003302003-09-11 20:23:52 +0000[diff] [blame]53
mike-me2c3a492010-05-07 00:28:04 +0000[diff] [blame]54<li><a href="/cmds/llvm-ar.html"><b>llvm-ar</b></a> -
Reid Spencer0aa18992004-11-11 09:30:00 +0000[diff] [blame]55 archive bytecode files</li>
56
mike-me2c3a492010-05-07 00:28:04 +0000[diff] [blame]57<li><a href="/cmds/llvm-ranlib.html"><b>llvm-ranlib</b></a> -
Misha Brukmanbbcb10f2004-11-15 19:53:43 +0000[diff] [blame]58 create an index for archives made with llvm-ar</li>
59
mike-me2c3a492010-05-07 00:28:04 +0000[diff] [blame]60<li><a href="/cmds/llvm-nm.html"><b>llvm-nm</b></a> -
Misha Brukman38ca9be2004-07-01 16:04:49 +0000[diff] [blame]61 print out the names and types of symbols in a bytecode file</li>
John Criswell32003302003-09-11 20:23:52 +0000[diff] [blame]62
mike-me2c3a492010-05-07 00:28:04 +0000[diff] [blame]63<li><a href="/cmds/llvm-prof.html"><b>llvm-prof</b></a> -
Chris Lattner1a5a79c2004-07-10 06:06:56 +0000[diff] [blame]64 format raw `<tt>llvmprof.out</tt>' data into a human-readable report</li>
John Criswellaa5ff242003-10-03 13:48:27 +0000[diff] [blame]65
mike-me2c3a492010-05-07 00:28:04 +0000[diff] [blame]66<li><a href="/cmds/llvm-ld.html"><b>llvm-ld</b></a> -
Misha Brukman39309df2008-12-11 17:12:52 +0000[diff] [blame]67 general purpose linker with loadable runtime optimization support</li>
Reid Spencer38f98b52004-11-29 04:32:37 +0000[diff] [blame]68
mike-me2c3a492010-05-07 00:28:04 +0000[diff] [blame]69<li><a href="/cmds/llvm-config.html"><b>llvm-config</b></a> -
Misha Brukman39309df2008-12-11 17:12:52 +0000[diff] [blame]70 print out LLVM compilation options, libraries, etc. as configured</li>
Reid Spencercbe3a782006-03-24 00:03:37 +0000[diff] [blame]71
mike-me2c3a492010-05-07 00:28:04 +0000[diff] [blame]72<li><a href="/cmds/llvmc.html"><b>llvmc</b></a> -
Misha Brukman39309df2008-12-11 17:12:52 +0000[diff] [blame]73 a generic customizable compiler driver</li>
Mikhail Glushenkova606d1f2008-11-25 21:38:38 +0000[diff] [blame]74
John McCall8c359362010-09-07 23:10:21 +0000[diff] [blame]75<li><a href="/cmds/llvm-diff.html"><b>llvm-diff</b></a> -
76 structurally compare two modules</li>
77
Misha Brukman38ca9be2004-07-01 16:04:49 +0000[diff] [blame]78</ul>
John Criswellaa5ff242003-10-03 13:48:27 +0000[diff] [blame]79
Misha Brukman38ca9be2004-07-01 16:04:49 +0000[diff] [blame]80</div>
John Criswell32003302003-09-11 20:23:52 +0000[diff] [blame]81
Misha Brukman38ca9be2004-07-01 16:04:49 +0000[diff] [blame]82<!-- *********************************************************************** -->
83<div class="doc_section">
Chris Lattner01924d02008-08-06 05:57:58 +0000[diff] [blame]84 <a name="frontend">C and C++ Front-end Commands</a>
Misha Brukman38ca9be2004-07-01 16:04:49 +0000[diff] [blame]85</div>
86<!-- *********************************************************************** -->
John Criswell32003302003-09-11 20:23:52 +0000[diff] [blame]87
Misha Brukman38ca9be2004-07-01 16:04:49 +0000[diff] [blame]88<div class="doc_text">
Misha Brukman38ca9be2004-07-01 16:04:49 +0000[diff] [blame]89<ul>
Chris Lattnerd053efd2003-10-07 20:05:23 +0000[diff] [blame]90
mike-me2c3a492010-05-07 00:28:04 +0000[diff] [blame]91<li><a href="/cmds/llvmgcc.html"><b>llvm-gcc</b></a> -
Chris Lattner1a5a79c2004-07-10 06:06:56 +0000[diff] [blame]92 GCC-based C front-end for LLVM
Misha Brukman38ca9be2004-07-01 16:04:49 +0000[diff] [blame]93
mike-me2c3a492010-05-07 00:28:04 +0000[diff] [blame]94<li><a href="/cmds/llvmgxx.html"><b>llvm-g++</b></a> -
Chris Lattner1a5a79c2004-07-10 06:06:56 +0000[diff] [blame]95 GCC-based C++ front-end for LLVM</li>
Misha Brukman38ca9be2004-07-01 16:04:49 +0000[diff] [blame]96
Misha Brukman38ca9be2004-07-01 16:04:49 +0000[diff] [blame]97</ul>
98
99</div>
100
101<!-- *********************************************************************** -->
102<div class="doc_section">
103 <a name="debug">Debugging Tools</a>
104</div>
105<!-- *********************************************************************** -->
Chris Lattnerd053efd2003-10-07 20:05:23 +0000[diff] [blame]106
107
Misha Brukman38ca9be2004-07-01 16:04:49 +0000[diff] [blame]108<div class="doc_text">
109
110<ul>
111
mike-me2c3a492010-05-07 00:28:04 +0000[diff] [blame]112<li><a href="/cmds/bugpoint.html"><b>bugpoint</b></a> -
Misha Brukman38ca9be2004-07-01 16:04:49 +0000[diff] [blame]113 automatic test-case reducer</li>
114
mike-me2c3a492010-05-07 00:28:04 +0000[diff] [blame]115<li><a href="/cmds/llvm-extract.html"><b>llvm-extract</b></a> -
Misha Brukman38ca9be2004-07-01 16:04:49 +0000[diff] [blame]116 extract a function from an LLVM bytecode file</li>
117
mike-me2c3a492010-05-07 00:28:04 +0000[diff] [blame]118<li><a href="/cmds/llvm-bcanalyzer.html"><b>llvm-bcanalyzer</b></a> -
Misha Brukman95bba872004-07-01 16:59:05 +0000[diff] [blame]119 bytecode analyzer (analyzes the binary encoding itself, not the program it
120 represents)</li>
121
Misha Brukman38ca9be2004-07-01 16:04:49 +0000[diff] [blame]122</ul>
Chris Lattnerc95cf1d2006-06-02 17:43:38 +0000[diff] [blame]123</div>
Misha Brukman38ca9be2004-07-01 16:04:49 +0000[diff] [blame]124
Chris Lattnerc95cf1d2006-06-02 17:43:38 +0000[diff] [blame]125<!-- *********************************************************************** -->
126<div class="doc_section">
127 <a name="internal">Internal Tools</a>
128</div>
129<!-- *********************************************************************** -->
130
131<div class="doc_text">
132<ul>
133
mike-me2c3a492010-05-07 00:28:04 +0000[diff] [blame]134<li><a href="/cmds/FileCheck.html"><b>FileCheck</b></a> -
Chris Lattner9d3787b2009-08-15 15:38:11 +0000[diff] [blame]135 Flexible file verifier used extensively by the testing harness</li>
mike-me2c3a492010-05-07 00:28:04 +0000[diff] [blame]136<li><a href="/cmds/tblgen.html"><b>tblgen</b></a> -
Chris Lattnerc95cf1d2006-06-02 17:43:38 +0000[diff] [blame]137 target description reader and generator</li>
mike-me2c3a492010-05-07 00:28:04 +0000[diff] [blame]138<li><a href="/cmds/lit.html"><b>lit</b></a> -
Daniel Dunbar8b828a82009-10-19 03:54:13 +0000[diff] [blame]139 LLVM Integrated Tester, for running tests</li>
Chris Lattnerc95cf1d2006-06-02 17:43:38 +0000[diff] [blame]140
141</ul>
Misha Brukman38ca9be2004-07-01 16:04:49 +0000[diff] [blame]142</div>
143
144<!-- *********************************************************************** -->
145
146<hr>
147<address>
148 <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
Misha Brukman39309df2008-12-11 17:12:52 +0000[diff] [blame]149 src="http://jigsaw.w3.org/css-validator/images/vcss-blue" alt="Valid CSS"></a>
Misha Brukman38ca9be2004-07-01 16:04:49 +0000[diff] [blame]150 <a href="http://validator.w3.org/check/referer"><img
Misha Brukman39309df2008-12-11 17:12:52 +0000[diff] [blame]151 src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a>
Misha Brukman38ca9be2004-07-01 16:04:49 +0000[diff] [blame]152
Reid Spencercd143fc2006-03-14 05:42:07 +0000[diff] [blame]153 <a href="http://llvm.org">LLVM Compiler Infrastructure</a><br>
Misha Brukman38ca9be2004-07-01 16:04:49 +0000[diff] [blame]154 Last modified: $Date$
155</address>
Chris Lattnerd053efd2003-10-07 20:05:23 +0000[diff] [blame]156
Misha Brukmanc6ad94c2003-10-31 00:39:28 +0000[diff] [blame]157</body>
John Criswellecf32e52003-09-11 19:58:03 +0000[diff] [blame]158</html>