md2man 5.0.1 → 5.0.3

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.
Files changed (31) hide show
  1. checksums.yaml +4 -4
  2. data/EXAMPLE.markdown +1 -1
  3. data/README.markdown +32 -12
  4. data/VERSION.markdown +49 -1
  5. data/bin/md2man-html +3 -3
  6. data/bin/md2man-rake +3 -3
  7. data/bin/md2man-roff +3 -3
  8. data/lib/md2man/document.rb +1 -1
  9. data/lib/md2man/html.rb +3 -2
  10. data/lib/md2man/rakefile.rb +4 -1
  11. data/lib/md2man/rakefile/style.css +8 -1
  12. data/lib/md2man/roff.rb +8 -7
  13. data/lib/md2man/version.rb +1 -1
  14. data/man/index.html +2 -2
  15. data/man/man0/EXAMPLE.html +20 -0
  16. data/man/man0/EXAMPLE.markdown +1 -0
  17. data/man/man0/README.html +22 -14
  18. data/man/man0/VERSION.html +40 -12
  19. data/man/man1/md2man-html.1 +6 -4
  20. data/man/man1/md2man-html.1.html +3 -3
  21. data/man/man1/md2man-rake.1 +4 -4
  22. data/man/man1/md2man-rake.1.html +3 -3
  23. data/man/man1/md2man-roff.1 +5 -6
  24. data/man/man1/md2man-roff.1.html +3 -3
  25. data/man/man5/md2man.5 +118 -33
  26. data/man/man5/md2man.5.html +101 -26
  27. data/man/man5/md2man.5.markdown +107 -26
  28. data/man/style.css +8 -1
  29. data/test/md2man/html_test.rb +71 -0
  30. data/test/md2man/roff_test.rb +99 -8
  31. metadata +4 -2
data/man/man1/md2man-html.1 CHANGED
@@ -1,4 +1,4 @@
1
- .TH MD2MAN\-HTML 1 2016\-02\-13 5.0.1
1
+ .TH MD2MAN\-HTML 1 2016\-02\-21 5.0.3
2
2
  .SH NAME
3
3
  .PP
4
4
  md2man\-html \- convert
@@ -57,8 +57,10 @@ For example, multiple headings labeled \fB\fCHello, world!\fR would be emitted a
57
57
  .nf
58
58
  <h2 id="hello\-world">Hello, world!<a name="hello\-world"
59
59
  href="#hello\-world" class="md2man\-permalink" title="permalink"></a></h2>
60
+
60
61
  <h2 id="hello\-world\-1">Hello, world!<a name="hello\-world\-1"
61
62
  href="#hello\-world\-1" class="md2man\-permalink" title="permalink"></a></h2>
63
+
62
64
  <h2 id="hello\-world\-2">Hello, world!<a name="hello\-world\-2"
63
65
  href="#hello\-world\-2" class="md2man\-permalink" title="permalink"></a></h2>
64
66
  .fi
@@ -78,10 +80,10 @@ For example, the \fB\fCprintf(3)\fR cross reference would be emitted as this HTM
78
80
  .RE
79
81
  .SH OPTIONS
80
82
  .TP
81
- \fB\fC\-h\fR, \fB\fC\-\-help\fR
82
- Show this help manual.
83
+ \fB\fC\-h\fR [\fIPATTERN\fP], \fB\fC\-\-help\fR [\fIPATTERN\fP]
84
+ Show this help manual and search for \fIPATTERN\fP regular expression therein.
83
85
  .SH SEE ALSO
84
86
  .PP
85
87
  .BR md2man-roff (1),
86
88
  .BR md2man-rake (1),
87
- .BR md2man (5)
89
+ .BR md2man (5)
data/man/man1/md2man-html.1.html CHANGED
@@ -2,12 +2,12 @@
2
2
  <html>
3
3
  <head>
4
4
  <meta charset="utf-8" />
5
- <meta name="generator" content="md2man 5.0.0 https://github.com/sunaku/md2man" />
5
+ <meta name="generator" content="md2man 5.0.3 https://github.com/sunaku/md2man" />
6
6
  <title>md2man-html(1) &mdash; convert md2man(5) flavored markdown(7) into HTML</title>
7
7
  <link rel="stylesheet" href="../style.css"/>
8
8
  <!--[if lt IE 9]><script src="http://html5shiv.googlecode.com/svn/trunk/html5.js"></script><![endif]-->
9
9
  </head>
