summaryrefslogtreecommitdiff
path: root/docs/CommandGuide/index.html
blob: 8854fbbebe6b8001f50117fda03ced2277853686 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
                      "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
  <title>LLVM Command Guide</title>
  <link rel="stylesheet" href="/docs/llvm.css" type="text/css">
</head>
<body>

<div class="doc_title">
  LLVM Command Guide
</div>

<div class="doc_text">

<p>These documents are HTML versions of the <a href="man/man1/">man pages</a>
for all of the LLVM tools.  These pages describe how to use the LLVM commands
and what their options are.  Note that these pages do not describe all of the
options available for all tools.  To get a complete listing, pass the
<tt>-help</tt> (general options) or <tt>-help-hidden</tt> (general+debugging
options) arguments to the tool you are interested in.</p>

</div>

<!-- *********************************************************************** -->
<div class="doc_section">
  <a name="basic">Basic Commands</a>
</div>
<!-- *********************************************************************** -->

<div class="doc_text">

<ul>

<li><a href="/cmds/llvm-as.html"><b>llvm-as</b></a> -
    assemble a human-readable .ll file into bytecode</li>

<li><a href="/cmds/llvm-dis.html"><b>llvm-dis</b></a> -
    disassemble a bytecode file into a human-readable .ll file</li>

<li><a href="/cmds/opt.html"><b>opt</b></a> -
    run a series of LLVM-to-LLVM optimizations on a bytecode file</li>

<li><a href="/cmds/llc.html"><b>llc</b></a> -
    generate native machine code for a bytecode file</li>

<li><a href="/cmds/lli.html"><b>lli</b></a> -
    directly run a program compiled to bytecode using a JIT compiler or
    interpreter</li>

<li><a href="/cmds/llvm-link.html"><b>llvm-link</b></a> -
    link several bytecode files into one</li>

<li><a href="/cmds/llvm-ar.html"><b>llvm-ar</b></a> -
    archive bytecode files</li>

<li><a href="/cmds/llvm-ranlib.html"><b>llvm-ranlib</b></a> -
    create an index for archives made with llvm-ar</li>

<li><a href="/cmds/llvm-nm.html"><b>llvm-nm</b></a> -
    print out the names and types of symbols in a bytecode file</li>

<li><a href="/cmds/llvm-prof.html"><b>llvm-prof</b></a> -
    format raw `<tt>llvmprof.out</tt>' data into a human-readable report</li>

<li><a href="/cmds/llvm-ld.html"><b>llvm-ld</b></a> -
    general purpose linker with loadable runtime optimization support</li>

<li><a href="/cmds/llvm-config.html"><b>llvm-config</b></a> -
    print out LLVM compilation options, libraries, etc. as configured</li>

<li><a href="/cmds/llvmc.html"><b>llvmc</b></a> -
    a generic customizable compiler driver</li>

<li><a href="/cmds/llvm-diff.html"><b>llvm-diff</b></a> -
    structurally compare two modules</li>

</ul>

</div>

<!-- *********************************************************************** -->
<div class="doc_section">
  <a name="frontend">C and C++ Front-end Commands</a>
</div>
<!-- *********************************************************************** -->

<div class="doc_text">
<ul>

<li><a href="/cmds/llvmgcc.html"><b>llvm-gcc</b></a> -
    GCC-based C front-end for LLVM

<li><a href="/cmds/llvmgxx.html"><b>llvm-g++</b></a> -
    GCC-based C++ front-end for LLVM</li>

</ul>

</div>

<!-- *********************************************************************** -->
<div class="doc_section">
  <a name="debug">Debugging Tools</a>
</div>
<!-- *********************************************************************** -->


<div class="doc_text">

<ul>

<li><a href="/cmds/bugpoint.html"><b>bugpoint</b></a> -
    automatic test-case reducer</li>

<li><a href="/cmds/llvm-extract.html"><b>llvm-extract</b></a> -
    extract a function from an LLVM bytecode file</li>

<li><a href="/cmds/llvm-bcanalyzer.html"><b>llvm-bcanalyzer</b></a> -
    bytecode analyzer (analyzes the binary encoding itself, not the program it
    represents)</li>

</ul>
</div>

<!-- *********************************************************************** -->
<div class="doc_section">
  <a name="internal">Internal Tools</a>
</div>
<!-- *********************************************************************** -->

<div class="doc_text">
<ul>

<li><a href="/cmds/FileCheck.html"><b>FileCheck</b></a> -
    Flexible file verifier used extensively by the testing harness</li>
<li><a href="/cmds/tblgen.html"><b>tblgen</b></a> -
    target description reader and generator</li>
<li><a href="/cmds/lit.html"><b>lit</b></a> -
    LLVM Integrated Tester, for running tests</li>

</ul>
</div>

<!-- *********************************************************************** -->

<hr>
<address>
  <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
  src="http://jigsaw.w3.org/css-validator/images/vcss-blue" alt="Valid CSS"></a>
  <a href="http://validator.w3.org/check/referer"><img
  src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a>

  <a href="http://llvm.org">LLVM Compiler Infrastructure</a><br>
  Last modified: $Date$
</address>

</body>
</html>