summaryrefslogtreecommitdiff
path: root/man/bst-artifact.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.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.1')
-rw-r--r--man/bst-artifact.125
1 files changed, 25 insertions, 0 deletions
diff --git a/man/bst-artifact.1 b/man/bst-artifact.1
new file mode 100644
index 000000000..b14798711
--- /dev/null
+++ b/man/bst-artifact.1
@@ -0,0 +1,25 @@
+.TH "BST ARTIFACT" "1" "22-Jan-2019" "" "bst artifact Manual"
+.SH NAME
+bst\-artifact \- Manipulate cached artifacts
+.SH SYNOPSIS
+.B bst artifact
+[OPTIONS] COMMAND [ARGS]...
+.SH DESCRIPTION
+Manipulate cached artifacts
+.SH COMMANDS
+.PP
+\fBcheckout\fP
+ Checkout contents of an artifact
+ See \fBbst artifact-checkout(1)\fP for full documentation on the \fBcheckout\fP command.
+.PP
+\fBpull\fP
+ Pull a built artifact
+ See \fBbst artifact-pull(1)\fP for full documentation on the \fBpull\fP command.
+.PP
+\fBpush\fP
+ Push a built artifact
+ See \fBbst artifact-push(1)\fP for full documentation on the \fBpush\fP command.
+.PP
+\fBlog\fP
+ Show logs of an artifact
+ See \fBbst artifact-log(1)\fP for full documentation on the \fBlog\fP command. \ No newline at end of file