Gitiles
Code Review Sign In
gerrit-public.fairphone.software / fp2-dev / platform / external / llvm / 78bf32b02bc63bd497b60dc49b11cf5c67f765ff / . / docs / CommandGuide / index.html
blob: baab3ed8312785633c65221397e21c48dad1fe7d [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
Reid Spencer38f98b52004-11-29 04:32:37 +0000[diff] [blame]35<li><a href="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 Spencer38f98b52004-11-29 04:32:37 +0000[diff] [blame]38<li><a href="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 Spencer38f98b52004-11-29 04:32:37 +0000[diff] [blame]41<li><a href="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
Reid Spencer38f98b52004-11-29 04:32:37 +0000[diff] [blame]44<li><a href="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
Reid Spencer38f98b52004-11-29 04:32:37 +0000[diff] [blame]47<li><a href="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
Reid Spencer38f98b52004-11-29 04:32:37 +0000[diff] [blame]51<li><a href="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
Reid Spencer38f98b52004-11-29 04:32:37 +0000[diff] [blame]54<li><a href="analyze.html"><b>analyze</b></a> -
Chris Lattner1a5a79c2004-07-10 06:06:56 +0000[diff] [blame]55 run LLVM analyses on a bytecode file and print the results</li>
56
Reid Spencer38f98b52004-11-29 04:32:37 +0000[diff] [blame]57<li><a href="llvm-ar.html"><b>llvm-ar</b></a> -
Reid Spencer0aa18992004-11-11 09:30:00 +0000[diff] [blame]58 archive bytecode files</li>
59
Reid Spencer38f98b52004-11-29 04:32:37 +0000[diff] [blame]60<li><a href="llvm-ranlib.html"><b>llvm-ranlib</b></a> -
Misha Brukmanbbcb10f2004-11-15 19:53:43 +0000[diff] [blame]61 create an index for archives made with llvm-ar</li>
62
Reid Spencer38f98b52004-11-29 04:32:37 +0000[diff] [blame]63<li><a href="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
Reid Spencer38f98b52004-11-29 04:32:37 +0000[diff] [blame]66<li><a href="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
Reid Spencer38f98b52004-11-29 04:32:37 +0000[diff] [blame]69<li><a href="llvmc.html"><b>llvmc</b></a> -
70 generic and configurable compiler driver</li>
71
72<li><a href="llvm-ld.html"><b>llvm-ld</b></a> -
73 general purpose linker with loadable runtime optimization support</li>
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 Lattner9099e3e2004-07-10 21:43:12 +0000[diff] [blame]81 <a name="frontend">C, C++, and Stacker 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
Reid Spencer38f98b52004-11-29 04:32:37 +0000[diff] [blame]88<li><a href="llvmgcc.html"><b>llvmgcc</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
Reid Spencer38f98b52004-11-29 04:32:37 +0000[diff] [blame]91<li><a href="llvmgxx.html"><b>llvmg++</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
Reid Spencer38f98b52004-11-29 04:32:37 +0000[diff] [blame]94<li><a href="gccas.html"><b>gccas</b></a> -
Chris Lattner1a5a79c2004-07-10 06:06:56 +0000[diff] [blame]95 compile-time optimizer used by llvm-g++ and llvm-gcc</li>
Misha Brukman38ca9be2004-07-01 16:04:49 +0000[diff] [blame]96
Reid Spencer38f98b52004-11-29 04:32:37 +0000[diff] [blame]97<li><a href="gccld.html"><b>gccld</b></a> -
Chris Lattner1a5a79c2004-07-10 06:06:56 +0000[diff] [blame]98 linker and link-time optimizer used by llvm-g++ and llvm-gcc</li>
Misha Brukman38ca9be2004-07-01 16:04:49 +0000[diff] [blame]99
Reid Spencer38f98b52004-11-29 04:32:37 +0000[diff] [blame]100<li><a href="stkrc.html"><b>stkrc</b></a> -
Chris Lattner9099e3e2004-07-10 21:43:12 +0000[diff] [blame]101 front-end compiler for the <a href="../Stacker.html">Stacker</a>
102 language</li>
103
Misha Brukman38ca9be2004-07-01 16:04:49 +0000[diff] [blame]104</ul>
105
106</div>
107
108<!-- *********************************************************************** -->
109<div class="doc_section">
110 <a name="debug">Debugging Tools</a>
111</div>
112<!-- *********************************************************************** -->
Chris Lattnerd053efd2003-10-07 20:05:23 +0000[diff] [blame]113
114
Misha Brukman38ca9be2004-07-01 16:04:49 +0000[diff] [blame]115<div class="doc_text">
116
117<ul>
118
Reid Spencer38f98b52004-11-29 04:32:37 +0000[diff] [blame]119<li><a href="bugpoint.html"><b>bugpoint</b></a> -
Misha Brukman38ca9be2004-07-01 16:04:49 +0000[diff] [blame]120 automatic test-case reducer</li>
121
Reid Spencer38f98b52004-11-29 04:32:37 +0000[diff] [blame]122<li><a href="extract.html"><b>extract</b></a> -
Misha Brukman38ca9be2004-07-01 16:04:49 +0000[diff] [blame]123 extract a function from an LLVM bytecode file</li>
124
Reid Spencer38f98b52004-11-29 04:32:37 +0000[diff] [blame]125<li><a href="llvm-bcanalyzer.html"><b>llvm-bcanalyzer</b></a> -
Misha Brukman95bba872004-07-01 16:59:05 +0000[diff] [blame]126 bytecode analyzer (analyzes the binary encoding itself, not the program it
127 represents)</li>
128
Misha Brukman38ca9be2004-07-01 16:04:49 +0000[diff] [blame]129</ul>
130
131</div>
132
133<!-- *********************************************************************** -->
134
135<hr>
136<address>
137 <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
138 src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a>
139 <a href="http://validator.w3.org/check/referer"><img
140 src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!"></a>
141
Misha Brukman38ca9be2004-07-01 16:04:49 +0000[diff] [blame]142 <a href="http://llvm.cs.uiuc.edu">LLVM Compiler Infrastructure</a><br>
143 Last modified: $Date$
144</address>
Chris Lattnerd053efd2003-10-07 20:05:23 +0000[diff] [blame]145
Misha Brukmanc6ad94c2003-10-31 00:39:28 +0000[diff] [blame]146</body>
John Criswellecf32e52003-09-11 19:58:03 +0000[diff] [blame]147</html>