Commit 0c57cdda authored by Tristan Van Berkom's avatar Tristan Van Berkom

man: Updating man pages for the upcoming 1.1.5 release

parent 38cf132e
Pipeline #27259511 passed with stages
in 73 minutes and 34 seconds
.TH "BST BUILD" "1" "18-Jul-2018" "" "bst build Manual" .TH "BST BUILD" "1" "06-Aug-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" "18-Jul-2018" "" "bst checkout Manual" .TH "BST CHECKOUT" "1" "06-Aug-2018" "" "bst checkout Manual"
.SH NAME .SH NAME
bst\-checkout \- Checkout a built artifact bst\-checkout \- Checkout a built artifact
.SH SYNOPSIS .SH SYNOPSIS
...@@ -22,5 +22,4 @@ Whether to run integration commands ...@@ -22,5 +22,4 @@ Whether to run integration commands
Checkout hardlinks instead of copies (handle with care) Checkout hardlinks instead of copies (handle with care)
.TP .TP
\fB\-\-tar\fP \fB\-\-tar\fP
Create a tarball from the artifact contents instead of a file tree. If Create a tarball from the artifact contents instead of a file tree. If LOCATION is '-', the tarball will be dumped to the standard output.
LOCATION is '-', the tarball will be dumped to the standard output. \ No newline at end of file
.TH "BST FETCH" "1" "18-Jul-2018" "" "bst fetch Manual" .TH "BST FETCH" "1" "06-Aug-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" .TH "BST HELP" "1" "06-Aug-2018" "" "bst help Manual"
.SH NAME .SH NAME
bst\-help \- Print usage information bst\-help \- Print usage information
.SH SYNOPSIS .SH SYNOPSIS
......
.TH "BST INIT" "1" "18-Jul-2018" "" "bst init Manual" .TH "BST INIT" "1" "06-Aug-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: 9) The required format version (default: 12)
.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" "18-Jul-2018" "" "bst pull Manual" .TH "BST PULL" "1" "06-Aug-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" "18-Jul-2018" "" "bst push Manual" .TH "BST PUSH" "1" "06-Aug-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" "18-Jul-2018" "" "bst shell Manual" .TH "BST SHELL" "1" "06-Aug-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" "18-Jul-2018" "" "bst show Manual" .TH "BST SHOW" "1" "06-Aug-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
......
.TH "BST SOURCE-BUNDLE" "1" "18-Jul-2018" "" "bst source-bundle Manual" .TH "BST SOURCE-BUNDLE" "1" "06-Aug-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
......
.TH "BST TRACK" "1" "18-Jul-2018" "" "bst track Manual" .TH "BST TRACK" "1" "06-Aug-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" "18-Jul-2018" "" "bst workspace close Manual" .TH "BST WORKSPACE CLOSE" "1" "06-Aug-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" "18-Jul-2018" "" "bst workspace list Manual" .TH "BST WORKSPACE LIST" "1" "06-Aug-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" "18-Jul-2018" "" "bst workspace open Manual" .TH "BST WORKSPACE OPEN" "1" "06-Aug-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" "18-Jul-2018" "" "bst workspace reset Manual" .TH "BST WORKSPACE RESET" "1" "06-Aug-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
......
.TH "BST WORKSPACE" "1" "18-Jul-2018" "" "bst workspace Manual" .TH "BST WORKSPACE" "1" "06-Aug-2018" "" "bst workspace Manual"
.SH NAME .SH NAME
bst\-workspace \- Manipulate developer workspaces bst\-workspace \- Manipulate developer workspaces
.SH SYNOPSIS .SH SYNOPSIS
...@@ -7,22 +7,22 @@ bst\-workspace \- Manipulate developer workspaces ...@@ -7,22 +7,22 @@ bst\-workspace \- Manipulate developer workspaces
.SH DESCRIPTION .SH DESCRIPTION
Manipulate developer workspaces Manipulate developer workspaces
.SH COMMANDS .SH COMMANDS
.PP
\fBopen\fP
Open a new workspace
See \fBbst workspace-open(1)\fP for full documentation on the \fBopen\fP command.
.PP .PP
\fBreset\fP \fBreset\fP
Reset a workspace to its original state Reset a workspace to its original state
See \fBbst workspace-reset(1)\fP for full documentation on the \fBreset\fP command. See \fBbst workspace-reset(1)\fP for full documentation on the \fBreset\fP command.
.PP
\fBclose\fP
Close workspaces
See \fBbst workspace-close(1)\fP for full documentation on the \fBclose\fP command.
.PP .PP
\fBlist\fP \fBlist\fP
List open workspaces List open workspaces
See \fBbst workspace-list(1)\fP for full documentation on the \fBlist\fP command. See \fBbst workspace-list(1)\fP for full documentation on the \fBlist\fP command.
.PP .PP
\fBclose\fP \fBopen\fP
Close workspaces Open a new workspace
See \fBbst workspace-close(1)\fP for full documentation on the \fBclose\fP command. See \fBbst workspace-open(1)\fP for full documentation on the \fBopen\fP command.
.TH "BST" "1" "18-Jul-2018" "" "bst Manual" .TH "BST" "1" "06-Aug-2018" "" "bst Manual"
.SH NAME .SH NAME
bst \- Build and manipulate BuildStream projects... bst \- Build and manipulate BuildStream projects...
.SH SYNOPSIS .SH SYNOPSIS
...@@ -61,31 +61,29 @@ Elements must be rebuilt when their dependencies have changed ...@@ -61,31 +61,29 @@ Elements must be rebuilt when their dependencies have changed
.TP .TP
\fB\-o,\fP \-\-option OPTION VALUE \fB\-o,\fP \-\-option OPTION VALUE
Specify a project option Specify a project option
.TP
\fB\-\-default\-mirror\fP TEXT
The mirror to fetch from first, before attempting other mirrors
.SH COMMANDS .SH COMMANDS
.PP .PP
\fBsource-bundle\fP \fBshow\fP
Produce a build bundle to be manually executed Show elements in the pipeline
See \fBbst-source-bundle(1)\fP for full documentation on the \fBsource-bundle\fP command. See \fBbst-show(1)\fP for full documentation on the \fBshow\fP command.
.PP
\fBhelp\fP
Print usage information
See \fBbst-help(1)\fP for full documentation on the \fBhelp\fP command.
.PP .PP
\fBinit\fP \fBpush\fP
Initialize a new BuildStream project Push a built artifact
See \fBbst-init(1)\fP for full documentation on the \fBinit\fP command. See \fBbst-push(1)\fP for full documentation on the \fBpush\fP command.
.PP .PP
\fBtrack\fP \fBcheckout\fP
Track new source references Checkout a built artifact
See \fBbst-track(1)\fP for full documentation on the \fBtrack\fP command. See \fBbst-checkout(1)\fP for full documentation on the \fBcheckout\fP command.
.PP .PP
\fBpull\fP \fBfetch\fP
Pull a built artifact Fetch sources in a pipeline
See \fBbst-pull(1)\fP for full documentation on the \fBpull\fP command. See \fBbst-fetch(1)\fP for full documentation on the \fBfetch\fP command.
.PP .PP
\fBworkspace\fP \fBworkspace\fP
...@@ -98,9 +96,19 @@ Specify a project option ...@@ -98,9 +96,19 @@ 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
\fBcheckout\fP \fBtrack\fP
Checkout a built artifact Track new source references
See \fBbst-checkout(1)\fP for full documentation on the \fBcheckout\fP command. See \fBbst-track(1)\fP for full documentation on the \fBtrack\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
\fBinit\fP
Initialize a new BuildStream project
See \fBbst-init(1)\fP for full documentation on the \fBinit\fP command.
.PP .PP
\fBshell\fP \fBshell\fP
...@@ -108,16 +116,11 @@ Specify a project option ...@@ -108,16 +116,11 @@ Specify a project option
See \fBbst-shell(1)\fP for full documentation on the \fBshell\fP command. See \fBbst-shell(1)\fP for full documentation on the \fBshell\fP command.
.PP .PP
\fBfetch\fP \fBpull\fP
Fetch sources in a pipeline Pull a built artifact
See \fBbst-fetch(1)\fP for full documentation on the \fBfetch\fP command. 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 .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.
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