summaryrefslogtreecommitdiff
path: root/man/bst-artifact-checkout.1
diff options
context:
space:
mode:
authorJames Ennis <james.ennis@codethink.com>2019-01-22 13:02:14 +0000
committerJames Ennis <james.ennis@codethink.com>2019-01-22 13:02:14 +0000
commitea2fbe4d69b7d3b214175620271a148510b75a19 (patch)
tree58133bc7dd8c95f0177e91750656a1b511e93362 /man/bst-artifact-checkout.1
parent077d5a96fe82afb11238fc4e19166e07f9667ad0 (diff)
downloadbuildstream-ea2fbe4d69b7d3b214175620271a148510b75a19.tar.gz
man: Regenerate all of our man pagesjennis/migrate_pull_push_commands
Due to an upstream click_man issue: https://github.com/click-contrib/click-man/issues/10 generating the man pages with our current setup.py only generates a man page for bst-artifact-server, our first entry point. I then had to remove this entry point from setup.py and regenerate to obtain man pages for the commands in cli.py
Diffstat (limited to 'man/bst-artifact-checkout.1')
-rw-r--r--man/bst-artifact-checkout.127
1 files changed, 27 insertions, 0 deletions
diff --git a/man/bst-artifact-checkout.1 b/man/bst-artifact-checkout.1
new file mode 100644
index 000000000..9d1bf5534
--- /dev/null
+++ b/man/bst-artifact-checkout.1
@@ -0,0 +1,27 @@
+.TH "BST ARTIFACT CHECKOUT" "1" "22-Jan-2019" "" "bst artifact checkout Manual"
+.SH NAME
+bst\-artifact\-checkout \- Checkout contents of an artifact
+.SH SYNOPSIS
+.B bst artifact checkout
+[OPTIONS] [ELEMENT]
+.SH DESCRIPTION
+Checkout contents of an artifact
+.SH OPTIONS
+.TP
+\fB\-f,\fP \-\-force
+Allow files to be overwritten
+.TP
+\fB\-d,\fP \-\-deps [run|build|none]
+The dependencies to checkout (default: run)
+.TP
+\fB\-\-integrate\fP / \-\-no\-integrate
+Whether to run integration commands
+.TP
+\fB\-\-hardlinks\fP
+Checkout hardlinks instead of copying if possible
+.TP
+\fB\-\-tar\fP LOCATION
+Create a tarball from the artifact contents instead of a file tree. If LOCATION is '-', the tarball will be dumped to the standard output.
+.TP
+\fB\-\-directory\fP DIRECTORY
+The directory to checkout the artifact to \ No newline at end of file