Sha256: a465d7bbe571d4613f653bee9bc413c614d14308438b89cffe14e9d0ceebad3c

Contents?: true

Size: 1.64 KB

Versions: 1

Compression:

Stored size: 1.64 KB

Contents

#!/usr/bin/env ruby
=begin

MD2MAN 1 "2011-12-06" "1.0.1"
=============================

NAME
----

md2man - convert markdown(7) into roff(7)

SYNOPSIS
--------

`md2man` [*OPTION*]... [*FILE*]

DESCRIPTION
-----------

[md2man] converts markdown(7) input from the given *FILE* into roff(7) using
[Redcarpet2] and then prints the result to the standard output stream.  If
*FILE* is not given, then the standard input stream is read in its place.

### Document Format

The following additional semantics are attached to markdown(7):

  * There can be at most one top-level heading (H1).  It is emitted as `.TH`
    in the roff(7) output, specifying the UNIX man page's header and footer.

  * Paragraphs whose lines are all uniformly indented by two spaces are
    considered to be "indented paragraphs".  They are unindented accordingly
    before emission as `.IP` in the roff(7) output.

  * 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 `.TP` in the roff(7) output.

### Markdown Extensions

The following [Redcarpet2] extensions for markdown(7) are enabled:

* tables
* autolink
* superscript
* strikethrough
* no_intra_emphasis
* fenced_code_blocks

OPTIONS
-------

`-h`, `--help`
  Display this help manual using man(1).

SEE ALSO
--------

markdown(7), roff(7)

[md2man]: https://github.com/sunaku/md2man
[Redcarpet2]: https://github.com/tanoku/redcarpet

=end =========================================================================

require 'binman'
BinMan.help

require 'md2man'
puts Md2Man::ENGINE.render(ARGF.read)

Version data entries

1 entries across 1 versions & 1 rubygems

Version Path
md2man-1.0.1 bin/md2man