blob: b82d0a3966e40468040b354db5d7b1a504cdb071 [file] [log] [blame]
.TH "BST SHOW" "1" "26-Apr-2018" "" "bst show Manual"
bst\-show \- Show elements in the pipeline
.B bst show
Show elements in the pipeline
By default this will show all of the dependencies of the
specified target element.
Specify `--deps` to control which elements to show:

none: No dependencies, just the element itself
plan: Dependencies required for a build plan
run: Runtime dependencies, including the element itself
build: Build time dependencies, excluding the element itself
all: All dependencies

The --format option controls what should be printed for each element,
the following symbols can be used in the format string:

%{name} The element name
%{key} The abbreviated cache key (if all sources are consistent)
%{full-key} The full cache key (if all sources are consistent)
%{state} cached, buildable, waiting or inconsistent
%{config} The element configuration
%{vars} Variable configuration
%{env} Environment settings
%{public} Public domain data
%{workspaced} If the element is workspaced
%{workspace-dirs} A list of workspace directories
The value of the %{symbol} without the leading '%' character is understood
as a pythonic formatting string, so python formatting features apply,

bst show target.bst --format \
'Name: %{name: ^20} Key: %{key: ^8} State: %{state}'
If you want to use a newline in a format string in bash, use the '$' modifier:

bst show target.bst --format \
$'---------- %{name} ----------\n%{vars}'
\fB\-\-except\fP PATH
Except certain dependencies
\fB\-d,\fP \-\-deps [none|plan|run|build|all]
The dependencies to show (default: all)
\fB\-\-order\fP [stage|alpha]
Staging or alphabetic ordering of dependencies
\fB\-f,\fP \-\-format FORMAT
Format string for each element
Refresh downloadable state