10
- <body><div class="navbar"><div class="navbar-inner"><span class="brand"><a href="../index.html#man1">man1</a>/md2man-html.1</span></div></div><div class="container-fluid"><h1 id="md2man-html-1-2016-02-13-5-0-1"><span class="md2man-title">MD2MAN-HTML</span> <span class="md2man-section">1</span> <span class="md2man-date">2016-02-13</span> <span class="md2man-source">5.0.1</span><a name="md2man-html-1-2016-02-13-5-0-1" href="#md2man-html-1-2016-02-13-5-0-1" class="md2man-permalink" title="permalink"></a></h1><h2 id="name">NAME<a name="name" href="#name" class="md2man-permalink" title="permalink"></a></h2><p>md2man-html - convert <a class="md2man-reference" href="../man5/md2man.5.html">md2man(5)</a> flavored <a class="md2man-reference">markdown(7)</a> into HTML</p><h2 id="synopsis">SYNOPSIS<a name="synopsis" href="#synopsis" class="md2man-permalink" title="permalink"></a></h2><p><code>md2man-html</code> [<em>OPTION</em>]... [<em>FILE</em>]</p><h2 id="description">DESCRIPTION<a name="description" href="#description" class="md2man-permalink" title="permalink"></a></h2><p>This program converts <a class="md2man-reference" href="../man5/md2man.5.html">md2man(5)</a> flavored <a class="md2man-reference">markdown(7)</a> input from the given
10
+ <body><div class="navbar"><div class="navbar-inner"><span class="brand"><a href="../index.html#man1">man1</a>/md2man-html.1</span></div></div><div class="container-fluid"><h1 id="md2man-html-1-2016-02-21-5-0-3"><span class="md2man-title">MD2MAN-HTML</span> <span class="md2man-section">1</span> <span class="md2man-date">2016-02-21</span> <span class="md2man-source">5.0.3</span><a name="md2man-html-1-2016-02-21-5-0-3" href="#md2man-html-1-2016-02-21-5-0-3" class="md2man-permalink" title="permalink"></a></h1><h2 id="name">NAME<a name="name" href="#name" class="md2man-permalink" title="permalink"></a></h2><p>md2man-html - convert <a class="md2man-reference" href="../man5/md2man.5.html">md2man(5)</a> flavored <a class="md2man-reference">markdown(7)</a> into HTML</p><h2 id="synopsis">SYNOPSIS<a name="synopsis" href="#synopsis" class="md2man-permalink" title="permalink"></a></h2><p><code>md2man-html</code> [<em>OPTION</em>]... [<em>FILE</em>]</p><h2 id="description">DESCRIPTION<a name="description" href="#description" class="md2man-permalink" title="permalink"></a></h2><p>This program converts <a class="md2man-reference" href="../man5/md2man.5.html">md2man(5)</a> flavored <a class="md2man-reference">markdown(7)</a> input from the given
11
11
  <em>FILE</em> into HTML and then prints the result to the standard output stream.
12
12
  If <em>FILE</em> is not given, then the standard input stream is read in its place.</p><h3 id="top-level-headings">Top-level headings<a name="top-level-headings" href="#top-level-headings" class="md2man-permalink" title="permalink"></a></h3><p>Each component of the <code>.TH</code> directive in <a class="md2man-reference">roff(7)</a>, described under &quot;Top-level
13
13
  headings&quot; in <a class="md2man-reference" href="../man5/md2man.5.html">md2man(5)</a>, is wrapped in stylable <code>&lt;span&gt;</code> elements as follows:</p><pre><code>&lt;span class=&quot;md2man-title&quot;&gt;...&lt;/span&gt;
@@ -34,5 +34,5 @@ href=&quot;#hello-world-2&quot; class=&quot;md2man-permalink&quot; title=&quot;p
34
34
  <code>class=&quot;md2man-reference&quot;</code> and <code>href=&quot;../man$SECTION/$PAGE.$SECTION.html&quot;</code>
35
35
  attributes.</p><p>For example, the <code>printf(3)</code> cross reference would be emitted as this HTML:</p><pre><code>&lt;a class=&quot;md2man-reference&quot; href=&quot;../man3/printf.3.html&quot;&gt;printf(3)&lt;/a&gt;
36
36
  </code></pre>
37
- <h2 id="options">OPTIONS<a name="options" href="#options" class="md2man-permalink" title="permalink"></a></h2><dl><dt><code>-h</code>, <code>--help</code></dt><dd>Show this help manual.</dd></dl><h2 id="see-also">SEE ALSO<a name="see-also" href="#see-also" class="md2man-permalink" title="permalink"></a></h2><p><a class="md2man-reference" href="../man1/md2man-roff.1.html">md2man-roff(1)</a>, <a class="md2man-reference" href="../man1/md2man-rake.1.html">md2man-rake(1)</a>, <a class="md2man-reference" href="../man5/md2man.5.html">md2man(5)</a></p></div></body>
37
+ <h2 id="options">OPTIONS<a name="options" href="#options" class="md2man-permalink" title="permalink"></a></h2><dl><dt><code>-h</code> [<em>PATTERN</em>], <code>--help</code> [<em>PATTERN</em>]</dt><dd>Show this help manual and search for <em>PATTERN</em> regular expression therein.</dd></dl><h2 id="see-also">SEE ALSO<a name="see-also" href="#see-also" class="md2man-permalink" title="permalink"></a></h2><p><a class="md2man-reference" href="../man1/md2man-roff.1.html">md2man-roff(1)</a>, <a class="md2man-reference" href="../man1/md2man-rake.1.html">md2man-rake(1)</a>, <a class="md2man-reference" href="../man5/md2man.5.html">md2man(5)</a></p></div></body>
38
38
  </html>
data/man/man1/md2man-rake.1 CHANGED
@@ -1,4 +1,4 @@
1
- .TH MD2MAN\-RAKE 1 2016\-02\-13 5.0.1
1
+ .TH MD2MAN\-RAKE 1 2016\-02\-21 5.0.3
2
2
  .SH NAME
3
3
  .PP
4
4
  md2man\-rake \- run
@@ -38,8 +38,8 @@ Builds HTML manual pages from \fB\fC*.markdown\fR, \fB\fC*.mkd\fR, and \fB\fC*.m
38
38
  found in or beneath the \fB\fCman/\fR subdirectory in your working directory.
39
39
  .SH OPTIONS
40
40
  .TP
