@@ -13,22 +13,28 @@ This program is a compiler for the Rust language, available at
13
13
<\fB https://github.com/graydon/rust \fR >.
14
14
.SH OPTIONS
15
15
.TP
16
- \fB -h, --help \fR : Display help.
16
+ \fB -h, --help \fR :
17
+ Display help.
17
18
.TP
18
- \fB -v, --version \fR : Display version information.
19
+ \fB -v, --version \fR :
20
+ Display version information.
19
21
.TP
20
- \fB -o \fR \fI filename \fR : Write output to \fI filename \fR . The default output
22
+ \fB -o \fR \fI filename \fR :
23
+ Write output to \fI filename \fR . The default output
21
24
filename for \fB foo.rs \fR is otherwise \fB foo \fR (when compiling a binary),
22
25
\fB foo \fR (when compiling a library), \fB foo.o \fR (when using \fB -c \fR ),
23
26
\fB foo.s \fR (when using \fB -S \fR ) or \fB foo.bc \fR (when using
24
27
\fB --emit-llvm \fR ).
25
28
.TP
26
- \fB --lib \fR : Compile and link a library crate into a shared object.
29
+ \fB --lib \fR :
30
+ Compile and link a library crate into a shared object.
27
31
.TP
28
- \fB --static \fR : Produce a statically-linked binary, or generate a static
32
+ \fB --static \fR :
33
+ Produce a statically-linked binary, or generate a static
29
34
library.
30
35
.TP
31
- \fB --pretty \fR \fI type \fR : Pretty-print the input. Valid \fI type \fR s are:
36
+ \fB --pretty \fR \fI type \fR :
37
+ Pretty-print the input. Valid \fI type \fR s are:
32
38
.RS
33
39
.TP
34
40
\fB normal \fR : Un-annotated source.
@@ -40,61 +46,82 @@ library.
40
46
\fB identified \fR : Fully parenthesized, ast nodes and blocks annotated with IDs.
41
47
.RE
42
48
.TP
43
- \fB --ls \fR : Lists symbols defined by the specified \fB compiled \fR library.
49
+ \fB --ls \fR :
50
+ Lists symbols defined by the specified \fB compiled \fR library.
44
51
.TP
45
- \fB -L \fR \fI path \fR : Adds \fI path \fR to the library search path.
52
+ \fB -L \fR \fI path \fR :
53
+ Adds \fI path \fR to the library search path.
46
54
.TP
47
- \fB --noverify \fR : Disables LLVM verification pass, which does sanity checking of
55
+ \fB --noverify \fR :
56
+ Disables LLVM verification pass, which does sanity checking of
48
57
bitcode generated by rustc. Using this option gives a slight speedup, at the
49
58
cost of vastly reduced ability to catch rustc bugs. See
50
59
<\fB http://llvm.org/docs/Passes.html \fR > for a list of properties checked.
51
60
.TP
52
- \fB --parse-only \fR : Run the parse phase only. If parsing succeeds, produces no
61
+ \fB --parse-only \fR :
62
+ Run the parse phase only. If parsing succeeds, produces no
53
63
output.
54
64
.TP
55
- \fB --no-trans \fR : Run all passes except translation. Produces no output.
65
+ \fB --no-trans \fR :
66
+ Run all passes except translation. Produces no output.
56
67
.TP
57
68
\fB -g \fR : Produce debug info.
58
69
.TP
59
- \fB --OptLevel \fR =\fI level \fR : Set optimization level to \fI level \fR .
70
+ \fB --OptLevel \fR =\fI level \fR :
71
+ Set optimization level to \fI level \fR .
60
72
.TP
61
- \fB -O \fR : Equal to --OptLevel=2
73
+ \fB -O \fR :
74
+ Equal to --OptLevel=2
62
75
.TP
63
- \fB -S \fR : Compile to assembly, but do not assemble or link.
76
+ \fB -S \fR :
77
+ Compile to assembly, but do not assemble or link.
64
78
.TP
65
- \fB -c \fR : Compile and assemble, but do not link.
79
+ \fB -c \fR :
80
+ Compile and assemble, but do not link.
66
81
.TP
67
- \fB --emit-llvm \fR : Generate llvm bitcode.
82
+ \fB --emit-llvm \fR :
83
+ Generate llvm bitcode.
68
84
.TP
69
- \fB --save-temps \fR : For foo.rs, save generated bitcode before optimization to
85
+ \fB --save-temps \fR :
86
+ For foo.rs, save generated bitcode before optimization to
70
87
\fB foo.bc \fR , bitcode after optimization to \fB foo.opt.bc \fR , and the generated
71
88
object file to \fB foo.o \fR .
72
89
.TP
73
- \fB --stats \fR : Print statistics about compilation.
90
+ \fB --stats \fR :
91
+ Print statistics about compilation.
74
92
.TP
75
- \fB --cfg \fR \fI cfgspec \fR : Provide a crate config spec.
93
+ \fB --cfg \fR \fI cfgspec \fR :
94
+ Provide a crate config spec.
76
95
.TP
77
- \fB --time-passes \fR : Print runtimes of compilation phases.
96
+ \fB --time-passes \fR :
97
+ Print runtimes of compilation phases.
78
98
.TP
79
- \fB --time-llvm-passes \fR : Print runtimes of llvm phases.
99
+ \fB --time-llvm-passes \fR :
100
+ Print runtimes of llvm phases.
80
101
.TP
81
- \fB --sysroot \fR \fI path \fR : Set the system root. Default is the directory above
102
+ \fB --sysroot \fR \fI path \fR :
103
+ Set the system root. Default is the directory above
82
104
rustc's.
83
105
.TP
84
- \fB --target \fR \fI gnu-config-name \fR : Set the compilation target, which is a
106
+ \fB --target \fR \fI gnu-config-name \fR :
107
+ Set the compilation target, which is a
85
108
string of the form \fB cpu \fR -\fB manufacturer \fR -\fB kernel \fR [-\fB os \fR ]. Example
86
109
values include "i686-unknown-linux-gnu" and "mips-idt-ecoff"; see
87
110
<\fB http://sources.redhat.com/autobook/autobook/autobook_17.html \fR >. If not
88
111
supplied, the host triple is used (see \fB --version \fR output).
89
112
.TP
90
- \fB --no-typestate \fR : Disable the typestate pass. This breaks some safety
113
+ \fB --no-typestate \fR :
114
+ Disable the typestate pass. This breaks some safety
91
115
guarantees of the language and is quite dangerous.
92
116
.TP
93
- \fB --test \fR : Build a test harness.
117
+ \fB --test \fR :
118
+ Build a test harness.
94
119
.TP
95
- \fB --gc \fR : \fB EXPERIMENTAL \fR . Garbage-collect shared data.
120
+ \fB --gc \fR :
121
+ \fB EXPERIMENTAL \fR . Garbage-collect shared data.
96
122
.TP
97
- \fB --stack-growth \fR : \fB EXPERIMENTAL \fR . Perform stack growth checks.
123
+ \fB --stack-growth \fR :
124
+ \fB EXPERIMENTAL \fR . Perform stack growth checks.
98
125
.SH "BUGS"
99
126
See \fB https://github.com/graydon/rust/issues \fR for a list of known bugs.
100
127
.SH "AUTHOR"
0 commit comments