man/rustc.1

   1 .TH RUSTC "1" "March 2014" "rustc 0.11.0" "User Commands"
   2 .SH NAME
   3 rustc \- The Rust compiler
   4 .SH SYNOPSIS
   5 .B rustc
   6 [\fIOPTIONS\fR] \fIINPUT\fR
   7
   8 .SH DESCRIPTION
   9 This program is a compiler for the Rust language, available at
  10 <\fBhttps://www.rust-lang.org\fR>.
  11
  12 .SH OPTIONS
  13
  14 .TP
  15 \fB\-\-crate-type=[bin|lib|dylib|rlib|staticlib]\fR
  16 Configure the flavor of rust crate that is generated (default `bin`)
  17 .TP
  18 \fB\-\-cfg\fR SPEC
  19 Configure the compilation environment
  20 .TP
  21 \fB\-\-emit=[asm,ir,bc,obj,link]\fR
  22 Configure the output that rustc will produce
  23 .TP
  24 \fB\-h\fR, \fB\-\-help\fR
  25 Display this message
  26 .TP
  27 \fB\-L\fR PATH
  28 Add a directory to the library search path
  29 .TP
  30 \fB\-\-no\-trans\fR
  31 Run all passes except translation; no output
  32 .TP
  33 \fB\-\-no\-analysis\fR
  34 Parse and expand the source, but run no analysis and produce no output
  35 .TP
  36 \fB\-g\fR
  37 Emit DWARF debug information into object files generated.
  38 .TP
  39 \fB\-\-debuginfo\fR LEVEL
  40 Emit DWARF debug info to the objects created: 0 = no debug info, 1 =
  41 line-tables only (for stacktraces and breakpoints), 2 = full debug
  42 info with variable and type information (same as -g).
  43 .TP
  44 \fB\-O\fR
  45 Equivalent to \fI\-\-opt\-level=2\fR
  46 .TP
  47 \fB\-o\fR FILENAME
  48 Write output to <filename>. Ignored if more than one --emit is specified.
  49 .TP
  50 \fB\-\-opt\-level\fR LEVEL
  51 Optimize with possible levels 0-3
  52 .TP
  53 \fB\-\-out\-dir\fR DIR
  54 Write output to compiler-chosen filename in <dir>. Ignored if -o is specified.
  55 (default the current directory)
  56 .TP
  57 \fB\-\-parse\-only\fR
  58 Parse only; do not compile, assemble, or link
  59 .TP
  60 \fB\-\-pretty\fR [TYPE]
  61 Pretty-print the input instead of compiling; valid types are: normal
  62 (un-annotated source), expanded (crates expanded), typed (crates
  63 expanded, with type annotations), or identified (fully parenthesized,
  64 AST nodes and blocks with IDs)
  65 .TP
  66 \fB\-\-dep-info\fR [FILENAME]
  67 Output dependency info to <filename> after compiling, in o format suitable
  68 for use by Makefiles.
  69 .TP
  70 \fB\-\-sysroot\fR PATH
  71 Override the system root
  72 .TP
  73 \fB\-\-test\fR
  74 Build a test harness
  75 .TP
  76 \fB\-\-target\fR TRIPLE
  77 Target triple cpu-manufacturer-kernel[-os] to compile for (see
  78 http://sources.redhat.com/autobook/autobook/autobook_17.html
  79 for details)
  80 .TP
  81 \fB\-W\fR help
  82 Print 'lint' options and default settings
  83 .TP
  84 \fB\-W\fR OPT, \fB\-\-warn\fR OPT
  85 Set lint warnings
  86 .TP
  87 \fB\-A\fR OPT, \fB\-\-allow\fR OPT
  88 Set lint allowed
  89 .TP
  90 \fB\-D\fR OPT, \fB\-\-deny\fR OPT
  91 Set lint denied
  92 .TP
  93 \fB\-F\fR OPT, \fB\-\-forbid\fR OPT
  94 Set lint forbidden
  95 .TP
  96 \fB\-Z\fR FLAG
  97 Set internal debugging options. Use "-Z help" to print available options.
  98 .TP
  99 \fB\-C\fR FLAG[=VAL], \fB\-\-codegen\fR FLAG[=VAL]
 100 Set a codegen-related flag to the value specified. Use "-C help" to print
 101 available flags. See CODEGEN OPTIONS below
 102 .TP
 103 \fB\-v\fR, \fB\-\-version\fR
 104 Print version info and exit
 105
 106 .SH CODEGEN OPTIONS
 107
 108 .TP
 109 \fBar\fR=/path/to/ar
 110 Path to the archive utility to use when assembling archives.
 111 .TP
 112 \fBlinker\fR=/path/to/cc
 113 Path to the linker utility to use when linking libraries, executables, and
 114 objects.
 115 .TP
 116 \fBlink-args\fR='-flag1 -flag2'
 117 A space-separated list of extra arguments to pass to the linker when the linker
 118 is invoked.
 119 .TP
 120 \fBtarget-cpu\fR=help
 121 Selects a target processor. If the value is 'help', then a list of available
 122 CPUs is printed.
 123 .TP
 124 \fBtarget-feature\fR='+feature1 -feature2'
 125 A space-separated list of features to enable or disable for the target. A
 126 preceding '+' enables a feature while a preceding '-' disables it. Available
 127 features can be discovered through target-cpu=help.
 128 .TP
 129 \fBpasses\fR=list
 130 A space-separated list of extra LLVM passes to run. A value of 'list' will
 131 cause rustc to print all known passes and exit. The passes specified are
 132 appended at the end of the normal pass manager.
 133 .TP
 134 \fBllvm-args\fR='-arg1 -arg2'
 135 A space-separated list of arguments to pass through to LLVM.
 136 .TP
 137 \fBsave-temps\fR
 138 If specified, the compiler will save more files (.bc, .o, .no-opt.bc) generated
 139 throughout compilation in the output directory.
 140 .TP
 141 \fBno-rpath\fR
 142 If specified, then the rpath value for dynamic libraries will not be set in
 143 either dynamic library or executable outputs.
 144 .TP
 145 \fBno-prepopulate-passes\fR
 146 Suppresses pre-population of the LLVM pass manager that is run over the module.
 147 .TP
 148 \fBno-vectorize-loops\fR
 149 Suppresses running the loop vectorization LLVM pass, regardless of optimization
 150 level.
 151 .TP
 152 \fBno-vectorize-slp\fR
 153 Suppresses running the LLVM SLP vectorization pass, regardless of optimization
 154 level.
 155 .TP
 156 \fBsoft-float\fR
 157 Generates software floating point library calls instead of hardware
 158 instructions.
 159 .TP
 160 \fBprefer-dynamic\fR
 161 Prefers dynamic linking to static linking.
 162 .TP
 163 \fBno-integrated-as\fR
 164 Force usage of an external assembler rather than LLVM's integrated one.
 165 .TP
 166 \fBrelocation-model\fR=[pic,static,dynamic-no-pic]
 167 The relocation model to use. (default: pic)
 168
 169 .SH "EXAMPLES"
 170 To build an executable from a source file with a main function:
 171     $ rustc -o hello hello.rs
 172
 173 To build a library from a source file:
 174     $ rustc --crate-type=lib hello-lib.rs
 175
 176 To build either with a crate (.rs) file:
 177     $ rustc hello.rs
 178
 179 To build an executable with debug info:
 180     $ rustc -g -o hello hello.rs
 181
 182 .SH "SEE ALSO"
 183
 184 rustdoc
 185
 186 .SH "BUGS"
 187 See <\fBhttps://github.com/rust-lang/rust/issues\fR> for issues.
 188
 189 .SH "AUTHOR"
 190 See \fBAUTHORS.txt\fR in the Rust source distribution.
 191
 192 .SH "COPYRIGHT"
 193 This work is dual-licensed under Apache 2.0 and MIT terms.  See \fBCOPYRIGHT\fR
 194 file in the rust source distribution.