usr.bin/clang/llvm-as/llvm-as.1

   1 .\" $FreeBSD$
   2 .TH "LLVM-AS" "1" "2013-04-11" "3.3" "LLVM"
   3 .SH NAME
   4 llvm-as \- LLVM assembler
   5 .
   6 .nr rst2man-indent-level 0
   7 .
   8 .de1 rstReportMargin
   9 \\$1 \\n[an-margin]
  10 level \\n[rst2man-indent-level]
  11 level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
  12 -
  13 \\n[rst2man-indent0]
  14 \\n[rst2man-indent1]
  15 \\n[rst2man-indent2]
  16 ..
  17 .de1 INDENT
  18 .\" .rstReportMargin pre:
  19 . RS \\$1
  20 . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
  21 . nr rst2man-indent-level +1
  22 .\" .rstReportMargin post:
  23 ..
  24 .de UNINDENT
  25 . RE
  26 .\" indent \\n[an-margin]
  27 .\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
  28 .nr rst2man-indent-level -1
  29 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
  30 .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
  31 ..
  32 .\" Man page generated from reStructuredText.
  33 .
  34 .SH SYNOPSIS
  35 .sp
  36 \fBllvm\-as\fP [\fIoptions\fP] [\fIfilename\fP]
  37 .SH DESCRIPTION
  38 .sp
  39 \fBllvm\-as\fP is the LLVM assembler.  It reads a file containing human\-readable
  40 LLVM assembly language, translates it to LLVM bitcode, and writes the result
  41 into a file or to standard output.
  42 .sp
  43 If \fIfilename\fP is omitted or is \fB\-\fP, then \fBllvm\-as\fP reads its input from
  44 standard input.
  45 .sp
  46 If an output file is not specified with the \fB\-o\fP option, then
  47 \fBllvm\-as\fP sends its output to a file or standard output by following
  48 these rules:
  49 .INDENT 0.0
  50 .IP \(bu 2
  51 If the input is standard input, then the output is standard output.
  52 .IP \(bu 2
  53 If the input is a file that ends with \fB.ll\fP, then the output file is of the
  54 same name, except that the suffix is changed to \fB.bc\fP.
  55 .IP \(bu 2
  56 If the input is a file that does not end with the \fB.ll\fP suffix, then the
  57 output file has the same name as the input file, except that the \fB.bc\fP
  58 suffix is appended.
  59 .UNINDENT
  60 .SH OPTIONS
  61 .INDENT 0.0
  62 .TP
  63 .B \fB\-f\fP
  64 Enable binary output on terminals.  Normally, \fBllvm\-as\fP will refuse to
  65 write raw bitcode output if the output stream is a terminal. With this option,
  66 \fBllvm\-as\fP will write raw bitcode regardless of the output device.
  67 .TP
  68 .B \fB\-help\fP
  69 Print a summary of command line options.
  70 .TP
  71 .B \fB\-o\fP \fIfilename\fP
  72 Specify the output file name.  If \fIfilename\fP is \fB\-\fP, then \fBllvm\-as\fP
  73 sends its output to standard output.
  74 .UNINDENT
  75 .SH EXIT STATUS
  76 .sp
  77 If \fBllvm\-as\fP succeeds, it will exit with 0.  Otherwise, if an error occurs, it
  78 will exit with a non\-zero value.
  79 .SH SEE ALSO
  80 .sp
  81 llvm\-dis|llvm\-dis, gccas|gccas
  82 .SH AUTHOR
  83 Maintained by The LLVM Team (http://llvm.org/).
  84 .SH COPYRIGHT
  85 2003-2013, LLVM Project
  86 .\" Generated by docutils manpage writer.
  87 .