Gitiles
Code Review Sign In
gerrit-public.fairphone.software / fp2-dev / platform / external / llvm / eae5a13078037e6b6591fd4f414452a7075cecf7 / . / docs / CommandGuide / index.html
blob: 6f217db4d0e056f26a667855395e1c8fd7408633 [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>
NAKAMURA Takumiee699262011-04-11 03:27:38 +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
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]10<h1>
Misha Brukman38ca9be2004-07-01 16:04:49 +0000[diff] [blame]11 LLVM Command Guide
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]12</h1>
John Criswellecf32e52003-09-11 19:58:03 +0000[diff] [blame]13
NAKAMURA Takumif5af6ad2011-04-23 00:30:22 +0000[diff] [blame]14<div>
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
Duncan Sands7e7ae5a2010-02-18 14:08:13 +0000[diff] [blame]20<tt>-help</tt> (general options) or <tt>-help-hidden</tt> (general+debugging
Chris Lattner1a5a79c2004-07-10 06:06:56 +0000[diff] [blame]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
Tanya Lattner10934e82010-05-11 16:47:42 +0000[diff] [blame]25<!-- *********************************************************************** -->
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]26<h2>
Misha Brukman38ca9be2004-07-01 16:04:49 +0000[diff] [blame]27 <a name="basic">Basic Commands</a>
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]28</h2>
Misha Brukman38ca9be2004-07-01 16:04:49 +0000[diff] [blame]29<!-- *********************************************************************** -->
John Criswellecf32e52003-09-11 19:58:03 +0000[diff] [blame]30
NAKAMURA Takumif5af6ad2011-04-23 00:30:22 +0000[diff] [blame]31<div>
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
mike-me2c3a492010-05-07 00:28:04 +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
mike-me2c3a492010-05-07 00:28:04 +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
mike-me2c3a492010-05-07 00:28:04 +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
mike-me2c3a492010-05-07 00:28:04 +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
mike-me2c3a492010-05-07 00:28:04 +0000[diff] [blame]47<li><a href="/cmds/lli.html"><b>lli</b></a> -
Mikhail Glushenkova606d1f2008-11-25 21:38:38 +0000[diff] [blame]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
mike-me2c3a492010-05-07 00:28:04 +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
mike-me2c3a492010-05-07 00:28:04 +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
mike-me2c3a492010-05-07 00:28:04 +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
mike-me2c3a492010-05-07 00:28:04 +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
mike-me2c3a492010-05-07 00:28:04 +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
mike-me2c3a492010-05-07 00:28:04 +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
mike-me2c3a492010-05-07 00:28:04 +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
John McCall8c359362010-09-07 23:10:21 +0000[diff] [blame]72<li><a href="/cmds/llvm-diff.html"><b>llvm-diff</b></a> -
73 structurally compare two modules</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<!-- *********************************************************************** -->
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]80<h2>
Chris Lattner01924d02008-08-06 05:57:58 +0000[diff] [blame]81 <a name="frontend">C and C++ Front-end Commands</a>
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]82</h2>
Misha Brukman38ca9be2004-07-01 16:04:49 +0000[diff] [blame]83<!-- *********************************************************************** -->
John Criswell32003302003-09-11 20:23:52 +0000[diff] [blame]84
NAKAMURA Takumif5af6ad2011-04-23 00:30:22 +0000[diff] [blame]85<div>
Misha Brukman38ca9be2004-07-01 16:04:49 +0000[diff] [blame]86<ul>
Chris Lattnerd053efd2003-10-07 20:05:23 +0000[diff] [blame]87
mike-me2c3a492010-05-07 00:28:04 +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
mike-me2c3a492010-05-07 00:28:04 +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<!-- *********************************************************************** -->
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]99<h2>
Misha Brukman38ca9be2004-07-01 16:04:49 +0000[diff] [blame]100 <a name="debug">Debugging Tools</a>
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]101</h2>
Misha Brukman38ca9be2004-07-01 16:04:49 +0000[diff] [blame]102<!-- *********************************************************************** -->
Chris Lattnerd053efd2003-10-07 20:05:23 +0000[diff] [blame]103
104
NAKAMURA Takumif5af6ad2011-04-23 00:30:22 +0000[diff] [blame]105<div>
Misha Brukman38ca9be2004-07-01 16:04:49 +0000[diff] [blame]106
107<ul>
108
mike-me2c3a492010-05-07 00:28:04 +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
mike-me2c3a492010-05-07 00:28:04 +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
mike-me2c3a492010-05-07 00:28:04 +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<!-- *********************************************************************** -->
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]123<h2>
Chris Lattnerc95cf1d2006-06-02 17:43:38 +0000[diff] [blame]124 <a name="internal">Internal Tools</a>
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]125</h2>
Chris Lattnerc95cf1d2006-06-02 17:43:38 +0000[diff] [blame]126<!-- *********************************************************************** -->
127
NAKAMURA Takumif5af6ad2011-04-23 00:30:22 +0000[diff] [blame]128<div>
Chris Lattnerc95cf1d2006-06-02 17:43:38 +0000[diff] [blame]129<ul>
130
mike-me2c3a492010-05-07 00:28:04 +0000[diff] [blame]131<li><a href="/cmds/FileCheck.html"><b>FileCheck</b></a> -
Chris Lattner9d3787b2009-08-15 15:38:11 +0000[diff] [blame]132 Flexible file verifier used extensively by the testing harness</li>
mike-me2c3a492010-05-07 00:28:04 +0000[diff] [blame]133<li><a href="/cmds/tblgen.html"><b>tblgen</b></a> -
Chris Lattnerc95cf1d2006-06-02 17:43:38 +0000[diff] [blame]134 target description reader and generator</li>
mike-me2c3a492010-05-07 00:28:04 +0000[diff] [blame]135<li><a href="/cmds/lit.html"><b>lit</b></a> -
Daniel Dunbar8b828a82009-10-19 03:54:13 +0000[diff] [blame]136 LLVM Integrated Tester, for running tests</li>
Chris Lattnerc95cf1d2006-06-02 17:43:38 +0000[diff] [blame]137
138</ul>
Misha Brukman38ca9be2004-07-01 16:04:49 +0000[diff] [blame]139</div>
140
141<!-- *********************************************************************** -->
142
143<hr>
144<address>
145 <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
Misha Brukman39309df2008-12-11 17:12:52 +0000[diff] [blame]146 src="http://jigsaw.w3.org/css-validator/images/vcss-blue" alt="Valid CSS"></a>
Misha Brukman38ca9be2004-07-01 16:04:49 +0000[diff] [blame]147 <a href="http://validator.w3.org/check/referer"><img
Misha Brukman39309df2008-12-11 17:12:52 +0000[diff] [blame]148 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]149
NAKAMURA Takumib9a33632011-04-09 02:13:37 +0000[diff] [blame]150 <a href="http://llvm.org/">LLVM Compiler Infrastructure</a><br>
Misha Brukman38ca9be2004-07-01 16:04:49 +0000[diff] [blame]151 Last modified: $Date$
152</address>
Chris Lattnerd053efd2003-10-07 20:05:23 +0000[diff] [blame]153
Misha Brukmanc6ad94c2003-10-31 00:39:28 +0000[diff] [blame]154</body>
John Criswellecf32e52003-09-11 19:58:03 +0000[diff] [blame]155</html>