about summary refs log tree commit diff
diff options
context:
space:
mode:
authorMarvin Löbel <loebel.marvin@gmail.com>2013-02-19 20:57:23 +0100
committerMarvin Löbel <loebel.marvin@gmail.com>2013-02-19 20:57:23 +0100
commit8ee2d58683cd2dfe981b4c84b7538f44c7ec9cd2 (patch)
tree4aea89660190a8fea14b3afcf5c721a970df8c40
parentf684a8a56be054997c1df8807eac9d5cad221979 (diff)
downloadrust-8ee2d58683cd2dfe981b4c84b7538f44c7ec9cd2.tar.gz
rust-8ee2d58683cd2dfe981b4c84b7538f44c7ec9cd2.zip
Give the rust tool an own section in the tutorial.
-rw-r--r--doc/tutorial.md23
1 files changed, 21 insertions, 2 deletions
diff --git a/doc/tutorial.md b/doc/tutorial.md
index 895af6f1289..ed6d3c9c7a0 100644
--- a/doc/tutorial.md
+++ b/doc/tutorial.md
@@ -115,8 +115,8 @@ for more information on them.
 When complete, `make install` will place several programs into
 `/usr/local/bin`: `rustc`, the Rust compiler; `rustdoc`, the
 API-documentation tool; `rustpkg`, the Rust package manager;
-`rusti`, the Rust REPL; and `rust`, a tool which acts as a unified way to
-call them, either directly or with common command line arguments.
+`rusti`, the Rust REPL; and `rust`, a tool which acts both as a unified
+interface for them, and for a few common command line scenarios.
 
 [wiki-start]: https://github.com/mozilla/rust/wiki/Note-getting-started-developing-Rust
 [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
 live inside a function.  Rust programs can also be compiled as
 libraries, and included in other programs.
 
+## Using the rust tool
+
+While using `rustc` directly to generate your executables, and then
+running them manually is a perfectly valid way to test your code,
+for smaller projects, prototypes, or if you're a beginner, it might be
+more convenient to use the `rust` tool.
+
+You use it by calling it with one of the supported commands, followed by
+arguments for that command. For example `rust build foo.rs` calls the
+`build` command with the argument `foo.rs`.
+
+The commands are:
+  - `build`, `doc`, `pkg` and `sketch`, which simply forward all arguments
+     to the included programs `rustc`, `rustdoc`, `rustpkg` and `rusti`.
+  - `run` and `test`, which both accept one source file and, using `rustc`,
+    produce either a normal or a test executable in the current working
+    directory and run it.
+  - `help`, which prints out the usage text of one of the commands.
+
 ## Editing Rust code
 
 There are vim highlighting and indentation scripts in the Rust source