Skip to content

Update rustpkg man page. #9234

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

Update rustpkg man page. #9234

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 4 additions & 17 deletions man/rustpkg.1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ This tool is a package manager for applications written in the Rust language,
available at <\fBhttps://www.rust-lang.org\fR>. It provides commands to build,
install and test Rust programs.

\fBrustpkg\fR is still a work in progress. See \fBdoc/rustpkg.md\fR in the Rust source distribution for future plans.

.SH COMMANDS

.TP
Expand All @@ -25,10 +27,6 @@ Remove all generated files from the \fIbuild\fR directory in the target's worksp
Builds the specified target, and all its dependencies, and then installs the
build products into the \fIlib\fR and \fIbin\fR directories of their respective
workspaces.
.TP
\fBtest\fR
Builds the module called \fItest.rs\fR in the specified workspace, and then runs
the resulting executable in test mode.

.SS "BUILD COMMAND"

Expand Down Expand Up @@ -58,20 +56,9 @@ of the first entry in RUST_PATH.

Examples:

$ rustpkg install git://github.com/mozilla/servo.git#1.2
$ rustpkg install github.com/mozilla/servo.git#1.2
$ rustpkg install rust-glfw

.SS "TEST COMMAND"

rustpkg test \fI[pkgname]\fR

The test command is a shortcut for the command line:

$ rustc --test <filename> -o <filestem>test~ && ./<filestem>test~

Note the suffix on the output filename (the word "test" followed by a tilde),
which should ensure the file does not clash with a user-generated files.

.SH "ENVIRONMENT"

.TP
Expand Down Expand Up @@ -186,7 +173,7 @@ rust, rustc, rustdoc, rusti
See <\fBhttps://github.com/mozilla/rust/issues\fR> for issues.

.SH "AUTHOR"
See \fBAUTHORS.txt\fR in the rust source distribution. Graydon Hoare
See \fBAUTHORS.txt\fR in the Rust source distribution. Graydon Hoare
<\[email protected]\fR> is the project leader.

.SH "COPYRIGHT"
Expand Down