Dan Gohman | f17a25c | 2007-07-18 16:29:46 +0000 | [diff] [blame] | 1 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" |
| 2 | "http://www.w3.org/TR/html4/strict.dtd"> |
| 3 | <html> |
| 4 | <head> |
| 5 | <title>LLVM Command Guide</title> |
| 6 | <link rel="stylesheet" href="/docs/llvm.css" type="text/css"> |
| 7 | </head> |
| 8 | <body> |
| 9 | |
| 10 | <div class="doc_title"> |
| 11 | LLVM Command Guide |
| 12 | </div> |
| 13 | |
| 14 | <div class="doc_text"> |
| 15 | |
| 16 | <p>These documents are HTML versions of the <a href="man/man1/">man pages</a> |
| 17 | for all of the LLVM tools. These pages describe how to use the LLVM commands |
| 18 | and what their options are. Note that these pages do not describe all of the |
| 19 | options available for all tools. To get a complete listing, pass the |
| 20 | <tt>--help</tt> (general options) or <tt>--help-hidden</tt> (general+debugging |
| 21 | options) arguments to the tool you are interested in.</p> |
| 22 | |
| 23 | </div> |
| 24 | |
| 25 | <!-- *********************************************************************** --> |
| 26 | <div class="doc_section"> |
| 27 | <a name="basic">Basic Commands</a> |
| 28 | </div> |
| 29 | <!-- *********************************************************************** --> |
| 30 | |
| 31 | <div class="doc_text"> |
| 32 | |
| 33 | <ul> |
| 34 | |
Reid Spencer | 76f73d1 | 2007-08-05 23:43:44 +0000 | [diff] [blame] | 35 | <li><a href="/cmds/llvm-as.html"><b>llvm-as</b></a> - |
Dan Gohman | f17a25c | 2007-07-18 16:29:46 +0000 | [diff] [blame] | 36 | assemble a human-readable .ll file into bytecode</li> |
| 37 | |
Reid Spencer | 76f73d1 | 2007-08-05 23:43:44 +0000 | [diff] [blame] | 38 | <li><a href="/cmds/llvm-dis.html"><b>llvm-dis</b></a> - |
Dan Gohman | f17a25c | 2007-07-18 16:29:46 +0000 | [diff] [blame] | 39 | disassemble a bytecode file into a human-readable .ll file</li> |
| 40 | |
Reid Spencer | 76f73d1 | 2007-08-05 23:43:44 +0000 | [diff] [blame] | 41 | <li><a href="/cmds/opt.html"><b>opt</b></a> - |
Dan Gohman | f17a25c | 2007-07-18 16:29:46 +0000 | [diff] [blame] | 42 | run a series of LLVM-to-LLVM optimizations on a bytecode file</li> |
| 43 | |
Reid Spencer | 76f73d1 | 2007-08-05 23:43:44 +0000 | [diff] [blame] | 44 | <li><a href="/cmds/llc.html"><b>llc</b></a> - |
Dan Gohman | f17a25c | 2007-07-18 16:29:46 +0000 | [diff] [blame] | 45 | generate native machine code for a bytecode file</li> |
| 46 | |
Reid Spencer | 76f73d1 | 2007-08-05 23:43:44 +0000 | [diff] [blame] | 47 | <li><a href="/cmds/lli.html"><b>lli</b></a> - |
Dan Gohman | f17a25c | 2007-07-18 16:29:46 +0000 | [diff] [blame] | 48 | directly run a program compiled to bytecode using a JIT compiler or |
| 49 | interpreter</li> |
| 50 | |
Reid Spencer | 76f73d1 | 2007-08-05 23:43:44 +0000 | [diff] [blame] | 51 | <li><a href="/cmds/llvm-link.html"><b>llvm-link</b></a> - |
Dan Gohman | f17a25c | 2007-07-18 16:29:46 +0000 | [diff] [blame] | 52 | link several bytecode files into one</li> |
| 53 | |
Reid Spencer | 76f73d1 | 2007-08-05 23:43:44 +0000 | [diff] [blame] | 54 | <li><a href="/cmds/llvm-ar.html"><b>llvm-ar</b></a> - |
Dan Gohman | f17a25c | 2007-07-18 16:29:46 +0000 | [diff] [blame] | 55 | archive bytecode files</li> |
| 56 | |
Reid Spencer | 76f73d1 | 2007-08-05 23:43:44 +0000 | [diff] [blame] | 57 | <li><a href="/cmds/llvm-ranlib.html"><b>llvm-ranlib</b></a> - |
Dan Gohman | f17a25c | 2007-07-18 16:29:46 +0000 | [diff] [blame] | 58 | create an index for archives made with llvm-ar</li> |
| 59 | |
Reid Spencer | 76f73d1 | 2007-08-05 23:43:44 +0000 | [diff] [blame] | 60 | <li><a href="/cmds/llvm-nm.html"><b>llvm-nm</b></a> - |
Dan Gohman | f17a25c | 2007-07-18 16:29:46 +0000 | [diff] [blame] | 61 | print out the names and types of symbols in a bytecode file</li> |
| 62 | |
Reid Spencer | 76f73d1 | 2007-08-05 23:43:44 +0000 | [diff] [blame] | 63 | <li><a href="/cmds/llvm-prof.html"><b>llvm-prof</b></a> - |
Dan Gohman | f17a25c | 2007-07-18 16:29:46 +0000 | [diff] [blame] | 64 | format raw `<tt>llvmprof.out</tt>' data into a human-readable report</li> |
| 65 | |
Reid Spencer | 76f73d1 | 2007-08-05 23:43:44 +0000 | [diff] [blame] | 66 | <li><a href="/cmds/llvm-ld.html"><b>llvm-ld</b></a> - |
Dan Gohman | f17a25c | 2007-07-18 16:29:46 +0000 | [diff] [blame] | 67 | general purpose linker with loadable runtime optimization support</li> |
| 68 | |
Reid Spencer | 76f73d1 | 2007-08-05 23:43:44 +0000 | [diff] [blame] | 69 | <li><a href="/cmds/llvm-config.html"><b>llvm-config</b></a> - |
Dan Gohman | f17a25c | 2007-07-18 16:29:46 +0000 | [diff] [blame] | 70 | print out LLVM compilation options, libraries, etc. as configured.</li> |
| 71 | |
Dan Gohman | f17a25c | 2007-07-18 16:29:46 +0000 | [diff] [blame] | 72 | </ul> |
| 73 | |
| 74 | </div> |
| 75 | |
| 76 | <!-- *********************************************************************** --> |
| 77 | <div class="doc_section"> |
| 78 | <a name="frontend">C, C++, and Stacker Front-end Commands</a> |
| 79 | </div> |
| 80 | <!-- *********************************************************************** --> |
| 81 | |
| 82 | <div class="doc_text"> |
| 83 | <ul> |
| 84 | |
Chris Lattner | b71250f | 2008-08-06 05:56:52 +0000 | [diff] [blame^] | 85 | <li><a href="/cmds/llvmgcc.html"><b>llvm-gcc</b></a> - |
Dan Gohman | f17a25c | 2007-07-18 16:29:46 +0000 | [diff] [blame] | 86 | GCC-based C front-end for LLVM |
| 87 | |
Chris Lattner | b71250f | 2008-08-06 05:56:52 +0000 | [diff] [blame^] | 88 | <li><a href="/cmds/llvmgxx.html"><b>llvm-g++</b></a> - |
Dan Gohman | f17a25c | 2007-07-18 16:29:46 +0000 | [diff] [blame] | 89 | GCC-based C++ front-end for LLVM</li> |
| 90 | |
Dan Gohman | f17a25c | 2007-07-18 16:29:46 +0000 | [diff] [blame] | 91 | </ul> |
| 92 | |
| 93 | </div> |
| 94 | |
| 95 | <!-- *********************************************************************** --> |
| 96 | <div class="doc_section"> |
| 97 | <a name="debug">Debugging Tools</a> |
| 98 | </div> |
| 99 | <!-- *********************************************************************** --> |
| 100 | |
| 101 | |
| 102 | <div class="doc_text"> |
| 103 | |
| 104 | <ul> |
| 105 | |
Reid Spencer | 76f73d1 | 2007-08-05 23:43:44 +0000 | [diff] [blame] | 106 | <li><a href="/cmds/bugpoint.html"><b>bugpoint</b></a> - |
Dan Gohman | f17a25c | 2007-07-18 16:29:46 +0000 | [diff] [blame] | 107 | automatic test-case reducer</li> |
| 108 | |
Reid Spencer | 76f73d1 | 2007-08-05 23:43:44 +0000 | [diff] [blame] | 109 | <li><a href="/cmds/llvm-extract.html"><b>llvm-extract</b></a> - |
Dan Gohman | f17a25c | 2007-07-18 16:29:46 +0000 | [diff] [blame] | 110 | extract a function from an LLVM bytecode file</li> |
| 111 | |
Reid Spencer | 76f73d1 | 2007-08-05 23:43:44 +0000 | [diff] [blame] | 112 | <li><a href="/cmds/llvm-bcanalyzer.html"><b>llvm-bcanalyzer</b></a> - |
Dan Gohman | f17a25c | 2007-07-18 16:29:46 +0000 | [diff] [blame] | 113 | bytecode analyzer (analyzes the binary encoding itself, not the program it |
| 114 | represents)</li> |
| 115 | |
| 116 | </ul> |
| 117 | </div> |
| 118 | |
| 119 | <!-- *********************************************************************** --> |
| 120 | <div class="doc_section"> |
| 121 | <a name="internal">Internal Tools</a> |
| 122 | </div> |
| 123 | <!-- *********************************************************************** --> |
| 124 | |
| 125 | <div class="doc_text"> |
| 126 | <ul> |
| 127 | |
Reid Spencer | 76f73d1 | 2007-08-05 23:43:44 +0000 | [diff] [blame] | 128 | <li><a href="/cmds/tblgen.html"><b>tblgen</b></a> - |
Dan Gohman | f17a25c | 2007-07-18 16:29:46 +0000 | [diff] [blame] | 129 | target description reader and generator</li> |
| 130 | |
| 131 | </ul> |
| 132 | </div> |
| 133 | |
| 134 | <!-- *********************************************************************** --> |
| 135 | |
| 136 | <hr> |
| 137 | <address> |
| 138 | <a href="http://jigsaw.w3.org/css-validator/check/referer"><img |
| 139 | src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a> |
| 140 | <a href="http://validator.w3.org/check/referer"><img |
| 141 | src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!"></a> |
| 142 | |
| 143 | <a href="http://llvm.org">LLVM Compiler Infrastructure</a><br> |
| 144 | Last modified: $Date$ |
| 145 | </address> |
| 146 | |
| 147 | </body> |
| 148 | </html> |