man/man5/md2man.5 in md2man-5.0.3 vs man/man5/md2man.5 in md2man-5.1.0

- old
+ new

@@ -1,26 +1,23 @@ -.TH MD2MAN 5 2016\-02\-21 5.0.3 +.TH MD2MAN 5 2016\-02\-28 5.1.0 .SH NAME .PP -md2man \- UNIX manual page flavoring for the -.BR markdown (7) -file format +md2man \- UNIX manual page flavoring for Markdown \[la]http://daringfireball.net/projects/markdown/syntax\[ra] .SH DESCRIPTION .PP -md2man \[la]https://github.com/sunaku/md2man\[ra] makes the -.BR markdown (7) -file format friendly for writing UNIX manual +md2man makes the Markdown \[la]http://daringfireball.net/projects/markdown/syntax\[ra] format more friendly for writing UNIX manual pages by extending its syntax, semantics, and assumed processing extensions. .SS Syntax .PP -md2man extends -.BR markdown (7) -syntax by distinguishing three kinds of paragraphs. +md2man extends Markdown \[la]http://daringfireball.net/projects/markdown/syntax\[ra] syntax by recognizing three kinds of paragraphs, +analogous to the underlying \fB\fC\&.PP\fR, \fB\fC\&.TP\fR, and \fB\fC\&.IP\fR directives in +.BR roff (7). .SS Normal paragraphs .PP Paragraphs whose lines are all indented by exactly zero or one additional -spaces are considered to be "normal paragraphs". For example: +space are considered "normal paragraphs", analogous to \fB\fC\&.PP\fR in +.BR roff (7): .PP .RS .nf This is a normal paragraph. @@ -38,12 +35,13 @@ .fi .RE .SS Tagged paragraphs .PP Paragraphs whose first line is indented by less than two additional spaces and -whose subsequent lines are uniformly indented by exactly two additional spaces -are considered to be "tagged paragraphs". For example: +whose subsequent lines are all uniformly indented by exactly two additional +spaces are considered "tagged paragraphs", analogous to \fB\fC\&.TP\fR in +.BR roff (7): .PP .RS .nf This is a tagged @@ -51,24 +49,23 @@ .fi .RE .SS Indented paragraphs .PP Paragraphs whose lines are all uniformly indented by exactly two additional -spaces are considered to be "indented paragraphs". For example: +spaces are considered "indented paragraphs", analogous to \fB\fC\&.IP\fR in +.BR roff (7): .PP .RS .nf This is an indented paragraph. .fi .RE .SS Semantics .PP -md2man extends -.BR markdown (7) -semantics by treating top\-level headings specially. +md2man extends Markdown \[la]http://daringfireball.net/projects/markdown/syntax\[ra] semantics by treating top\-level headings specially. .SS Top\-level headings .PP The first top\-level \fB\fC<h1>\fR heading found in the input is considered to be the \fB\fC\&.TH\fR directive in .BR roff (7), @@ -100,12 +97,11 @@ .RE .PP Any subsequent top\-level headings are treated as second\-level \fB\fC<h2>\fR headings. .SS Extensions .PP -md2man enables the following Redcarpet \[la]https://github.com/vmg/redcarpet\[ra] extensions while reading -.BR markdown (7): +md2man enables the following [Redcarpet] extensions while reading Markdown \[la]http://daringfireball.net/projects/markdown/syntax\[ra]: .RS .IP \(bu 2 tables .IP \(bu 2 autolink @@ -214,10 +210,10 @@ http://www.schweikhardt.net/man_page_howto.html) .fi .RE .SH SEE ALSO .PP -.BR markdown (7), +Markdown \[la]http://daringfireball.net/projects/markdown/syntax\[ra], .BR man-pages (7), +.BR roff (7), .BR md2man-roff (1), -.BR md2man-html (1), -.BR md2man-rake (1) +.BR md2man-html (1)