[DRE-commits] [ruby-qed] 01/01: Add manpages

Tim Potter tpot-guest at moszumanska.debian.org
Tue Sep 23 01:11:34 UTC 2014


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

tpot-guest pushed a commit to branch master
in repository ruby-qed.

commit 346919ac88c872a5cddce6efd7224a602681dde5
Author: Tim Potter <tpot at hp.com>
Date:   Tue Sep 23 11:11:09 2014 +1000

    Add manpages
---
 debian/qed.1             | 76 ++++++++++++++++++++++++++++++++++++++++++++++++
 debian/qedoc.1           | 52 +++++++++++++++++++++++++++++++++
 debian/ruby-qed.manpages |  2 ++
 3 files changed, 130 insertions(+)

diff --git a/debian/qed.1 b/debian/qed.1
new file mode 100644
index 0000000..364188c
--- /dev/null
+++ b/debian/qed.1
@@ -0,0 +1,76 @@
+.\"                                      Hey, EMACS: -*- nroff -*-
+.\" (C) Copyright 2014 Tim Potter <tpot at hp.com>
+.\"
+.\" First parameter, NAME, should be all caps
+.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
+.\" other parameters are allowed: see man(7), man(1)
+.TH "QED" "1" "July 25, 2014"
+.\" Please adjust this date whenever revising the manpage.
+.\"
+.\" Some roff macros, for reference:
+.\" .nh        disable hyphenation
+.\" .hy        enable hyphenation
+.\" .ad l      left justify
+.\" .ad b      justify to both left and right margins
+.\" .nf        disable filling
+.\" .fi        enable filling
+.\" .br        insert line break
+.\" .sp <n>    insert n+1 empty lines
+.\" for manpage-specific macros, see man(7)
+.SH NAME
+qed \- run tests using the QED TDD/BDD framework
+.SH SYNOPSIS
+.B qed
+.RI [ options ] " files" ...
+.SH DESCRIPTION
+\fBqed\fP is a program that executes tests written using the QED TDD/BDD
+framework.
+.SH OPTIONS
+These programs follow the usual GNU command line syntax, with long
+options starting with two dashes (`-').
+A summary of options is included below.
+For a complete description, see the Info files.
+.TP
+.B \-v, \-\-verbatim
+Shortcut for verbatim reporter
+.TP
+.B \-y, \-\-tapy
+Shortcut for TAP-Y reporter
+.TP
+.B \-f, \-\-format FORMAT
+Use custom reporter
+.TP
+.B \-p, \-\-profile NAME
+Load runtime profile
+.TP
+.B \-c, \-\-comment
+Run comment code
+.TP
+.B \-I, \-\-loadpath PATH
+Add paths to Ruby $LOAD_PATH
+.TP
+.B \-r, \-\-require LIB
+Require feature (immediately)
+.TP
+.B \-R, \-\-rooted
+Run from project root instead of temporary directory
+.TP
+.B \-t, \-\-trace [COUNT]
+Number of backtraces for exceptions (0 for all)
+.TP
+.B \-\-warn
+Run with warnings turned on
+.TP
+.B \-\-debug
+Exit immediately upon raised exception
+.TP
+.B \-\-version
+Display version
+.TP
+.B \-\-copyright
+Display copyrights
+.TP
+.B \-h, \-\-help
+Display help message
+.SH SEE ALSO
+.BR qedoc (1),
diff --git a/debian/qedoc.1 b/debian/qedoc.1
new file mode 100644
index 0000000..efb024b
--- /dev/null
+++ b/debian/qedoc.1
@@ -0,0 +1,52 @@
+.\"                                      Hey, EMACS: -*- nroff -*-
+.\" (C) Copyright 2014 Tim Potter <tpot at hp.com>
+.\"
+.\" First parameter, NAME, should be all caps
+.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
+.\" other parameters are allowed: see man(7), man(1)
+.TH "QEDOC" "1" "July 25, 2014"
+.\" Please adjust this date whenever revising the manpage.
+.\"
+.\" Some roff macros, for reference:
+.\" .nh        disable hyphenation
+.\" .hy        enable hyphenation
+.\" .ad l      left justify
+.\" .ad b      justify to both left and right margins
+.\" .nf        disable filling
+.\" .fi        enable filling
+.\" .br        insert line break
+.\" .sp <n>    insert n+1 empty lines
+.\" for manpage-specific macros, see man(7)
+.SH NAME
+qedoc \- generate documentation from QED tests
+.SH SYNOPSIS
+.B qedoc
+.RI [ options ] " files" ...
+.SH DESCRIPTION
+\fBqed\fP is a program that generates documentation from tests written
+using the QED TDD/BDD framework.
+.SH OPTIONS
+These programs follow the usual GNU command line syntax, with long
+options starting with two dashes (`-').
+A summary of options is included below.
+For a complete description, see the Info files.
+.TP
+.B \-o, \-\-output DIR
+Output directory
+.TP
+.B \-t, \-\-title TITLE
+Title of document
+.TP
+.B \-\-css URI
+Specify a URI for a CSS file added to HTML header
+.TP
+.B \-\-dryrun
+Don't generate any actual documentation
+.TP
+.B \-q, \-\-quiet
+Don't generate any output
+.TP
+.B \-h, \-\-help
+Display help message
+.SH SEE ALSO
+.BR qed (1),
diff --git a/debian/ruby-qed.manpages b/debian/ruby-qed.manpages
new file mode 100644
index 0000000..ac0abbb
--- /dev/null
+++ b/debian/ruby-qed.manpages
@@ -0,0 +1,2 @@
+debian/qed.1
+debian/qedoc.1

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



More information about the Pkg-ruby-extras-commits mailing list