summaryrefslogtreecommitdiff
path: root/man/bst-shell.1
diff options
context:
space:
mode:
authorAngelos Evripiotis <jevripiotis@bloomberg.net>2018-11-29 16:55:46 +0400
committerJürg Billeter <j@bitron.ch>2018-11-30 09:34:38 +0000
commit1f31aefc2afb3e09cd294e83cb3cace4af076613 (patch)
tree356f2a451b41a9e5d248ffebbab384425623b5ec /man/bst-shell.1
parentf6c184f5bdaa664d543d00c6f42f25614d0f79dd (diff)
downloadbuildstream-1f31aefc2afb3e09cd294e83cb3cace4af076613.tar.gz
man/: update with changes since Apr 2018
It seems that the regenerated man pages haven't been committed for some time. Add them all in one lump now. Had to manually strip the version number from the generated files. Had to manually fix the NAME field of bst.1 to not be 'bst - None'. Oddly had to invoke click-man directly in order to get the changes to be applied, the usual setup.py route mentioned in contributing.rst didn't work. Eyeballed the result of invoking man on each of the commands, seems good.
Diffstat (limited to 'man/bst-shell.1')
-rw-r--r--man/bst-shell.110
1 files changed, 5 insertions, 5 deletions
diff --git a/man/bst-shell.1 b/man/bst-shell.1
index bc8b1164a..3cc02f973 100644
--- a/man/bst-shell.1
+++ b/man/bst-shell.1
@@ -1,4 +1,4 @@
-.TH "BST SHELL" "1" "26-Apr-2018" "" "bst shell Manual"
+.TH "BST SHELL" "1" "29-Nov-2018" "" "bst shell Manual"
.SH NAME
bst\-shell \- Shell into an element's sandbox environment
.SH SYNOPSIS
@@ -6,18 +6,18 @@ bst\-shell \- Shell into an element's sandbox environment
[OPTIONS] ELEMENT [COMMAND]...
.SH DESCRIPTION
Run a command in the target element's sandbox environment
-
+.PP
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 the --build option to create a temporary sysroot for
building the element instead.
-
+.PP
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.
-
+.PP
If no COMMAND is specified, the default is to attempt
to run an interactive shell.
.SH OPTIONS