Commit 7de8c1b8 authored by Tristan Van Berkom's avatar Tristan Van Berkom

Updating man pages for 1.1.4 release

parent 26b9f6fa
Pipeline #26002534 passed with stages
in 36 minutes and 33 seconds
.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
.TH "BST BUILD" "1" "26-Apr-2018" "" "bst build Manual" .TH "BST BUILD" "1" "18-Jul-2018" "" "bst build Manual"
.SH NAME .SH NAME
bst\-build \- Build elements in a pipeline bst\-build \- Build elements in a pipeline
.SH SYNOPSIS .SH SYNOPSIS
......
.TH "BST CHECKOUT" "1" "26-Apr-2018" "" "bst checkout Manual" .TH "BST CHECKOUT" "1" "18-Jul-2018" "" "bst checkout Manual"
.SH NAME .SH NAME
bst\-checkout \- Checkout a built artifact bst\-checkout \- Checkout a built artifact
.SH SYNOPSIS .SH SYNOPSIS
...@@ -12,6 +12,9 @@ Checkout a built artifact to the specified directory ...@@ -12,6 +12,9 @@ Checkout a built artifact to the specified directory
\fB\-f,\fP \-\-force \fB\-f,\fP \-\-force
Overwrite files existing in checkout directory Overwrite files existing in checkout directory
.TP .TP
\fB\-d,\fP \-\-deps [run|none]
The dependencies to checkout (default: run)
.TP
\fB\-\-integrate\fP / \-\-no\-integrate \fB\-\-integrate\fP / \-\-no\-integrate
Whether to run integration commands Whether to run integration commands
.TP .TP
......
.TH "BST FETCH" "1" "26-Apr-2018" "" "bst fetch Manual" .TH "BST FETCH" "1" "18-Jul-2018" "" "bst fetch Manual"
.SH NAME .SH NAME
bst\-fetch \- Fetch sources in a pipeline bst\-fetch \- Fetch sources in a pipeline
.SH SYNOPSIS .SH SYNOPSIS
......
.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
.TH "BST INIT" "1" "26-Apr-2018" "" "bst init Manual" .TH "BST INIT" "1" "18-Jul-2018" "" "bst init Manual"
.SH NAME .SH NAME
bst\-init \- Initialize a new BuildStream project bst\-init \- Initialize a new BuildStream project
.SH SYNOPSIS .SH SYNOPSIS
...@@ -18,7 +18,7 @@ interactive session. ...@@ -18,7 +18,7 @@ interactive session.
The project name to use The project name to use
.TP .TP
\fB\-\-format\-version\fP INTEGER \fB\-\-format\-version\fP INTEGER
The required format version (default: 8) The required format version (default: 9)
.TP .TP
\fB\-\-element\-path\fP PATH \fB\-\-element\-path\fP PATH
The subdirectory to store elements in (default: elements) The subdirectory to store elements in (default: elements)
......
.TH "BST PULL" "1" "26-Apr-2018" "" "bst pull Manual" .TH "BST PULL" "1" "18-Jul-2018" "" "bst pull Manual"
.SH NAME .SH NAME
bst\-pull \- Pull a built artifact bst\-pull \- Pull a built artifact
.SH SYNOPSIS .SH SYNOPSIS
......
.TH "BST PUSH" "1" "26-Apr-2018" "" "bst push Manual" .TH "BST PUSH" "1" "18-Jul-2018" "" "bst push Manual"
.SH NAME .SH NAME
bst\-push \- Push a built artifact bst\-push \- Push a built artifact
.SH SYNOPSIS .SH SYNOPSIS
......
.TH "BST SHELL" "1" "26-Apr-2018" "" "bst shell Manual" .TH "BST SHELL" "1" "18-Jul-2018" "" "bst shell Manual"
.SH NAME .SH NAME
bst\-shell \- Shell into an element's sandbox environment bst\-shell \- Shell into an element's sandbox environment
.SH SYNOPSIS .SH SYNOPSIS
......
.TH "BST SHOW" "1" "26-Apr-2018" "" "bst show Manual" .TH "BST SHOW" "1" "18-Jul-2018" "" "bst show Manual"
.SH NAME .SH NAME
bst\-show \- Show elements in the pipeline bst\-show \- Show elements in the pipeline
.SH SYNOPSIS .SH SYNOPSIS
...@@ -62,7 +62,4 @@ The dependencies to show (default: all) ...@@ -62,7 +62,4 @@ The dependencies to show (default: all)
Staging or alphabetic ordering of dependencies Staging or alphabetic ordering of dependencies
.TP .TP
\fB\-f,\fP \-\-format FORMAT \fB\-f,\fP \-\-format FORMAT
Format string for each element Format string for each element
.TP \ No newline at end of file
\fB\-\-downloadable\fP
Refresh downloadable state
\ No newline at end of file
.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 .SH NAME
bst\-source-bundle \- Produce a build bundle to be manually executed bst\-source-bundle \- Produce a build bundle to be manually executed
.SH SYNOPSIS .SH SYNOPSIS
.B bst source-bundle .B bst source-bundle
[OPTIONS] TARGET [OPTIONS] ELEMENT
.SH DESCRIPTION .SH DESCRIPTION
Produce a source bundle to be manually executed Produce a source bundle to be manually executed
...@@ -16,10 +16,10 @@ Elements to except from the tarball ...@@ -16,10 +16,10 @@ Elements to except from the tarball
Compress the tar file using the given algorithm. Compress the tar file using the given algorithm.
.TP .TP
\fB\-\-track\fP \fB\-\-track\fP
Track new source references before building Track new source references before bundling
.TP .TP
\fB\-f,\fP \-\-force \fB\-f,\fP \-\-force
Overwrite files existing in checkout directory Overwrite an existing tarball
.TP .TP
\fB\-\-directory\fP TEXT \fB\-\-directory\fP TEXT
The directory to write the tarball to The directory to write the tarball to
\ No newline at end of file
.TH "BST TRACK" "1" "26-Apr-2018" "" "bst track Manual" .TH "BST TRACK" "1" "18-Jul-2018" "" "bst track Manual"
.SH NAME .SH NAME
bst\-track \- Track new source references bst\-track \- Track new source references
.SH SYNOPSIS .SH SYNOPSIS
......
.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 .SH NAME
bst\-workspace\-close \- Close workspaces bst\-workspace\-close \- Close workspaces
.SH SYNOPSIS .SH SYNOPSIS
......
.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 .SH NAME
bst\-workspace\-list \- List open workspaces bst\-workspace\-list \- List open workspaces
.SH SYNOPSIS .SH SYNOPSIS
......
.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 .SH NAME
bst\-workspace\-open \- Open a new workspace bst\-workspace\-open \- Open a new workspace
.SH SYNOPSIS .SH SYNOPSIS
......
.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 .SH NAME
bst\-workspace\-reset \- Reset a workspace to its original state bst\-workspace\-reset \- Reset a workspace to its original state
.SH SYNOPSIS .SH SYNOPSIS
...@@ -8,6 +8,9 @@ bst\-workspace\-reset \- Reset a workspace to its original state ...@@ -8,6 +8,9 @@ bst\-workspace\-reset \- Reset a workspace to its original state
Reset a workspace to its original state Reset a workspace to its original state
.SH OPTIONS .SH OPTIONS
.TP .TP
\fB\-\-soft\fP
Reset workspace state without affecting its contents
.TP
\fB\-\-track\fP \fB\-\-track\fP
Track and fetch the latest source before resetting Track and fetch the latest source before resetting
.TP .TP
......
.TH "BST WORKSPACE" "1" "26-Apr-2018" "" "bst workspace Manual" .TH "BST WORKSPACE" "1" "18-Jul-2018" "" "bst workspace Manual"
.SH NAME .SH NAME
bst\-workspace \- Manipulate developer workspaces bst\-workspace \- Manipulate developer workspaces
.SH SYNOPSIS .SH SYNOPSIS
...@@ -12,6 +12,11 @@ Manipulate developer workspaces ...@@ -12,6 +12,11 @@ Manipulate developer workspaces
Open a new workspace Open a new workspace
See \fBbst workspace-open(1)\fP for full documentation on the \fBopen\fP command. 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 .PP
\fBlist\fP \fBlist\fP
List open workspaces List open workspaces
...@@ -21,8 +26,3 @@ Manipulate developer workspaces ...@@ -21,8 +26,3 @@ Manipulate developer workspaces
\fBclose\fP \fBclose\fP
Close workspaces Close workspaces
See \fBbst workspace-close(1)\fP for full documentation on the \fBclose\fP command. 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.
.TH "BST" "1" "26-Apr-2018" "" "bst Manual" .TH "BST" "1" "18-Jul-2018" "" "bst Manual"
.SH NAME .SH NAME
bst \- Build and manipulate BuildStream projects... bst \- Build and manipulate BuildStream projects...
.SH SYNOPSIS .SH SYNOPSIS
...@@ -62,30 +62,20 @@ Elements must be rebuilt when their dependencies have changed ...@@ -62,30 +62,20 @@ Elements must be rebuilt when their dependencies have changed
\fB\-o,\fP \-\-option OPTION VALUE \fB\-o,\fP \-\-option OPTION VALUE
Specify a project option Specify a project option
.SH COMMANDS .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 .PP
\fBsource-bundle\fP \fBsource-bundle\fP
Produce a build bundle to be manually executed Produce a build bundle to be manually executed
See \fBbst-source-bundle(1)\fP for full documentation on the \fBsource-bundle\fP command. See \fBbst-source-bundle(1)\fP for full documentation on the \fBsource-bundle\fP command.
.PP .PP
\fBshow\fP \fBhelp\fP
Show elements in the pipeline Print usage information
See \fBbst-show(1)\fP for full documentation on the \fBshow\fP command. See \fBbst-help(1)\fP for full documentation on the \fBhelp\fP command.
.PP .PP
\fBworkspace\fP \fBinit\fP
Manipulate developer workspaces Initialize a new BuildStream project
See \fBbst-workspace(1)\fP for full documentation on the \fBworkspace\fP command. See \fBbst-init(1)\fP for full documentation on the \fBinit\fP command.
.PP .PP
\fBtrack\fP \fBtrack\fP
...@@ -93,14 +83,14 @@ Specify a project option ...@@ -93,14 +83,14 @@ Specify a project option
See \fBbst-track(1)\fP for full documentation on the \fBtrack\fP command. See \fBbst-track(1)\fP for full documentation on the \fBtrack\fP command.
.PP .PP
\fBinit\fP \fBpull\fP
Initialize a new BuildStream project Pull a built artifact
See \fBbst-init(1)\fP for full documentation on the \fBinit\fP command. See \fBbst-pull(1)\fP for full documentation on the \fBpull\fP command.
.PP .PP
\fBshell\fP \fBworkspace\fP
Shell into an element's sandbox environment Manipulate developer workspaces
See \fBbst-shell(1)\fP for full documentation on the \fBshell\fP command. See \fBbst-workspace(1)\fP for full documentation on the \fBworkspace\fP command.
.PP .PP
\fBbuild\fP \fBbuild\fP
...@@ -108,11 +98,26 @@ Specify a project option ...@@ -108,11 +98,26 @@ Specify a project option
See \fBbst-build(1)\fP for full documentation on the \fBbuild\fP command. See \fBbst-build(1)\fP for full documentation on the \fBbuild\fP command.
.PP .PP
\fBpull\fP \fBcheckout\fP
Pull a built artifact Checkout a built artifact
See \fBbst-pull(1)\fP for full documentation on the \fBpull\fP command. 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 .PP
\fBpush\fP \fBpush\fP
Push a built artifact Push a built artifact
See \fBbst-push(1)\fP for full documentation on the \fBpush\fP command. 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.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment