[DRE-commits] [ruby-gitlab] 01/01: Add a simple manpage

[Sophie Brun]

This is an automated email from the git hooks/post-receive script.

sbrun-guest pushed a commit to branch master
in repository ruby-gitlab.

commit 11a3be8454469f3c1f3973bb8da613d164780a52
Author: Sophie Brun <sophie at freexian.com>
Date:   Fri Sep 22 13:42:21 2017 +0200

    Add a simple manpage
---
 debian/gitlab.1             | 51 +++++++++++++++++++++++++++++++++++++++++++++
 debian/ruby-gitlab.manpages |  1 +
 2 files changed, 52 insertions(+)

diff --git a/debian/gitlab.1 b/debian/gitlab.1
new file mode 100644
index 0000000..d6c9e6b
--- /dev/null
+++ b/debian/gitlab.1
@@ -0,0 +1,51 @@
+.TH GITLAB 1 "2017-09-22" "0.1" ""
+.SH NAME
+gitlab \- command line interface to gitlab
+.SH SYNOPSIS
+.br
+.B gitlab
+.I command
+.br
+.SH DESCRIPTION
+.B gitlab
+is a command line interface to gitlab based on the gem gitlab.
+It requires to set a few environment variables (see configuration).
+.PP
+For a complete list of supported CLI commands, see:
+.P
+<\fI\%http://www.rubydoc.info/gems/gitlab/Gitlab/Client\fP>
+.P
+Any of those methods can be called as a command by passing the parameters
+of the commands as parameters of
+.B gitlab.
+.SH CONFIGURATION
+.TP
+A few environment variables needs to be set:
+.sp
+export GITLAB_API_ENDPOINT=https://gitlab.yourcompany.com/api/v4
+.sp
+export GITLAB_API_PRIVATE_TOKEN=<your private token from /profile/account>
+.TP
+The variable GITLAB_API_HTTPARTY_OPTIONS is optional. It can be used to set any HTTParty option you may need using YAML hash syntax. For example SSL verification can be disabled with:
+.sp
+export GITLAB_API_HTTPARTY_OPTIONS="{verify: false}"
+.
+.SH EXAMPLES
+.TP
+To list users:
+.B gitlab users
+.TP
+To get current user:
+.B gitlab user
+.TP
+The result can be filtered:
+.B gitlab user \-\-only=id,username
+
+.B gitlab user \-\-except=email,bio
+.SH SEE ALSO
+.IP \(bu 2
+gem documentation <http://www.rubydoc.info/gems/gitlab/Gitlab/Client>
+.IP \(bu 2
+/usr/share/doc/ruby\-gitlab/README.md.gz
+.SH AUTHOR
+Sophie Brun <sophie at freexian.com>
diff --git a/debian/ruby-gitlab.manpages b/debian/ruby-gitlab.manpages
new file mode 100644
index 0000000..2270ff9
--- /dev/null
+++ b/debian/ruby-gitlab.manpages
@@ -0,0 +1 @@
+debian/gitlab.1

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-ruby-extras/ruby-gitlab.git