Commit 2fd1fc03 authored by Tristan Van Berkom's avatar Tristan Van Berkom

Updating man pages to reflect recent frontend changes.

parent 85c5d6aa
Pipeline #9190168 passed with stages
in 5 minutes and 56 seconds
.TH "BST BUILD" "1" "28-May-2017" "" "bst build Manual"
.TH "BST BUILD" "1" "21-Jun-2017" "" "bst build Manual"
.SH NAME
bst\-build \- Build elements in a pipeline
.SH SYNOPSIS
......
.TH "BST CHECKOUT" "1" "28-May-2017" "" "bst checkout Manual"
.TH "BST CHECKOUT" "1" "21-Jun-2017" "" "bst checkout Manual"
.SH NAME
bst\-checkout \- Checkout a built artifact
.SH SYNOPSIS
......
.TH "BST FETCH" "1" "28-May-2017" "" "bst fetch Manual"
.TH "BST FETCH" "1" "21-Jun-2017" "" "bst fetch Manual"
.SH NAME
bst\-fetch \- Fetch sources in a pipeline
.SH SYNOPSIS
......@@ -20,9 +20,15 @@ Specify `--deps` to control which sources to fetch:
all: All dependencies
.SH OPTIONS
.TP
\fB\-\-except\fP TEXT
Except certain dependencies from fetching
.TP
\fB\-d,\fP \-\-deps [none|plan|all]
The dependencies to fetch (default: plan)
.TP
\fB\-\-track\fP
Track new source references before fetching
.TP
\fB\-a,\fP \-\-arch TEXT
The target architecture (default: x86_64)
.TP
......
.TH "BST SHELL" "1" "28-May-2017" "" "bst shell Manual"
.TH "BST SHELL" "1" "21-Jun-2017" "" "bst shell Manual"
.SH NAME
bst\-shell \- Shell into an element's sandbox environment
.SH SYNOPSIS
......
.TH "BST SHOW" "1" "28-May-2017" "" "bst show Manual"
.TH "BST SHOW" "1" "21-Jun-2017" "" "bst show Manual"
.SH NAME
bst\-show \- Show elements in the pipeline
.SH SYNOPSIS
......@@ -14,7 +14,9 @@ Specify `--deps` to control which elements to show:

none: No dependencies, just the element itself
plan: Only dependencies required for the build plan
plan: Dependencies required for a build plan
run: Runtime dependencies, including the element itself
build: Build time dependencies, excluding the element itself
all: All dependencies

......@@ -48,7 +50,10 @@ If you want to use a newline in a format string in bash, use the '$' modifier:
$'---------- %{name} ----------\n%{vars}'
.SH OPTIONS
.TP
\fB\-d,\fP \-\-deps [none|plan|all]
\fB\-\-except\fP TEXT
Except certain dependencies
.TP
\fB\-d,\fP \-\-deps [none|plan|run|build|all]
The dependencies to show (default: all)
.TP
\fB\-\-order\fP [stage|alpha]
......
.TH "BST TRACK" "1" "28-May-2017" "" "bst track Manual"
.TH "BST TRACK" "1" "21-Jun-2017" "" "bst track Manual"
.SH NAME
bst\-track \- Track new source references
.SH SYNOPSIS
......@@ -18,6 +18,9 @@ Specify `--deps` to control which sources to track:
all: All dependencies
.SH OPTIONS
.TP
\fB\-\-except\fP TEXT
Except certain dependencies from tracking
.TP
\fB\-d,\fP \-\-deps [none|all]
The dependencies to track (default: all)
.TP
......
.TH "BST" "1" "28-May-2017" "" "bst Manual"
.TH "BST" "1" "21-Jun-2017" "" "bst Manual"
.SH NAME
bst \- Build and manipulate BuildStream projects...
.SH SYNOPSIS
......@@ -47,6 +47,16 @@ Maximum number of lines to show in a detailed message
\fB\-\-log\-file\fP FILENAME
A file to store the main log (allows storing the main log while in interactive mode)
.SH COMMANDS
.PP
\fBfetch\fP
Fetch sources in a pipeline
See \fBbst-fetch(1)\fP for full documentation on the \fBfetch\fP command.
.PP
\fBbuild\fP
Build elements in a pipeline
See \fBbst-build(1)\fP for full documentation on the \fBbuild\fP command.
.PP
\fBtrack\fP
Track new source references
......@@ -58,21 +68,11 @@ A file to store the main log (allows storing the main log while in interactive m
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.
\fBshow\fP
Show elements in the pipeline
See \fBbst-show(1)\fP for full documentation on the \fBshow\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.
.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