man/man1/binman.1 in binman-3.4.1 vs man/man1/binman.1 in binman-4.0.0

- old
+ new

@@ -1,25 +1,22 @@ -.TH BINMAN 1 2014\-07\-01 3.4.1 +.TH BINMAN 1 2014\-10\-26 4.0.0 .SH NAME .PP 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 manual pages for your executable scripts. It can +\[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 -.UR https://github.com/sunaku/md2man -.UE , and display them using +\[la]https://github.com/sunaku/md2man\[ra], 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 @@ -64,13 +61,11 @@ output. .RE .SS Markdown processing extensions .PP The following Redcarpet -.UR https://github.com/vmg/redcarpet -.UE -extensions are enabled while processing +\[la]https://github.com/vmg/redcarpet\[ra] extensions are enabled while processing .BR markdown (7): .RS .IP \(bu 2 tables .IP \(bu 2 @@ -86,22 +81,19 @@ .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. .SH COMMANDS .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\fCsnip\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\fCshow\fR [\fIFILE\fP] [\fIPATTERN\fP] Use .BR man (1) to display the .BR roff (7) @@ -109,25 +101,20 @@ 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. .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. +\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\&. .SH SEE ALSO .PP .BR binman-rake (1), .BR man (1), .BR roff (7), \ No newline at end of file