[DRE-commits] [ruby-rotp] 03/07: Add documentation and manpage

[Balasankar C]

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

balasankarc-guest pushed a commit to branch master
in repository ruby-rotp.

commit dfa79a8a08f1ecd7915afbbb4431f60c89324786
Author: Balasankar C <balasankarc at autistici.org>
Date:   Sat Jun 13 22:09:22 2015 +0530

    Add documentation and manpage
---
 debian/rotp.1             | 48 +++++++++++++++++++++++++++++++++++++++++++++++
 debian/ruby-rotp.doc-base |  9 +++++++++
 debian/ruby-rotp.docs     |  8 ++------
 debian/ruby-rotp.manpages |  1 +
 4 files changed, 60 insertions(+), 6 deletions(-)

diff --git a/debian/rotp.1 b/debian/rotp.1
new file mode 100644
index 0000000..9012369
--- /dev/null
+++ b/debian/rotp.1
@@ -0,0 +1,48 @@
+.TH rotp 1 "May 2015"
+.SH NAME
+.PP
+
+rotp \- Ruby library for generating and verifying one time passwords
+.SH SYNOPSIS
+rotp [options]
+.PP
+.SH DESCRIPTION
+.PP
+A Ruby library for generating and verifying one time passwords. It works for 
+both HOTP and TOTP, and includes QR Code provisioning
+.SH OPTIONS
+.TP
+.fi
+.B
+\-s, \-\-secret [SECRET]
+The shared secret
+.TP
+.fi
+.B
+\-c, \-\-counter [COUNTER]
+The counter for counter-based hmac OTP
+.TP
+.fi
+.B
+\-t, \-\-time
+Use time-based OTP according to RFC 6238 (default)
+.TP
+.fi
+.B
+\-m, \-\-hmac
+Use counter-based OTP according to RFC 4226
+.TP
+.fi
+.B
+\-h, \-\-help
+Show help
+
+.SH Examples
+.PP
+rotp \-\-secret p4ssword                       # Generates a time-based one-time password
+.PP
+rotp \-\-hmac \-\-secret p4ssword \-\-counter 42   # Generates a counter-based one-time password
+
+.SH SEE ALSO
+.PP
+/usr/share/doc/ruby-rotp/index.html
diff --git a/debian/ruby-rotp.doc-base b/debian/ruby-rotp.doc-base
new file mode 100644
index 0000000..3aef1f3
--- /dev/null
+++ b/debian/ruby-rotp.doc-base
@@ -0,0 +1,9 @@
+Document: ruby-rotp
+Title: rotp manual
+Author: Mark Percival <m at mdp.im>
+Abstract: Ruby library for generating and verifying one time passwords
+Section: Programming/Ruby
+
+Format: HTML
+Index: /usr/share/doc/ruby-rotp/_index.html
+Files: /usr/share/doc/ruby-rotp/*.html
diff --git a/debian/ruby-rotp.docs b/debian/ruby-rotp.docs
index cd90d2c..968f11e 100644
--- a/debian/ruby-rotp.docs
+++ b/debian/ruby-rotp.docs
@@ -1,6 +1,2 @@
-# Examples:
-# FIXME: READMEs found
-# FIXME: doc/ dir found in source. Consider installing the docs.
-# README.md
-# doc/manual.html
-# doc/site/*
+README.md
+doc/*
diff --git a/debian/ruby-rotp.manpages b/debian/ruby-rotp.manpages
new file mode 100644
index 0000000..0421e62
--- /dev/null
+++ b/debian/ruby-rotp.manpages
@@ -0,0 +1 @@
+debian/rotp.1

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