summaryrefslogtreecommitdiff
path: root/man/bst-show.1
blob: c4a075f1e9de20811c242e36f1ec8149efde4bbd (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
51
52
53
54
55
56
57
.TH "BST SHOW" "1" "27-May-2017" "" "bst show Manual"
.SH NAME
bst\-show \- Show elements in the pipeline
.SH SYNOPSIS
.B bst show
[OPTIONS] TARGET
.SH DESCRIPTION
Show elements in the pipeline

By default this will only show the specified element, use
the --deps option to show an entire pipeline.


FORMAT
~~~~~~
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

The value of the %{symbol} without the leading '%' character is understood
as a pythonic formatting string, so python formatting features apply,
examle:


    build-stream 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:


    build-stream show target.bst --format \
        $'---------- %{name} ----------\n%{vars}'
.SH OPTIONS
.TP
\fB\-d,\fP \-\-deps [none|plan|all|build|run]
Specify a dependency scope to show (default: none)
.TP
\fB\-\-order\fP [stage|alpha]
Staging or alphabetic ordering of dependencies
.TP
\fB\-f,\fP \-\-format FORMAT
Format string for each element
.TP
\fB\-a,\fP \-\-arch TEXT
The target architecture (default: x86_64)
.TP
\fB\-\-variant\fP TEXT
A variant of the specified target