@@ -115,8 +115,8 @@ for more information on them.
115115When complete, ` make install ` will place several programs into
116116` /usr/local/bin ` : ` rustc ` , the Rust compiler; ` rustdoc ` , the
117117API-documentation tool; ` rustpkg ` , the Rust package manager;
118- ` rusti ` , the Rust REPL; and ` rust ` , a tool which acts as a unified way to
119- call them, either directly or with common command line arguments .
118+ ` rusti ` , the Rust REPL; and ` rust ` , a tool which acts both as a unified
119+ interface for them, and for a few common command line scenarios .
120120
121121[ wiki-start ] : https://github.com/mozilla/rust/wiki/Note-getting-started-developing-Rust
122122[ tarball ] : http://static.rust-lang.org/dist/rust-0.5.tar.gz
@@ -155,6 +155,25 @@ declaration to appear at the top level of the file: all statements must
155155live inside a function. Rust programs can also be compiled as
156156libraries, and included in other programs.
157157
158+ ## Using the rust tool
159+
160+ While using ` rustc ` directly to generate your executables, and then
161+ running them manually is a perfectly valid way to test your code,
162+ for smaller projects, prototypes, or if you're a beginner, it might be
163+ more convenient to use the ` rust ` tool.
164+
165+ You use it by calling it with one of the supported commands, followed by
166+ arguments for that command. For example ` rust build foo.rs ` calls the
167+ ` build ` command with the argument ` foo.rs ` .
168+
169+ The commands are:
170+ - ` build ` , ` doc ` , ` pkg ` and ` sketch ` , which simply forward all arguments
171+ to the included programs ` rustc ` , ` rustdoc ` , ` rustpkg ` and ` rusti ` .
172+ - ` run ` and ` test ` , which both accept one source file and, using ` rustc ` ,
173+ produce either a normal or a test executable in the current working
174+ directory and run it.
175+ - ` help ` , which prints out the usage text of one of the commands.
176+
158177## Editing Rust code
159178
160179There are vim highlighting and indentation scripts in the Rust source
0 commit comments