Commit 2643b095 authored by Tristan Van Berkom's avatar Tristan Van Berkom

Regenerating man pages for 1.1.0 dev release

parent 9e383634
Pipeline #17704427 passed with stages
in 23 minutes and 52 seconds
.TH "BST-ARTIFACT-RECEIVE" "1" "10-Sep-2017" "" "bst-artifact-receive Manual" .TH "BST-ARTIFACT-RECEIVE" "1" "19-Feb-2018" "" "bst-artifact-receive Manual"
.SH NAME .SH NAME
bst-artifact-receive \- Receive pushed artifacts over ssh bst-artifact-receive \- Receive pushed artifacts over ssh
.SH SYNOPSIS .SH SYNOPSIS
...@@ -13,4 +13,7 @@ A BuildStream sister program for receiving artifacts send to a shared artifact c ...@@ -13,4 +13,7 @@ A BuildStream sister program for receiving artifacts send to a shared artifact c
Verbose mode Verbose mode
.TP .TP
\fB\-d,\fP \-\-debug \fB\-d,\fP \-\-debug
Debug mode Debug mode
\ No newline at end of file .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" "10-Sep-2017" "" "bst build Manual" .TH "BST BUILD" "1" "19-Feb-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
.B bst build .B bst build
[OPTIONS] TARGET [OPTIONS] [ELEMENTS]...
.SH DESCRIPTION .SH DESCRIPTION
Build elements in a pipeline Build elements in a pipeline
.SH OPTIONS .SH OPTIONS
...@@ -11,8 +11,14 @@ Build elements in a pipeline ...@@ -11,8 +11,14 @@ Build elements in a pipeline
\fB\-\-all\fP \fB\-\-all\fP
Build elements that would not be needed for the current build plan Build elements that would not be needed for the current build plan
.TP .TP
\fB\-\-track\fP \fB\-\-track\fP PATH
Track new source references before building (implies --all) Specify elements to track during the build. Can be used repeatedly to specify multiple elements
.TP .TP
\fB\-\-variant\fP TEXT \fB\-\-track\-all\fP
A variant of the specified target Track all elements in the pipeline
\ No newline at end of file .TP
\fB\-\-track\-except\fP PATH
Except certain dependencies from tracking
.TP
\fB\-\-track\-save\fP
Write out the tracked references to their element files
\ No newline at end of file
.TH "BST CHECKOUT" "1" "10-Sep-2017" "" "bst checkout Manual" .TH "BST CHECKOUT" "1" "19-Feb-2018" "" "bst checkout Manual"
.SH NAME .SH NAME
bst\-checkout \- Checkout a built artifact bst\-checkout \- Checkout a built artifact
.SH SYNOPSIS .SH SYNOPSIS
.B bst checkout .B bst checkout
[OPTIONS] TARGET DIRECTORY [OPTIONS] ELEMENT DIRECTORY
.SH DESCRIPTION .SH DESCRIPTION
Checkout a built artifact to the specified directory Checkout a built artifact to the specified directory
...@@ -12,5 +12,8 @@ Checkout a built artifact to the specified directory ...@@ -12,5 +12,8 @@ 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\-\-variant\fP TEXT \fB\-\-integrate\fP / \-\-no\-integrate
A variant of the specified target Whether to run integration commands
\ No newline at end of file .TP
\fB\-\-hardlinks\fP
Checkout hardlinks instead of copies (handle with care)
\ No newline at end of file
.TH "BST FETCH" "1" "10-Sep-2017" "" "bst fetch Manual" .TH "BST FETCH" "1" "19-Feb-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
.B bst fetch .B bst fetch
[OPTIONS] TARGET [OPTIONS] [ELEMENTS]...
.SH DESCRIPTION .SH DESCRIPTION
Fetch sources required to build the pipeline Fetch sources required to build the pipeline
...@@ -20,14 +20,11 @@ Specify `--deps` to control which sources to fetch: ...@@ -20,14 +20,11 @@ Specify `--deps` to control which sources to fetch:
all: All dependencies all: All dependencies
.SH OPTIONS .SH OPTIONS
.TP .TP
\fB\-\-except\fP TEXT \fB\-\-except\fP PATH
Except certain dependencies from fetching Except certain dependencies from fetching
.TP .TP
\fB\-d,\fP \-\-deps [none|plan|all] \fB\-d,\fP \-\-deps [none|plan|all]
The dependencies to fetch (default: plan) The dependencies to fetch (default: plan)
.TP .TP
\fB\-\-track\fP \fB\-\-track\fP
Track new source references before fetching Track new source references before fetching
.TP \ No newline at end of file
\fB\-\-variant\fP TEXT
A variant of the specified target
\ No newline at end of file
.TH "BST PULL" "1" "10-Sep-2017" "" "bst pull Manual" .TH "BST PULL" "1" "19-Feb-2018" "" "bst pull Manual"
.SH NAME .SH NAME
bst\-pull \- Pull a built artifact bst\-pull \- Pull a built artifact
.SH SYNOPSIS .SH SYNOPSIS
.B bst pull .B bst pull
[OPTIONS] TARGET [OPTIONS] [ELEMENTS]...
.SH DESCRIPTION .SH DESCRIPTION
Pull a built artifact from the configured remote artifact cache. Pull a built artifact from the configured remote artifact cache.
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.
Specify `--deps` to control which artifacts to pull: Specify `--deps` to control which artifacts to pull:
 
