blob: 1ce152f947e1d1bc3bd7a9512d50bc0bf1d6a7dd [file] [log] [blame]
.TH "BST SHOW" "1" "2020-10-14" "" "bst show Manual"
bst\-show \- Show elements in the pipeline
.B bst show
Show elements in the pipeline
Specifying no elements will result in showing the default targets
of the project. If no default targets are configured, all project
elements will be shown.
When this command is executed from a workspace directory, the default
is to show the workspace element.
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, inconsistent or junction
%{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
%{deps} A list of all dependencies
%{build-deps} A list of build dependencies
%{runtime-deps} A list of runtime dependencies
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 [default: stage]
\fB\-f,\fP \-\-format FORMAT
Format string for each element