Gitiles
Code Review Sign In
gerrit-public.fairphone.software / fp2-dev / platform / external / llvm / e53b5c10e34d8e3a4cc43b0a7c7b5a4256cc1809 / . / docs / CommandGuide / index.html
blob: 30d0486f456ef0fa0348ad0eee7b32c22ddac668 [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>
Misha Brukman38ca9be2004-07-01 16:04:49 +0000[diff] [blame]6 <link rel="stylesheet" href="../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
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 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
Misha Brukman66a72ef2004-07-02 15:46:55 +0000[diff] [blame]35<li><a href="html/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
Misha Brukman66a72ef2004-07-02 15:46:55 +0000[diff] [blame]38<li><a href="html/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
Misha Brukman66a72ef2004-07-02 15:46:55 +0000[diff] [blame]41<li><a href="html/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
Misha Brukman66a72ef2004-07-02 15:46:55 +0000[diff] [blame]44<li><a href="html/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
Misha Brukman66a72ef2004-07-02 15:46:55 +0000[diff] [blame]47<li><a href="html/lli.html"><b>lli</b></a> -
Chris Lattner1a5a79c2004-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 Criswellecf32e52003-09-11 19:58:03 +0000[diff] [blame]50
Misha Brukmanbbcb10f2004-11-15 19:53:43 +0000[diff] [blame]51<li><a href="html/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
Chris Lattner1a5a79c2004-07-10 06:06:56 +0000[diff] [blame]54<li><a href="html/analyze.html"><b>analyze</b></a> -
55 run LLVM analyses on a bytecode file and print the results</li>
56
Reid Spencer0aa18992004-11-11 09:30:00 +0000[diff] [blame]57<li><a href="html/llvm-ar.html"><b>llvm-ar</b></a> -
58 archive bytecode files</li>
59
Misha Brukmanbbcb10f2004-11-15 19:53:43 +0000[diff] [blame]60<li><a href="html/llvm-ranlib.html"><b>llvm-ranlib</b></a> -
61 create an index for archives made with llvm-ar</li>
62
63<li><a href="html/llvm-nm.html"><b>llvm-nm</b></a> -
Misha Brukman38ca9be2004-07-01 16:04:49 +0000[diff] [blame]64 print out the names and types of symbols in a bytecode file</li>
John Criswell32003302003-09-11 20:23:52 +0000[diff] [blame]65
Misha Brukman66a72ef2004-07-02 15:46:55 +0000[diff] [blame]66<li><a href="html/llvm-prof.html"><b>llvm-prof</b></a> -
Chris Lattner1a5a79c2004-07-10 06:06:56 +0000[diff] [blame]67 format raw `<tt>llvmprof.out</tt>' data into a human-readable report</li>
John Criswellaa5ff242003-10-03 13:48:27 +0000[diff] [blame]68
Misha Brukman38ca9be2004-07-01 16:04:49 +0000[diff] [blame]69</ul>
John Criswellaa5ff242003-10-03 13:48:27 +0000[diff] [blame]70
Misha Brukman38ca9be2004-07-01 16:04:49 +0000[diff] [blame]71</div>
John Criswell32003302003-09-11 20:23:52 +0000[diff] [blame]72
Misha Brukman38ca9be2004-07-01 16:04:49 +0000[diff] [blame]73<!-- *********************************************************************** -->
74<div class="doc_section">
Chris Lattner9099e3e2004-07-10 21:43:12 +0000[diff] [blame]75 <a name="frontend">C, C++, and Stacker Front-end Commands</a>
Misha Brukman38ca9be2004-07-01 16:04:49 +0000[diff] [blame]76</div>
77<!-- *********************************************************************** -->
John Criswell32003302003-09-11 20:23:52 +0000[diff] [blame]78
Misha Brukman38ca9be2004-07-01 16:04:49 +0000[diff] [blame]79<div class="doc_text">
Misha Brukman38ca9be2004-07-01 16:04:49 +0000[diff] [blame]80<ul>
Chris Lattnerd053efd2003-10-07 20:05:23 +0000[diff] [blame]81
Misha Brukman66a72ef2004-07-02 15:46:55 +0000[diff] [blame]82<li><a href="html/llvmgcc.html"><b>llvmgcc</b></a> -
Chris Lattner1a5a79c2004-07-10 06:06:56 +0000[diff] [blame]83 GCC-based C front-end for LLVM
Misha Brukman38ca9be2004-07-01 16:04:49 +0000[diff] [blame]84
Misha Brukman66a72ef2004-07-02 15:46:55 +0000[diff] [blame]85<li><a href="html/llvmgxx.html"><b>llvmg++</b></a> -
Chris Lattner1a5a79c2004-07-10 06:06:56 +0000[diff] [blame]86 GCC-based C++ front-end for LLVM</li>
Misha Brukman38ca9be2004-07-01 16:04:49 +0000[diff] [blame]87
Misha Brukman66a72ef2004-07-02 15:46:55 +0000[diff] [blame]88<li><a href="html/gccas.html"><b>gccas</b></a> -
Chris Lattner1a5a79c2004-07-10 06:06:56 +0000[diff] [blame]89 compile-time optimizer used by llvm-g++ and llvm-gcc</li>
Misha Brukman38ca9be2004-07-01 16:04:49 +0000[diff] [blame]90
Misha Brukman66a72ef2004-07-02 15:46:55 +0000[diff] [blame]91<li><a href="html/gccld.html"><b>gccld</b></a> -
Chris Lattner1a5a79c2004-07-10 06:06:56 +0000[diff] [blame]92 linker and link-time optimizer used by llvm-g++ and llvm-gcc</li>
Misha Brukman38ca9be2004-07-01 16:04:49 +0000[diff] [blame]93
Chris Lattner9099e3e2004-07-10 21:43:12 +0000[diff] [blame]94<li><a href="html/stkrc.html"><b>stkrc</b></a> -
95 front-end compiler for the <a href="../Stacker.html">Stacker</a>
96 language</li>
97
Misha Brukman38ca9be2004-07-01 16:04:49 +0000[diff] [blame]98</ul>
99
100</div>
101
102<!-- *********************************************************************** -->
103<div class="doc_section">
104 <a name="debug">Debugging Tools</a>
105</div>
106<!-- *********************************************************************** -->
Chris Lattnerd053efd2003-10-07 20:05:23 +0000[diff] [blame]107
108
Misha Brukman38ca9be2004-07-01 16:04:49 +0000[diff] [blame]109<div class="doc_text">
110
111<ul>
112
Misha Brukman66a72ef2004-07-02 15:46:55 +0000[diff] [blame]113<li><a href="html/bugpoint.html"><b>bugpoint</b></a> -
Misha Brukman38ca9be2004-07-01 16:04:49 +0000[diff] [blame]114 automatic test-case reducer</li>
115
Misha Brukman66a72ef2004-07-02 15:46:55 +0000[diff] [blame]116<li><a href="html/extract.html"><b>extract</b></a> -
Misha Brukman38ca9be2004-07-01 16:04:49 +0000[diff] [blame]117 extract a function from an LLVM bytecode file</li>
118
Misha Brukman66a72ef2004-07-02 15:46:55 +0000[diff] [blame]119<li><a href="html/llvm-bcanalyzer.html"><b>llvm-bcanalyzer</b></a> -
Misha Brukman95bba872004-07-01 16:59:05 +0000[diff] [blame]120 bytecode analyzer (analyzes the binary encoding itself, not the program it
121 represents)</li>
122
Misha Brukman38ca9be2004-07-01 16:04:49 +0000[diff] [blame]123</ul>
124
125</div>
126
127<!-- *********************************************************************** -->
128
129<hr>
130<address>
131 <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
132 src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a>
133 <a href="http://validator.w3.org/check/referer"><img
134 src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!"></a>
135
Misha Brukman38ca9be2004-07-01 16:04:49 +0000[diff] [blame]136 <a href="http://llvm.cs.uiuc.edu">LLVM Compiler Infrastructure</a><br>
137 Last modified: $Date$
138</address>
Chris Lattnerd053efd2003-10-07 20:05:23 +0000[diff] [blame]139
Misha Brukmanc6ad94c2003-10-31 00:39:28 +0000[diff] [blame]140</body>
John Criswellecf32e52003-09-11 19:58:03 +0000[diff] [blame]141</html>