summaryrefslogtreecommitdiff
path: root/man
diff options
context:
space:
mode:
authorTristan Van Berkom <tristan.vanberkom@codethink.co.uk>2017-05-27 18:13:44 +0900
committerTristan Van Berkom <tristan.vanberkom@codethink.co.uk>2017-05-27 18:13:44 +0900
commit60ed2d3d7ae2006bc3a19d969442cb9ecea18a00 (patch)
tree7e4b25c89152e5a32ec7cf00a8d402f2d888eb36 /man
parentf45feffe05e234f55808353c116b788d4647ad70 (diff)
downloadbuildstream-60ed2d3d7ae2006bc3a19d969442cb9ecea18a00.tar.gz
Committing automatically generated man pages.
Diffstat (limited to 'man')
-rw-r--r--man/bst-build.12
-rw-r--r--man/bst-checkout.12
-rw-r--r--man/bst-fetch.16
-rw-r--r--man/bst-shell.12
-rw-r--r--man/bst-show.16
-rw-r--r--man/bst-track.16
-rw-r--r--man/bst.125
7 files changed, 26 insertions, 23 deletions
diff --git a/man/bst-build.1 b/man/bst-build.1
index 1d9cb61ca..3f5935481 100644
--- a/man/bst-build.1
+++ b/man/bst-build.1
@@ -1,4 +1,4 @@
-.TH "BST BUILD" "1" "09-May-2017" "" "bst build Manual"
+.TH "BST BUILD" "1" "27-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 ff2b03949..d585755c9 100644
--- a/man/bst-checkout.1
+++ b/man/bst-checkout.1
@@ -1,4 +1,4 @@
-.TH "BST CHECKOUT" "1" "09-May-2017" "" "bst checkout Manual"
+.TH "BST CHECKOUT" "1" "27-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 8d81de689..ec20af783 100644
--- a/man/bst-fetch.1
+++ b/man/bst-fetch.1
@@ -1,4 +1,4 @@
-.TH "BST FETCH" "1" "09-May-2017" "" "bst fetch Manual"
+.TH "BST FETCH" "1" "27-May-2017" "" "bst fetch Manual"
.SH NAME
bst\-fetch \- Fetch sources in a pipeline
.SH SYNOPSIS
@@ -8,8 +8,8 @@ bst\-fetch \- Fetch sources in a pipeline
Fetch sources in a pipeline
.SH OPTIONS
.TP
-\fB\-\-needed\fP
-Fetch only sources required to build missing artifacts
+\fB\-d,\fP \-\-deps [none|plan|all|build|run]
+Specify a dependency scope to fetch (default: none)
.TP
\fB\-a,\fP \-\-arch TEXT
The target architecture (default: x86_64)
diff --git a/man/bst-shell.1 b/man/bst-shell.1
index d3ec61d10..90455d460 100644
--- a/man/bst-shell.1
+++ b/man/bst-shell.1
@@ -1,4 +1,4 @@
-.TH "BST SHELL" "1" "09-May-2017" "" "bst shell Manual"
+.TH "BST SHELL" "1" "27-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 e7d16678b..c4a075f1e 100644
--- a/man/bst-show.1
+++ b/man/bst-show.1
@@ -1,4 +1,4 @@
-.TH "BST SHOW" "1" "09-May-2017" "" "bst show Manual"
+.TH "BST SHOW" "1" "27-May-2017" "" "bst show Manual"
.SH NAME
bst\-show \- Show elements in the pipeline
.SH SYNOPSIS
@@ -41,8 +41,8 @@ If you want to use a newline in a format string in bash, use the '$' modifier:
$'---------- %{name} ----------\n%{vars}'
.SH OPTIONS
.TP
-\fB\-d,\fP \-\-deps [all|build|run]
-Optionally specify a dependency scope to show
+\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
diff --git a/man/bst-track.1 b/man/bst-track.1
index bcffa5581..1a6fabe61 100644
--- a/man/bst-track.1
+++ b/man/bst-track.1
@@ -1,4 +1,4 @@
-.TH "BST TRACK" "1" "09-May-2017" "" "bst track Manual"
+.TH "BST TRACK" "1" "27-May-2017" "" "bst track Manual"
.SH NAME
bst\-track \- Track new source references
.SH SYNOPSIS
@@ -14,8 +14,8 @@ branch or tag.
The project data will be rewritten inline.
.SH OPTIONS
.TP
-\fB\-d,\fP \-\-deps [all|build|run]
-Optionally specify a dependency scope to track
+\fB\-d,\fP \-\-deps [none|plan|all|build|run]
+Specify a dependency scope to track (default: none)
.TP
\fB\-a,\fP \-\-arch TEXT
The target architecture (default: x86_64)
diff --git a/man/bst.1 b/man/bst.1
index e9c494d35..b7b08db79 100644
--- a/man/bst.1
+++ b/man/bst.1
@@ -1,4 +1,4 @@
-.TH "BST" "1" "09-May-2017" "" "bst Manual"
+.TH "BST" "1" "27-May-2017" "" "bst Manual"
.SH NAME
bst \- Build and manipulate BuildStream projects...
.SH SYNOPSIS
@@ -41,30 +41,33 @@ Print debugging output
\fB\-\-error\-lines\fP INTEGER
Maximum number of lines to show from a task log
.TP
+\fB\-\-message\-lines\fP INTEGER
+Maximum number of lines to show in a detailed message
+.TP
\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
- See \fBbst-track(1)\fP for full documentation on the \fBtrack\fP command.
-
-.PP
\fBbuild\fP
Build elements in a pipeline
See \fBbst-build(1)\fP for full documentation on the \fBbuild\fP command.
.PP
+\fBshow\fP
+ Show elements in the pipeline
+ See \fBbst-show(1)\fP for full documentation on the \fBshow\fP command.
+
+.PP
\fBfetch\fP
Fetch sources in a pipeline
See \fBbst-fetch(1)\fP for full documentation on the \fBfetch\fP command.
.PP
+\fBtrack\fP
+ Track new source references
+ See \fBbst-track(1)\fP for full documentation on the \fBtrack\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.