diff --git a/man/rustc.1 b/man/rustc.1 index b7e79c97b8a..04c0c36351c 100644 --- a/man/rustc.1 +++ b/man/rustc.1 @@ -13,22 +13,28 @@ This program is a compiler for the Rust language, available at <\fBhttps://github.com/graydon/rust\fR>. .SH OPTIONS .TP -\fB-h, --help\fR: Display help. +\fB-h, --help\fR: +Display help. .TP -\fB-v, --version\fR: Display version information. +\fB-v, --version\fR: +Display version information. .TP -\fB-o\fR \fIfilename\fR: Write output to \fIfilename\fR. The default output +\fB-o\fR \fIfilename\fR: +Write output to \fIfilename\fR. The default output filename for \fBfoo.rs\fR is otherwise \fBfoo\fR (when compiling a binary), \fBfoo\fR (when compiling a library), \fBfoo.o\fR (when using \fB-c\fR), \fBfoo.s\fR (when using \fB-S\fR) or \fBfoo.bc\fR (when using \fB--emit-llvm\fR). .TP -\fB--lib\fR: Compile and link a library crate into a shared object. +\fB--lib\fR: +Compile and link a library crate into a shared object. .TP -\fB--static\fR: Produce a statically-linked binary, or generate a static +\fB--static\fR: +Produce a statically-linked binary, or generate a static library. .TP -\fB--pretty\fR \fItype\fR: Pretty-print the input. Valid \fItype\fRs are: +\fB--pretty\fR \fItype\fR: +Pretty-print the input. Valid \fItype\fRs are: .RS .TP \fBnormal\fR: Un-annotated source. @@ -40,61 +46,82 @@ library. \fBidentified\fR: Fully parenthesized, ast nodes and blocks annotated with IDs. .RE .TP -\fB--ls\fR: Lists symbols defined by the specified \fBcompiled\fR library. +\fB--ls\fR: +Lists symbols defined by the specified \fBcompiled\fR library. .TP -\fB-L\fR \fIpath\fR: Adds \fIpath\fR to the library search path. +\fB-L\fR \fIpath\fR: +Adds \fIpath\fR to the library search path. .TP -\fB--noverify\fR: Disables LLVM verification pass, which does sanity checking of +\fB--noverify\fR: +Disables LLVM verification pass, which does sanity checking of bitcode generated by rustc. Using this option gives a slight speedup, at the cost of vastly reduced ability to catch rustc bugs. See <\fBhttp://llvm.org/docs/Passes.html\fR> for a list of properties checked. .TP -\fB--parse-only\fR: Run the parse phase only. If parsing succeeds, produces no +\fB--parse-only\fR: +Run the parse phase only. If parsing succeeds, produces no output. .TP -\fB--no-trans\fR: Run all passes except translation. Produces no output. +\fB--no-trans\fR: +Run all passes except translation. Produces no output. .TP \fB-g\fR: Produce debug info. .TP -\fB--OptLevel\fR=\fIlevel\fR: Set optimization level to \fIlevel\fR. +\fB--OptLevel\fR=\fIlevel\fR: +Set optimization level to \fIlevel\fR. .TP -\fB-O\fR: Equal to --OptLevel=2 +\fB-O\fR: +Equal to --OptLevel=2 .TP -\fB-S\fR: Compile to assembly, but do not assemble or link. +\fB-S\fR: +Compile to assembly, but do not assemble or link. .TP -\fB-c\fR: Compile and assemble, but do not link. +\fB-c\fR: +Compile and assemble, but do not link. .TP -\fB--emit-llvm\fR: Generate llvm bitcode. +\fB--emit-llvm\fR: +Generate llvm bitcode. .TP -\fB--save-temps\fR: For foo.rs, save generated bitcode before optimization to +\fB--save-temps\fR: +For foo.rs, save generated bitcode before optimization to \fBfoo.bc\fR, bitcode after optimization to \fBfoo.opt.bc\fR, and the generated object file to \fBfoo.o\fR. .TP -\fB--stats\fR: Print statistics about compilation. +\fB--stats\fR: +Print statistics about compilation. .TP -\fB--cfg\fR \fIcfgspec\fR: Provide a crate config spec. +\fB--cfg\fR \fIcfgspec\fR: +Provide a crate config spec. .TP -\fB--time-passes\fR: Print runtimes of compilation phases. +\fB--time-passes\fR: +Print runtimes of compilation phases. .TP -\fB--time-llvm-passes\fR: Print runtimes of llvm phases. +\fB--time-llvm-passes\fR: +Print runtimes of llvm phases. .TP -\fB--sysroot\fR \fIpath\fR: Set the system root. Default is the directory above +\fB--sysroot\fR \fIpath\fR: +Set the system root. Default is the directory above rustc's. .TP -\fB--target\fR \fIgnu-config-name\fR: Set the compilation target, which is a +\fB--target\fR \fIgnu-config-name\fR: +Set the compilation target, which is a string of the form \fBcpu\fR-\fBmanufacturer\fR-\fBkernel\fR[-\fBos\fR]. Example values include "i686-unknown-linux-gnu" and "mips-idt-ecoff"; see <\fBhttp://sources.redhat.com/autobook/autobook/autobook_17.html\fR>. If not supplied, the host triple is used (see \fB--version\fR output). .TP -\fB--no-typestate\fR: Disable the typestate pass. This breaks some safety +\fB--no-typestate\fR: +Disable the typestate pass. This breaks some safety guarantees of the language and is quite dangerous. .TP -\fB--test\fR: Build a test harness. +\fB--test\fR: +Build a test harness. .TP -\fB--gc\fR: \fBEXPERIMENTAL\fR. Garbage-collect shared data. +\fB--gc\fR: +\fBEXPERIMENTAL\fR. Garbage-collect shared data. .TP -\fB--stack-growth\fR: \fBEXPERIMENTAL\fR. Perform stack growth checks. +\fB--stack-growth\fR: +\fBEXPERIMENTAL\fR. Perform stack growth checks. .SH "BUGS" See \fBhttps://github.com/graydon/rust/issues\fR for a list of known bugs. .SH "AUTHOR"