Updated rustpkg man page to match 0.7
This commit is contained in:
Gavin Baker
parent
6143419ee1
commit
50600c302e
226
man/rustpkg.1
226
man/rustpkg.1
|
|
@ -15,146 +15,168 @@ install and test Rust programs.
|
||||||
|
|
||||||
.TP
|
.TP
|
||||||
\fBbuild\fR
|
\fBbuild\fR
|
||||||
Build all targets described in the package script in the current
|
Searches for a package with the specified name and builds it in the workspace in
|
||||||
directory.
|
which it is found.
|
||||||
.TP
|
.TP
|
||||||
\fBclean\fR
|
\fBclean\fR
|
||||||
Remove all build files in the work cache for the package in the current
|
Remove all generated files from the \fIbuild\fR directory in the target's workspace.
|
||||||
directory.
|
|
||||||
.TP
|
|
||||||
\fBdo\fR
|
|
||||||
Runs a command in the package script.
|
|
||||||
.TP
|
|
||||||
\fBinfo\fR
|
|
||||||
Probe the package script in the current directory for information.
|
|
||||||
.TP
|
.TP
|
||||||
\fBinstall\fR
|
\fBinstall\fR
|
||||||
Install a package given a local archive or a remote URI or VCS.
|
Builds the specified target, and all its dependencies, and then installs the
|
||||||
.TP
|
build products into the \fIlib\fR and \fIbin\fR directories of their respective
|
||||||
\fBprefer\fR
|
workspaces.
|
||||||
Specify which version of a binary to use.
|
|
||||||
.TP
|
.TP
|
||||||
\fBtest\fR
|
\fBtest\fR
|
||||||
Build all targets described in the package script in the current directory
|
Builds the module called \fItest.rs\fR in the specified workspace, and then runs
|
||||||
with the test flag.
|
the resulting executable in test mode.
|
||||||
.TP
|
|
||||||
\fBuninstall\fR
|
|
||||||
Remove a package by id or name and optionally version.
|
|
||||||
.TP
|
|
||||||
\fBunprefer\fR
|
|
||||||
Remove links to the versioned binary.
|
|
||||||
.TP
|
|
||||||
\fBhelp\fR
|
|
||||||
show detailed usage of a command
|
|
||||||
|
|
||||||
.SH "BUILD COMMAND"
|
.SS "BUILD COMMAND"
|
||||||
|
|
||||||
The \fBbuild\fR command builds all targets described in the package script in
|
rustpkg build \fI[pkgname]\fR
|
||||||
the current directory.
|
|
||||||
|
|
||||||
.TP
|
The \fBbuild\fR command searches for a package with specified package name and
|
||||||
-c, --cfg
|
builds it in any workspace(s) where it finds one. Any dependent packages are
|
||||||
Pass a cfg flag to the package script
|
also built. The output files produced by the build phase are stored in the
|
||||||
|
\fIbuild\fR subdirectories of each package. The executables and libraries are
|
||||||
|
not copied to the 'bin' or 'lib' directories; that is the purpose of the
|
||||||
|
\fBinstall\fR command.
|
||||||
|
|
||||||
.SH "DO COMMAND"
|
.SS "CLEAN COMMAND"
|
||||||
|
|
||||||
The \fBdo\fR command runs a command in the package script. You can listen to a
|
rustpkg clean \fI[pkgname]\fR
|
||||||
command by tagging a function with the attribute `#[pkg_do(cmd)]`.
|
|
||||||
|
|
||||||
.SH "TEST COMMAND"
|
deletes the contents of package's build directory.
|
||||||
|
|
||||||
The test command is an shortcut for the command line:
|
.SS "INSTALL COMMAND"
|
||||||
|
|
||||||
$ rustc --test <filename> -o <filestem>test~ && ./<filestem>test~
|
rustpkg install \fI[url]\fR
|
||||||
|
|
||||||
Note the trailing tilde on the output filename, which should ensure the
|
builds the libraries and/or executables that are targets for the specified
|
||||||
file does not clash with a user-generated files.
|
package name or URL, and then installs them either into package's \fIlib\fR
|
||||||
|
and \fIbin\fR directories, or into the \fIlib\fR and \fIbin\fR subdirectories
|
||||||
.SH "INFO COMMAND"
|
of the first entry in RUST_PATH.
|
||||||
|
|
||||||
Probe the package script in the current directory for information.
|
|
||||||
|
|
||||||
Options:
|
|
||||||
|
|
||||||
.TP
|
|
||||||
-j, --json
|
|
||||||
Output the result as JSON
|
|
||||||
|
|
||||||
.SH "INSTALL COMMAND"
|
|
||||||
|
|
||||||
rustpkg [options..] install [url] [target]
|
|
||||||
|
|
||||||
Install a package from a URL by Git or cURL (FTP, HTTP, etc.). If target is
|
|
||||||
provided, Git will checkout the branch or tag before continuing. If the URL
|
|
||||||
is a TAR file (with or without compression), extract it before
|
|
||||||
installing. If a URL isn't provided, the package will be built and installed
|
|
||||||
from the current directory (which is functionally the same as `rustpkg
|
|
||||||
build` and installing the result).
|
|
||||||
|
|
||||||
Examples:
|
Examples:
|
||||||
|
|
||||||
rustpkg install
|
$ rustpkg install git://github.com/mozilla/servo.git#1.2
|
||||||
rustpkg install git://github.com/mozilla/servo.git
|
$ rustpkg install rust-glfw
|
||||||
rustpkg install git://github.com/mozilla/servo.git v0.1.2
|
|
||||||
rustpkg install http://rust-lang.org/servo-0.1.2.tar.gz
|
|
||||||
|
|
||||||
Options:
|
.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
|
.TP
|
||||||
-c, --cfg
|
RUST_PATH
|
||||||
Pass a cfg flag to the package script
|
A colon-separated (semicolon-separated) list of paths denoting workspaces
|
||||||
|
to search for Rust source files. See the section \fBPATHS\fR for full details.
|
||||||
|
|
||||||
.SH "PREFER COMMAND"
|
.SH "PATHS"
|
||||||
|
|
||||||
By default all binaries are given a unique name so that multiple versions
|
The \fBrustpkg\fR tool searches for packages in the folders specified by the
|
||||||
can coexist. The prefer command will symlink the uniquely named binary to
|
\fBRUST_PATH\fR environment variable. Each folder constitutes a
|
||||||
the binary directory under its bare name. If version is not supplied, the
|
\fIworkspace\fR, which contains one or more modules available to import.
|
||||||
latest version of the package will be preferred.
|
|
||||||
|
|
||||||
Example:
|
In addition to the RUST_PATH settings, the following implicit paths are
|
||||||
|
\fIalways\fR searched, in the following order:
|
||||||
|
|
||||||
export PATH=$PATH:/home/user/.rustpkg/bin
|
1. Any folders named ".rust" in the current directory, \fIand every parent\fR
|
||||||
rustpkg prefer machine@1.2.4
|
of the curent directory, up to the filesystem root;
|
||||||
machine -v
|
|
||||||
==> v1.2.4
|
|
||||||
rustpkg prefer machine@0.4.6
|
|
||||||
machine -v
|
|
||||||
==> v0.4.6
|
|
||||||
|
|
||||||
.SH "TEST COMMAND"
|
2. The system path "/usr/local" on Unix-style systems, or the equivalent on
|
||||||
|
Windows; and
|
||||||
|
|
||||||
Build all targets described in the package script in the current directory
|
3. A folder named ".rust" in the user's home directory (ie. "~/.rust" on Unix-
|
||||||
with the test flag. The test bootstraps will be run afterwards and the output
|
style systems or the equivalent on Windows).
|
||||||
and exit code will be redirected.
|
|
||||||
|
|
||||||
Options:
|
.SH "PACKAGE STRUCTURE"
|
||||||
|
|
||||||
|
A valid workspace must contain each of the following subdirectories:
|
||||||
|
|
||||||
.TP
|
.TP
|
||||||
-c, --cfg
|
\fBsrc/\fR
|
||||||
Pass a cfg flag to the package script
|
Contains the Rust source code, with one subdirectory per package. Each
|
||||||
|
subdirectory contains source files for a given package.
|
||||||
|
.TP
|
||||||
|
\fBlib/\fR
|
||||||
|
"rustpkg install" installs libraries into a target-specific subdirectory of this directory.
|
||||||
|
.TP
|
||||||
|
\fBbin/\fR
|
||||||
|
"rustpkg install" installs executable binaries into a target-specific subdirectory of this directory.
|
||||||
|
.TP
|
||||||
|
\fBbuild/\fR
|
||||||
|
"rustpkg build" stores temporary build artifacts in a target-specific subdirectory of this directory.
|
||||||
|
|
||||||
.SH "UNINSTALL COMMAND"
|
For example, if "foo" is a workspace containing the package "bar", then
|
||||||
|
"foo/src/bar/main.rs" would be the "main" entry point for building a "bar"
|
||||||
|
executable.
|
||||||
|
|
||||||
Remove a package by id or name and optionally version. If the package(s)
|
.SH "PACKAGE IDENTIFIERS"
|
||||||
is/are depended on by another package then they cannot be removed.
|
|
||||||
|
|
||||||
.SH "UNPREFER COMMAND"
|
A package identifier uniquely identifies a package. A package can be stored in
|
||||||
|
a workspace on the local file system, or on a remote Web server, in which case
|
||||||
|
the package ID resembles a URL.
|
||||||
|
|
||||||
$ rustpkg [options..] unprefer <id|name>[@version]
|
For example, \fIgithub.com/mozilla/rust\fR is a package ID
|
||||||
|
that would refer to the git repository browsable at \fIhttp://github.com/mozilla/rust\fR.
|
||||||
|
|
||||||
Remove all symlinks from the store to the binary directory for a package
|
A package ID can also specify a version, like:
|
||||||
name and optionally version. If version is not supplied, the latest version
|
\fIgithub.com/mozilla/rust#0.3\fR. In this case, \fBrustpkg\fR will check that
|
||||||
of the package will be unpreferred. See `rustpkg prefer -h` for more
|
the repository \fIgithub.com/mozilla/rust\fR has a tag named \fI0.3\fR, and
|
||||||
information.
|
report an error otherwise.
|
||||||
|
|
||||||
.SH "EXAMPLES"
|
.SH "SPECIAL MODULES"
|
||||||
|
|
||||||
To clone, build and install a specific version of the Servo engine from
|
\fBrustpkg\fR searches for four different known filenames in the src directory
|
||||||
its git repository on Github:
|
in order to determine which crates to build:
|
||||||
$ rustpkg install git://github.com/mozilla/servo.git v0.1.2
|
|
||||||
|
|
||||||
To download the archive and install Servo from a tarball:
|
.TP
|
||||||
$ rustpkg install http://rust-lang.org/servo-0.1.2.tar.gz
|
\fBmain.rs\fR
|
||||||
|
Assumed to be a main entry point for building an executable (install destination is 'bin' directory).
|
||||||
|
.TP
|
||||||
|
\fBlib.rs\fR
|
||||||
|
Assumed to be a library crate (install destination is 'lib' directory).
|
||||||
|
.TP
|
||||||
|
\fBtest.rs\fR
|
||||||
|
Assumed to contain tests declared with the \fI#[test]\fR attribute.
|
||||||
|
.TP
|
||||||
|
\fBbench.rs\fR
|
||||||
|
Assumed to contain benchmarks declared with the \fI#[bench]\fR attribute.
|
||||||
|
|
||||||
|
.SH "CRATE VERSIONS"
|
||||||
|
|
||||||
|
\fBrustpkg\fR packages do not need to declare their versions with an attribute
|
||||||
|
inside one of the source files, because rustpkg infers it from the version
|
||||||
|
control system. When building a package that is in a git repository,
|
||||||
|
rustpkg assumes that the most recent tag specifies the current version. When
|
||||||
|
building a package that is not under version control, or that has no tags,
|
||||||
|
rustpkg defaults the version to 0.1.
|
||||||
|
|
||||||
|
.SH "DEPENDENCIES"
|
||||||
|
|
||||||
|
rustpkg infers dependencies from "extern mod" directives. Thus, there should
|
||||||
|
be no need to pass a "-L" flag to rustpkg to tell it where to find a library.
|
||||||
|
(In the future, it will also be possible to write an "extern mod" directive
|
||||||
|
referring to a remote package.)
|
||||||
|
|
||||||
|
.SH "CUSTOM BUILD SCRIPTS"
|
||||||
|
|
||||||
|
A file called \fIpkg.rs\fR at the root level in a workspace is called a \fIpackage
|
||||||
|
script\fR. If a package script exists, rustpkg executes it to build the
|
||||||
|
package rather than inferring crates as described previously.
|
||||||
|
|
||||||
|
Inside \fIpkg.rs\fR, it's possible to call back into rustpkg to finish up the
|
||||||
|
build. The \fIrustpkg::api\fR module contains functions to build, install, or
|
||||||
|
clean libraries and executables in the way rustpkg normally would without
|
||||||
|
custom build logic.
|
||||||
|
|
||||||
.SH "SEE ALSO"
|
.SH "SEE ALSO"
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue