Gitiles
Code Review Sign In
gerrit-public.fairphone.software / fp2-dev / platform / external / llvm / 38ca9be9efade42cf9d78fd163d94a115a3807e6 / . / docs / CommandGuide / index.html
blob: 789d85d68b580241151fc866bf3ea37acb8435cf [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 Brukman38ca9be2004-07-01 16:04:49 +0000[diff] [blame^]39<li><a href="llvm-as.html"><b>llvm-as</b></a> -
40 assemble a human-readable program into bytecode</li>
John Criswellecf32e52003-09-11 19:58:03 +0000[diff] [blame]41
Misha Brukman38ca9be2004-07-01 16:04:49 +0000[diff] [blame^]42<li><a href="llvm-dis.html"><b>llvm-dis</b></a> -
43 disassemble a bytecode file into human-readable form</li>
John Criswellecf32e52003-09-11 19:58:03 +0000[diff] [blame]44
Misha Brukman38ca9be2004-07-01 16:04:49 +0000[diff] [blame^]45<li><a href="analyze.html"><b>analyze</b></a> -
46 analyze a bytecode file</li>
Chris Lattnere66e73a2003-11-02 02:10:54 +0000[diff] [blame]47
Misha Brukman38ca9be2004-07-01 16:04:49 +0000[diff] [blame^]48<li><a href="opt.html"><b>opt</b></a> -
49 optimize a bytecode file</li>
Chris Lattnere66e73a2003-11-02 02:10:54 +0000[diff] [blame]50
Misha Brukman38ca9be2004-07-01 16:04:49 +0000[diff] [blame^]51<li><a href="llc.html"><b>llc</b></a> -
52 compile a bytecode program into native machine code</li>
Chris Lattnere66e73a2003-11-02 02:10:54 +0000[diff] [blame]53
Misha Brukman38ca9be2004-07-01 16:04:49 +0000[diff] [blame^]54<li><a href="lli.html"><b>lli</b></a> -
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 Brukman38ca9be2004-07-01 16:04:49 +0000[diff] [blame^]57<li><a href="llvm-link.html"><b>llvm-link</b></A>
58 link several bytecode files into one</li>
John Criswell32003302003-09-11 20:23:52 +0000[diff] [blame]59
Misha Brukman38ca9be2004-07-01 16:04:49 +0000[diff] [blame^]60<li><a href="llvm-nm.html"><b>llvm-nm</b></a>
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 Brukman38ca9be2004-07-01 16:04:49 +0000[diff] [blame^]63<li><a href="llvm-prof.html"><b>llvm-prof</b></a> -
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 Brukman38ca9be2004-07-01 16:04:49 +0000[diff] [blame^]80<li><a href="llvmgcc.html"><b>llvmgcc</b></a> -
81 GCC-based C front end for LLVM
82
83<li><a href="llvmgxx.html"><b>llvmg++</b></a> -
84 GCC-based C++ front end for LLVM</li>
85
86<li><a href="gccas.html"><b>gccas</b></a> -
87 optimizing assembler used by llvm-g++ and llvm-gcc</li>
88
89<li><a href="gccld.html"><b>gccld</b></a> -
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
107<li><a href="bugpoint.html"><b>bugpoint</b></a> -
108 automatic test-case reducer</li>
109
110<li><a href="extract.html"><b>extract</b></a> -
111 extract a function from an LLVM bytecode file</li>
112
113</ul>
114
115</div>
116
117<!-- *********************************************************************** -->
118
119<hr>
120<address>
121 <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
122 src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a>
123 <a href="http://validator.w3.org/check/referer"><img
124 src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!"></a>
125
126 <a href="mailto:criswell at cs dot uiuc dot edu">John Criswell</a><br>
127 <a href="http://llvm.cs.uiuc.edu">LLVM Compiler Infrastructure</a><br>
128 Last modified: $Date$
129</address>
Chris Lattnerd053efd2003-10-07 20:05:23 +0000[diff] [blame]130
Misha Brukmanc6ad94c2003-10-31 00:39:28 +0000[diff] [blame]131</body>
John Criswellecf32e52003-09-11 19:58:03 +0000[diff] [blame]132</html>