summaryrefslogtreecommitdiff
path: root/man
diff options
context:
space:
mode:
authorJames Ennis <james.ennis@codethink.com>2019-01-22 13:02:14 +0000
committerJames Ennis <james.ennis@codethink.com>2019-01-22 13:02:14 +0000
commitea2fbe4d69b7d3b214175620271a148510b75a19 (patch)
tree58133bc7dd8c95f0177e91750656a1b511e93362 /man
parent077d5a96fe82afb11238fc4e19166e07f9667ad0 (diff)
downloadbuildstream-ea2fbe4d69b7d3b214175620271a148510b75a19.tar.gz
man: Regenerate all of our man pagesjennis/migrate_pull_push_commands
Due to an upstream click_man issue: https://github.com/click-contrib/click-man/issues/10 generating the man pages with our current setup.py only generates a man page for bst-artifact-server, our first entry point. I then had to remove this entry point from setup.py and regenerate to obtain man pages for the commands in cli.py
Diffstat (limited to 'man')
-rw-r--r--man/bst-artifact-checkout.127
-rw-r--r--man/bst-artifact-log.18
-rw-r--r--man/bst-artifact-pull.125
-rw-r--r--man/bst-artifact-push.128
-rw-r--r--man/bst-artifact-receive.119
-rw-r--r--man/bst-artifact-server.110
-rw-r--r--man/bst-artifact.125
-rw-r--r--man/bst-build.12
-rw-r--r--man/bst-checkout.19
-rw-r--r--man/bst-fetch.116
-rw-r--r--man/bst-help.12
-rw-r--r--man/bst-init.14
-rw-r--r--man/bst-pull.114
-rw-r--r--man/bst-push.113
-rw-r--r--man/bst-shell.115
-rw-r--r--man/bst-show.12
-rw-r--r--man/bst-source-bundle.125
-rw-r--r--man/bst-source-checkout.119
-rw-r--r--man/bst-source-fetch.133
-rw-r--r--man/bst-source-track.128
-rw-r--r--man/bst-source.121
-rw-r--r--man/bst-track.114
-rw-r--r--man/bst-workspace-close.12
-rw-r--r--man/bst-workspace-list.14
-rw-r--r--man/bst-workspace-open.12
-rw-r--r--man/bst-workspace-reset.12
-rw-r--r--man/bst-workspace.12
-rw-r--r--man/bst.154
28 files changed, 274 insertions, 151 deletions
diff --git a/man/bst-artifact-checkout.1 b/man/bst-artifact-checkout.1
new file mode 100644
index 000000000..9d1bf5534
--- /dev/null
+++ b/man/bst-artifact-checkout.1
@@ -0,0 +1,27 @@
+.TH "BST ARTIFACT CHECKOUT" "1" "22-Jan-2019" "" "bst artifact checkout Manual"
+.SH NAME
+bst\-artifact\-checkout \- Checkout contents of an artifact
+.SH SYNOPSIS
+.B bst artifact checkout
+[OPTIONS] [ELEMENT]
+.SH DESCRIPTION
+Checkout contents of an artifact
+.SH OPTIONS
+.TP
+\fB\-f,\fP \-\-force
+Allow files to be overwritten
+.TP
+\fB\-d,\fP \-\-deps [run|build|none]
+The dependencies to checkout (default: run)
+.TP
+\fB\-\-integrate\fP / \-\-no\-integrate
+Whether to run integration commands
+.TP
+\fB\-\-hardlinks\fP
+Checkout hardlinks instead of copying if possible
+.TP
+\fB\-\-tar\fP LOCATION
+Create a tarball from the artifact contents instead of a file tree. If LOCATION is '-', the tarball will be dumped to the standard output.
+.TP
+\fB\-\-directory\fP DIRECTORY
+The directory to checkout the artifact to \ No newline at end of file
diff --git a/man/bst-artifact-log.1 b/man/bst-artifact-log.1
new file mode 100644
index 000000000..d5911da9f
--- /dev/null
+++ b/man/bst-artifact-log.1
@@ -0,0 +1,8 @@
+.TH "BST ARTIFACT LOG" "1" "22-Jan-2019" "" "bst artifact log Manual"
+.SH NAME
+bst\-artifact\-log \- Show logs of an artifact
+.SH SYNOPSIS
+.B bst artifact log
+[OPTIONS] [ARTIFACTS]...
+.SH DESCRIPTION
+Show logs of all artifacts \ No newline at end of file
diff --git a/man/bst-artifact-pull.1 b/man/bst-artifact-pull.1
new file mode 100644
index 000000000..5ac21ad94
--- /dev/null
+++ b/man/bst-artifact-pull.1
@@ -0,0 +1,25 @@
+.TH "BST ARTIFACT PULL" "1" "22-Jan-2019" "" "bst artifact pull Manual"
+.SH NAME
+bst\-artifact\-pull \- Pull a built artifact
+.SH SYNOPSIS
+.B bst artifact pull
+[OPTIONS] [ELEMENTS]...
+.SH DESCRIPTION
+Pull a built artifact from the configured remote artifact cache.
+.PP
+By default the artifact will be pulled one of the configured caches
+if possible, following the usual priority order. If the `--remote` flag
+is given, only the specified cache will be queried.
+.PP
+Specify `--deps` to control which artifacts to pull:
+.PP
+
+ none: No dependencies, just the element itself
+ all: All dependencies
+.SH OPTIONS
+.TP
+\fB\-d,\fP \-\-deps [none|all]
+The dependency artifacts to pull (default: none)
+.TP
+\fB\-r,\fP \-\-remote TEXT
+The URL of the remote cache (defaults to the first configured cache) \ No newline at end of file
diff --git a/man/bst-artifact-push.1 b/man/bst-artifact-push.1
new file mode 100644
index 000000000..5ede66917
--- /dev/null
+++ b/man/bst-artifact-push.1
@@ -0,0 +1,28 @@
+.TH "BST ARTIFACT PUSH" "1" "22-Jan-2019" "" "bst artifact push Manual"
+.SH NAME
+bst\-artifact\-push \- Push a built artifact
+.SH SYNOPSIS
+.B bst artifact push
+[OPTIONS] [ELEMENTS]...
+.SH DESCRIPTION
+Push a built artifact to a remote artifact cache.
+.PP
+The default destination is the highest priority configured cache. You can
+override this by passing a different cache URL with the `--remote` flag.
+.PP
+If bst has been configured to include build trees on artifact pulls,
+an attempt will be made to pull any required build trees to avoid the
+skipping of partial artifacts being pushed.
+.PP
+Specify `--deps` to control which artifacts to push:
+.PP
+
+ none: No dependencies, just the element itself
+ all: All dependencies
+.SH OPTIONS
+.TP
+\fB\-d,\fP \-\-deps [none|all]
+The dependencies to push (default: none)
+.TP
+\fB\-r,\fP \-\-remote TEXT
+The URL of the remote cache (defaults to the first configured cache) \ No newline at end of file
diff --git a/man/bst-artifact-receive.1 b/man/bst-artifact-receive.1
deleted file mode 100644
index 2874ded5b..000000000
--- a/man/bst-artifact-receive.1
+++ /dev/null
@@ -1,19 +0,0 @@
-.TH "BST-ARTIFACT-RECEIVE" "1" "26-Apr-2018" "" "bst-artifact-receive Manual"
-.SH NAME
-bst-artifact-receive \- Receive pushed artifacts over ssh
-.SH SYNOPSIS
-.B bst-artifact-receive
-[OPTIONS] REPO
-.SH DESCRIPTION
-A BuildStream sister program for receiving artifacts send to a shared artifact cache
-
-.SH OPTIONS
-.TP
-\fB\-v,\fP \-\-verbose
-Verbose mode
-.TP
-\fB\-d,\fP \-\-debug
-Debug mode
-.TP
-\fB\-\-pull\-url\fP TEXT
-Clients who try to pull over SSH will be redirected here [required] \ No newline at end of file
diff --git a/man/bst-artifact-server.1 b/man/bst-artifact-server.1
index c488810ab..1cd8a6ef5 100644
--- a/man/bst-artifact-server.1
+++ b/man/bst-artifact-server.1
@@ -1,4 +1,4 @@
-.TH "BST-ARTIFACT-SERVER" "1" "29-Nov-2018" "" "bst-artifact-server Manual"
+.TH "BST-ARTIFACT-SERVER" "1" "22-Jan-2019" "" "bst-artifact-server Manual"
.SH NAME
bst-artifact-server \- CAS Artifact Server
.SH SYNOPSIS
@@ -19,4 +19,10 @@ Public server certificate for TLS (PEM-encoded)
Public client certificates for TLS (PEM-encoded)
.TP
\fB\-\-enable\-push\fP
-Allow clients to upload blobs and update artifact cache \ No newline at end of file
+Allow clients to upload blobs and update artifact cache
+.TP
+\fB\-\-head\-room\-min\fP INTEGER
+Disk head room minimum in bytes
+.TP
+\fB\-\-head\-room\-max\fP INTEGER
+Disk head room maximum in bytes \ No newline at end of file
diff --git a/man/bst-artifact.1 b/man/bst-artifact.1
new file mode 100644
index 000000000..b14798711
--- /dev/null
+++ b/man/bst-artifact.1
@@ -0,0 +1,25 @@
+.TH "BST ARTIFACT" "1" "22-Jan-2019" "" "bst artifact Manual"
+.SH NAME
+bst\-artifact \- Manipulate cached artifacts
+.SH SYNOPSIS
+.B bst artifact
+[OPTIONS] COMMAND [ARGS]...
+.SH DESCRIPTION
+Manipulate cached artifacts
+.SH COMMANDS
+.PP
+\fBcheckout\fP
+ Checkout contents of an artifact
+ See \fBbst artifact-checkout(1)\fP for full documentation on the \fBcheckout\fP command.
+.PP
+\fBpull\fP
+ Pull a built artifact
+ See \fBbst artifact-pull(1)\fP for full documentation on the \fBpull\fP command.
+.PP
+\fBpush\fP
+ Push a built artifact
+ See \fBbst artifact-push(1)\fP for full documentation on the \fBpush\fP command.
+.PP
+\fBlog\fP
+ Show logs of an artifact
+ See \fBbst artifact-log(1)\fP for full documentation on the \fBlog\fP command. \ No newline at end of file
diff --git a/man/bst-build.1 b/man/bst-build.1
index df7b508fd..ae024c5db 100644
--- a/man/bst-build.1
+++ b/man/bst-build.1
@@ -1,4 +1,4 @@
-.TH "BST BUILD" "1" "29-Nov-2018" "" "bst build Manual"
+.TH "BST BUILD" "1" "22-Jan-2019" "" "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 dbe7873f0..2482f94ef 100644
--- a/man/bst-checkout.1
+++ b/man/bst-checkout.1
@@ -1,18 +1,15 @@
-.TH "BST CHECKOUT" "1" "29-Nov-2018" "" "bst checkout Manual"
+.TH "BST CHECKOUT" "1" "22-Jan-2019" "" "bst checkout Manual"
.SH NAME
bst\-checkout \- Checkout a built artifact
.SH SYNOPSIS
.B bst checkout
-[OPTIONS] ELEMENT LOCATION
-.SH DESCRIPTION
-Checkout a built artifact to the specified location
-
+[OPTIONS] [ELEMENT] [LOCATION]
.SH OPTIONS
.TP
\fB\-f,\fP \-\-force
Allow files to be overwritten
.TP
-\fB\-d,\fP \-\-deps [run|none]
+\fB\-d,\fP \-\-deps [run|build|none]
The dependencies to checkout (default: run)
.TP
\fB\-\-integrate\fP / \-\-no\-integrate
diff --git a/man/bst-fetch.1 b/man/bst-fetch.1
index 968193777..12ebea8b0 100644
--- a/man/bst-fetch.1
+++ b/man/bst-fetch.1
@@ -1,23 +1,9 @@
-.TH "BST FETCH" "1" "29-Nov-2018" "" "bst fetch Manual"
+.TH "BST FETCH" "1" "22-Jan-2019" "" "bst fetch Manual"
.SH NAME
bst\-fetch \- Fetch sources in a pipeline
.SH SYNOPSIS
.B bst fetch
[OPTIONS] [ELEMENTS]...
-.SH DESCRIPTION
-Fetch sources required to build the pipeline
-.PP
-By default this will only try to fetch sources which are
-required for the build plan of the specified target element,
-omitting sources for any elements which are already built
-and available in the artifact cache.
-.PP
-Specify `--deps` to control which sources to fetch:
-.PP
-
- none: No dependencies, just the element itself
- plan: Only dependencies required for the build plan
- all: All dependencies
.SH OPTIONS
.TP
\fB\-\-except\fP PATH
diff --git a/man/bst-help.1 b/man/bst-help.1
index 2ee9805ac..43f26cb0d 100644
--- a/man/bst-help.1
+++ b/man/bst-help.1
@@ -1,4 +1,4 @@
-.TH "BST HELP" "1" "29-Nov-2018" "" "bst help Manual"
+.TH "BST HELP" "1" "22-Jan-2019" "" "bst help Manual"
.SH NAME
bst\-help \- Print usage information
.SH SYNOPSIS
diff --git a/man/bst-init.1 b/man/bst-init.1
index 15330aa6d..561dadea5 100644
--- a/man/bst-init.1
+++ b/man/bst-init.1
@@ -1,4 +1,4 @@
-.TH "BST INIT" "1" "29-Nov-2018" "" "bst init Manual"
+.TH "BST INIT" "1" "22-Jan-2019" "" "bst init Manual"
.SH NAME
bst\-init \- Initialize a new BuildStream project
.SH SYNOPSIS
@@ -18,7 +18,7 @@ interactive session.
The project name to use
.TP
\fB\-\-format\-version\fP INTEGER
-The required format version (default: 18)
+The required format version (default: 20)
.TP
\fB\-\-element\-path\fP PATH
The subdirectory to store elements in (default: elements)
diff --git a/man/bst-pull.1 b/man/bst-pull.1
index 73f892e73..2c4c72863 100644
--- a/man/bst-pull.1
+++ b/man/bst-pull.1
@@ -1,21 +1,9 @@
-.TH "BST PULL" "1" "29-Nov-2018" "" "bst pull Manual"
+.TH "BST PULL" "1" "22-Jan-2019" "" "bst pull Manual"
.SH NAME
bst\-pull \- Pull a built artifact
.SH SYNOPSIS
.B bst pull
[OPTIONS] [ELEMENTS]...
-.SH DESCRIPTION
-Pull a built artifact from the configured remote artifact cache.
-.PP
-By default the artifact will be pulled one of the configured caches
-if possible, following the usual priority order. If the `--remote` flag
-is given, only the specified cache will be queried.
-.PP
-Specify `--deps` to control which artifacts to pull:
-.PP
-
- none: No dependencies, just the element itself
- all: All dependencies
.SH OPTIONS
.TP
\fB\-d,\fP \-\-deps [none|all]
diff --git a/man/bst-push.1 b/man/bst-push.1
index 2b566ddd2..2aa5144e2 100644
--- a/man/bst-push.1
+++ b/man/bst-push.1
@@ -1,20 +1,9 @@
-.TH "BST PUSH" "1" "29-Nov-2018" "" "bst push Manual"
+.TH "BST PUSH" "1" "22-Jan-2019" "" "bst push Manual"
.SH NAME
bst\-push \- Push a built artifact
.SH SYNOPSIS
.B bst push
[OPTIONS] [ELEMENTS]...
-.SH DESCRIPTION
-Push a built artifact to a remote artifact cache.
-.PP
-The default destination is the highest priority configured cache. You can
-override this by passing a different cache URL with the `--remote` flag.
-.PP
-Specify `--deps` to control which artifacts to push:
-.PP
-
- none: No dependencies, just the element itself
- all: All dependencies
.SH OPTIONS
.TP
\fB\-d,\fP \-\-deps [none|all]
diff --git a/man/bst-shell.1 b/man/bst-shell.1
index 3cc02f973..5f806e453 100644
--- a/man/bst-shell.1
+++ b/man/bst-shell.1
@@ -1,9 +1,9 @@
-.TH "BST SHELL" "1" "29-Nov-2018" "" "bst shell Manual"
+.TH "BST SHELL" "1" "22-Jan-2019" "" "bst shell Manual"
.SH NAME
bst\-shell \- Shell into an element's sandbox environment
.SH SYNOPSIS
.B bst shell
-[OPTIONS] ELEMENT [COMMAND]...
+[OPTIONS] [ELEMENT] [COMMAND]...
.SH DESCRIPTION
Run a command in the target element's sandbox environment
.PP
@@ -11,6 +11,12 @@ This will stage a temporary sysroot for running the target
element, assuming it has already been built and all required
artifacts are in the local cache.
.PP
+Use '--' to separate a command from the options to bst,
+otherwise bst may respond to them instead. e.g.
+.PP
+
+ bst shell example.bst -- df -h
+.PP
Use the --build option to create a temporary sysroot for
building the element instead.
.PP
@@ -32,4 +38,7 @@ An existing sysroot
Mount a file or directory into the sandbox
.TP
\fB\-\-isolate\fP
-Create an isolated build sandbox \ No newline at end of file
+Create an isolated build sandbox
+.TP
+\fB\-t,\fP \-\-use\-buildtree [ask|try|always|never]
+Defaults to ask but if set to always the function will fail if a build tree is not available \ No newline at end of file
diff --git a/man/bst-show.1 b/man/bst-show.1
index 74344edc8..7804bc5f3 100644
--- a/man/bst-show.1
+++ b/man/bst-show.1
@@ -1,4 +1,4 @@
-.TH "BST SHOW" "1" "29-Nov-2018" "" "bst show Manual"
+.TH "BST SHOW" "1" "22-Jan-2019" "" "bst show Manual"
.SH NAME
bst\-show \- Show elements in the pipeline
.SH SYNOPSIS
diff --git a/man/bst-source-bundle.1 b/man/bst-source-bundle.1
deleted file mode 100644
index 3806c26e6..000000000
--- a/man/bst-source-bundle.1
+++ /dev/null
@@ -1,25 +0,0 @@
-.TH "BST SOURCE-BUNDLE" "1" "29-Nov-2018" "" "bst source-bundle Manual"
-.SH NAME
-bst\-source-bundle \- Produce a build bundle to be manually executed
-.SH SYNOPSIS
-.B bst source-bundle
-[OPTIONS] ELEMENT
-.SH DESCRIPTION
-Produce a source bundle to be manually executed
-
-.SH OPTIONS
-.TP
-\fB\-\-except\fP PATH
-Elements to except from the tarball
-.TP
-\fB\-\-compression\fP [none|gz|bz2|xz]
-Compress the tar file using the given algorithm.
-.TP
-\fB\-\-track\fP
-Track new source references before bundling
-.TP
-\fB\-f,\fP \-\-force
-Overwrite an existing tarball
-.TP
-\fB\-\-directory\fP TEXT
-The directory to write the tarball to \ No newline at end of file
diff --git a/man/bst-source-checkout.1 b/man/bst-source-checkout.1
index 115a77afb..7afbc9394 100644
--- a/man/bst-source-checkout.1
+++ b/man/bst-source-checkout.1
@@ -1,14 +1,17 @@
-.TH "BST SOURCE-CHECKOUT" "1" "29-Nov-2018" "" "bst source-checkout Manual"
+.TH "BST SOURCE CHECKOUT" "1" "22-Jan-2019" "" "bst source checkout Manual"
.SH NAME
-bst\-source-checkout \- Checkout sources for an element
+bst\-source\-checkout \- Checkout sources for an element
.SH SYNOPSIS
-.B bst source-checkout
-[OPTIONS] ELEMENT LOCATION
+.B bst source checkout
+[OPTIONS] [ELEMENT] [LOCATION]
.SH DESCRIPTION
Checkout sources of an element to the specified location
.SH OPTIONS
.TP
+\fB\-f,\fP \-\-force
+Allow files to be overwritten
+.TP
\fB\-\-except\fP PATH
Except certain dependencies
.TP
@@ -16,4 +19,10 @@ Except certain dependencies
The dependencies whose sources to checkout (default: none)
.TP
\fB\-\-fetch\fP
-Fetch elements if they are not fetched \ No newline at end of file
+Fetch elements if they are not fetched
+.TP
+\fB\-\-tar\fP
+Create a tarball from the element's sources instead of a file tree.
+.TP
+\fB\-\-include\-build\-scripts\fP
+.PP \ No newline at end of file
diff --git a/man/bst-source-fetch.1 b/man/bst-source-fetch.1
new file mode 100644
index 000000000..6168f5f92
--- /dev/null
+++ b/man/bst-source-fetch.1
@@ -0,0 +1,33 @@
+.TH "BST SOURCE FETCH" "1" "22-Jan-2019" "" "bst source fetch Manual"
+.SH NAME
+bst\-source\-fetch \- Fetch sources in a pipeline
+.SH SYNOPSIS
+.B bst source fetch
+[OPTIONS] [ELEMENTS]...
+.SH DESCRIPTION
+Fetch sources required to build the pipeline
+.PP
+By default this will only try to fetch sources which are
+required for the build plan of the specified target element,
+omitting sources for any elements which are already built
+and available in the artifact cache.
+.PP
+Specify `--deps` to control which sources to fetch:
+.PP
+
+ none: No dependencies, just the element itself
+ plan: Only dependencies required for the build plan
+ all: All dependencies
+.SH OPTIONS
+.TP
+\fB\-\-except\fP PATH
+Except certain dependencies from fetching
+.TP
+\fB\-d,\fP \-\-deps [none|plan|all]
+The dependencies to fetch (default: plan)
+.TP
+\fB\-\-track\fP
+Track new source references before fetching
+.TP
+\fB\-J,\fP \-\-track\-cross\-junctions
+Allow tracking to cross junction boundaries \ No newline at end of file
diff --git a/man/bst-source-track.1 b/man/bst-source-track.1
new file mode 100644
index 000000000..0fb3af3b5
--- /dev/null
+++ b/man/bst-source-track.1
@@ -0,0 +1,28 @@
+.TH "BST SOURCE TRACK" "1" "22-Jan-2019" "" "bst source track Manual"
+.SH NAME
+bst\-source\-track \- Track new source references
+.SH SYNOPSIS
+.B bst source track
+[OPTIONS] [ELEMENTS]...
+.SH DESCRIPTION
+Consults the specified tracking branches for new versions available
+to build and updates the project with any newly available references.
+.PP
+By default this will track just the specified element, but you can also
+update a whole tree of dependencies in one go.
+.PP
+Specify `--deps` to control which sources to track:
+.PP
+
+ none: No dependencies, just the specified elements
+ all: All dependencies of all specified elements
+.SH OPTIONS
+.TP
+\fB\-\-except\fP PATH
+Except certain dependencies from tracking
+.TP
+\fB\-d,\fP \-\-deps [none|all]
+The dependencies to track (default: none)
+.TP
+\fB\-J,\fP \-\-cross\-junctions
+Allow crossing junction boundaries \ No newline at end of file
diff --git a/man/bst-source.1 b/man/bst-source.1
new file mode 100644
index 000000000..09df7510e
--- /dev/null
+++ b/man/bst-source.1
@@ -0,0 +1,21 @@
+.TH "BST SOURCE" "1" "22-Jan-2019" "" "bst source Manual"
+.SH NAME
+bst\-source \- Manipulate sources for an element
+.SH SYNOPSIS
+.B bst source
+[OPTIONS] COMMAND [ARGS]...
+.SH DESCRIPTION
+Manipulate sources for an element
+.SH COMMANDS
+.PP
+\fBfetch\fP
+ Fetch sources in a pipeline
+ See \fBbst source-fetch(1)\fP for full documentation on the \fBfetch\fP command.
+.PP
+\fBtrack\fP
+ Track new source references
+ See \fBbst source-track(1)\fP for full documentation on the \fBtrack\fP command.
+.PP
+\fBcheckout\fP
+ Checkout sources for an element
+ See \fBbst source-checkout(1)\fP for full documentation on the \fBcheckout\fP command. \ No newline at end of file
diff --git a/man/bst-track.1 b/man/bst-track.1
index fd8530676..a57c0f11a 100644
--- a/man/bst-track.1
+++ b/man/bst-track.1
@@ -1,21 +1,9 @@
-.TH "BST TRACK" "1" "29-Nov-2018" "" "bst track Manual"
+.TH "BST TRACK" "1" "22-Jan-2019" "" "bst track Manual"
.SH NAME
bst\-track \- Track new source references
.SH SYNOPSIS
.B bst track
[OPTIONS] [ELEMENTS]...
-.SH DESCRIPTION
-Consults the specified tracking branches for new versions available
-to build and updates the project with any newly available references.
-.PP
-By default this will track just the specified element, but you can also
-update a whole tree of dependencies in one go.
-.PP
-Specify `--deps` to control which sources to track:
-.PP
-
- none: No dependencies, just the specified elements
- all: All dependencies of all specified elements
.SH OPTIONS
.TP
\fB\-\-except\fP PATH
diff --git a/man/bst-workspace-close.1 b/man/bst-workspace-close.1
index 0858f21a3..e8112e239 100644
--- a/man/bst-workspace-close.1
+++ b/man/bst-workspace-close.1
@@ -1,4 +1,4 @@
-.TH "BST WORKSPACE CLOSE" "1" "29-Nov-2018" "" "bst workspace close Manual"
+.TH "BST WORKSPACE CLOSE" "1" "22-Jan-2019" "" "bst workspace close Manual"
.SH NAME
bst\-workspace\-close \- Close workspaces
.SH SYNOPSIS
diff --git a/man/bst-workspace-list.1 b/man/bst-workspace-list.1
index c4fb5bf3f..aca6c71db 100644
--- a/man/bst-workspace-list.1
+++ b/man/bst-workspace-list.1
@@ -1,8 +1,8 @@
-.TH "BST WORKSPACE LIST" "1" "29-Nov-2018" "" "bst workspace list Manual"
+.TH "BST WORKSPACE LIST" "1" "22-Jan-2019" "" "bst workspace list Manual"
.SH NAME
bst\-workspace\-list \- List open workspaces
.SH SYNOPSIS
.B bst workspace list
[OPTIONS]
.SH DESCRIPTION
-List open workspaces
+List open workspaces \ No newline at end of file
diff --git a/man/bst-workspace-open.1 b/man/bst-workspace-open.1
index 319888426..3018443c6 100644
--- a/man/bst-workspace-open.1
+++ b/man/bst-workspace-open.1
@@ -1,4 +1,4 @@
-.TH "BST WORKSPACE OPEN" "1" "29-Nov-2018" "" "bst workspace open Manual"
+.TH "BST WORKSPACE OPEN" "1" "22-Jan-2019" "" "bst workspace open Manual"
.SH NAME
bst\-workspace\-open \- Open a new workspace
.SH SYNOPSIS
diff --git a/man/bst-workspace-reset.1 b/man/bst-workspace-reset.1
index 8f5ca0e4a..df374f5eb 100644
--- a/man/bst-workspace-reset.1
+++ b/man/bst-workspace-reset.1
@@ -1,4 +1,4 @@
-.TH "BST WORKSPACE RESET" "1" "29-Nov-2018" "" "bst workspace reset Manual"
+.TH "BST WORKSPACE RESET" "1" "22-Jan-2019" "" "bst workspace reset Manual"
.SH NAME
bst\-workspace\-reset \- Reset a workspace to its original state
.SH SYNOPSIS
diff --git a/man/bst-workspace.1 b/man/bst-workspace.1
index 2b4881cfc..896cb709b 100644
--- a/man/bst-workspace.1
+++ b/man/bst-workspace.1
@@ -1,4 +1,4 @@
-.TH "BST WORKSPACE" "1" "29-Nov-2018" "" "bst workspace Manual"
+.TH "BST WORKSPACE" "1" "22-Jan-2019" "" "bst workspace Manual"
.SH NAME
bst\-workspace \- Manipulate developer workspaces
.SH SYNOPSIS
diff --git a/man/bst.1 b/man/bst.1
index 61d0efdee..f6c84dee0 100644
--- a/man/bst.1
+++ b/man/bst.1
@@ -1,6 +1,6 @@
-.TH "BST" "1" "29-Nov-2018" "" "bst Manual"
+.TH "BST" "1" "22-Jan-2019" "" "bst Manual"
.SH NAME
-bst \- Build and manipulate BuildStream projects...
+bst \- None
.SH SYNOPSIS
.B bst
[OPTIONS] COMMAND [ARGS]...
@@ -81,6 +81,26 @@ Include an element's build tree when pulling remote element artifacts
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
+\fBshell\fP
+ Shell into an element's sandbox environment
+ See \fBbst-shell(1)\fP for full documentation on the \fBshell\fP command.
+.PP
+\fBsource\fP
+ Manipulate sources for an element
+ See \fBbst-source(1)\fP for full documentation on the \fBsource\fP command.
+.PP
+\fBworkspace\fP
+ Manipulate developer workspaces
+ See \fBbst-workspace(1)\fP for full documentation on the \fBworkspace\fP command.
+.PP
+\fBartifact\fP
+ Manipulate cached artifacts
+ See \fBbst-artifact(1)\fP for full documentation on the \fBartifact\fP command.
+.PP
\fBfetch\fP
Fetch sources in a pipeline
See \fBbst-fetch(1)\fP for full documentation on the \fBfetch\fP command.
@@ -89,34 +109,14 @@ Include an element's build tree when pulling remote element artifacts
Track new source references
See \fBbst-track(1)\fP for full documentation on the \fBtrack\fP command.
.PP
+\fBcheckout\fP
+ Checkout a built artifact
+ See \fBbst-checkout(1)\fP for full documentation on the \fBcheckout\fP command.
+.PP
\fBpull\fP
Pull a built artifact
See \fBbst-pull(1)\fP for full documentation on the \fBpull\fP command.
.PP
\fBpush\fP
Push a built artifact
- See \fBbst-push(1)\fP for full documentation on the \fBpush\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.
-.PP
-\fBsource-checkout\fP
- Checkout sources for an element
- See \fBbst-source-checkout(1)\fP for full documentation on the \fBsource-checkout\fP command.
-.PP
-\fBworkspace\fP
- Manipulate developer workspaces
- See \fBbst-workspace(1)\fP for full documentation on the \fBworkspace\fP command.
-.PP
-\fBsource-bundle\fP
- Produce a build bundle to be manually executed
- See \fBbst-source-bundle(1)\fP for full documentation on the \fBsource-bundle\fP command. \ No newline at end of file
+ See \fBbst-push(1)\fP for full documentation on the \fBpush\fP command. \ No newline at end of file