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