diff options
| author | Tristan Van Berkom <tristan.vanberkom@codethink.co.uk> | 2017-09-10 23:59:32 -0400 |
|---|---|---|
| committer | Tristan Van Berkom <tristan.vanberkom@codethink.co.uk> | 2017-09-10 23:59:32 -0400 |
| commit | 7bc2e070182fc45b9e6d630e95d5e90d97fc910e (patch) | |
| tree | 234d1e22cfc816b4f8461010afd03d7dacffd258 /man/bst-shell.1 | |
| parent | be295512bb405b12a0008852ff74e36135700186 (diff) | |
| download | buildstream-7bc2e070182fc45b9e6d630e95d5e90d97fc910e.tar.gz | |
Generating man pages
Including changes for newly added bst push & pull
commands and also some changes to the shell command.
Diffstat (limited to 'man/bst-shell.1')
| -rw-r--r-- | man/bst-shell.1 | 31 |
1 files changed, 19 insertions, 12 deletions
diff --git a/man/bst-shell.1 b/man/bst-shell.1 index 510a4918e..7c53ff1dc 100644 --- a/man/bst-shell.1 +++ b/man/bst-shell.1 @@ -1,25 +1,32 @@ -.TH "BST SHELL" "1" "27-Jul-2017" "" "bst shell Manual" +.TH "BST SHELL" "1" "10-Sep-2017" "" "bst shell Manual" .SH NAME bst\-shell \- Shell into an element's sandbox environment .SH SYNOPSIS .B bst shell -[OPTIONS] TARGET +[OPTIONS] TARGET [COMMAND]... .SH DESCRIPTION -Shell into an element's sandbox environment +Run a command in the target element's sandbox environment -This can be used either to debug building or to launch -test and debug successful build results. +This will first stage a temporary sysroot for running +the target element, assuming it has already been built +and all required artifacts are in the local cache. -Use the --builddir option with an existing build directory -or use the --scope option instead to create a new staging -area automatically. +Use the --build option to create a temporary sysroot for +building the element instead. + +Use the --sysroot option with an existing failed build +directory or with a checkout of the given target, in order +to use a specific sysroot. + +If no COMMAND is specified, the default is to attempt +to run an interactive shell with `sh -i`. .SH OPTIONS .TP -\fB\-b,\fP \-\-builddir DIRECTORY -Existing build directory +\fB\-b,\fP \-\-build +Create a build sandbox .TP -\fB\-s,\fP \-\-scope [build|run] -Specify element scope to stage +\fB\-s,\fP \-\-sysroot DIRECTORY +An existing sysroot .TP \fB\-\-variant\fP TEXT A variant of the specified target
\ No newline at end of file |