41
- \fB\fC\-h\fR, \fB\fC\-\-help\fR
42
- Show this help manual.
41
+ \fB\fC\-h\fR [\fIPATTERN\fP], \fB\fC\-\-help\fR [\fIPATTERN\fP]
42
+ Show this help manual and search for \fIPATTERN\fP regular expression therein.
43
43
  .PP
44
44
  Run \fB\fCrake \-\-help\fR to see more options.
45
45
  .SH SEE ALSO
@@ -47,4 +47,4 @@ Run \fB\fCrake \-\-help\fR to see more options.
47
47
  .BR rake (1),
48
48
  .BR md2man-roff (1),
49
49
  .BR md2man-html (1),
50
- .BR md2man (5)
50
+ .BR md2man (5)
data/man/man1/md2man-rake.1.html CHANGED
@@ -2,15 +2,15 @@
2
2
  <html>
3
3
  <head>
4
4
  <meta charset="utf-8" />
5
- <meta name="generator" content="md2man 5.0.0 https://github.com/sunaku/md2man" />
5
+ <meta name="generator" content="md2man 5.0.3 https://github.com/sunaku/md2man" />
6
6
  <title>md2man-rake(1) &mdash; run rake(1) tasks from md2man(1)</title>
7
7
  <link rel="stylesheet" href="../style.css"/>
8
8
  <!--[if lt IE 9]><script src="http://html5shiv.googlecode.com/svn/trunk/html5.js"></script><![endif]-->
9
9
  </head>
10
- <body><div class="navbar"><div class="navbar-inner"><span class="brand"><a href="../index.html#man1">man1</a>/md2man-rake.1</span></div></div><div class="container-fluid"><h1 id="md2man-rake-1-2016-02-13-5-0-1"><span class="md2man-title">MD2MAN-RAKE</span> <span class="md2man-section">1</span> <span class="md2man-date">2016-02-13</span> <span class="md2man-source">5.0.1</span><a name="md2man-rake-1-2016-02-13-5-0-1" href="#md2man-rake-1-2016-02-13-5-0-1" class="md2man-permalink" title="permalink"></a></h1><h2 id="name">NAME<a name="name" href="#name" class="md2man-permalink" title="permalink"></a></h2><p>md2man-rake - run <a class="md2man-reference">rake(1)</a> tasks from <a class="md2man-reference">md2man(1)</a></p><h2 id="synopsis">SYNOPSIS<a name="synopsis" href="#synopsis" class="md2man-permalink" title="permalink"></a></h2><p><code>md2man-rake</code> [<em>OPTION</em>]... [<em>TASK</em>]...</p><h2 id="description">DESCRIPTION<a name="description" href="#description" class="md2man-permalink" title="permalink"></a></h2><p>This program lets you run <a class="md2man-reference">rake(1)</a> tasks provided by <a class="md2man-reference">md2man(1)</a> without having
10
+ <body><div class="navbar"><div class="navbar-inner"><span class="brand"><a href="../index.html#man1">man1</a>/md2man-rake.1</span></div></div><div class="container-fluid"><h1 id="md2man-rake-1-2016-02-21-5-0-3"><span class="md2man-title">MD2MAN-RAKE</span> <span class="md2man-section">1</span> <span class="md2man-date">2016-02-21</span> <span class="md2man-source">5.0.3</span><a name="md2man-rake-1-2016-02-21-5-0-3" href="#md2man-rake-1-2016-02-21-5-0-3" class="md2man-permalink" title="permalink"></a></h1><h2 id="name">NAME<a name="name" href="#name" class="md2man-permalink" title="permalink"></a></h2><p>md2man-rake - run <a class="md2man-reference">rake(1)</a> tasks from <a class="md2man-reference">md2man(1)</a></p><h2 id="synopsis">SYNOPSIS<a name="synopsis" href="#synopsis" class="md2man-permalink" title="permalink"></a></h2><p><code>md2man-rake</code> [<em>OPTION</em>]... [<em>TASK</em>]...</p><h2 id="description">DESCRIPTION<a name="description" href="#description" class="md2man-permalink" title="permalink"></a></h2><p>This program lets you run <a class="md2man-reference">rake(1)</a> tasks provided by <a class="md2man-reference">md2man(1)</a> without having
11
11
  to create a special file named <code>Rakefile</code> that contains the following snippet:</p><pre><code>require &#39;md2man/rakefile&#39;
12
12
  </code></pre>
13
13
  <p>If no <em>TASK</em> is specified, then the <code>md2man</code> task is run by default.</p><h2 id="tasks">TASKS<a name="tasks" href="#tasks" class="md2man-permalink" title="permalink"></a></h2><dl><dt><code>md2man</code></dt><dd>Runs the <code>md2man:man</code> and <code>md2man:web</code> tasks, in that order.</dd></dl><dl><dt><code>md2man:man</code></dt><dd>Builds UNIX manual pages from <code>*.markdown</code>, <code>*.mkd</code>, and <code>*.md</code> files
14
14
  found in or beneath the <code>man/</code> subdirectory in your working directory.</dd></dl><dl><dt><code>md2man:web</code></dt><dd>Builds HTML manual pages from <code>*.markdown</code>, <code>*.mkd</code>, and <code>*.md</code> files
