summaryrefslogtreecommitdiff
path: root/man/bst.1
diff options
context:
space:
mode:
authorTristan Van Berkom <tristan.vanberkom@codethink.co.uk>2017-09-10 23:59:32 -0400
committerTristan Van Berkom <tristan.vanberkom@codethink.co.uk>2017-09-10 23:59:32 -0400
commit7bc2e070182fc45b9e6d630e95d5e90d97fc910e (patch)
tree234d1e22cfc816b4f8461010afd03d7dacffd258 /man/bst.1
parentbe295512bb405b12a0008852ff74e36135700186 (diff)
downloadbuildstream-7bc2e070182fc45b9e6d630e95d5e90d97fc910e.tar.gz
Generating man pages
Including changes for newly added bst push & pull commands and also some changes to the shell command.
Diffstat (limited to 'man/bst.1')
-rw-r--r--man/bst.148
1 files changed, 29 insertions, 19 deletions
diff --git a/man/bst.1 b/man/bst.1
index 513478464..783b74af0 100644
--- a/man/bst.1
+++ b/man/bst.1
@@ -1,4 +1,4 @@
-.TH "BST" "1" "27-Jul-2017" "" "bst Manual"
+.TH "BST" "1" "10-Sep-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 FILE
+\fB\-c,\fP \-\-config PATH
Configuration file to use
.TP
\fB\-C,\fP \-\-directory DIRECTORY
@@ -69,19 +69,34 @@ Machine architecture for build output (defaults to --arch)
Elements must be rebuilt when their dependencies have changed
.SH COMMANDS
.PP
+\fBbuild\fP
+ Build elements in a pipeline
+ See \fBbst-build(1)\fP for full documentation on the \fBbuild\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
-\fBbuild\fP
- Build elements in a pipeline
- See \fBbst-build(1)\fP for full documentation on the \fBbuild\fP command.
+\fBcheckout\fP
+ Checkout a built artifact
+ See \fBbst-checkout(1)\fP for full documentation on the \fBcheckout\fP command.
.PP
-\fBtrack\fP
- Track new source references
- See \fBbst-track(1)\fP for full documentation on the \fBtrack\fP command.
+\fBfetch\fP
+ Fetch sources in a pipeline
+ See \fBbst-fetch(1)\fP for full documentation on the \fBfetch\fP command.
+
+.PP
+\fBworkspace\fP
+ Manipulate developer workspaces
+ See \fBbst-workspace(1)\fP for full documentation on the \fBworkspace\fP command.
+
+.PP
+\fBpull\fP
+ Pull a built artifact
+ See \fBbst-pull(1)\fP for full documentation on the \fBpull\fP command.
.PP
\fBshow\fP
@@ -94,16 +109,11 @@ Elements must be rebuilt when their dependencies have changed
See \fBbst-source-bundle(1)\fP for full documentation on the \fBsource-bundle\fP command.
.PP
-\fBfetch\fP
- Fetch sources in a pipeline
- See \fBbst-fetch(1)\fP for full documentation on the \fBfetch\fP command.
+\fBpush\fP
+ Push a built artifact
+ See \fBbst-push(1)\fP for full documentation on the \fBpush\fP command.
.PP
-\fBcheckout\fP
- Checkout a built artifact
- See \fBbst-checkout(1)\fP for full documentation on the \fBcheckout\fP command.
-
-.PP
-\fBworkspace\fP
- Manipulate developer workspaces
- See \fBbst-workspace(1)\fP for full documentation on the \fBworkspace\fP command.
+\fBtrack\fP
+ Track new source references
+ See \fBbst-track(1)\fP for full documentation on the \fBtrack\fP command.