...@@ -14,8 +18,8 @@ Specify `--deps` to control which artifacts to pull: ...@@ -14,8 +18,8 @@ Specify `--deps` to control which artifacts to pull:
all: All dependencies all: All dependencies
.SH OPTIONS .SH OPTIONS
.TP .TP
\fB\-\-variant\fP TEXT
A variant of the specified target
.TP
\fB\-d,\fP \-\-deps [none|all] \fB\-d,\fP \-\-deps [none|all]
The dependency artifacts to pull (default: none) The dependency artifacts to pull (default: none)
\ No newline at end of file .TP
\fB\-r,\fP \-\-remote TEXT
The URL of the remote cache (defaults to the first configured cache)
\ No newline at end of file
.TH "BST PUSH" "1" "10-Sep-2017" "" "bst push Manual" .TH "BST PUSH" "1" "19-Feb-2018" "" "bst push Manual"
.SH NAME .SH NAME
bst\-push \- Push a built artifact bst\-push \- Push a built artifact
.SH SYNOPSIS .SH SYNOPSIS
.B bst push .B bst push
[OPTIONS] TARGET [OPTIONS] [ELEMENTS]...
.SH DESCRIPTION .SH DESCRIPTION
Push a built artifact to the configured remote artifact cache. Push a built artifact to a remote artifact cache.
The default destination is the highest priority configured cache. You can
override this by passing a different cache URL with the `--remote` flag.
Specify `--deps` to control which artifacts to push: Specify `--deps` to control which artifacts to push:
...@@ -14,8 +17,8 @@ Specify `--deps` to control which artifacts to push: ...@@ -14,8 +17,8 @@ Specify `--deps` to control which artifacts to push:
all: All dependencies all: All dependencies
.SH OPTIONS .SH OPTIONS
.TP .TP
\fB\-\-variant\fP TEXT
A variant of the specified target
.TP
\fB\-d,\fP \-\-deps [none|all] \fB\-d,\fP \-\-deps [none|all]
The dependencies to push (default: none) The dependencies to push (default: none)
\ No newline at end of file .TP
\fB\-r,\fP \-\-remote TEXT
The URL of the remote cache (defaults to the first configured cache)
\ No newline at end of file
.TH "BST SHELL" "1" "10-Sep-2017" "" "bst shell Manual" .TH "BST SHELL" "1" "19-Feb-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
.B bst shell .B bst shell
[OPTIONS] TARGET [COMMAND]... [OPTIONS] ELEMENT [COMMAND]...
.SH DESCRIPTION .SH DESCRIPTION
Run a command in the target element's sandbox environment Run a command in the target element's sandbox environment
...@@ -26,7 +26,4 @@ to run an interactive shell with `sh -i`. ...@@ -26,7 +26,4 @@ to run an interactive shell with `sh -i`.
Create a build sandbox Create a build sandbox
.TP .TP
\fB\-s,\fP \-\-sysroot DIRECTORY \fB\-s,\fP \-\-sysroot DIRECTORY
An existing sysroot An existing sysroot
.TP \ No newline at end of file
\fB\-\-variant\fP TEXT
A variant of the specified target
\ No newline at end of file
.TH "BST SHOW" "1" "10-Sep-2017" "" "bst show Manual" .TH "BST SHOW" "1" "19-Feb-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
.B bst show .B bst show
[OPTIONS] TARGET [OPTIONS] [ELEMENTS]...
.SH DESCRIPTION .SH DESCRIPTION
Show elements in the pipeline Show elements in the pipeline
...@@ -27,7 +27,6 @@ the following symbols can be used in the format string: ...@@ -27,7 +27,6 @@ the following symbols can be used in the format string:
 
