mirror of
https://github.com/rust-lang/rust.git
synced 2024-11-22 23:04:33 +00:00
ae4f8fb87a
* Mark --static as experimental; * Remove --stats, as the option isn't implemented. * Bold and surround by pointy brackets (<>) all the URLs of rustc man page, for consistency.
128 lines
2.8 KiB
Groff
128 lines
2.8 KiB
Groff
.TH RUSTC "1" "July 2012" "rustc 0.3" "User Commands"
|
|
.SH NAME
|
|
rustc \- rust compiler
|
|
.SH SYNOPSIS
|
|
.B rustc
|
|
[\fIoptions\fR] \fI<input>\fR
|
|
|
|
.SH DESCRIPTION
|
|
This program is a compiler for the Rust language, available at
|
|
<\fBhttps://www.rust-lang.org\fR>.
|
|
|
|
.SH OPTIONS
|
|
|
|
.TP
|
|
\fB\-\-bin\fR
|
|
Compile an executable crate (default)
|
|
.TP
|
|
\fB\-c\fR
|
|
Compile and assemble, but do not link
|
|
.TP
|
|
\fB\-\-cfg\fR <cfgspec>
|
|
Configure the compilation environment
|
|
.TP
|
|
\fB\-\-emit\-llvm\fR
|
|
Produce an LLVM bitcode file
|
|
.TP
|
|
\fB\-g\fR
|
|
Produce debug info (experimental)
|
|
.TP
|
|
\fB\-\-gc\fR
|
|
Garbage collect shared data (experimental/temporary)
|
|
.TP
|
|
\fB\-h\fR \fB\-\-help\fR
|
|
Display this message
|
|
.TP
|
|
\fB\-L\fR <path>
|
|
Add a directory to the library search path
|
|
.TP
|
|
\fB\-\-lib\fR
|
|
Compile a library crate
|
|
.TP
|
|
\fB\-\-ls\fR
|
|
List the symbols defined by a compiled library crate
|
|
.TP
|
|
\fB\-\-no\-trans\fR
|
|
Run all passes except translation; no output
|
|
.TP
|
|
\fB\-O\fR
|
|
Equivalent to \fB\-\-opt\-level\fR=\fI2\fR
|
|
.TP
|
|
\fB\-o\fR <filename>
|
|
Write output to <filename>
|
|
.TP
|
|
\fB\-\-opt\-level\fR <lvl>
|
|
Optimize with possible levels 0\-3
|
|
.TP
|
|
\fB\-\-out\-dir\fR <dir>
|
|
Write output to compiler\-chosen filename in <dir>
|
|
.TP
|
|
\fB\-\-parse\-only\fR
|
|
Parse only; do not compile, assemble, or link
|
|
.TP
|
|
\fB\-\-pretty\fR [type]
|
|
Pretty\-print the input instead of compiling;
|
|
valid types are: \fBnormal\fR (un\-annotated source),
|
|
\fBexpanded\fR (crates expanded), \fBtyped\fR (crates expanded,
|
|
with type annotations), or \fBidentified\fR (fully
|
|
parenthesized, AST nodes and blocks with IDs)
|
|
.TP
|
|
\fB\-S\fR
|
|
Compile only; do not assemble or link
|
|
.TP
|
|
\fB\-\-save\-temps\fR
|
|
Write intermediate files (.bc, .opt.bc, .o)
|
|
in addition to normal output
|
|
.TP
|
|
\fB\-\-static\fR
|
|
Use or produce static libraries or binaries (experimental)
|
|
.TP
|
|
\fB\-\-sysroot\fR <path>
|
|
Override the system root
|
|
.TP
|
|
\fB\-\-test\fR
|
|
Build a test harness
|
|
.TP
|
|
\fB\-\-target\fR <triple>
|
|
Target cpu\-manufacturer\-kernel[\-os] to compile for (default: host triple)
|
|
(see <\fBhttp://sources.redhat.com/autobook/autobook/autobook_17.html\fR> for
|
|
detail)
|
|
.TP
|
|
\fB\-W\fR <foo>
|
|
enable warning <foo>
|
|
.TP
|
|
\fB\-W\fR no\-<foo>
|
|
disable warning <foo>
|
|
.TP
|
|
\fB\-W\fR err\-<foo>
|
|
enable warning <foo> as an error
|
|
.TP
|
|
\fB\-W\fR help
|
|
Print available warnings and default settings
|
|
.TP
|
|
\fB\-Z\fR help
|
|
list internal options for debugging rustc
|
|
.TP
|
|
\fB\-v\fR \fB\-\-version\fR
|
|
Print version info and exit
|
|
|
|
.SH "EXAMPLES"
|
|
To build an executable from a source file with a main function:
|
|
$ rustc -o hello hello.rs
|
|
|
|
To build a library from a source file:
|
|
$ rustc --lib hello-lib.rs
|
|
|
|
To build either with a crate (.rc) file:
|
|
$ rustc hello.rc
|
|
|
|
.SH "BUGS"
|
|
See <\fBhttps://github.com/mozilla/rust/issues\fR> for a list of known bugs.
|
|
|
|
.SH "AUTHOR"
|
|
See \fBAUTHORS.txt\fR in the rust source distribution. Graydon Hoare
|
|
<\fIgraydon@mozilla.com\fR> is the project leader.
|
|
|
|
.SH "COPYRIGHT"
|
|
See \fBLICENSE.txt\fR in the rust source distribution.
|