summaryrefslogtreecommitdiff
path: root/man/bst-shell.1
diff options
context:
space:
mode:
Diffstat (limited to 'man/bst-shell.1')
-rw-r--r--man/bst-shell.115
1 files changed, 12 insertions, 3 deletions
diff --git a/man/bst-shell.1 b/man/bst-shell.1
index 3cc02f973..5f806e453 100644
--- a/man/bst-shell.1
+++ b/man/bst-shell.1
@@ -1,9 +1,9 @@
-.TH "BST SHELL" "1" "29-Nov-2018" "" "bst shell Manual"
+.TH "BST SHELL" "1" "22-Jan-2019" "" "bst shell Manual"
.SH NAME
bst\-shell \- Shell into an element's sandbox environment
.SH SYNOPSIS
.B bst shell
-[OPTIONS] ELEMENT [COMMAND]...
+[OPTIONS] [ELEMENT] [COMMAND]...
.SH DESCRIPTION
Run a command in the target element's sandbox environment
.PP
@@ -11,6 +11,12 @@ This will stage a temporary sysroot for running the target
element, assuming it has already been built and all required
artifacts are in the local cache.
.PP
+Use '--' to separate a command from the options to bst,
+otherwise bst may respond to them instead. e.g.
+.PP
+
+ bst shell example.bst -- df -h
+.PP
Use the --build option to create a temporary sysroot for
building the element instead.
.PP
@@ -32,4 +38,7 @@ An existing sysroot
Mount a file or directory into the sandbox
.TP
\fB\-\-isolate\fP
-Create an isolated build sandbox \ No newline at end of file
+Create an isolated build sandbox
+.TP
+\fB\-t,\fP \-\-use\-buildtree [ask|try|always|never]
+Defaults to ask but if set to always the function will fail if a build tree is not available \ No newline at end of file