%{name} The element name %{name} The element name
%{variant} The selected element variant
%{key} The abbreviated cache key (if all sources are consistent) %{key} The abbreviated cache key (if all sources are consistent)
%{full-key} The full cache key (if all sources are consistent) %{full-key} The full cache key (if all sources are consistent)
%{state} cached, buildable, waiting or inconsistent %{state} cached, buildable, waiting or inconsistent
...@@ -53,7 +52,7 @@ If you want to use a newline in a format string in bash, use the '$' modifier: ...@@ -53,7 +52,7 @@ If you want to use a newline in a format string in bash, use the '$' modifier:
$'---------- %{name} ----------\n%{vars}' $'---------- %{name} ----------\n%{vars}'
.SH OPTIONS .SH OPTIONS
.TP .TP
\fB\-\-except\fP TEXT \fB\-\-except\fP PATH
Except certain dependencies Except certain dependencies
.TP .TP
\fB\-d,\fP \-\-deps [none|plan|run|build|all] \fB\-d,\fP \-\-deps [none|plan|run|build|all]
...@@ -65,5 +64,5 @@ Staging or alphabetic ordering of dependencies ...@@ -65,5 +64,5 @@ Staging or alphabetic ordering of dependencies
\fB\-f,\fP \-\-format FORMAT \fB\-f,\fP \-\-format FORMAT
Format string for each element Format string for each element
.TP .TP
\fB\-\-variant\fP TEXT \fB\-\-downloadable\fP
A variant of the specified target Refresh downloadable state
\ No newline at end of file \ No newline at end of file
.TH "BST SOURCE-BUNDLE" "1" "10-Sep-2017" "" "bst source-bundle Manual" .TH "BST SOURCE-BUNDLE" "1" "19-Feb-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
...@@ -8,7 +8,7 @@ bst\-source-bundle \- Produce a build bundle to be manually executed ...@@ -8,7 +8,7 @@ bst\-source-bundle \- Produce a build bundle to be manually executed
Produce a source bundle to be manually executed Produce a source bundle to be manually executed
.SH OPTIONS .SH OPTIONS
.TP .TP
\fB\-\-except\fP TEXT \fB\-\-except\fP PATH
Elements to except from the tarball Elements to except from the tarball
.TP .TP
\fB\-\-compression\fP [none|gz|bz2|xz] \fB\-\-compression\fP [none|gz|bz2|xz]
...@@ -17,9 +17,6 @@ Compress the tar file using the given algorithm. ...@@ -17,9 +17,6 @@ Compress the tar file using the given algorithm.
\fB\-\-track\fP \fB\-\-track\fP
Track new source references before building Track new source references before building
.TP .TP
\fB\-\-variant\fP TEXT
A variant of the specified target
.TP
\fB\-f,\fP \-\-force \fB\-f,\fP \-\-force
Overwrite files existing in checkout directory Overwrite files existing in checkout directory
.TP .TP
......
.TH "BST TRACK" "1" "10-Sep-2017" "" "bst track Manual" .TH "BST TRACK" "1" "19-Feb-2018" "" "bst track Manual"
.SH NAME .SH NAME
bst\-track \- Track new source references bst\-track \- Track new source references
.SH SYNOPSIS .SH SYNOPSIS
.B bst track .B bst track
[OPTIONS] TARGET [OPTIONS] [ELEMENTS]...
.SH DESCRIPTION .SH DESCRIPTION
Consults the specified tracking branches for new versions available Consults the specified tracking branches for new versions available
to build and updates the project with any newly available references. to build and updates the project with any newly available references.
...@@ -18,11 +18,8 @@ Specify `--deps` to control which sources to track: ...@@ -18,11 +18,8 @@ Specify `--deps` to control which sources to track:
all: All dependencies all: All dependencies
.SH OPTIONS .SH OPTIONS
.TP .TP
\fB\-\-except\fP TEXT \fB\-\-except\fP PATH
Except certain dependencies from tracking Except certain dependencies from tracking
.TP .TP
\fB\-d,\fP \-\-deps [none|all] \fB\-d,\fP \-\-deps [none|all]
The dependencies to track (default: none) The dependencies to track (default: none)
.TP \ No newline at end of file
\fB\-\-variant\fP TEXT
A variant of the specified target
\ No newline at end of file
.TH "BST WORKSPACE CLOSE" "1" "10-Sep-2017" "" "bst workspace close Manual" .TH "BST WORKSPACE CLOSE" "1" "19-Feb-2018" "" "bst workspace close Manual"
.SH NAME .SH NAME
bst\-workspace\-close \- Close a workspace bst\-workspace\-close \- Close a workspace
.SH SYNOPSIS .SH SYNOPSIS
...@@ -8,11 +8,5 @@ bst\-workspace\-close \- Close a workspace ...@@ -8,11 +8,5 @@ bst\-workspace\-close \- Close a workspace
Close a workspace Close a workspace
.SH OPTIONS .SH OPTIONS
.TP .TP
\fB\-s,\fP \-\-source INDEX
The source of the workspace to remove. Projects with one source may omit this
.TP
\fB\-\-remove\-dir\fP \fB\-\-remove\-dir\fP
Remove the path that contains the closed workspace Remove the path that contains the closed workspace
.TP \ No newline at end of file
\fB\-\-variant\fP TEXT
A variant of the specified target
\ No newline at end of file
.TH "BST WORKSPACE LIST" "1" "10-Sep-2017" "" "bst workspace list Manual" .TH "BST WORKSPACE LIST" "1" "19-Feb-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" "10-Sep-2017" "" "bst workspace open Manual" .TH "BST WORKSPACE OPEN" "1" "19-Feb-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
...@@ -14,11 +14,5 @@ Do not checkout the source, only link to the given directory ...@@ -14,11 +14,5 @@ Do not checkout the source, only link to the given directory
\fB\-f,\fP \-\-force \fB\-f,\fP \-\-force
Overwrite files existing in checkout directory Overwrite files existing in checkout directory
.TP .TP
\fB\-s,\fP \-\-source INDEX
The source to create a workspace for. Projects with one source may omit this
.TP
\fB\-\-variant\fP TEXT
A variant of the specified target
.TP
\fB\-\-track\fP \fB\-\-track\fP
Track and fetch new source references before checking out the workspace Track and fetch new source references before checking out the workspace
\ No newline at end of file
.TH "BST WORKSPACE RESET" "1" "10-Sep-2017" "" "bst workspace reset Manual" .TH "BST WORKSPACE RESET" "1" "19-Feb-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,14 +8,8 @@ bst\-workspace\-reset \- Reset a workspace to its original state ...@@ -8,14 +8,8 @@ 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\-s,\fP \-\-source INDEX
The source of the workspace to reset. Projects with one source may omit this
.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
\fB\-\-no\-checkout\fP \fB\-\-no\-checkout\fP
Do not checkout the source, only link to the given directory Do not checkout the source, only link to the given directory
.TP \ No newline at end of file
\fB\-\-variant\fP TEXT
A variant of the specified target
\ No newline at end of file
.TH "BST WORKSPACE" "1" "10-Sep-2017" "" "bst workspace Manual" .TH "BST WORKSPACE" "1" "19-Feb-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
\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
\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
\fBclose\fP \fBclose\fP
Close a workspace Close a workspace
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 .PP
\fBreset\fP \fBopen\fP
Reset a workspace to its original state Open a new workspace
See \fBbst workspace-reset(1)\fP for full documentation on the \fBreset\fP command. See \fBbst workspace-open(1)\fP for full documentation on the \fBopen\fP command.
.TH "BST" "1" "10-Sep-2017" "" "bst Manual" .TH "BST" "1" "19-Feb-2018" "" "bst Manual"
.SH NAME .SH NAME
bst \- Build and manipulate BuildStream projects... bst \- Build and manipulate BuildStream projects...
.SH SYNOPSIS .SH SYNOPSIS
...@@ -56,33 +56,12 @@ A file to store the main log (allows storing the main log while in interactive m ...@@ -56,33 +56,12 @@ A file to store the main log (allows storing the main log while in interactive m
\fB\-\-colors\fP / \-\-no\-colors \fB\-\-colors\fP / \-\-no\-colors
Force enable/disable ANSI color codes in output Force enable/disable ANSI color codes in output
.TP .TP
\fB\-a,\fP \-\-arch TEXT
Machine architecture (default: x86_64)
.TP
\fB\-\-host\-arch\fP TEXT
Machine architecture for the sandbox (defaults to --arch)
.TP
\fB\-\-target\-arch\fP TEXT
Machine architecture for build output (defaults to --arch)
.TP
\fB\-\-strict\fP / \-\-no\-strict \fB\-\-strict\fP / \-\-no\-strict
Elements must be rebuilt when their dependencies have changed Elements must be rebuilt when their dependencies have changed
.TP
\fB\-o,\fP \-\-option <TEXT TEXT>...
Specify a project option
.SH COMMANDS .SH COMMANDS
.PP
\fBbuild\fP
Build elements in a pipeline
See \fBbst-build(1)\fP for full documentation on the \fBbuild\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 .PP
\fBfetch\fP \fBfetch\fP
Fetch sources in a pipeline Fetch sources in a pipeline
...@@ -94,26 +73,41 @@ Elements must be rebuilt when their dependencies have changed ...@@ -94,26 +73,41 @@ Elements must be rebuilt when their dependencies have changed
See \fBbst-workspace(1)\fP for full documentation on the \fBworkspace\fP command. See \fBbst-workspace(1)\fP for full documentation on the \fBworkspace\fP command.
.PP .PP
\fBpull\fP \fBtrack\fP
Pull a built artifact Track new source references
See \fBbst-pull(1)\fP for full documentation on the \fBpull\fP command. See \fBbst-track(1)\fP for full documentation on the \fBtrack\fP command.
.PP .PP
\fBshow\fP \fBcheckout\fP
Show elements in the pipeline Checkout a built artifact
See \fBbst-show(1)\fP for full documentation on the \fBshow\fP command. See \fBbst-checkout(1)\fP for full documentation on the \fBcheckout\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
\fBbuild\fP
Build elements in a pipeline
See \fBbst-build(1)\fP for full documentation on the \fBbuild\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 .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 .PP
\fBtrack\fP \fBshow\fP
Track new source references Show elements in the pipeline
See \fBbst-track(1)\fP for full documentation on the \fBtrack\fP command. See \fBbst-show(1)\fP for full documentation on the \fBshow\fP command.
.PP
\fBpull\fP
Pull a built artifact
See \fBbst-pull(1)\fP for full documentation on the \fBpull\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