binman.1 in binman-5.1.0

- old
+ new
@@ -1,132 +1,43 @@
-.TH BINMAN 1 2016\-02\-13 5.0.1
+.TH BINMAN 1                        2016\-02\-28                            5.1.0
 .SH NAME
 .PP
-binman \- man pages for bin scripts
+binman \- deprecated; use binman\-* instead
 .SH SYNOPSIS
 .PP
 \fB\fCbinman\fR [\fIOPTION\fP]... \fICOMMAND\fP
 .SH DESCRIPTION
 .PP
-binman
-\[la]https://github.com/sunaku/binman\[ra] 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
-\[la]https://github.com/sunaku/md2man\[ra], and display them using 
-.BR man (1).
-.SS Leading comment headers
+Runs the fellow "\fB\fCbinman\fR\-\fICOMMAND\fP" programs listed under "Commands" below.
 .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 (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]
-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.
+Note: This program is deprecated for removal in the next major version. To
+prepare yourself, please run the fellow binman\-* programs directly instead.
 .RE
-.SS Markdown processing divergence
-.PP
-Although your leading comment headers are written in 
-.BR markdown (7), 
-\fB\fCbinman
-conv\fR inherits the following additions to 
-.BR markdown (7) 
-syntax from 
-.BR md2man (5):
-.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 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) 
-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 Redcarpet
-\[la]https://github.com/vmg/redcarpet\[ra] extensions are enabled while processing 
-.BR markdown (7):
-.RS
-.IP \(bu 2
-tables
-.IP \(bu 2
-autolink
-.IP \(bu 2
-superscript
-.IP \(bu 2
-strikethrough
-.IP \(bu 2
-fenced_code_blocks
-.RE
 .SH OPTIONS
 .TP
 \fB\fC\-h\fR [\fIPATTERN\fP], \fB\fC\-\-help\fR [\fIPATTERN\fP]
-Show this help manual and search for \fIPATTERN\fP regular expression therein.
+Show this help manual and optionally search for \fIPATTERN\fP regular expression.
 .SH COMMANDS
 .TP
-\fB\fCtext\fR [\fIFILE\fP]
-Print the leading comment header extracted from the given \fIFILE\fP or STDIN.
+\fB\fCtext\fR ...
+Runs 
+.BR binman-text (1).
 .TP
-\fB\fCroff\fR [\fIFILE\fP]
-Print the 
-.BR roff (7) 
-conversion of the leading comment header extracted from
-the given \fIFILE\fP or STDIN.
+\fB\fCroff\fR ...
+Runs 
+.BR binman-roff (1).
 .TP
-\fB\fChtml\fR [\fIFILE\fP]
-Print the HTML conversion of the leading comment header extracted from
-the given \fIFILE\fP or STDIN.
+\fB\fChtml\fR ...
+Runs 
+.BR binman-html (1).
 .TP
-\fB\fCshow\fR [\fIFILE\fP] [\fIPATTERN\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.  If \fIPATTERN\fP is given, search for
-it within the output displayed by 
-.BR man (1) 
-and jump to first match if found.
-If 
-.BR man (1) 
-cannot display the 
-.BR roff (1) 
-conversion, fall back to the showing
-the HTML conversion; if that fails too, display the extracted text as\-is.
+\fB\fCshow\fR ...
+Runs 
+.BR binman-show (1).
 .TP
-\fB\fChelp\fR \fIFILE\fP ... [\fB\fC\-h\fR|\fB\fC\-\-help\fR [\fIPATTERN\fP]] ... [\fB\fC\-\-\fR] ...
-If the given argument sequence contains \fB\fC\-h\fR or \fB\fC\-\-help\fR, except after
-\fB\fC\-\-\fR, optionally followed by a \fIPATTERN\fP regular expression that specifies
-text to search for and, if found, jump to inside the displayed man page,
-then this program extracts the given \fIFILE\fP\&'s leading comment header,
-converts it into 
-.BR roff (7), 
-displays it using 
-.BR man (1), 
-and finally exits with
-status code \fB\fC0\fR\&.  Otherwise, this program exits with status code \fB\fC111\fR\&.
+\fB\fChelp\fR ...
+Runs 
+.BR binman-help (1).
 .SH SEE ALSO
 .PP
-.BR binman-rake (1), 
-.BR man (1), 
-.BR roff (7), 
-.BR markdown (7)
\ No newline at end of file
+.BR binman-rake (1)