Sha256: 5d76d6e3ad4f0828b0c65020c42bec7daeb0b05201bb7fdb3b4618b2bda34d14

Contents?: true

Size: 1.3 KB

Versions: 1

Compression:

Stored size: 1.3 KB

Contents

.TH MD2MAN\-ROFF 1                   2016\-03\-04                            5.1.1
.SH NAME
.PP
md2man\-roff \- convert 
.BR md2man (5) 
flavored Markdown \[la]http://daringfireball.net/projects/markdown/syntax\[ra] text into 
.BR roff (7)
.SH SYNOPSIS
.PP
\fB\fCmd2man\-roff\fR [\fIOPTION\fP]... [\fIFILE\fP]
.SH DESCRIPTION
.PP
This program converts the 
.BR md2man (5) 
flavored Markdown \[la]http://daringfireball.net/projects/markdown/syntax\[ra] text from the given
\fIFILE\fP into 
.BR roff (7) 
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 Limitations
.PP
This program does not convert the following Redcarpet \[la]https://github.com/vmg/redcarpet\[ra] nodes into 
.BR roff (7):
.RS
.IP \(bu 2
\fB\fCblock_html\fR
.IP \(bu 2
\fB\fCstrikethrough\fR
.IP \(bu 2
\fB\fCsuperscript\fR
.IP \(bu 2
\fB\fCimage\fR
.IP \(bu 2
\fB\fCraw_html\fR
.RE
.PP
It issues a warning when it encounters these instead.  Patches are welcome!
.SH OPTIONS
.TP
\fB\fC\-h\fR [\fIPATTERN\fP], \fB\fC\-\-help\fR [\fIPATTERN\fP]
Show this help manual and optionally search for \fIPATTERN\fP regular expression.
.SH SEE ALSO
.PP
.BR md2man-html (1), 
.BR md2man-rake (1), 
.BR md2man (5), 
Markdown \[la]http://daringfireball.net/projects/markdown/syntax\[ra]

Version data entries

1 entries across 1 versions & 1 rubygems

Version Path
md2man-5.1.1 man/man1/md2man-roff.1