Commit 238ae708 authored by Tristan Van Berkom's avatar Tristan Van Berkom

Updated man pages after bst show formatting options have changed.

parent 071881c3
Pipeline #8139880 passed with stages
in 3 minutes and 50 seconds
.TH "BST BUILD" "1" "12-Apr-2017" "" "bst build Manual"
.TH "BST BUILD" "1" "09-May-2017" "" "bst build Manual"
.SH NAME
bst\-build \- Build elements in a pipeline
.SH SYNOPSIS
......
.TH "BST CHECKOUT" "1" "12-Apr-2017" "" "bst checkout Manual"
.TH "BST CHECKOUT" "1" "09-May-2017" "" "bst checkout Manual"
.SH NAME
bst\-checkout \- Checkout a built artifact
.SH SYNOPSIS
......
.TH "BST FETCH" "1" "12-Apr-2017" "" "bst fetch Manual"
.TH "BST FETCH" "1" "09-May-2017" "" "bst fetch Manual"
.SH NAME
bst\-fetch \- Fetch sources in a pipeline
.SH SYNOPSIS
......
.TH "BST SHELL" "1" "12-Apr-2017" "" "bst shell Manual"
.TH "BST SHELL" "1" "09-May-2017" "" "bst shell Manual"
.SH NAME
bst\-shell \- Shell into an element's sandbox environment
.SH SYNOPSIS
......
.TH "BST SHOW" "1" "12-Apr-2017" "" "bst show Manual"
.TH "BST SHOW" "1" "09-May-2017" "" "bst show Manual"
.SH NAME
bst\-show \- Show elements in the pipeline
.SH SYNOPSIS
......@@ -17,13 +17,14 @@ 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 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
%{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,
......
.TH "BST TRACK" "1" "12-Apr-2017" "" "bst track Manual"
.TH "BST TRACK" "1" "09-May-2017" "" "bst track Manual"
.SH NAME
bst\-track \- Track new source references
.SH SYNOPSIS
......
.TH "BST" "1" "12-Apr-2017" "" "bst Manual"
.TH "BST" "1" "09-May-2017" "" "bst Manual"
.SH NAME
bst \- Build and manipulate BuildStream projects...
.SH SYNOPSIS
......@@ -14,7 +14,7 @@ user preferences configuration file.
\fB\-\-version\fP
Show the version and exit.
.TP
\fB\-c,\fP \-\-config PATH
\fB\-c,\fP \-\-config FILE
Configuration file to use
.TP
\fB\-C,\fP \-\-directory DIRECTORY
......@@ -44,6 +44,11 @@ Maximum number of lines to show from a task log
\fB\-\-log\-file\fP FILENAME
A file to store the main log (allows storing the main log while in interactive mode)
.SH COMMANDS
.PP
\fBshow\fP
Show elements in the pipeline
See \fBbst-show(1)\fP for full documentation on the \fBshow\fP command.
.PP
\fBtrack\fP
Track new source references
......@@ -59,17 +64,12 @@ A file to store the main log (allows storing the main log while in interactive m
Fetch sources in a pipeline
See \fBbst-fetch(1)\fP for full documentation on the \fBfetch\fP command.
.PP
\fBcheckout\fP
Checkout a built artifact
See \fBbst-checkout(1)\fP for full documentation on the \fBcheckout\fP command.
.PP
\fBshow\fP
Show elements in the pipeline
See \fBbst-show(1)\fP for full documentation on the \fBshow\fP command.
.PP
\fBshell\fP
Shell into an element's sandbox environment
See \fBbst-shell(1)\fP for full documentation on the \fBshell\fP command.
.PP
\fBcheckout\fP
Checkout a built artifact
See \fBbst-checkout(1)\fP for full documentation on the \fBcheckout\fP command.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment