diff options
author | Tristan Van Berkom <tristan.vanberkom@codethink.co.uk> | 2017-05-09 21:31:58 +0900 |
---|---|---|
committer | Tristan Van Berkom <tristan.vanberkom@codethink.co.uk> | 2017-05-09 21:31:58 +0900 |
commit | 238ae70818acad2a3325dc20eb0acee05c60c97e (patch) | |
tree | fea9e2afb92182e1bc7c93e58545d65df73ad9b2 /man | |
parent | 071881c35ea88f3242936488d056f83320bd535f (diff) | |
download | buildstream-238ae70818acad2a3325dc20eb0acee05c60c97e.tar.gz |
Updated man pages after bst show formatting options have changed.
Diffstat (limited to 'man')
-rw-r--r-- | man/bst-build.1 | 2 | ||||
-rw-r--r-- | man/bst-checkout.1 | 2 | ||||
-rw-r--r-- | man/bst-fetch.1 | 2 | ||||
-rw-r--r-- | man/bst-shell.1 | 2 | ||||
-rw-r--r-- | man/bst-show.1 | 17 | ||||
-rw-r--r-- | man/bst-track.1 | 2 | ||||
-rw-r--r-- | man/bst.1 | 24 |
7 files changed, 26 insertions, 25 deletions
diff --git a/man/bst-build.1 b/man/bst-build.1 index d00fc500e..1d9cb61ca 100644 --- a/man/bst-build.1 +++ b/man/bst-build.1 @@ -1,4 +1,4 @@ -.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 diff --git a/man/bst-checkout.1 b/man/bst-checkout.1 index 80adaffd9..ff2b03949 100644 --- a/man/bst-checkout.1 +++ b/man/bst-checkout.1 @@ -1,4 +1,4 @@ -.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 diff --git a/man/bst-fetch.1 b/man/bst-fetch.1 index a23d5852c..8d81de689 100644 --- a/man/bst-fetch.1 +++ b/man/bst-fetch.1 @@ -1,4 +1,4 @@ -.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 diff --git a/man/bst-shell.1 b/man/bst-shell.1 index eb173b619..d3ec61d10 100644 --- a/man/bst-shell.1 +++ b/man/bst-shell.1 @@ -1,4 +1,4 @@ -.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 diff --git a/man/bst-show.1 b/man/bst-show.1 index 371d95240..e7d16678b 100644 --- a/man/bst-show.1 +++ b/man/bst-show.1 @@ -1,4 +1,4 @@ -.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, diff --git a/man/bst-track.1 b/man/bst-track.1 index 9c5dde6e0..bcffa5581 100644 --- a/man/bst-track.1 +++ b/man/bst-track.1 @@ -1,4 +1,4 @@ -.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 @@ -1,4 +1,4 @@ -.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 @@ -45,6 +45,11 @@ Maximum number of lines to show from a task log 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 See \fBbst-track(1)\fP for full documentation on the \fBtrack\fP command. @@ -60,16 +65,11 @@ A file to store the main log (allows storing the main log while in interactive m 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. |