Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / llvm / 2439972a618c2a05dd88725e47a372f9825fc4fc / . / docs / CommandGuide / index.html
blob: d549d3a22adae1377ed078c357d27cb0bf29ba21 [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
Misha Brukman38ca9be2004-07-01 16:04:49 +0000[diff] [blame]16<p>This document is the reference manual for the LLVM utilities. It will
17show you how to use the LLVM commands and what their options are. Note that in
18the descriptions below, `bytecode' and `program' refer to LLVM bytecode files
19and assembly programs, respectively.</p>
Chris Lattnerd053efd2003-10-07 20:05:23 +0000[diff] [blame]20
Misha Brukman38ca9be2004-07-01 16:04:49 +0000[diff] [blame]21<ul>
22 <li><a href="#basic">Basic Commands</a></li>
23 <li><a href="#frontend">C and C++ Frond-end Commands</a></li>
24 <li><a href="#debug">Debugging commands</a></li>
25</ul>
Chris Lattnerd053efd2003-10-07 20:05:23 +0000[diff] [blame]26
Misha Brukman38ca9be2004-07-01 16:04:49 +0000[diff] [blame]27</div>
John Criswellecf32e52003-09-11 19:58:03 +0000[diff] [blame]28
Misha Brukman38ca9be2004-07-01 16:04:49 +0000[diff] [blame]29<!-- *********************************************************************** -->
30<div class="doc_section">
31 <a name="basic">Basic Commands</a>
32</div>
33<!-- *********************************************************************** -->
John Criswellecf32e52003-09-11 19:58:03 +0000[diff] [blame]34
Misha Brukman38ca9be2004-07-01 16:04:49 +0000[diff] [blame]35<div class="doc_text">
John Criswellecf32e52003-09-11 19:58:03 +0000[diff] [blame]36
Misha Brukman38ca9be2004-07-01 16:04:49 +0000[diff] [blame]37<ul>
John Criswellecf32e52003-09-11 19:58:03 +0000[diff] [blame]38
Misha Brukman66a72ef2004-07-02 15:46:55 +0000[diff] [blame]39<li><a href="html/llvm-as.html"><b>llvm-as</b></a> -
Misha Brukman38ca9be2004-07-01 16:04:49 +0000[diff] [blame]40 assemble a human-readable program into bytecode</li>
John Criswellecf32e52003-09-11 19:58:03 +0000[diff] [blame]41
Misha Brukman66a72ef2004-07-02 15:46:55 +0000[diff] [blame]42<li><a href="html/llvm-dis.html"><b>llvm-dis</b></a> -
Misha Brukman38ca9be2004-07-01 16:04:49 +0000[diff] [blame]43 disassemble a bytecode file into human-readable form</li>
John Criswellecf32e52003-09-11 19:58:03 +0000[diff] [blame]44
Misha Brukman66a72ef2004-07-02 15:46:55 +0000[diff] [blame]45<li><a href="html/analyze.html"><b>analyze</b></a> -
Misha Brukman95bba872004-07-01 16:59:05 +0000[diff] [blame]46 analyze a program compiled to bytecode</li>
Chris Lattnere66e73a2003-11-02 02:10:54 +0000[diff] [blame]47
Misha Brukman66a72ef2004-07-02 15:46:55 +0000[diff] [blame]48<li><a href="html/opt.html"><b>opt</b></a> -
Misha Brukman38ca9be2004-07-01 16:04:49 +0000[diff] [blame]49 optimize a bytecode file</li>
Chris Lattnere66e73a2003-11-02 02:10:54 +0000[diff] [blame]50
Misha Brukman66a72ef2004-07-02 15:46:55 +0000[diff] [blame]51<li><a href="html/llc.html"><b>llc</b></a> -
Misha Brukman38ca9be2004-07-01 16:04:49 +0000[diff] [blame]52 compile a bytecode program into native machine code</li>
Chris Lattnere66e73a2003-11-02 02:10:54 +0000[diff] [blame]53
Misha Brukman66a72ef2004-07-02 15:46:55 +0000[diff] [blame]54<li><a href="html/lli.html"><b>lli</b></a> -
Misha Brukman38ca9be2004-07-01 16:04:49 +0000[diff] [blame]55 run a bytecode program using either an interpreter or a JIT compiler</li>
John Criswellecf32e52003-09-11 19:58:03 +0000[diff] [blame]56
Misha Brukman66a72ef2004-07-02 15:46:55 +0000[diff] [blame]57<li><a href="html/llvm-link.html"><b>llvm-link</b></A>
Misha Brukman38ca9be2004-07-01 16:04:49 +0000[diff] [blame]58 link several bytecode files into one</li>
John Criswell32003302003-09-11 20:23:52 +0000[diff] [blame]59
Misha Brukman66a72ef2004-07-02 15:46:55 +0000[diff] [blame]60<li><a href="html/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
Misha Brukman66a72ef2004-07-02 15:46:55 +0000[diff] [blame]63<li><a href="html/llvm-prof.html"><b>llvm-prof</b></a> -
Misha Brukman38ca9be2004-07-01 16:04:49 +0000[diff] [blame]64 transform raw `<tt>llvmprof.out</tt>' data into a human-readable report</li>
John Criswellaa5ff242003-10-03 13:48:27 +0000[diff] [blame]65
Misha Brukman38ca9be2004-07-01 16:04:49 +0000[diff] [blame]66</ul>
John Criswellaa5ff242003-10-03 13:48:27 +0000[diff] [blame]67
Misha Brukman38ca9be2004-07-01 16:04:49 +0000[diff] [blame]68</div>
John Criswell32003302003-09-11 20:23:52 +0000[diff] [blame]69
Misha Brukman38ca9be2004-07-01 16:04:49 +0000[diff] [blame]70<!-- *********************************************************************** -->
71<div class="doc_section">
72 <a name="frontend">C and C++ Front-end Commands</a>
73</div>
74<!-- *********************************************************************** -->
John Criswell32003302003-09-11 20:23:52 +0000[diff] [blame]75
Misha Brukman38ca9be2004-07-01 16:04:49 +0000[diff] [blame]76<div class="doc_text">
Chris Lattnerd053efd2003-10-07 20:05:23 +0000[diff] [blame]77
Misha Brukman38ca9be2004-07-01 16:04:49 +0000[diff] [blame]78<ul>
Chris Lattnerd053efd2003-10-07 20:05:23 +0000[diff] [blame]79
Misha Brukman66a72ef2004-07-02 15:46:55 +0000[diff] [blame]80<li><a href="html/llvmgcc.html"><b>llvmgcc</b></a> -
Misha Brukman38ca9be2004-07-01 16:04:49 +0000[diff] [blame]81 GCC-based C front end for LLVM
82
Misha Brukman66a72ef2004-07-02 15:46:55 +0000[diff] [blame]83<li><a href="html/llvmgxx.html"><b>llvmg++</b></a> -
Misha Brukman38ca9be2004-07-01 16:04:49 +0000[diff] [blame]84 GCC-based C++ front end for LLVM</li>
85
Misha Brukman66a72ef2004-07-02 15:46:55 +0000[diff] [blame]86<li><a href="html/gccas.html"><b>gccas</b></a> -
Misha Brukman38ca9be2004-07-01 16:04:49 +0000[diff] [blame]87 optimizing assembler used by llvm-g++ and llvm-gcc</li>
88
Misha Brukman66a72ef2004-07-02 15:46:55 +0000[diff] [blame]89<li><a href="html/gccld.html"><b>gccld</b></a> -
Misha Brukman38ca9be2004-07-01 16:04:49 +0000[diff] [blame]90 optimizing linker used by llvm-g++ and llvm-gcc</li>
91
92</ul>
93
94</div>
95
96<!-- *********************************************************************** -->
97<div class="doc_section">
98 <a name="debug">Debugging Tools</a>
99</div>
100<!-- *********************************************************************** -->
Chris Lattnerd053efd2003-10-07 20:05:23 +0000[diff] [blame]101
102
Misha Brukman38ca9be2004-07-01 16:04:49 +0000[diff] [blame]103<div class="doc_text">
104
105<ul>
106
Misha Brukman66a72ef2004-07-02 15:46:55 +0000[diff] [blame]107<li><a href="html/bugpoint.html"><b>bugpoint</b></a> -
Misha Brukman38ca9be2004-07-01 16:04:49 +0000[diff] [blame]108 automatic test-case reducer</li>
109
Misha Brukman66a72ef2004-07-02 15:46:55 +0000[diff] [blame]110<li><a href="html/extract.html"><b>extract</b></a> -
Misha Brukman38ca9be2004-07-01 16:04:49 +0000[diff] [blame]111 extract a function from an LLVM bytecode file</li>
112
Misha Brukman66a72ef2004-07-02 15:46:55 +0000[diff] [blame]113<li><a href="html/llvm-bcanalyzer.html"><b>llvm-bcanalyzer</b></a> -
Misha Brukman95bba872004-07-01 16:59:05 +0000[diff] [blame]114 bytecode analyzer (analyzes the binary encoding itself, not the program it
115 represents)</li>
116
Misha Brukman38ca9be2004-07-01 16:04:49 +0000[diff] [blame]117</ul>
118
119</div>
120
121<!-- *********************************************************************** -->
122
123<hr>
124<address>
125 <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
126 src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a>
127 <a href="http://validator.w3.org/check/referer"><img
128 src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!"></a>
129
Misha Brukman38ca9be2004-07-01 16:04:49 +0000[diff] [blame]130 <a href="http://llvm.cs.uiuc.edu">LLVM Compiler Infrastructure</a><br>
131 Last modified: $Date$
132</address>
Chris Lattnerd053efd2003-10-07 20:05:23 +0000[diff] [blame]133
Misha Brukmanc6ad94c2003-10-31 00:39:28 +0000[diff] [blame]134</body>
John Criswellecf32e52003-09-11 19:58:03 +0000[diff] [blame]135</html>