docs/CommandGuide/llvm-as.rst

   1 llvm-as - LLVM assembler
   2 ========================
   3
   4 SYNOPSIS
   5 --------
   6
   7 **llvm-as** [*options*] [*filename*]
   8
   9 DESCRIPTION
  10 -----------
  11
  12 **llvm-as** is the LLVM assembler.  It reads a file containing human-readable
  13 LLVM assembly language, translates it to LLVM bitcode, and writes the result
  14 into a file or to standard output.
  15
  16 If *filename* is omitted or is ``-``, then **llvm-as** reads its input from
  17 standard input.
  18
  19 If 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
  21 these rules:
  22
  23 * If the input is standard input, then the output is standard output.
  24
  25 * 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``.
  27
  28 * 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.
  31
  32 OPTIONS
  33 -------
  34
  35 **-f**
  36  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
  40 **-help**
  41  Print a summary of command line options.
  42
  43 **-o** *filename*
  44  Specify the output file name.  If *filename* is ``-``, then **llvm-as**
  45  sends its output to standard output.
  46
  47 EXIT STATUS
  48 -----------
  49
  50 If **llvm-as** succeeds, it will exit with 0.  Otherwise, if an error occurs, it
  51 will exit with a non-zero value.
  52
  53 SEE ALSO
  54 --------
  55
  56 llvm-dis|llvm-dis, gccas|gccas