summaryrefslogtreecommitdiff
path: root/man/bst-build.1
diff options
context:
space:
mode:
authorTristan Van Berkom <tristan.vanberkom@codethink.co.uk>2017-04-12 17:08:34 +0900
committerTristan Van Berkom <tristan.vanberkom@codethink.co.uk>2017-04-13 18:42:43 +0900
commita49d1aa4fda79cbffb8483638820109df7dcebb4 (patch)
treed28f299690d926016461f932a2094f764a29808d /man/bst-build.1
parenta7406d86cd7d7a4e5e9273689eeabb8b51632b18 (diff)
downloadbuildstream-a49d1aa4fda79cbffb8483638820109df7dcebb4.tar.gz
Adding man pages to distribution
Man pages are automatically generated but unfortunately committed to the repository, this should be fixed by integrating the man page generation as a part of the build step, but this seems to be very difficult and is not well documented at all. Tip: The man_pages module of click_man implements a distutils.core.Command for generating man pages, this command should be run as a part of setup.py
Diffstat (limited to 'man/bst-build.1')
-rw-r--r--man/bst-build.118
1 files changed, 18 insertions, 0 deletions
diff --git a/man/bst-build.1 b/man/bst-build.1
new file mode 100644
index 000000000..d00fc500e
--- /dev/null
+++ b/man/bst-build.1
@@ -0,0 +1,18 @@
+.TH "BST BUILD" "1" "12-Apr-2017" "" "bst build Manual"
+.SH NAME
+bst\-build \- Build elements in a pipeline
+.SH SYNOPSIS
+.B bst build
+[OPTIONS] TARGET
+.SH DESCRIPTION
+Build elements in a pipeline
+.SH OPTIONS
+.TP
+\fB\-\-all\fP
+Build elements that would not be needed for the current build plan
+.TP
+\fB\-a,\fP \-\-arch TEXT
+The target architecture (default: x86_64)
+.TP
+\fB\-\-variant\fP TEXT
+A variant of the specified target \ No newline at end of file