Commit ec5ee795 authored by Tristan Van Berkom's avatar Tristan Van Berkom

man: Updated man pages for the release

parent 1f63d214
Pipeline #18471606 passed with stages
in 12 minutes and 11 seconds
.TH "BST-ARTIFACT-RECEIVE" "1" "19-Feb-2018" "" "bst-artifact-receive Manual"
.TH "BST-ARTIFACT-RECEIVE" "1" "06-Mar-2018" "" "bst-artifact-receive Manual"
.SH NAME
bst-artifact-receive \- Receive pushed artifacts over ssh
.SH SYNOPSIS
......
.TH "BST BUILD" "1" "19-Feb-2018" "" "bst build Manual"
.TH "BST BUILD" "1" "06-Mar-2018" "" "bst build Manual"
.SH NAME
bst\-build \- Build elements in a pipeline
.SH SYNOPSIS
......
.TH "BST CHECKOUT" "1" "19-Feb-2018" "" "bst checkout Manual"
.TH "BST CHECKOUT" "1" "06-Mar-2018" "" "bst checkout Manual"
.SH NAME
bst\-checkout \- Checkout a built artifact
.SH SYNOPSIS
......
.TH "BST FETCH" "1" "19-Feb-2018" "" "bst fetch Manual"
.TH "BST FETCH" "1" "06-Mar-2018" "" "bst fetch Manual"
.SH NAME
bst\-fetch \- Fetch sources in a pipeline
.SH SYNOPSIS
......
.TH "BST PULL" "1" "19-Feb-2018" "" "bst pull Manual"
.TH "BST PULL" "1" "06-Mar-2018" "" "bst pull Manual"
.SH NAME
bst\-pull \- Pull a built artifact
.SH SYNOPSIS
......
.TH "BST PUSH" "1" "19-Feb-2018" "" "bst push Manual"
.TH "BST PUSH" "1" "06-Mar-2018" "" "bst push Manual"
.SH NAME
bst\-push \- Push a built artifact
.SH SYNOPSIS
......
.TH "BST SHELL" "1" "19-Feb-2018" "" "bst shell Manual"
.TH "BST SHELL" "1" "06-Mar-2018" "" "bst shell Manual"
.SH NAME
bst\-shell \- Shell into an element's sandbox environment
.SH SYNOPSIS
......@@ -7,9 +7,9 @@ bst\-shell \- Shell into an element's sandbox environment
.SH DESCRIPTION
Run a command in the target element's sandbox environment
This will first stage a temporary sysroot for running
the target element, assuming it has already been built
and all required artifacts are in the local cache.
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.
Use the --build option to create a temporary sysroot for
building the element instead.
......@@ -19,11 +19,17 @@ directory or with a checkout of the given target, in order
to use a specific sysroot.
If no COMMAND is specified, the default is to attempt
to run an interactive shell with `sh -i`.
to run an interactive shell.
.SH OPTIONS
.TP
\fB\-b,\fP \-\-build
Create a build sandbox
Stage dependencies and sources to build
.TP
\fB\-s,\fP \-\-sysroot DIRECTORY
An existing sysroot
.TP
\fB\-\-mount\fP HOSTPATH PATH
Mount a file or directory into the sandbox
.TP
\fB\-\-isolate\fP
Create an isolated build sandbox
\ No newline at end of file
.TH "BST SHOW" "1" "19-Feb-2018" "" "bst show Manual"
.TH "BST SHOW" "1" "06-Mar-2018" "" "bst show Manual"
.SH NAME
bst\-show \- Show elements in the pipeline
.SH SYNOPSIS
......
.TH "BST SOURCE-BUNDLE" "1" "19-Feb-2018" "" "bst source-bundle Manual"
.TH "BST SOURCE-BUNDLE" "1" "06-Mar-2018" "" "bst source-bundle Manual"
.SH NAME
bst\-source-bundle \- Produce a build bundle to be manually executed
.SH SYNOPSIS
......
.TH "BST TRACK" "1" "19-Feb-2018" "" "bst track Manual"
.TH "BST TRACK" "1" "06-Mar-2018" "" "bst track Manual"
.SH NAME
bst\-track \- Track new source references
.SH SYNOPSIS
......
.TH "BST WORKSPACE CLOSE" "1" "19-Feb-2018" "" "bst workspace close Manual"
.TH "BST WORKSPACE CLOSE" "1" "06-Mar-2018" "" "bst workspace close Manual"
.SH NAME
bst\-workspace\-close \- Close a workspace
.SH SYNOPSIS
......
.TH "BST WORKSPACE LIST" "1" "19-Feb-2018" "" "bst workspace list Manual"
.TH "BST WORKSPACE LIST" "1" "06-Mar-2018" "" "bst workspace list Manual"
.SH NAME
bst\-workspace\-list \- List open workspaces
.SH SYNOPSIS
......
.TH "BST WORKSPACE OPEN" "1" "19-Feb-2018" "" "bst workspace open Manual"
.TH "BST WORKSPACE OPEN" "1" "06-Mar-2018" "" "bst workspace open Manual"
.SH NAME
bst\-workspace\-open \- Open a new workspace
.SH SYNOPSIS
......
.TH "BST WORKSPACE RESET" "1" "19-Feb-2018" "" "bst workspace reset Manual"
.TH "BST WORKSPACE RESET" "1" "06-Mar-2018" "" "bst workspace reset Manual"
.SH NAME
bst\-workspace\-reset \- Reset a workspace to its original state
.SH SYNOPSIS
......
.TH "BST WORKSPACE" "1" "19-Feb-2018" "" "bst workspace Manual"
.TH "BST WORKSPACE" "1" "06-Mar-2018" "" "bst workspace Manual"
.SH NAME
bst\-workspace \- Manipulate developer workspaces
.SH SYNOPSIS
......@@ -7,11 +7,6 @@ bst\-workspace \- Manipulate developer workspaces
.SH DESCRIPTION
Manipulate developer workspaces
.SH COMMANDS
.PP
\fBlist\fP
List open workspaces
See \fBbst workspace-list(1)\fP for full documentation on the \fBlist\fP command.
.PP
\fBreset\fP
Reset a workspace to its original state
......@@ -22,6 +17,11 @@ Manipulate developer workspaces
Close a workspace
See \fBbst workspace-close(1)\fP for full documentation on the \fBclose\fP command.
.PP
\fBlist\fP
List open workspaces
See \fBbst workspace-list(1)\fP for full documentation on the \fBlist\fP command.
.PP
\fBopen\fP
Open a new workspace
......
.TH "BST" "1" "19-Feb-2018" "" "bst Manual"
.TH "BST" "1" "06-Mar-2018" "" "bst Manual"
.SH NAME
bst \- Build and manipulate BuildStream projects...
.SH SYNOPSIS
......@@ -59,18 +59,13 @@ Force enable/disable ANSI color codes in output
\fB\-\-strict\fP / \-\-no\-strict
Elements must be rebuilt when their dependencies have changed
.TP
\fB\-o,\fP \-\-option <TEXT TEXT>...
\fB\-o,\fP \-\-option OPTION VALUE
Specify a project option
.SH COMMANDS
.PP
\fBfetch\fP
Fetch sources in a pipeline
See \fBbst-fetch(1)\fP for full documentation on the \fBfetch\fP command.
.PP
\fBworkspace\fP
Manipulate developer workspaces
See \fBbst-workspace(1)\fP for full documentation on the \fBworkspace\fP command.
\fBshow\fP
Show elements in the pipeline
See \fBbst-show(1)\fP for full documentation on the \fBshow\fP command.
.PP
\fBtrack\fP
......@@ -78,34 +73,39 @@ Specify a project option
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.
\fBpush\fP
Push a built artifact
See \fBbst-push(1)\fP for full documentation on the \fBpush\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.
\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
\fBfetch\fP
Fetch sources in a pipeline
See \fBbst-fetch(1)\fP for full documentation on the \fBfetch\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
\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.
\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
\fBpull\fP
......
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