[ARM] Fixup pipeline test. NFC
[llvm-complete.git] / docs / CommandGuide / llvm-as.rst
blob97dcaf15bd054c088a96884016efd89b8514f15d
1 llvm-as - LLVM assembler
2 ========================
4 .. program:: llvm-as
6 SYNOPSIS
7 --------
9 **llvm-as** [*options*] [*filename*]
11 DESCRIPTION
12 -----------
14 **llvm-as** is the LLVM assembler.  It reads a file containing human-readable
15 LLVM assembly language, translates it to LLVM bitcode, and writes the result
16 into a file or to standard output.
18 If *filename* is omitted or is ``-``, then **llvm-as** reads its input from
19 standard input.
21 If an output file is not specified with the **-o** option, then
22 **llvm-as** sends its output to a file or standard output by following
23 these rules:
25 * If the input is standard input, then the output is standard output.
27 * If the input is a file that ends with ``.ll``, then the output file is of the
28   same name, except that the suffix is changed to ``.bc``.
30 * If the input is a file that does not end with the ``.ll`` suffix, then the
31   output file has the same name as the input file, except that the ``.bc``
32   suffix is appended.
34 OPTIONS
35 -------
37 **-f**
38  Enable binary output on terminals.  Normally, **llvm-as** will refuse to
39  write raw bitcode output if the output stream is a terminal. With this option,
40  **llvm-as** will write raw bitcode regardless of the output device.
42 **-help**
43  Print a summary of command line options.
45 **-o** *filename*
46  Specify the output file name.  If *filename* is ``-``, then **llvm-as**
47  sends its output to standard output.
49 EXIT STATUS
50 -----------
52 If **llvm-as** succeeds, it will exit with 0.  Otherwise, if an error occurs, it
53 will exit with a non-zero value.
55 SEE ALSO
56 --------
58 :manpage:`llvm-dis(1)`, as(1)