Sha256: c19e527b649147d7c94b7907938463975c3330dd82c3edd9f505ce51e6d7f4d8

Contents?: true

Size: 1.39 KB

Versions: 1

Compression:

Stored size: 1.39 KB

Contents

.TH MD2MAN\-HTML 1 2014\-06\-21 2.1.1
.SH NAME
.PP
md2man\-html \- convert 
.BR md2man (5) 
flavored 
.BR markdown (7) 
into HTML
.SH SYNOPSIS
.PP
\fB\fCmd2man\-html\fR [\fIOPTION\fP]... [\fIFILE\fP]
.SH DESCRIPTION
.PP
This program converts 
.BR md2man (5) 
flavored 
.BR markdown (7) 
input from the given
\fIFILE\fP into HTML 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 Top\-level headings
.PP
Each component of the \fB\fC\&.TH\fR directive in 
.BR roff (7), 
described under "Top\-level
headings" in 
.BR md2man (5), 
is wrapped in stylable \fB\fC<span>\fR elements as follows:
.PP
.RS
.nf
<span class="md2man\-title">...</span>
<span class="md2man\-section">...</span>
<span class="md2man\-date">...</span>
<span class="md2man\-source">...</span>
<span class="md2man\-manual">...</span>
.fi
.RE
.SS Cross references
.PP
Cross references to manual pages are emitted as HTML hyperlinks that have
\fB\fCclass="md2man\-xref"\fR and \fB\fChref="../man$SECTION/$PAGE.$SECTION.html"\fR
attributes.
.PP
For example, the \fB\fC
.BR printf (3)\fR 
cross reference would be emitted as this HTML:
.PP
.RS
.nf
<a class="md2man\-xref" href="../man3/printf.3.html">
.BR printf (3)</a>
.fi
.RE
.SH OPTIONS
.TP
\fB\fC\-h\fR, \fB\fC\-\-help\fR
Show this help manual.
.SH SEE ALSO
.PP
.BR md2man-roff (1), 
.BR md2man-rake (1), 
.BR md2man (5)

Version data entries

1 entries across 1 versions & 1 rubygems

Version Path
md2man-2.1.1 man/man1/md2man-html.1