.TH BINMAN 1 "2012\-01\-09" "3.0.0"
.SH NAME
.PP
binman \- UNIX man pages for Ruby \fB\fCbin/\fR scripts
.SH SYNOPSIS
.PP
\fB\fCbinman\fR [\fIOPTION\fP]... \fICOMMAND\fP
.SH DESCRIPTION
.PP
binman
.UR https://github.com/sunaku/binman
.UE
produces UNIX man pages for your Ruby \fB\fCbin/\fR scripts.  It can extract
their leading comment headers (defined below), convert them from 
.BR markdown (7)
into 
.BR roff (7) 
using md2man
.UR https://github.com/sunaku/md2man
.UE , and display them using 
.BR man (1).
.SS Leading Comment Headers
.PP
A leading comment header can be one of the following two things:
.nr step0 0 1
.RS
.IP \n+[step0]
A contiguous sequence of single\-line comments starting at the
beginning of the file (after shebang and encoding comments plus
optional blank lines) and ending at the first single blank line.
.IP \n+[step0]
First embedded document delimited by \fB\fC=begin\fR and \fB\fC=end\fR lines.
.RE
.SS Markdown Processing Divergence
.PP
Although your leading comment headers are written in 
.BR markdown (7), 
\fB\fCbinman
conv\fR introduces the following additions to 
.BR markdown (7) 
syntax via md2man
.UR https://github.com/sunaku/md2man
.UE :
.RS
.IP \(bu 2
There can be at most one top\-level heading (H1).  It is emitted as \fB\fC.TH\fR
in the 
.BR roff (7) 
output, specifying the UNIX man page's header and footer.
.IP \(bu 2
Paragraphs whose lines are all uniformly indented by two spaces are
considered to be "indented paragraphs".  They are unindented accordingly
before emission as \fB\fC.IP\fR in the 
.BR roff (7) 
output.
.IP \(bu 2
Paragraphs whose subsequent lines (all except the first) are uniformly
indented by two spaces are considered to be a "tagged paragraphs".  They
are unindented accordingly before emission as \fB\fC.TP\fR in the 
.BR roff (7) 
output.
.RE
.SS Markdown Processing Extensions
.PP
The following Redcarpet2
.UR https://github.com/tanoku/redcarpet
.UE
extensions for 
.BR markdown (7) 
are enabled:
.RS
.IP \(bu 2
tables
.IP \(bu 2
autolink
.IP \(bu 2
superscript
.IP \(bu 2
strikethrough
.IP \(bu 2
no_intra_emphasis
.IP \(bu 2
fenced_code_blocks
.RE
.SH OPTIONS
.TP
\fB\fC-h\fR, \fB\fC--help\fR
Display this help manual using 
.BR man (1).
.SH COMMANDS
.TP
\fB\fCshow\fR [\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.
.TP
\fB\fCload\fR [\fIFILE\fP]
Print the leading comment header extracted from the given \fIFILE\fP or STDIN.
.TP
\fB\fCdump\fR [\fIFILE\fP]
Print the 
.BR roff (7) 
conversion of the leading comment header extracted from
the given \fIFILE\fP or STDIN.
.TP
\fB\fCconv\fR [\fIFILE\fP]
Print the 
.BR roff (7) 
conversion of the 
.BR markdown (7) 
document read from the given
\fIFILE\fP or STDIN.
.SH SEE ALSO
.PP
.BR man (1), 
.BR roff (7), 
.BR markdown (7)