summaryrefslogtreecommitdiff
path: root/man/bst-shell.1
blob: a6e8956da40be225e963ae766899e6b27224eeb6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
.TH "BST SHELL" "1" "14-Jul-2019" "" "bst shell Manual"
.SH NAME
bst\-shell \- Shell into an element's sandbox environment
.SH SYNOPSIS
.B bst shell
[OPTIONS] [ELEMENT] [COMMAND]...
.SH DESCRIPTION
Run a command in the target element's sandbox environment
.PP
When this command is executed from a workspace directory, the default
is to shell into the workspace element.
.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 '--' 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
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
.TP
\fB\-b,\fP \-\-build
Stage dependencies and sources to build
.TP
\fB\-s,\fP \-\-sysroot DIRECTORY
An existing sysroot
.TP
\fB\-\-mount\fP HOSTPATH PATH
Mount a file or directory into the sandbox
.TP
\fB\-\-isolate\fP
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
.TP
\fB\-\-pull\fP
Attempt to pull missing or incomplete artifacts