Updating man pages for 1.1.4 release
diff --git a/man/bst-artifact-receive.1 b/man/bst-artifact-receive.1
deleted file mode 100644
index 2874ded..0000000
--- 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-build.1 b/man/bst-build.1
index 36f0b5c..eb74ec7 100644
--- a/man/bst-build.1
+++ b/man/bst-build.1
@@ -1,4 +1,4 @@
-.TH "BST BUILD" "1" "26-Apr-2018" "" "bst build Manual"
+.TH "BST BUILD" "1" "18-Jul-2018" "" "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 aaf1420..7f213be 100644
--- a/man/bst-checkout.1
+++ b/man/bst-checkout.1
@@ -1,4 +1,4 @@
-.TH "BST CHECKOUT" "1" "26-Apr-2018" "" "bst checkout Manual"
+.TH "BST CHECKOUT" "1" "18-Jul-2018" "" "bst checkout Manual"
.SH NAME
bst\-checkout \- Checkout a built artifact
.SH SYNOPSIS
@@ -12,6 +12,9 @@
\fB\-f,\fP \-\-force
Overwrite files existing in checkout directory
.TP
+\fB\-d,\fP \-\-deps [run|none]
+The dependencies to checkout (default: run)
+.TP
\fB\-\-integrate\fP / \-\-no\-integrate
Whether to run integration commands
.TP
diff --git a/man/bst-fetch.1 b/man/bst-fetch.1
index ca99671..a4dbe31 100644
--- a/man/bst-fetch.1
+++ b/man/bst-fetch.1
@@ -1,4 +1,4 @@
-.TH "BST FETCH" "1" "26-Apr-2018" "" "bst fetch Manual"
+.TH "BST FETCH" "1" "18-Jul-2018" "" "bst fetch Manual"
.SH NAME
bst\-fetch \- Fetch sources in a pipeline
.SH SYNOPSIS
diff --git a/man/bst-help.1 b/man/bst-help.1
new file mode 100644
index 0000000..9774ab4
--- /dev/null
+++ b/man/bst-help.1
@@ -0,0 +1,9 @@
+.TH "BST HELP" "1" "18-Jul-2018" "" "bst help Manual"
+.SH NAME
+bst\-help \- Print usage information
+.SH SYNOPSIS
+.B bst help
+[OPTIONS] COMMAND
+.SH DESCRIPTION
+Print usage information about a given command
+
\ No newline at end of file
diff --git a/man/bst-init.1 b/man/bst-init.1
index 0ec9abc..8a2b1ba 100644
--- a/man/bst-init.1
+++ b/man/bst-init.1
@@ -1,4 +1,4 @@
-.TH "BST INIT" "1" "26-Apr-2018" "" "bst init Manual"
+.TH "BST INIT" "1" "18-Jul-2018" "" "bst init Manual"
.SH NAME
bst\-init \- Initialize a new BuildStream project
.SH SYNOPSIS
@@ -18,7 +18,7 @@
The project name to use
.TP
\fB\-\-format\-version\fP INTEGER
-The required format version (default: 8)
+The required format version (default: 9)
.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 bc582e4..078c2eb 100644
--- a/man/bst-pull.1
+++ b/man/bst-pull.1
@@ -1,4 +1,4 @@
-.TH "BST PULL" "1" "26-Apr-2018" "" "bst pull Manual"
+.TH "BST PULL" "1" "18-Jul-2018" "" "bst pull Manual"
.SH NAME
bst\-pull \- Pull a built artifact
.SH SYNOPSIS
diff --git a/man/bst-push.1 b/man/bst-push.1
index b807b9d..a70f158 100644
--- a/man/bst-push.1
+++ b/man/bst-push.1
@@ -1,4 +1,4 @@
-.TH "BST PUSH" "1" "26-Apr-2018" "" "bst push Manual"
+.TH "BST PUSH" "1" "18-Jul-2018" "" "bst push Manual"
.SH NAME
bst\-push \- Push a built artifact
.SH SYNOPSIS
diff --git a/man/bst-shell.1 b/man/bst-shell.1
index bc8b116..1f1b6b8 100644
--- a/man/bst-shell.1
+++ b/man/bst-shell.1
@@ -1,4 +1,4 @@
-.TH "BST SHELL" "1" "26-Apr-2018" "" "bst shell Manual"
+.TH "BST SHELL" "1" "18-Jul-2018" "" "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 b82d0a3..1bbc25f 100644
--- a/man/bst-show.1
+++ b/man/bst-show.1
@@ -1,4 +1,4 @@
-.TH "BST SHOW" "1" "26-Apr-2018" "" "bst show Manual"
+.TH "BST SHOW" "1" "18-Jul-2018" "" "bst show Manual"
.SH NAME
bst\-show \- Show elements in the pipeline
.SH SYNOPSIS
@@ -62,7 +62,4 @@
Staging or alphabetic ordering of dependencies
.TP
\fB\-f,\fP \-\-format FORMAT
-Format string for each element
-.TP
-\fB\-\-downloadable\fP
-Refresh downloadable state
\ No newline at end of file
+Format string for each element
\ No newline at end of file
diff --git a/man/bst-source-bundle.1 b/man/bst-source-bundle.1
index 92580aa..575ecc2 100644
--- a/man/bst-source-bundle.1
+++ b/man/bst-source-bundle.1
@@ -1,9 +1,9 @@
-.TH "BST SOURCE-BUNDLE" "1" "26-Apr-2018" "" "bst source-bundle Manual"
+.TH "BST SOURCE-BUNDLE" "1" "18-Jul-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] TARGET
+[OPTIONS] ELEMENT
.SH DESCRIPTION
Produce a source bundle to be manually executed
@@ -16,10 +16,10 @@
Compress the tar file using the given algorithm.
.TP
\fB\-\-track\fP
-Track new source references before building
+Track new source references before bundling
.TP
\fB\-f,\fP \-\-force
-Overwrite files existing in checkout directory
+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-track.1 b/man/bst-track.1
index c32fc0a..b06bee8 100644
--- a/man/bst-track.1
+++ b/man/bst-track.1
@@ -1,4 +1,4 @@
-.TH "BST TRACK" "1" "26-Apr-2018" "" "bst track Manual"
+.TH "BST TRACK" "1" "18-Jul-2018" "" "bst track Manual"
.SH NAME
bst\-track \- Track new source references
.SH SYNOPSIS
diff --git a/man/bst-workspace-close.1 b/man/bst-workspace-close.1
index c085b35..1de08b3 100644
--- a/man/bst-workspace-close.1
+++ b/man/bst-workspace-close.1
@@ -1,4 +1,4 @@
-.TH "BST WORKSPACE CLOSE" "1" "26-Apr-2018" "" "bst workspace close Manual"
+.TH "BST WORKSPACE CLOSE" "1" "18-Jul-2018" "" "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 f07de24..401fa53 100644
--- a/man/bst-workspace-list.1
+++ b/man/bst-workspace-list.1
@@ -1,4 +1,4 @@
-.TH "BST WORKSPACE LIST" "1" "26-Apr-2018" "" "bst workspace list Manual"
+.TH "BST WORKSPACE LIST" "1" "18-Jul-2018" "" "bst workspace list Manual"
.SH NAME
bst\-workspace\-list \- List open workspaces
.SH SYNOPSIS
diff --git a/man/bst-workspace-open.1 b/man/bst-workspace-open.1
index 9264307..7bf37b2 100644
--- a/man/bst-workspace-open.1
+++ b/man/bst-workspace-open.1
@@ -1,4 +1,4 @@
-.TH "BST WORKSPACE OPEN" "1" "26-Apr-2018" "" "bst workspace open Manual"
+.TH "BST WORKSPACE OPEN" "1" "18-Jul-2018" "" "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 8d3d681..b6e9807 100644
--- a/man/bst-workspace-reset.1
+++ b/man/bst-workspace-reset.1
@@ -1,4 +1,4 @@
-.TH "BST WORKSPACE RESET" "1" "26-Apr-2018" "" "bst workspace reset Manual"
+.TH "BST WORKSPACE RESET" "1" "18-Jul-2018" "" "bst workspace reset Manual"
.SH NAME
bst\-workspace\-reset \- Reset a workspace to its original state
.SH SYNOPSIS
@@ -8,6 +8,9 @@
Reset a workspace to its original state
.SH OPTIONS
.TP
+\fB\-\-soft\fP
+Reset workspace state without affecting its contents
+.TP
\fB\-\-track\fP
Track and fetch the latest source before resetting
.TP
diff --git a/man/bst-workspace.1 b/man/bst-workspace.1
index ad20450..9de3274 100644
--- a/man/bst-workspace.1
+++ b/man/bst-workspace.1
@@ -1,4 +1,4 @@
-.TH "BST WORKSPACE" "1" "26-Apr-2018" "" "bst workspace Manual"
+.TH "BST WORKSPACE" "1" "18-Jul-2018" "" "bst workspace Manual"
.SH NAME
bst\-workspace \- Manipulate developer workspaces
.SH SYNOPSIS
@@ -13,6 +13,11 @@
See \fBbst workspace-open(1)\fP for full documentation on the \fBopen\fP command.
.PP
+\fBreset\fP
+ Reset a workspace to its original state
+ See \fBbst workspace-reset(1)\fP for full documentation on the \fBreset\fP command.
+
+.PP
\fBlist\fP
List open workspaces
See \fBbst workspace-list(1)\fP for full documentation on the \fBlist\fP command.
@@ -21,8 +26,3 @@
\fBclose\fP
Close workspaces
See \fBbst workspace-close(1)\fP for full documentation on the \fBclose\fP command.
-
-.PP
-\fBreset\fP
- Reset a workspace to its original state
- See \fBbst workspace-reset(1)\fP for full documentation on the \fBreset\fP command.
diff --git a/man/bst.1 b/man/bst.1
index df94062..d920b35 100644
--- a/man/bst.1
+++ b/man/bst.1
@@ -1,4 +1,4 @@
-.TH "BST" "1" "26-Apr-2018" "" "bst Manual"
+.TH "BST" "1" "18-Jul-2018" "" "bst Manual"
.SH NAME
bst \- Build and manipulate BuildStream projects...
.SH SYNOPSIS
@@ -63,34 +63,14 @@
Specify a project option
.SH COMMANDS
.PP
-\fBcheckout\fP
- Checkout a built artifact
- See \fBbst-checkout(1)\fP for full documentation on the \fBcheckout\fP command.
-
-.PP
-\fBfetch\fP
- Fetch sources in a pipeline
- See \fBbst-fetch(1)\fP for full documentation on the \fBfetch\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.
.PP
-\fBshow\fP
- Show elements in the pipeline
- See \fBbst-show(1)\fP for full documentation on the \fBshow\fP command.
-
-.PP
-\fBworkspace\fP
- Manipulate developer workspaces
- See \fBbst-workspace(1)\fP for full documentation on the \fBworkspace\fP command.
-
-.PP
-\fBtrack\fP
- Track new source references
- See \fBbst-track(1)\fP for full documentation on the \fBtrack\fP command.
+\fBhelp\fP
+ Print usage information
+ See \fBbst-help(1)\fP for full documentation on the \fBhelp\fP command.
.PP
\fBinit\fP
@@ -98,14 +78,9 @@
See \fBbst-init(1)\fP for full documentation on the \fBinit\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.
+\fBtrack\fP
+ Track new source references
+ See \fBbst-track(1)\fP for full documentation on the \fBtrack\fP command.
.PP
\fBpull\fP
@@ -113,6 +88,36 @@
See \fBbst-pull(1)\fP for full documentation on the \fBpull\fP command.
.PP
+\fBworkspace\fP
+ Manipulate developer workspaces
+ See \fBbst-workspace(1)\fP for full documentation on the \fBworkspace\fP command.
+
+.PP
+\fBbuild\fP
+ Build elements in a pipeline
+ See \fBbst-build(1)\fP for full documentation on the \fBbuild\fP command.
+
+.PP
+\fBcheckout\fP
+ Checkout a built artifact
+ See \fBbst-checkout(1)\fP for full documentation on the \fBcheckout\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
+\fBfetch\fP
+ Fetch sources in a pipeline
+ See \fBbst-fetch(1)\fP for full documentation on the \fBfetch\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.