15
- found in or beneath the <code>man/</code> subdirectory in your working directory.</dd></dl><h2 id="options">OPTIONS<a name="options" href="#options" class="md2man-permalink" title="permalink"></a></h2><dl><dt><code>-h</code>, <code>--help</code></dt><dd>Show this help manual.</dd></dl><p>Run <code>rake --help</code> to see more options.</p><h2 id="see-also">SEE ALSO<a name="see-also" href="#see-also" class="md2man-permalink" title="permalink"></a></h2><p><a class="md2man-reference">rake(1)</a>, <a class="md2man-reference" href="../man1/md2man-roff.1.html">md2man-roff(1)</a>, <a class="md2man-reference" href="../man1/md2man-html.1.html">md2man-html(1)</a>, <a class="md2man-reference" href="../man5/md2man.5.html">md2man(5)</a></p></div></body>
15
+ found in or beneath the <code>man/</code> subdirectory in your working directory.</dd></dl><h2 id="options">OPTIONS<a name="options" href="#options" class="md2man-permalink" title="permalink"></a></h2><dl><dt><code>-h</code> [<em>PATTERN</em>], <code>--help</code> [<em>PATTERN</em>]</dt><dd>Show this help manual and search for <em>PATTERN</em> regular expression therein.</dd></dl><p>Run <code>rake --help</code> to see more options.</p><h2 id="see-also">SEE ALSO<a name="see-also" href="#see-also" class="md2man-permalink" title="permalink"></a></h2><p><a class="md2man-reference">rake(1)</a>, <a class="md2man-reference" href="../man1/md2man-roff.1.html">md2man-roff(1)</a>, <a class="md2man-reference" href="../man1/md2man-html.1.html">md2man-html(1)</a>, <a class="md2man-reference" href="../man5/md2man.5.html">md2man(5)</a></p></div></body>
16
16
  </html>
data/man/man1/md2man-roff.1 CHANGED
@@ -1,4 +1,4 @@
1
- .TH MD2MAN\-ROFF 1 2016\-02\-13 5.0.1
1
+ .TH MD2MAN\-ROFF 1 2016\-02\-21 5.0.3
2
2
  .SH NAME
3
3
  .PP
4
4
  md2man\-roff \- convert
@@ -23,8 +23,7 @@ and then prints the result to the standard output stream.
23
23
  If \fIFILE\fP is not given, then the standard input stream is read in its place.
24
24
  .SS Limitations
25
25
  .PP
26
- This program does not convert the following Redcarpet
27
- \[la]https://github.com/vmg/redcarpet\[ra] nodes into
26
+ This program does not convert the following Redcarpet \[la]https://github.com/vmg/redcarpet\[ra] nodes into
28
27
  .BR roff (7):
29
28
  .RS
