Gitiles
Code Review Sign In
gerrit-public.fairphone.software / fp2-dev / platform / external / llvm / d6b7a242d345fd79a337afd384bb586c5619cfe7 / . / docs / CommandGuide / index.html
blob: 75933e8d7471531522b21fa6c2e7d787ba479b45 [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>
Reid Spencerc69f7772007-07-09 06:32:55 +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
Chris Lattner1a5a79c2004-07-10 06:06:56 +0000[diff] [blame]20<tt>--help</tt> (general options) or <tt>--help-hidden</tt> (general+debugging
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
Misha Brukman38ca9be2004-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 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
Mikhail Glushenkova606d1f2008-11-25 21:38:38 +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
Reid Spencer944b7f22007-08-05 23:43:44 +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
Reid Spencer944b7f22007-08-05 23:43:44 +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
Mikhail Glushenkova606d1f2008-11-25 21:38:38 +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
Mikhail Glushenkova606d1f2008-11-25 21:38:38 +0000[diff] [blame]47<li><a href="/cmds/lli.html"><b>lli</b></a> -
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
Reid Spencer944b7f22007-08-05 23:43:44 +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
Mikhail Glushenkova606d1f2008-11-25 21:38:38 +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
Mikhail Glushenkova606d1f2008-11-25 21:38:38 +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
Reid Spencer944b7f22007-08-05 23:43:44 +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
Reid Spencer944b7f22007-08-05 23:43:44 +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
Reid Spencer944b7f22007-08-05 23:43:44 +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
Mikhail Glushenkova606d1f2008-11-25 21:38:38 +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
Misha Brukman39309df2008-12-11 17:12:52 +0000[diff] [blame]72<li><a href="/cmds/llvmc.html"><b>llvmc</b></a> -
73 a generic customizable compiler driver</li>
Mikhail Glushenkova606d1f2008-11-25 21:38:38 +0000[diff] [blame]74
Misha Brukman38ca9be2004-07-01 16:04:49 +0000[diff] [blame]75</ul>
John Criswellaa5ff242003-10-03 13:48:27 +0000[diff] [blame]76
Misha Brukman38ca9be2004-07-01 16:04:49 +0000[diff] [blame]77</div>
John Criswell32003302003-09-11 20:23:52 +0000[diff] [blame]78
Misha Brukman38ca9be2004-07-01 16:04:49 +0000[diff] [blame]79<!-- *********************************************************************** -->
80<div class="doc_section">
Chris Lattner01924d02008-08-06 05:57:58 +0000[diff] [blame]81 <a name="frontend">C and C++ Front-end Commands</a>
Misha Brukman38ca9be2004-07-01 16:04:49 +0000[diff] [blame]82</div>
83<!-- *********************************************************************** -->
John Criswell32003302003-09-11 20:23:52 +0000[diff] [blame]84
Misha Brukman38ca9be2004-07-01 16:04:49 +0000[diff] [blame]85<div class="doc_text">
Misha Brukman38ca9be2004-07-01 16:04:49 +0000[diff] [blame]86<ul>
Chris Lattnerd053efd2003-10-07 20:05:23 +0000[diff] [blame]87
Chris Lattner2a3cea12008-08-06 05:56:52 +0000[diff] [blame]88<li><a href="/cmds/llvmgcc.html"><b>llvm-gcc</b></a> -
Chris Lattner1a5a79c2004-07-10 06:06:56 +0000[diff] [blame]89 GCC-based C front-end for LLVM
Misha Brukman38ca9be2004-07-01 16:04:49 +0000[diff] [blame]90
Chris Lattner2a3cea12008-08-06 05:56:52 +0000[diff] [blame]91<li><a href="/cmds/llvmgxx.html"><b>llvm-g++</b></a> -
Chris Lattner1a5a79c2004-07-10 06:06:56 +0000[diff] [blame]92 GCC-based C++ front-end for LLVM</li>
Misha Brukman38ca9be2004-07-01 16:04:49 +0000[diff] [blame]93
Misha Brukman38ca9be2004-07-01 16:04:49 +0000[diff] [blame]94</ul>
95
96</div>
97
98<!-- *********************************************************************** -->
99<div class="doc_section">
100 <a name="debug">Debugging Tools</a>
101</div>
102<!-- *********************************************************************** -->
Chris Lattnerd053efd2003-10-07 20:05:23 +0000[diff] [blame]103
104
Misha Brukman38ca9be2004-07-01 16:04:49 +0000[diff] [blame]105<div class="doc_text">
106
107<ul>
108
Reid Spencer944b7f22007-08-05 23:43:44 +0000[diff] [blame]109<li><a href="/cmds/bugpoint.html"><b>bugpoint</b></a> -
Misha Brukman38ca9be2004-07-01 16:04:49 +0000[diff] [blame]110 automatic test-case reducer</li>
111
Reid Spencer944b7f22007-08-05 23:43:44 +0000[diff] [blame]112<li><a href="/cmds/llvm-extract.html"><b>llvm-extract</b></a> -
Misha Brukman38ca9be2004-07-01 16:04:49 +0000[diff] [blame]113 extract a function from an LLVM bytecode file</li>
114
Reid Spencer944b7f22007-08-05 23:43:44 +0000[diff] [blame]115<li><a href="/cmds/llvm-bcanalyzer.html"><b>llvm-bcanalyzer</b></a> -
Misha Brukman95bba872004-07-01 16:59:05 +0000[diff] [blame]116 bytecode analyzer (analyzes the binary encoding itself, not the program it
117 represents)</li>
118
Misha Brukman38ca9be2004-07-01 16:04:49 +0000[diff] [blame]119</ul>
Chris Lattnerc95cf1d2006-06-02 17:43:38 +0000[diff] [blame]120</div>
Misha Brukman38ca9be2004-07-01 16:04:49 +0000[diff] [blame]121
Chris Lattnerc95cf1d2006-06-02 17:43:38 +0000[diff] [blame]122<!-- *********************************************************************** -->
123<div class="doc_section">
124 <a name="internal">Internal Tools</a>
125</div>
126<!-- *********************************************************************** -->
127
128<div class="doc_text">
129<ul>
130
Reid Spencer944b7f22007-08-05 23:43:44 +0000[diff] [blame]131<li><a href="/cmds/tblgen.html"><b>tblgen</b></a> -
Chris Lattnerc95cf1d2006-06-02 17:43:38 +0000[diff] [blame]132 target description reader and generator</li>
133
134</ul>
Misha Brukman38ca9be2004-07-01 16:04:49 +0000[diff] [blame]135</div>
136
137<!-- *********************************************************************** -->
138
139<hr>
140<address>
141 <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
Misha Brukman39309df2008-12-11 17:12:52 +0000[diff] [blame]142 src="http://jigsaw.w3.org/css-validator/images/vcss-blue" alt="Valid CSS"></a>
Misha Brukman38ca9be2004-07-01 16:04:49 +0000[diff] [blame]143 <a href="http://validator.w3.org/check/referer"><img
Misha Brukman39309df2008-12-11 17:12:52 +0000[diff] [blame]144 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]145
Reid Spencercd143fc2006-03-14 05:42:07 +0000[diff] [blame]146 <a href="http://llvm.org">LLVM Compiler Infrastructure</a><br>
Misha Brukman38ca9be2004-07-01 16:04:49 +0000[diff] [blame]147 Last modified: $Date$
148</address>
Chris Lattnerd053efd2003-10-07 20:05:23 +0000[diff] [blame]149
Misha Brukmanc6ad94c2003-10-31 00:39:28 +0000[diff] [blame]150</body>
John Criswellecf32e52003-09-11 19:58:03 +0000[diff] [blame]151</html>