From a49d1aa4fda79cbffb8483638820109df7dcebb4 Mon Sep 17 00:00:00 2001
From: Tristan Van Berkom <tristan.vanberkom@codethink.co.uk>
Date: Wed, 12 Apr 2017 17:08:34 +0900
Subject: 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
---
 man/bst.1 | 75 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 75 insertions(+)
 create mode 100644 man/bst.1

(limited to 'man/bst.1')

diff --git a/man/bst.1 b/man/bst.1
new file mode 100644
index 000000000..5c3de031d
--- /dev/null
+++ b/man/bst.1
@@ -0,0 +1,75 @@
+.TH "BST" "1" "12-Apr-2017" "" "bst Manual"
+.SH NAME
+bst \- Build and manipulate BuildStream projects...
+.SH SYNOPSIS
+.B bst
+[OPTIONS] COMMAND [ARGS]...
+.SH DESCRIPTION
+Build and manipulate BuildStream projects
+
+Most of the main options override options in the
+user preferences configuration file.
+.SH OPTIONS
+.TP
+\fB\-\-version\fP
+Show the version and exit.
+.TP
+\fB\-c,\fP \-\-config PATH
+Configuration file to use
+.TP
+\fB\-C,\fP \-\-directory DIRECTORY
+Project directory (default: current directory)
+.TP
+\fB\-\-on\-error\fP [continue|quit|terminate]
+What to do when an error is encountered
+.TP
+\fB\-\-fetchers\fP INTEGER
+Maximum simultaneous download tasks
+.TP
+\fB\-\-builders\fP INTEGER
+Maximum simultaneous build tasks
+.TP
+\fB\-\-no\-interactive\fP
+Force non interactive mode, otherwise this is automatically decided
+.TP
+\fB\-\-verbose\fP / \-\-no\-verbose
+Be extra verbose
+.TP
+\fB\-\-debug\fP / \-\-no\-debug
+Print debugging output
+.TP
+\fB\-\-error\-lines\fP INTEGER
+Maximum number of lines to show from a task log
+.TP
+\fB\-\-log\-file\fP FILENAME
+A file to store the main log (allows storing the main log while in interactive mode)
+.SH COMMANDS
+.PP
+\fBtrack\fP
+  Track new source references
+  See \fBbst-track(1)\fP for full documentation on the \fBtrack\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
+\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.
-- 
cgit v1.2.1