30
29
  .IP \(bu 2
@@ -42,10 +41,10 @@ This program does not convert the following Redcarpet
42
41
  It issues a warning when it encounters these instead. Patches are welcome!
43
42
  .SH OPTIONS
44
43
  .TP
45
- \fB\fC\-h\fR, \fB\fC\-\-help\fR
46
- Show this help manual.
44
+ \fB\fC\-h\fR [\fIPATTERN\fP], \fB\fC\-\-help\fR [\fIPATTERN\fP]
45
+ Show this help manual and search for \fIPATTERN\fP regular expression therein.
47
46
  .SH SEE ALSO
48
47
  .PP
49
48
  .BR md2man-html (1),
50
49
  .BR md2man-rake (1),
51
- .BR md2man (5)
50
+ .BR md2man (5)
data/man/man1/md2man-roff.1.html CHANGED
@@ -2,12 +2,12 @@
2
2
  <html>
3
3
  <head>
4
4
  <meta charset="utf-8" />
5
- <meta name="generator" content="md2man 5.0.0 https://github.com/sunaku/md2man" />
5
+ <meta name="generator" content="md2man 5.0.3 https://github.com/sunaku/md2man" />
6
6
  <title>md2man-roff(1) &mdash; convert md2man(5) flavored markdown(7) into roff(7)</title>
7
7
  <link rel="stylesheet" href="../style.css"/>
8
8
  <!--[if lt IE 9]><script src="http://html5shiv.googlecode.com/svn/trunk/html5.js"></script><![endif]-->
9
9
  </head>
10
- <body><div class="navbar"><div class="navbar-inner"><span class="brand"><a href="../index.html#man1">man1</a>/md2man-roff.1</span></div></div><div class="container-fluid"><h1 id="md2man-roff-1-2016-02-13-5-0-1"><span class="md2man-title">MD2MAN-ROFF</span> <span class="md2man-section">1</span> <span class="md2man-date">2016-02-13</span> <span class="md2man-source">5.0.1</span><a name="md2man-roff-1-2016-02-13-5-0-1" href="#md2man-roff-1-2016-02-13-5-0-1" class="md2man-permalink" title="permalink"></a></h1><h2 id="name">NAME<a name="name" href="#name" class="md2man-permalink" title="permalink"></a></h2><p>md2man-roff - convert <a class="md2man-reference" href="../man5/md2man.5.html">md2man(5)</a> flavored <a class="md2man-reference">markdown(7)</a> into <a class="md2man-reference">roff(7)</a></p><h2 id="synopsis">SYNOPSIS<a name="synopsis" href="#synopsis" class="md2man-permalink" title="permalink"></a></h2><p><code>md2man-roff</code> [<em>OPTION</em>]... [<em>FILE</em>]</p><h2 id="description">DESCRIPTION<a name="description" href="#description" class="md2man-permalink" title="permalink"></a></h2><p>This program converts <a class="md2man-reference" href="../man5/md2man.5.html">md2man(5)</a> flavored <a class="md2man-reference">markdown(7)</a> input from the given
10
+ <body><div class="navbar"><div class="navbar-inner"><span class="brand"><a href="../index.html#man1">man1</a>/md2man-roff.1</span></div></div><div class="container-fluid"><h1 id="md2man-roff-1-2016-02-21-5-0-3"><span class="md2man-title">MD2MAN-ROFF</span> <span class="md2man-section">1</span> <span class="md2man-date">2016-02-21</span> <span class="md2man-source">5.0.3</span><a name="md2man-roff-1-2016-02-21-5-0-3" href="#md2man-roff-1-2016-02-21-5-0-3" class="md2man-permalink" title="permalink"></a></h1><h2 id="name">NAME<a name="name" href="#name" class="md2man-permalink" title="permalink"></a></h2><p>md2man-roff - convert <a class="md2man-reference" href="../man5/md2man.5.html">md2man(5)</a> flavored <a class="md2man-reference">markdown(7)</a> into <a class="md2man-reference">roff(7)</a></p><h2 id="synopsis">SYNOPSIS<a name="synopsis" href="#synopsis" class="md2man-permalink" title="permalink"></a></h2><p><code>md2man-roff</code> [<em>OPTION</em>]... [<em>FILE</em>]</p><h2 id="description">DESCRIPTION<a name="description" href="#description" class="md2man-permalink" title="permalink"></a></h2><p>This program converts <a class="md2man-reference" href="../man5/md2man.5.html">md2man(5)</a> flavored <a class="md2man-reference">markdown(7)</a> input from the given
11
11
  <em>FILE</em> into <a class="md2man-reference">roff(7)</a> and then prints the result to the standard output stream.
12
12
  If <em>FILE</em> is not given, then the standard input stream is read in its place.</p><h3 id="limitations">Limitations<a name="limitations" href="#limitations" class="md2man-permalink" title="permalink"></a></h3><p>This program does not convert the following <a href="https://github.com/vmg/redcarpet">Redcarpet</a> nodes into <a class="md2man-reference">roff(7)</a>:</p>
13
13
  <ul>
@@ -17,5 +17,5 @@ If <em>FILE</em> is not given, then the standard input stream is read in its pla
17
17
  <li><code>image</code></li>
18
18
  <li><code>raw_html</code></li>
19
19
  </ul>
20
- <p>It issues a warning when it encounters these instead. Patches are welcome!</p><h2 id="options">OPTIONS<a name="options" href="#options" class="md2man-permalink" title="permalink"></a></h2><dl><dt><code>-h</code>, <code>--help</code></dt><dd>Show this help manual.</dd></dl><h2 id="see-also">SEE ALSO<a name="see-also" href="#see-also" class="md2man-permalink" title="permalink"></a></h2><p><a class="md2man-reference" href="../man1/md2man-html.1.html">md2man-html(1)</a>, <a class="md2man-reference" href="../man1/md2man-rake.1.html">md2man-rake(1)</a>, <a class="md2man-reference" href="../man5/md2man.5.html">md2man(5)</a></p></div></body>
20
+ <p>It issues a warning when it encounters these instead. Patches are welcome!</p><h2 id="options">OPTIONS<a name="options" href="#options" class="md2man-permalink" title="permalink"></a></h2><dl><dt><code>-h</code> [<em>PATTERN</em>], <code>--help</code> [<em>PATTERN</em>]</dt><dd>Show this help manual and search for <em>PATTERN</em> regular expression therein.</dd></dl><h2 id="see-also">SEE ALSO<a name="see-also" href="#see-also" class="md2man-permalink" title="permalink"></a></h2><p><a class="md2man-reference" href="../man1/md2man-html.1.html">md2man-html(1)</a>, <a class="md2man-reference" href="../man1/md2man-rake.1.html">md2man-rake(1)</a>, <a class="md2man-reference" href="../man5/md2man.5.html">md2man(5)</a></p></div></body>
21
21
  </html>
data/man/man5/md2man.5 CHANGED
@@ -1,13 +1,12 @@
1
- .TH MD2MAN 5 2016\-02\-13 5.0.1
1
+ .TH MD2MAN 5 2016\-02\-21 5.0.3
2
2
  .SH NAME
3
3
  .PP
4
- md2man \- manual page flavoring for the
4
+ md2man \- UNIX manual page flavoring for the
5
5
  .BR markdown (7)
6
6
  file format
7
7
  .SH DESCRIPTION
8
8
  .PP
9
- md2man
10
- \[la]https://github.com/sunaku/md2man\[ra] makes the
9
+ md2man \[la]https://github.com/sunaku/md2man\[ra] makes the
11
10
  .BR markdown (7)
12
11
  file format friendly for writing UNIX manual
13
12
  pages by extending its syntax, semantics, and assumed processing extensions.
@@ -15,25 +14,7 @@ pages by extending its syntax, semantics, and assumed processing extensions.
15
14
  .PP
16
15
  md2man extends
17
16
  .BR markdown (7)
18
- syntax by defining three kinds of paragraphs.
19
- .PP
20
- .RS
21
- .nf
22
- This is a
23
- normal
24
- paragraph.
25
- This is a
26
- tagged
27
- paragraph.
28
- This is an
29
- indented
30
- paragraph.
31
- This
32
- is another
33
- normal
34
- paragraph.
35
- .fi
36
- .RE
17
+ syntax by distinguishing three kinds of paragraphs.
37
18
  .SS Normal paragraphs
38
19
  .PP
39
20
  Paragraphs whose lines are all indented by exactly zero or one additional
@@ -41,13 +22,19 @@ spaces are considered to be "normal paragraphs". For example:
41
22
  .PP
42
23
  .RS
43
24
  .nf
44
- This is a
45
- normal
25
+ This is a normal paragraph.
26
+
27
+ This is also
28
+ a normal
46
29
  paragraph.
47
- This
48
- is another
30
+
31
+ And
32
+ this
33
+ is
34
+ a
49
35
  normal
50
- paragraph.
36
+ paragraph
37
+ too.
51
38
  .fi
52
39
  .RE
53
40
  .SS Tagged paragraphs
@@ -85,8 +72,9 @@ semantics by treating top\-level headings specially.
85
72
  The first top\-level \fB\fC<h1>\fR heading found in the input is considered to be the
86
73
  \fB\fC\&.TH\fR directive in
87
74
  .BR roff (7),
88
- as described under "Title line" in
89
- .BR man-pages (7):
75
+ described under "Title line" in
76
+ .BR man-pages (7)
77
+ thus:
90
78
  .PP
91
79
  .RS
92
80
  .RS
@@ -114,8 +102,7 @@ The title of the manual (e.g., \fB\fCLinux Programmer's Manual\fR).
114
102
  Any subsequent top\-level headings are treated as second\-level \fB\fC<h2>\fR headings.
115
103
  .SS Extensions
116
104
  .PP
117
- md2man enables the following Redcarpet
118
- \[la]https://github.com/vmg/redcarpet\[ra] extensions while reading
105
+ md2man enables the following Redcarpet \[la]https://github.com/vmg/redcarpet\[ra] extensions while reading
119
106
  .BR markdown (7):
120
107
  .RS
121
108
  .IP \(bu 2
@@ -129,10 +116,108 @@ strikethrough
129
116
  .IP \(bu 2
130
117
  fenced_code_blocks
131
118
  .RE
119
+ .SS Examples
120
+ .PP
121
+ Below is a complete example of an
122
+ .BR md2man (5)
123
+ formatted manual page adapted from
124
+ the Linux Man Page Howto \[la]http://www.schweikhardt.net/man_page_howto.html\[ra]
125
+ guide by Jens Schweikhardt. The result of processing \[la]../man0/EXAMPLE.html\[ra]
126
+ this example with
127
+ .BR md2man-html (1)
128
+ has been bundled along with this manual page.
129
+ .PP
130
+ .RS
131
+ .nf
132
+ FOO 1 "MARCH 1995" Linux "User Manuals"
133
+ =======================================
134
+
135
+ NAME
136
+ \-\-\-\-
137
+
138
+ foo \- frobnicate the bar library
139
+
140
+ SYNOPSIS
141
+ \-\-\-\-\-\-\-\-
142
+
143
+ `foo` [`\-bar`] [`\-c` *config\-file*] *file* ...
144
+
145
+ DESCRIPTION
146
+ \-\-\-\-\-\-\-\-\-\-\-
147
+
148
+ `foo` frobnicates the bar library by tweaking internal symbol tables. By
149
+ default it parses all baz segments and rearranges them in reverse order by
150
+ time for the xyzzy(1) linker to find them. The symdef entry is then compressed
151
+ using the WBG (Whiz\-Bang\-Gizmo) algorithm. All files are processed in the
152
+ order specified.
153
+
154
+ OPTIONS
155
+ \-\-\-\-\-\-\-
156
+
157
+ `\-b`
158
+ Do not write "busy" to stdout while processing.
159
+
160
+ `\-c` *config\-file*
161
+ Use the alternate system wide *config\-file* instead of */etc/foo.conf*. This
162
+ overrides any `FOOCONF` environment variable.
163
+
164
+ `\-a`
165
+ In addition to the baz segments, also parse the blurfl headers.
166
+
167
+ `\-r`
168
+ Recursive mode. Operates as fast as lightning at the expense of a megabyte
169
+ of virtual memory.
170
+
171
+ FILES
172
+ \-\-\-\-\-
173
+
174
+ */etc/foo.conf*
175
+ The system wide configuration file. See foo(5) for further details.
176
+
177
+ *~/.foorc*
178
+ Per user configuration file. See foo(5) for further details.
179
+
180
+ ENVIRONMENT
181
+ \-\-\-\-\-\-\-\-\-\-\-
182
+
183
+ `FOOCONF`
184
+ If non\-null the full pathname for an alternate system wide */etc/foo.conf*.
185
+ Overridden by the `\-c` option.
186
+
187
+ DIAGNOSTICS
188
+ \-\-\-\-\-\-\-\-\-\-\-
189
+
190
+ The following diagnostics may be issued on stderr:
191
+
192
+ **Bad magic number.**
193
+ The input file does not look like an archive file.
194
+
195
+ **Old style baz segments.**
196
+ `foo` can only handle new style baz segments. COBOL object libraries are not
197
+ supported in this version.
198
+
199
+ BUGS
200
+ \-\-\-\-
201
+
202
+ The command name should have been chosen more carefully to reflect its
203
+ purpose.
204
+
205
+ AUTHOR
206
+ \-\-\-\-\-\-
207
+
208
+ Jens Schweikhardt <howto@schweikhardt.net>
209
+
210
+ SEE ALSO
211
+ \-\-\-\-\-\-\-\-
212
+
213
+ bar(1), foo(5), xyzzy(1), [Linux Man Page Howto](
214
+ http://www.schweikhardt.net/man_page_howto.html)
215
+ .fi
216
+ .RE
132
217
  .SH SEE ALSO
133
218
  .PP
134
219
  .BR markdown (7),
135
220
  .BR man-pages (7),
136
221
  .BR md2man-roff (1),
137
222
  .BR md2man-html (1),
138
- .BR md2man-rake (1)
223
+ .BR md2man-rake (1)
data/man/man5/md2man.5.html CHANGED
@@ -2,38 +2,26 @@
2
2
  <html>
3
3
  <head>
4
4
  <meta charset="utf-8" />
5
- <meta name="generator" content="md2man 5.0.0 https://github.com/sunaku/md2man" />
6
- <title>md2man(5) &mdash; manual page flavoring for the markdown(7) file format</title>
5
+ <meta name="generator" content="md2man 5.0.3 https://github.com/sunaku/md2man" />
6
+ <title>md2man(5) &mdash; UNIX manual page flavoring for the markdown(7) file format</title>
7
7
  <link rel="stylesheet" href="../style.css"/>
8
8
  <!--[if lt IE 9]><script src="http://html5shiv.googlecode.com/svn/trunk/html5.js"></script><![endif]-->
9
9
  </head>
10
- <body><div class="navbar"><div class="navbar-inner"><span class="brand"><a href="../index.html#man5">man5</a>/md2man.5</span></div></div><div class="container-fluid"><h1 id="md2man-5-2016-02-13-5-0-1"><span class="md2man-title">MD2MAN</span> <span class="md2man-section">5</span> <span class="md2man-date">2016-02-13</span> <span class="md2man-source">5.0.1</span><a name="md2man-5-2016-02-13-5-0-1" href="#md2man-5-2016-02-13-5-0-1" class="md2man-permalink" title="permalink"></a></h1><h2 id="name">NAME<a name="name" href="#name" class="md2man-permalink" title="permalink"></a></h2><p>md2man - manual page flavoring for the <a class="md2man-reference">markdown(7)</a> file format</p><h2 id="description">DESCRIPTION<a name="description" href="#description" class="md2man-permalink" title="permalink"></a></h2><p><a href="https://github.com/sunaku/md2man">md2man</a> makes the <a class="md2man-reference">markdown(7)</a> file format friendly for writing UNIX manual
11
- pages by extending its syntax, semantics, and assumed processing extensions.</p><h3 id="syntax">Syntax<a name="syntax" href="#syntax" class="md2man-permalink" title="permalink"></a></h3><p>md2man extends <a class="md2man-reference">markdown(7)</a> syntax by defining three kinds of paragraphs.</p><pre><code>This is a
12
- normal
13
- paragraph.
10
+ <body><div class="navbar"><div class="navbar-inner"><span class="brand"><a href="../index.html#man5">man5</a>/md2man.5</span></div></div><div class="container-fluid"><h1 id="md2man-5-2016-02-21-5-0-3"><span class="md2man-title">MD2MAN</span> <span class="md2man-section">5</span> <span class="md2man-date">2016-02-21</span> <span class="md2man-source">5.0.3</span><a name="md2man-5-2016-02-21-5-0-3" href="#md2man-5-2016-02-21-5-0-3" class="md2man-permalink" title="permalink"></a></h1><h2 id="name">NAME<a name="name" href="#name" class="md2man-permalink" title="permalink"></a></h2><p>md2man - UNIX manual page flavoring for the <a class="md2man-reference">markdown(7)</a> file format</p><h2 id="description">DESCRIPTION<a name="description" href="#description" class="md2man-permalink" title="permalink"></a></h2><p><a href="https://github.com/sunaku/md2man">md2man</a> makes the <a class="md2man-reference">markdown(7)</a> file format friendly for writing UNIX manual
11
+ pages by extending its syntax, semantics, and assumed processing extensions.</p><h3 id="syntax">Syntax<a name="syntax" href="#syntax" class="md2man-permalink" title="permalink"></a></h3><p>md2man extends <a class="md2man-reference">markdown(7)</a> syntax by distinguishing three kinds of paragraphs.</p><h4 id="normal-paragraphs">Normal paragraphs<a name="normal-paragraphs" href="#normal-paragraphs" class="md2man-permalink" title="permalink"></a></h4><p>Paragraphs whose lines are all indented by exactly zero or one additional
12
+ spaces are considered to be &quot;normal paragraphs&quot;. For example:</p><pre><code>This is a normal paragraph.
14
13
 
15
- This is a
16
- tagged
17
- paragraph.
18
-
19
- This is an
20
- indented
21
- paragraph.
22
-
23
- This
24
- is another
25
- normal
26
- paragraph.
27
- </code></pre>
28
- <h4 id="normal-paragraphs">Normal paragraphs<a name="normal-paragraphs" href="#normal-paragraphs" class="md2man-permalink" title="permalink"></a></h4><p>Paragraphs whose lines are all indented by exactly zero or one additional
29
- spaces are considered to be &quot;normal paragraphs&quot;. For example:</p><pre><code>This is a
30
- normal
14
+ This is also
15
+ a normal
31
16
  paragraph.
32
17
 
33
- This
34
- is another
18
+ And
19
+ this
20
+ is
21
+ a
35
22
  normal
36
- paragraph.
23
+ paragraph
24
+ too.
37
25
  </code></pre>
38
26
  <h4 id="tagged-paragraphs">Tagged paragraphs<a name="tagged-paragraphs" href="#tagged-paragraphs" class="md2man-permalink" title="permalink"></a></h4><p>Paragraphs whose first line is indented by less than two additional spaces and
39
27
  whose subsequent lines are uniformly indented by exactly two additional spaces
@@ -47,7 +35,7 @@ spaces are considered to be &quot;indented paragraphs&quot;. For example:</p><p
47
35
  paragraph.
48
36
  </code></pre>
49
37
  <h3 id="semantics">Semantics<a name="semantics" href="#semantics" class="md2man-permalink" title="permalink"></a></h3><p>md2man extends <a class="md2man-reference">markdown(7)</a> semantics by treating top-level headings specially.</p><h4 id="top-level-headings">Top-level headings<a name="top-level-headings" href="#top-level-headings" class="md2man-permalink" title="permalink"></a></h4><p>The first top-level <code>&lt;h1&gt;</code> heading found in the input is considered to be the
50
- <code>.TH</code> directive in <a class="md2man-reference">roff(7)</a>, as described under &quot;Title line&quot; in <a class="md2man-reference">man-pages(7)</a>:</p>
38
+ <code>.TH</code> directive in <a class="md2man-reference">roff(7)</a>, described under &quot;Title line&quot; in <a class="md2man-reference">man-pages(7)</a> thus:</p>
51
39
  <blockquote>
52
40
  <pre><code>.TH title section date source manual
53
41
  </code></pre>
@@ -60,5 +48,92 @@ spaces are considered to be &quot;indented paragraphs&quot;. For example:</p><p
60
48
  <li>strikethrough</li>
61
49
  <li>fenced_code_blocks</li>
62
50
  </ul>
51
+ <h3 id="examples">Examples<a name="examples" href="#examples" class="md2man-permalink" title="permalink"></a></h3><p>Below is a complete example of an <a class="md2man-reference" href="../man5/md2man.5.html">md2man(5)</a> formatted manual page adapted from
52
+ the <a href="http://www.schweikhardt.net/man_page_howto.html">Linux Man Page Howto</a>
53
+ guide by Jens Schweikhardt. <a href="../man0/EXAMPLE.html">The result of processing</a>
54
+ this example with <a class="md2man-reference" href="../man1/md2man-html.1.html">md2man-html(1)</a> has been bundled along with this manual page.</p><pre><code>FOO 1 &quot;MARCH 1995&quot; Linux &quot;User Manuals&quot;
55
+ =======================================
56
+
57
+ NAME
58
+ ----
59
+
60
+ foo - frobnicate the bar library
61
+
62
+ SYNOPSIS
63
+ --------
64
+
65
+ `foo` [`-bar`] [`-c` *config-file*] *file* ...
66
+
67
+ DESCRIPTION
68
+ -----------
69
+
70
+ `foo` frobnicates the bar library by tweaking internal symbol tables. By
71
+ default it parses all baz segments and rearranges them in reverse order by
72
+ time for the xyzzy(1) linker to find them. The symdef entry is then compressed
73
+ using the WBG (Whiz-Bang-Gizmo) algorithm. All files are processed in the
74
+ order specified.
75
+
76
+ OPTIONS
77
+ -------
78
+
79
+ `-b`
80
+ Do not write &quot;busy&quot; to stdout while processing.
81
+
82
+ `-c` *config-file*
83
+ Use the alternate system wide *config-file* instead of */etc/foo.conf*. This
84
+ overrides any `FOOCONF` environment variable.
85
+
86
+ `-a`
87
+ In addition to the baz segments, also parse the blurfl headers.
88
+
89
+ `-r`
90
+ Recursive mode. Operates as fast as lightning at the expense of a megabyte
91
+ of virtual memory.
92
+
93
+ FILES
94
+ -----
95
+
96
+ */etc/foo.conf*
97
+ The system wide configuration file. See foo(5) for further details.
98
+
99
+ *~/.foorc*
100
+ Per user configuration file. See foo(5) for further details.
101
+
102
+ ENVIRONMENT
103
+ -----------
104
+
105
+ `FOOCONF`
106
+ If non-null the full pathname for an alternate system wide */etc/foo.conf*.
107
+ Overridden by the `-c` option.
108
+
109
+ DIAGNOSTICS
110
+ -----------
111
+
112
+ The following diagnostics may be issued on stderr:
113
+
114
+ **Bad magic number.**
115
+ The input file does not look like an archive file.
116
+
117
+ **Old style baz segments.**
118
+ `foo` can only handle new style baz segments. COBOL object libraries are not
119
+ supported in this version.
120
+
121
+ BUGS
122
+ ----
123
+
124
+ The command name should have been chosen more carefully to reflect its
125
+ purpose.
126
+
127
+ AUTHOR
128
+ ------
129
+
130
+ Jens Schweikhardt &lt;howto@schweikhardt.net&gt;
131
+
132
+ SEE ALSO
133
+ --------
134
+
135
+ bar(1), foo(5), xyzzy(1), [Linux Man Page Howto](
136
+ http://www.schweikhardt.net/man_page_howto.html)
137
+ </code></pre>
63
138
  <h2 id="see-also">SEE ALSO<a name="see-also" href="#see-also" class="md2man-permalink" title="permalink"></a></h2><p><a class="md2man-reference">markdown(7)</a>, <a class="md2man-reference">man-pages(7)</a>, <a class="md2man-reference" href="../man1/md2man-roff.1.html">md2man-roff(1)</a>, <a class="md2man-reference" href="../man1/md2man-html.1.html">md2man-html(1)</a>, <a class="md2man-reference" href="../man1/md2man-rake.1.html">md2man-rake(1)</a></p></div></body>
64
139
  </html>