Convert this code from using annotations to using a local map
[oota-llvm.git] / docs / CommandGuide / llvm-as.html
1 <html>
2 <title>
3 LLVM: llvm-as tool
4 </title>
5
6 <body bgcolor=white>
7
8 <center><h1>LLVM: <tt>llvm-as</tt> tool</h1></center>
9 <HR>
10
11 <h3>NAME</h3>
12 <tt>llvm-as</tt>
13
14 <h3>SYNOPSIS</h3>
15 <tt>llvm-as [options] [filename]</tt>
16
17 <h3>DESCRIPTION</h3>
18
19 The <tt>llvm-as</tt> command is the LLVM assembler.  It reads a file containing
20 human readable LLVM assembly language, translates it to LLVM bytecode, and
21 writes the result into a file or to standard output.
22 <p>
23
24 If filename is omitted or is -, then <tt>llvm-as</tt> reads its input from
25 standard input.
26 <p>
27
28 If an output file is not specified with the <tt>-o</tt> option, then
29 <tt>llvm-as</tt> sends its output to a file or standard output by the following
30 logic:
31
32 <ul>
33         <li>
34         If the input is standard input, then the output is standard output.
35         <p>
36
37         <li>
38         If the input is a file that ends with .ll, then the output file is of
39         the same name, except that the suffix is changed to .bc.
40         <p>
41
42         <li>
43         If the input is a file that does not end with the .ll suffix, then the
44         output file has the same name as the input file, except that the .bc
45         suffix is appended.
46         <p>
47 </ul>
48
49 <h3>OPTIONS</h3>
50
51 <ul>
52         <li> -f
53         <br>
54         Force overwrite.  Normally, <tt>llvm-as</tt> will refuse to overwrite an
55         output file that already exists.  With this option, <tt>llvm-as</tt>
56         will overwrite the output file and replace it with new bytecode.
57         <p>
58
59         <li> -help
60         <br>
61         Print a summary of command line options.
62         <p>
63
64         <li> -o &lt;filename&gt;
65         <br>
66         Specify the output filename.  If filename is -, then <tt>llvm-as</tt>
67         sends its output to standard output.
68         <p>
69
70         <li> -stats
71         <br>
72         Print statistics.
73         <p>
74
75         <li> -time-passes
76         <br>
77         Record the amount of time needed for each pass and print it to standard
78         error.
79         <p>
80 </ul>
81
82 <h3>EXIT STATUS</h3>
83
84 If <tt>llvm-as</tt> succeeds, it will exit with 0.  Otherwise, if an error
85 occurs, it will exit with a non-zero value.
86
87 <h3>SEE ALSO</h3>
88
89 <a href="llvm-dis.html"><tt>llvm-dis</tt></a>
90 <a href="gccas.html"><tt>gccas</tt></a>
91
92
93 <HR>
94 Maintained by the <a href="http://llvm.cs.uiuc.edu">LLVM Team</a>.
95 </body>
96 </html>
97