md2man 1.6.2 → 2.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
data/bin/md2man DELETED
@@ -1,67 +0,0 @@
1
- #!/usr/bin/env ruby
2
- =begin =======================================================================
3
-
4
- # MD2MAN 1 2013-05-05 1.6.2
5
-
6
- ## NAME
7
-
8
- md2man - convert markdown(7) into roff(7)
9
-
10
- ## SYNOPSIS
11
-
12
- `md2man` [*OPTION*]... [*FILE*]
13
-
14
- ## DESCRIPTION
15
-
16
- [md2man] converts markdown(7) input from the given *FILE* into roff(7) using
17
- [Redcarpet] and then prints the result to the standard output stream. If
18
- *FILE* is not given, then the standard input stream is read in its place.
19
-
20
- ### Document format
21
-
22
- md2man extends markdown(7) syntax in the following ways, as provisioned in the
23
- `Md2Man::Document` module and defined in its derivative `Md2Man::Roff` module:
24
-
25
- * Paragraphs whose lines are all uniformly indented by two spaces are
26
- considered to be "indented paragraphs". They are unindented accordingly
27
- before emission as `.IP` in the roff(7) output.
28
-
29
- * Paragraphs whose subsequent lines (all except the first) are uniformly
30
- indented by two spaces are considered to be a "tagged paragraphs". They
31
- are unindented accordingly before emission as `.TP` in the roff(7) output.
32
-
33
- md2man extends markdown(7) semantics in the following ways:
34
-
35
- * The first top-level heading (H1) found in the document is emitted as `.TH`
36
- in the roff(7) output to define the UNIX manual page's header and footer.
37
- Any subsequent top-level headings (H1) are treated as second-level (H2).
38
-
39
- ### Markdown extensions
40
-
41
- The following [Redcarpet] extensions are enabled while processing markdown(7):
42
-
43
- * tables
44
- * autolink
45
- * superscript
46
- * strikethrough
47
- * fenced\_code\_blocks
48
-
49
- ## OPTIONS
50
-
51
- `-h`, `--help`
52
- Show this help manual.
53
-
54
- ## SEE ALSO
55
-
56
- md2man-html(1), md2man-rake(1)
57
-
58
- [md2man]: https://github.com/sunaku/md2man
59
- [Redcarpet]: https://github.com/vmg/redcarpet
60
-
61
- =end =========================================================================
62
-
63
- require 'binman'
64
- BinMan.help
65
-
66
- require 'md2man'
67
- puts Md2Man::ENGINE.render(ARGF.read)
data/man/man1/md2man.1 DELETED
@@ -1,84 +0,0 @@
1
- .TH MD2MAN 1 2013\-05\-05 1.6.2
2
- .SH NAME
3
- .PP
4
- md2man \- convert
5
- .BR markdown (7)
6
- into
7
- .BR roff (7)
8
- .SH SYNOPSIS
9
- .PP
10
- \fB\fCmd2man\fR [\fIOPTION\fP]... [\fIFILE\fP]
11
- .SH DESCRIPTION
12
- .PP
13
- md2man
14
- .UR https://github.com/sunaku/md2man
15
- .UE
16
- converts
17
- .BR markdown (7)
18
- input from the given \fIFILE\fP into
19
- .BR roff (7)
20
- using
21
- Redcarpet
22
- .UR https://github.com/vmg/redcarpet
23
- .UE
24
- and then prints the result to the standard output stream. If
25
- \fIFILE\fP is not given, then the standard input stream is read in its place.
26
- .SS Document format
27
- .PP
28
- md2man extends
29
- .BR markdown (7)
30
- syntax in the following ways, as provisioned in the
31
- \fB\fCMd2Man::Document\fR module and defined in its derivative \fB\fCMd2Man::Roff\fR module:
32
- .RS
33
- .IP \(bu 2
34
- Paragraphs whose lines are all uniformly indented by two spaces are
35
- considered to be "indented paragraphs". They are unindented accordingly
36
- before emission as \fB\fC.IP\fR in the
37
- .BR roff (7)
38
- output.
39
- .IP \(bu 2
40
- Paragraphs whose subsequent lines (all except the first) are uniformly
41
- indented by two spaces are considered to be a "tagged paragraphs". They
42
- are unindented accordingly before emission as \fB\fC.TP\fR in the
43
- .BR roff (7)
44
- output.
45
- .RE
46
- .PP
47
- md2man extends
48
- .BR markdown (7)
49
- semantics in the following ways:
50
- .RS
51
- .IP \(bu 2
52
- The first top\-level heading (H1) found in the document is emitted as \fB\fC.TH\fR
53
- in the
54
- .BR roff (7)
55
- output to define the UNIX manual page's header and footer.
56
- Any subsequent top\-level headings (H1) are treated as second\-level (H2).
57
- .RE
58
- .SS Markdown extensions
59
- .PP
60
- The following Redcarpet
61
- .UR https://github.com/vmg/redcarpet
62
- .UE
63
- extensions are enabled while processing
64
- .BR markdown (7):
65
- .RS
66
- .IP \(bu 2
67
- tables
68
- .IP \(bu 2
69
- autolink
70
- .IP \(bu 2
71
- superscript
72
- .IP \(bu 2
73
- strikethrough
74
- .IP \(bu 2
75
- fenced_code_blocks
76
- .RE
77
- .SH OPTIONS
78
- .TP
79
- \fB\fC-h\fR, \fB\fC--help\fR
80
- Show this help manual.
81
- .SH SEE ALSO
82
- .PP
83
- .BR md2man-html (1),
84
- .BR md2man-rake (1)
@@ -1,37 +0,0 @@
1
- <!DOCTYPE html>
2
- <html>
3
- <head>
4
- <meta charset="utf-8" />
5
- <meta name="generator" content="md2man 1.6.2 https://github.com/sunaku/md2man" />
6
- <title>md2man(1) &mdash; convert markdown(7) into roff(7)</title>
7
- <link rel="stylesheet" href="../style.css"/>
8
- <!--[if lt IE 9]><script src="http://html5shiv.googlecode.com/svn/trunk/html5.js"></script><![endif]-->
9
- </head>
10
- <body><div class="navbar"><div class="navbar-inner"><span class="brand"><a href="../index.html#man1">man1</a>/md2man.1</span></div></div><div class="container-fluid"><div class="manpage"><h1 id="MD2MAN-1-2013-05-05-1-6-2">MD2MAN 1 2013-05-05 1.6.2</h1><h2 id="NAME">NAME</h2><p>md2man - convert <a class="manpage-reference">markdown(7)</a> into <a class="manpage-reference">roff(7)</a></p><h2 id="SYNOPSIS">SYNOPSIS</h2><p><code>md2man</code> [<em>OPTION</em>]... [<em>FILE</em>]</p><h2 id="DESCRIPTION">DESCRIPTION</h2><p><a href="https://github.com/sunaku/md2man">md2man</a> converts <a class="manpage-reference">markdown(7)</a> input from the given <em>FILE</em> into <a class="manpage-reference">roff(7)</a> using
11
- <a href="https://github.com/vmg/redcarpet">Redcarpet</a> and then prints the result to the standard output stream. If
12
- <em>FILE</em> is not given, then the standard input stream is read in its place.</p><h3 id="Document-format">Document format</h3><p>md2man extends <a class="manpage-reference">markdown(7)</a> syntax in the following ways, as provisioned in the
13
- <code>Md2Man::Document</code> module and defined in its derivative <code>Md2Man::Roff</code> module:</p>
14
- <ul>
15
- <li><p>Paragraphs whose lines are all uniformly indented by two spaces are
16
- considered to be &quot;indented paragraphs&quot;. They are unindented accordingly
17
- before emission as <code>.IP</code> in the <a class="manpage-reference">roff(7)</a> output.</p></li>
18
- <li><p>Paragraphs whose subsequent lines (all except the first) are uniformly
19
- indented by two spaces are considered to be a &quot;tagged paragraphs&quot;. They
20
- are unindented accordingly before emission as <code>.TP</code> in the <a class="manpage-reference">roff(7)</a> output.</p></li>
21
- </ul>
22
- <p>md2man extends <a class="manpage-reference">markdown(7)</a> semantics in the following ways:</p>
23
- <ul>
24
- <li>The first top-level heading (H1) found in the document is emitted as <code>.TH</code>
25
- in the <a class="manpage-reference">roff(7)</a> output to define the UNIX manual page&#39;s header and footer.
26
- Any subsequent top-level headings (H1) are treated as second-level (H2).</li>
27
- </ul>
28
- <h3 id="Markdown-extensions">Markdown extensions</h3><p>The following <a href="https://github.com/vmg/redcarpet">Redcarpet</a> extensions are enabled while processing <a class="manpage-reference">markdown(7)</a>:</p>
29
- <ul>
30
- <li>tables</li>
31
- <li>autolink</li>
32
- <li>superscript</li>
33
- <li>strikethrough</li>
34
- <li>fenced_code_blocks</li>
35
- </ul>
36
- <h2 id="OPTIONS">OPTIONS</h2><dl><dt><code>-h</code>, <code>--help</code></dt><dd>Show this help manual.</dd></dl><h2 id="SEE-ALSO">SEE ALSO</h2><p><a class="manpage-reference" href="../man1/md2man-html.1.html">md2man-html(1)</a>, <a class="manpage-reference" href="../man1/md2man-rake.1.html">md2man-rake(1)</a></p></div></div></body>
37
- </html>