blob: 985c8af399d508ca9427094d8f7a7560aabf989b [file] [log] [blame]
John Criswellecf32e52003-09-11 19:58:03 +00001<html>
2<title>
Chris Lattneree43b692003-09-25 19:50:05 +00003LLVM: llvm-as tool
John Criswellecf32e52003-09-11 19:58:03 +00004</title>
5
6<body>
7
8<center>
Chris Lattneree43b692003-09-25 19:50:05 +00009<h1>LLVM: llvm-as tool</h1>
John Criswellecf32e52003-09-11 19:58:03 +000010</center>
11<HR>
12
13<h3>
14NAME
15</h3>
16
17llvm-as
18
19<h3>
20SYNOPSIS
21</h3>
22
John Criswell67753922003-09-26 02:59:00 +000023llvm-as [options] [filename]
John Criswellecf32e52003-09-11 19:58:03 +000024<h3>
25DESCRIPTION
26</h3>
27
John Criswell67753922003-09-26 02:59:00 +000028The llvm-as command is the LLVM assembler. It reads a file containing human
29readable LLVM assembly language, translates it to LLVM bytecode, and writes the
30result into a file or to standard output.
31<p>
John Criswellecf32e52003-09-11 19:58:03 +000032
John Criswell67753922003-09-26 02:59:00 +000033If filename is omitted or is -, then llvm-as reads its input from standard
34input.
35<p>
36
37If an output file is not specified with the -o option, then llvm-as sends its
38output 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>
John Criswellecf32e52003-09-11 19:58:03 +000056
57<h3>
58OPTIONS
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>
John Criswell67753922003-09-26 02:59:00 +000076 Specify the output filename. If filename is -, then llvm-as sends its
77 output to standard output.
John Criswellecf32e52003-09-11 19:58:03 +000078 <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>
93EXIT STATUS
94</h3>
95
96If llvm-as succeeds, it will exit with 0. Otherwise, if an error occurs, it
97will exit with a non-zero value.
98
99<h3>
100SEE ALSO
101</h3>
102llvm-dis
103
104<HR>
John Criswell32003302003-09-11 20:23:52 +0000105<a href="http://llvm.cs.uiuc.edu">LLVM Team</a>
John Criswellecf32e52003-09-11 19:58:03 +0000106</body>
107</html>
108