man/man1/binman.1 in binman-3.0.1 vs man/man1/binman.1 in binman-3.1.0
- old
+ new
@@ -1,54 +1,58 @@
-.TH BINMAN 1 "2012\-02\-02" "3.0.1"
+.TH BINMAN 1 2012\-02\-06 3.1.0
.SH NAME
.PP
-binman \- UNIX man pages for Ruby \fB\fCbin/\fR scripts
+binman \- man pages for bin 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)
+produces UNIX manual pages for your executable 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
+.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.
+A contiguous sequence of single\-line comments (which begin with \fB\fC#\fR
+and optionally continue with a single space followed by any number of
+characters until the end of the line) 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.
+The first embedded document delimited by \fB\fC=begin\fR and \fB\fC=end\fR lines, which
+begin with the respective delimiters and optionally continue with a single
+space followed by any number of characters until the end of the line.
.RE
-.SS Markdown Processing Divergence
+.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
+conv\fR inherits the following additions to
.BR markdown (7)
-syntax via md2man
+syntax from 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.
+output to define the UNIX manual 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)
@@ -58,18 +62,17 @@
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
+.SS Markdown processing extensions
.PP
-The following Redcarpet2
+The following Redcarpet
.UR https://github.com/tanoku/redcarpet
.UE
-extensions for
-.BR markdown (7)
-are enabled:
+extensions are enabled while processing
+.BR markdown (7):
.RS
.IP \(bu 2
tables
.IP \(bu 2
autolink
@@ -83,12 +86,21 @@
fenced_code_blocks
.RE
.SH OPTIONS
.TP
\fB\fC-h\fR, \fB\fC--help\fR
-Display this help manual using
-.BR man (1).
+Show this help manual.
.SH COMMANDS
+.TP
+\fB\fChelp\fR \fIFILE\fP [\fIARGUMENT\fP]...
+If the given \fIARGUMENT\fP sequence contains \fB\fC-h\fR or \fB\fC--help\fR except after
+\fB\fC--\fR, then this program extracts the given \fIFILE\fP's leading comment header,
+converts it into
+.BR roff (7),
+and displays it using
+.BR man (1)
+before exiting with
+status code \fB\fC0\fR. Otherwise, this program exits with status code \fB\fC111\fR.
.TP
\fB\fCshow\fR [\fIFILE\fP]
Use
.BR man (1)
to display the