md2man - UNIX manual page flavoring for Markdown
md2man makes the Markdown format more friendly for writing UNIX manual pages by extending its syntax, semantics, and assumed processing extensions.
md2man extends Markdown syntax by recognizing three kinds of paragraphs,
analogous to the underlying .PP, .TP, and .IP directives in roff(7).
Paragraphs whose lines are all indented by exactly zero or one additional
space are considered "normal paragraphs", analogous to .PP in roff(7):
This is a normal paragraph.
This is also
a normal
paragraph.
And
this
is
a
normal
paragraph
too.
Paragraphs whose first line is indented by less than two additional spaces and
whose subsequent lines are all uniformly indented by exactly two additional
spaces are considered "tagged paragraphs", analogous to .TP in roff(7):
This is a
tagged
paragraph.
Paragraphs whose lines are all uniformly indented by exactly two additional
spaces are considered "indented paragraphs", analogous to .IP in roff(7):
This is an
indented
paragraph.
md2man extends Markdown semantics by treating top-level headings specially.
The first top-level <h1> heading found in the input is considered to be the
.TH directive in roff(7), described under "Title line" in man-pages(7) thus:
.TH title section date source manual
- title
- The title of the man page, written in all caps (e.g.,
MAN-PAGES).
- section
- The section number in which the man page should be placed (e.g.,
7).
- date
- The date of the last revision, written in the form YYYY-MM-DD.
- source
- The source of the command, function, or system call (e.g.,
Linux).
- manual
- The title of the manual (e.g.,
Linux Programmer's Manual).
Any subsequent top-level headings are treated as second-level <h2> headings.
md2man enables the following [Redcarpet] extensions while reading Markdown:
Below is a complete example of an md2man(5) formatted manual page adapted from the Linux Man Page Howto guide by Jens Schweikhardt. The result of processing this example with md2man-html(1) has been bundled along with this manual page.
FOO 1 "MARCH 1995" Linux "User Manuals"
=======================================
NAME
----
foo - frobnicate the bar library
SYNOPSIS
--------
`foo` [`-bar`] [`-c` *config-file*] *file* ...
DESCRIPTION
-----------
`foo` frobnicates the bar library by tweaking internal symbol tables. By
default it parses all baz segments and rearranges them in reverse order by
time for the xyzzy(1) linker to find them. The symdef entry is then compressed
using the WBG (Whiz-Bang-Gizmo) algorithm. All files are processed in the
order specified.
OPTIONS
-------
`-b`
Do not write "busy" to stdout while processing.
`-c` *config-file*
Use the alternate system wide *config-file* instead of */etc/foo.conf*. This
overrides any `FOOCONF` environment variable.
`-a`
In addition to the baz segments, also parse the blurfl headers.
`-r`
Recursive mode. Operates as fast as lightning at the expense of a megabyte
of virtual memory.
FILES
-----
*/etc/foo.conf*
The system wide configuration file. See foo(5) for further details.
*~/.foorc*
Per user configuration file. See foo(5) for further details.
ENVIRONMENT
-----------
`FOOCONF`
If non-null the full pathname for an alternate system wide */etc/foo.conf*.
Overridden by the `-c` option.
DIAGNOSTICS
-----------
The following diagnostics may be issued on stderr:
**Bad magic number.**
The input file does not look like an archive file.
**Old style baz segments.**
`foo` can only handle new style baz segments. COBOL object libraries are not
supported in this version.
BUGS
----
The command name should have been chosen more carefully to reflect its
purpose.
AUTHOR
------
Jens Schweikhardt <howto@schweikhardt.net>
SEE ALSO
--------
bar(1), foo(5), xyzzy(1), [Linux Man Page Howto](
http://www.schweikhardt.net/man_page_howto.html)
Markdown, man-pages(7), roff(7), md2man-roff(1), md2man-html(1)