Contents

.TH MD2MAN 1 2012\-07\-05 1.2.1
.SH NAME
.PP
md2man \- convert 
.BR markdown (7) 
into 
.BR roff (7)
.SH SYNOPSIS
.PP
\fB\fCmd2man\fR [\fIOPTION\fP]... [\fIFILE\fP]
.SH DESCRIPTION
.PP
md2man
.UR https://github.com/sunaku/md2man
.UE
converts 
.BR markdown (7) 
input from the given \fIFILE\fP into 
.BR roff (7) 
using
Redcarpet
.UR https://github.com/tanoku/redcarpet
.UE
and then prints the result to the standard output stream.  If
\fIFILE\fP is not given, then the standard input stream is read in its place.
.SS Document format
.PP
md2man extends 
.BR markdown (7) 
syntax in the following ways, as provisioned in the
\fB\fCMd2Man::Document\fR module and defined in its derivative \fB\fCMd2Man::Roff\fR module:
.RS
.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
.PP
md2man extends 
.BR markdown (7) 
semantics in the following ways:
.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.
.RE
.SS Markdown extensions
.PP
The following Redcarpet
.UR https://github.com/tanoku/redcarpet
.UE
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
no_intra_emphasis
.IP \(bu 2
fenced_code_blocks
.RE
.SH OPTIONS
.TP
\fB\fC-h\fR, \fB\fC--help\fR
Show this help manual.
.SH SEE ALSO
.PP
.BR markdown (7), 
.BR roff (7)

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
md2man-1.2.1	man/man1/md2man.1