Contents

.TH BINMAN 1 "2011-01-12" "0.0.1" "Ruby User Manuals"
.SH NAME
.PP
binman \- UNIX man pages for Ruby \fBbin/\fP scripts
.SH SYNOPSIS
.PP
\fBbinman\fP [\fIOPTION\fP]... \fICOMMAND\fP
.SH DESCRIPTION
.PP
\fBbinman\fP \fIhttps://github.com/sunaku/binman\fP produces UNIX man pages for your Ruby \fBbin/\fP scripts by extracting
their leading comment header (a contiguous sequence of single-line comments
starting at beginning of file and ending at first single blank line) and
then converting them from 
.BR markdown (7) 
to 
.BR roff (7) 
using \fBRedcarpet2\fP \fIhttps://github.com/tanoku/redcarpet\fP for
display using 
.BR man (1).
.PP
See for more information and resources.
.SS Markdown Processing Extensions
.PP
Although your leading comment headers are written in 
.BR markdown (7), 
\fBbinman\fP
introduces the following additional conventions to simplify common tasks:
.nr step 0 1
.IP \n+[step]
Paragraphs beginning with bold/italic and followed by at least
one two-space indented line are considered to be definitions.
The first line of such a paragraph is the term being defined and
the subsequent two-space indented lines are the definition body.
.SH OPTIONS
.TP
\fB-h\fP, \fB--help\fP
Display this manual page using 
.BR man (1).
.SH COMMANDS
.TP
\fBread\fP [\fIFILE\fP]
Print the leading comment header extracted from the given \fIFILE\fP or stdin.
.TP
\fBdump\fP [\fIFILE\fP]
Print the 
.BR roff (7) 
conversion of the leading comment header extracted from
the given \fIFILE\fP or stdin.
.TP
\fBshow\fP [\fIFILE\fP]
Use 
.BR man (1) 
to display the 
.BR roff (7) 
conversion of the leading comment header
extracted from the given \fIFILE\fP or stdin.
.SH SEE ALSO
.PP
.BR man (1), 
.BR roff (7), 
.BR markdown (7)

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
binman-0.0.1	man/man1/binman.1