blob: 1b499bbe9708e16c2cc21f6f384c03affef7a1e9 [file] [log] [blame]
Daniel Dunbar3b709d52012-05-08 16:50:35 +00001llvm-as - LLVM assembler
2========================
3
Daniel Dunbar3b709d52012-05-08 16:50:35 +00004SYNOPSIS
5--------
6
Daniel Dunbar3b709d52012-05-08 16:50:35 +00007**llvm-as** [*options*] [*filename*]
8
Daniel Dunbar3b709d52012-05-08 16:50:35 +00009DESCRIPTION
10-----------
11
Daniel Dunbar3b709d52012-05-08 16:50:35 +000012**llvm-as** is the LLVM assembler. It reads a file containing human-readable
13LLVM assembly language, translates it to LLVM bitcode, and writes the result
14into a file or to standard output.
15
16If *filename* is omitted or is ``-``, then **llvm-as** reads its input from
17standard input.
18
19If an output file is not specified with the **-o** option, then
20**llvm-as** sends its output to a file or standard output by following
21these rules:
22
Bill Wendling20cc0fb2012-06-20 11:25:11 +000023* If the input is standard input, then the output is standard output.
Daniel Dunbar3b709d52012-05-08 16:50:35 +000024
Bill Wendling20cc0fb2012-06-20 11:25:11 +000025* If the input is a file that ends with ``.ll``, then the output file is of the
26 same name, except that the suffix is changed to ``.bc``.
Daniel Dunbar3b709d52012-05-08 16:50:35 +000027
Bill Wendling20cc0fb2012-06-20 11:25:11 +000028* If the input is a file that does not end with the ``.ll`` suffix, then the
29 output file has the same name as the input file, except that the ``.bc``
30 suffix is appended.
Daniel Dunbar3b709d52012-05-08 16:50:35 +000031
32OPTIONS
33-------
34
Daniel Dunbar3b709d52012-05-08 16:50:35 +000035**-f**
Daniel Dunbar3b709d52012-05-08 16:50:35 +000036 Enable binary output on terminals. Normally, **llvm-as** will refuse to
37 write raw bitcode output if the output stream is a terminal. With this option,
38 **llvm-as** will write raw bitcode regardless of the output device.
39
Daniel Dunbar3b709d52012-05-08 16:50:35 +000040**-help**
Daniel Dunbar3b709d52012-05-08 16:50:35 +000041 Print a summary of command line options.
42
Daniel Dunbar3b709d52012-05-08 16:50:35 +000043**-o** *filename*
Daniel Dunbar3b709d52012-05-08 16:50:35 +000044 Specify the output file name. If *filename* is ``-``, then **llvm-as**
45 sends its output to standard output.
46
Daniel Dunbar3b709d52012-05-08 16:50:35 +000047EXIT STATUS
48-----------
49
Bill Wendling20cc0fb2012-06-20 11:25:11 +000050If **llvm-as** succeeds, it will exit with 0. Otherwise, if an error occurs, it
51will exit with a non-zero value.
Daniel Dunbar3b709d52012-05-08 16:50:35 +000052
53SEE ALSO
54--------
55
Daniel Dunbar3b709d52012-05-08 16:50:35 +000056llvm-dis|llvm-dis, gccas|gccas