md2man 5.1.1 → 5.1.2

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.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 54d32c93af420f0ae85e9d928dde83e159928960
4
- data.tar.gz: 6a3eed66f847ad262f3923ae92fdaa3550b8e9bd
3
+ metadata.gz: d78ef13b33193fcefa24b5683ab06541a7759f66
4
+ data.tar.gz: 973decd6f789fb388412f8a2142b74e8975c47e5
5
5
  SHA512:
6
- metadata.gz: 2bfe36eba99e532f23ec5ea68ef0e1f112d8b9fafe47c361787123165f40a440bab8a856210753633cc85ec99752e3fc588f36779efd6c06b47ee7d8c4bc470f
7
- data.tar.gz: ea161aec1450ea0232c9f4fa4ea594b6def0c5a326b7dc957b056682c0105adaa8b847e1792ab8e1bfc91ae14a26a256202743eda697bc222d3488e1ea186ddc
6
+ metadata.gz: 19ab1bf4c1cf03dca2374b9b0401ecf0e9ca12180bb84cc95e145ede8c14a388b823f5286c1fb03ccf5b7d0bf6b264030ea41b9504302e91c04b790cc809025b
7
+ data.tar.gz: b601d6e7713e12d620bc7762dc2ef008aa5c0f5342c3e4c01330d0c28ff29f4defc37cf73075700f2f154114efd7ac92145b606a05427f78474f31580baf896b
@@ -228,6 +228,12 @@ gem spec pkg/*.gem | fgrep man/
228
228
 
229
229
  ## License
230
230
 
231
+ [Spare A Life]: https://sunaku.github.io/vegan-for-life.html
232
+ > Like my work? :+1: Please [spare a life] today as thanks!
233
+ :cow::pig::chicken::fish::speak_no_evil::v::revolving_hearts:
234
+
235
+ Copyright 2011 Suraj N. Kurapati <https://github.com/sunaku>
236
+
231
237
  Released under the ISC license. See the LICENSE file for details.
232
238
 
233
239
  [roff]: http://troff.org
@@ -1,3 +1,18 @@
1
+ ## Version 5.1.2 (2018-02-04)
2
+
3
+ ### Patch:
4
+
5
+ * md2man-roff(1): fix ordered list numbering for nested list items.
6
+
7
+ Thanks to thinca for contributing this patch in pull request #27:
8
+ https://github.com/sunaku/md2man/pull/27
9
+
10
+ ### Other:
11
+
12
+ * Upgrade to Rouge 3.0 for syntax highlighting.
13
+
14
+ * Upgrade to Rake 12.0 for build automation.
15
+
1
16
  ## Version 5.1.1 (2016-03-04)
2
17
 
3
18
  ### Patch:
@@ -1,7 +1,7 @@
1
1
  #!/usr/bin/env ruby
2
2
  =begin =======================================================================
3
3
 
4
- # MD2MAN-HTML 1 2016-03-04 5.1.1
4
+ # MD2MAN-HTML 1 2018-02-04 5.1.2
5
5
 
6
6
  ## NAME
7
7
 
@@ -1,7 +1,7 @@
1
1
  #!/usr/bin/env ruby
2
2
  =begin =======================================================================
3
3
 
4
- # MD2MAN-RAKE 1 2016-03-04 5.1.1
4
+ # MD2MAN-RAKE 1 2018-02-04 5.1.2
5
5
 
6
6
  ## NAME
7
7
 
@@ -1,7 +1,7 @@
1
1
  #!/usr/bin/env ruby
2
2
  =begin =======================================================================
3
3
 
4
- # MD2MAN-ROFF 1 2016-03-04 5.1.1
4
+ # MD2MAN-ROFF 1 2018-02-04 5.1.2
5
5
 
6
6
  ## NAME
7
7
 
@@ -80,6 +80,7 @@ module Md2Man::Roff
80
80
 
81
81
  if list_type == :ordered
82
82
  result << ".nr step#{@ordered_list_id} 0 1"
83
+ contents.gsub!(/^\.IP \\n\+\[step_tbd\]$/, ".IP \\n+[step#{@ordered_list_id}]")
83
84
  @ordered_list_id += 1
84
85
  end
85
86
 
@@ -91,7 +92,7 @@ module Md2Man::Roff
91
92
  designator =
92
93
  case list_type
93
94
  when :ordered
94
- "\\n+[step#{@ordered_list_id}]"
95
+ "\\n+[step_tbd]"
95
96
  when :unordered
96
97
  "\\(bu 2"
97
98
  end
@@ -1,3 +1,3 @@
1
1
  module Md2Man
2
- VERSION = "5.1.1"
2
+ VERSION = "5.1.2"
3
3
  end
@@ -2,7 +2,7 @@
2
2
  <html>
3
3
  <head>
4
4
  <meta charset="utf-8" />
5
- <meta name="generator" content="md2man 5.1.1 https://github.com/sunaku/md2man" />
5
+ <meta name="generator" content="md2man 5.1.2 https://github.com/sunaku/md2man" />
6
6
  <title>man/index &mdash; md2man</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]-->
@@ -2,7 +2,7 @@
2
2
  <html>
3
3
  <head>
4
4
  <meta charset="utf-8" />
5
- <meta name="generator" content="md2man 5.1.1 https://github.com/sunaku/md2man" />
5
+ <meta name="generator" content="md2man 5.1.2 https://github.com/sunaku/md2man" />
6
6
  <title>EXAMPLE &mdash; frobnicate the bar library</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]-->
@@ -2,7 +2,7 @@
2
2
  <html>
3
3
  <head>
4
4
  <meta charset="utf-8" />
5
- <meta name="generator" content="md2man 5.1.1 https://github.com/sunaku/md2man" />
5
+ <meta name="generator" content="md2man 5.1.2 https://github.com/sunaku/md2man" />
6
6
  <title>README &mdash; md2man</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]-->
@@ -23,40 +23,31 @@
23
23
  <h3 id="examples">Examples<a name="examples" href="#examples" class="md2man-permalink" title="permalink"></a></h3><p>Try converting
24
24
  <a href="https://raw.github.com/sunaku/md2man/master/EXAMPLE.markdown">this example Markdown file</a>
25
25
  into
26
- <a href="https://github.com/sunaku/md2man/raw/gh-pages/man/man0/EXAMPLE">a UNIX manual page</a>:</p><pre class="highlight shell"><code>md2man-roff EXAMPLE.markdown &gt; EXAMPLE.1
27
- </code></pre>
28
- <p>You can view <a href="https://github.com/sunaku/md2man/raw/gh-pages/man/man0/EXAMPLE">the resulting UNIX manual page</a> in your <a class="md2man-reference">man(1)</a>
29
- viewer:</p><pre class="highlight shell"><code>man -l EXAMPLE.1
30
- </code></pre>
31
- <p><img src="https://github.com/sunaku/md2man/raw/gh-pages/EXAMPLE.png" alt="screenshot"></p><p>Next, try converting
26
+ <a href="https://github.com/sunaku/md2man/raw/gh-pages/man/man0/EXAMPLE">a UNIX manual page</a>:</p><div class="highlight"><pre class="highlight shell"><code>md2man-roff EXAMPLE.markdown <span class="o">&gt;</span> EXAMPLE.1
27
+ </code></pre></div><p>You can view <a href="https://github.com/sunaku/md2man/raw/gh-pages/man/man0/EXAMPLE">the resulting UNIX manual page</a> in your <a class="md2man-reference">man(1)</a>
28
+ viewer:</p><div class="highlight"><pre class="highlight shell"><code>man <span class="nt">-l</span> EXAMPLE.1
29
+ </code></pre></div><p><img src="https://github.com/sunaku/md2man/raw/gh-pages/EXAMPLE.png" alt="screenshot"></p><p>Next, try converting
32
30
  <a href="https://raw.github.com/sunaku/md2man/master/EXAMPLE.markdown">the same example file</a>
33
31
  into
34
- <a href="https://sunaku.github.io/md2man/man/man0/EXAMPLE.html">a HTML web page</a>:</p><pre class="highlight shell"><code>md2man-html EXAMPLE.markdown &gt; EXAMPLE.html
35
- </code></pre>
36
- <p>You can view <a href="https://sunaku.github.io/md2man/man/man0/EXAMPLE.html">the resulting HTML manual page</a> in your web
37
- browser:</p><pre class="highlight shell"><code>firefox EXAMPLE.html
38
- </code></pre>
39
- <h2 id="installation">Installation<a name="installation" href="#installation" class="md2man-permalink" title="permalink"></a></h2><pre class="highlight shell"><code>gem install md2man
40
- </code></pre>
41
- <h3 id="development">Development<a name="development" href="#development" class="md2man-permalink" title="permalink"></a></h3><pre class="highlight shell"><code>git clone https://github.com/sunaku/md2man
32
+ <a href="https://sunaku.github.io/md2man/man/man0/EXAMPLE.html">a HTML web page</a>:</p><div class="highlight"><pre class="highlight shell"><code>md2man-html EXAMPLE.markdown <span class="o">&gt;</span> EXAMPLE.html
33
+ </code></pre></div><p>You can view <a href="https://sunaku.github.io/md2man/man/man0/EXAMPLE.html">the resulting HTML manual page</a> in your web
34
+ browser:</p><div class="highlight"><pre class="highlight shell"><code>firefox EXAMPLE.html
35
+ </code></pre></div><h2 id="installation">Installation<a name="installation" href="#installation" class="md2man-permalink" title="permalink"></a></h2><div class="highlight"><pre class="highlight shell"><code>gem <span class="nb">install </span>md2man
36
+ </code></pre></div><h3 id="development">Development<a name="development" href="#development" class="md2man-permalink" title="permalink"></a></h3><div class="highlight"><pre class="highlight shell"><code>git clone https://github.com/sunaku/md2man
42
37
  <span class="nb">cd </span>md2man
43
- bundle install
44
- bundle <span class="nb">exec </span>rake --tasks <span class="c"># packaging tasks</span>
45
- bundle <span class="nb">exec </span>md2man-roff --help <span class="c"># run it directly</span>
46
- bundle <span class="nb">exec </span>md2man-html --help <span class="c"># run it directly</span>
47
- </code></pre>
48
- <h2 id="usage">Usage<a name="usage" href="#usage" class="md2man-permalink" title="permalink"></a></h2><h3 id="for-roff-output">For <a href="http://troff.org">roff</a> output<a name="for-roff-output" href="#for-roff-output" class="md2man-permalink" title="permalink"></a></h3><h4 id="at-the-command-line">At the command line<a name="at-the-command-line" href="#at-the-command-line" class="md2man-permalink" title="permalink"></a></h4><p>See <a class="md2man-reference" href="../man1/md2man-roff.1.html">md2man-roff(1)</a> manual:</p><pre class="highlight shell"><code>md2man-roff --help
49
- </code></pre>
50
- <h4 id="inside-a-ruby-script">Inside a Ruby script<a name="inside-a-ruby-script" href="#inside-a-ruby-script" class="md2man-permalink" title="permalink"></a></h4><p>Use the default renderer:</p><pre class="highlight ruby"><code><span class="nb">require</span> <span class="s1">'md2man/roff/engine'</span>
38
+ bundle <span class="nb">install
39
+ </span>bundle <span class="nb">exec </span>rake <span class="nt">--tasks</span> <span class="c"># packaging tasks</span>
40
+ bundle <span class="nb">exec </span>md2man-roff <span class="nt">--help</span> <span class="c"># run it directly</span>
41
+ bundle <span class="nb">exec </span>md2man-html <span class="nt">--help</span> <span class="c"># run it directly</span>
42
+ </code></pre></div><h2 id="usage">Usage<a name="usage" href="#usage" class="md2man-permalink" title="permalink"></a></h2><h3 id="for-roff-output">For <a href="http://troff.org">roff</a> output<a name="for-roff-output" href="#for-roff-output" class="md2man-permalink" title="permalink"></a></h3><h4 id="at-the-command-line">At the command line<a name="at-the-command-line" href="#at-the-command-line" class="md2man-permalink" title="permalink"></a></h4><p>See <a class="md2man-reference" href="../man1/md2man-roff.1.html">md2man-roff(1)</a> manual:</p><div class="highlight"><pre class="highlight shell"><code>md2man-roff <span class="nt">--help</span>
43
+ </code></pre></div><h4 id="inside-a-ruby-script">Inside a Ruby script<a name="inside-a-ruby-script" href="#inside-a-ruby-script" class="md2man-permalink" title="permalink"></a></h4><p>Use the default renderer:</p><div class="highlight"><pre class="highlight ruby"><code><span class="nb">require</span> <span class="s1">'md2man/roff/engine'</span>
51
44
 
52
45
  <span class="n">your_roff_output</span> <span class="o">=</span> <span class="no">Md2Man</span><span class="o">::</span><span class="no">Roff</span><span class="o">::</span><span class="no">ENGINE</span><span class="p">.</span><span class="nf">render</span><span class="p">(</span><span class="n">your_markdown_input</span><span class="p">)</span>
53
- </code></pre>
54
- <p>Build your own renderer:</p><pre class="highlight ruby"><code><span class="nb">require</span> <span class="s1">'md2man/roff/engine'</span>
46
+ </code></pre></div><p>Build your own renderer:</p><div class="highlight"><pre class="highlight ruby"><code><span class="nb">require</span> <span class="s1">'md2man/roff/engine'</span>
55
47
 
56
48
  <span class="n">engine</span> <span class="o">=</span> <span class="no">Redcarpet</span><span class="o">::</span><span class="no">Markdown</span><span class="p">.</span><span class="nf">new</span><span class="p">(</span><span class="no">Md2Man</span><span class="o">::</span><span class="no">Roff</span><span class="o">::</span><span class="no">Engine</span><span class="p">,</span> <span class="n">your_options_hash</span><span class="p">)</span>
57
49
  <span class="n">your_roff_output</span> <span class="o">=</span> <span class="n">engine</span><span class="p">.</span><span class="nf">render</span><span class="p">(</span><span class="n">your_markdown_input</span><span class="p">)</span>
58
- </code></pre>
59
- <p>Define your own renderer:</p><pre class="highlight ruby"><code><span class="nb">require</span> <span class="s1">'md2man/roff/engine'</span>
50
+ </code></pre></div><p>Define your own renderer:</p><div class="highlight"><pre class="highlight ruby"><code><span class="nb">require</span> <span class="s1">'md2man/roff/engine'</span>
60
51
 
61
52
  <span class="k">class</span> <span class="nc">YourManpageRenderer</span> <span class="o">&lt;</span> <span class="no">Md2Man</span><span class="o">::</span><span class="no">Roff</span><span class="o">::</span><span class="no">Engine</span>
62
53
  <span class="c1"># ... your stuff here ...</span>
@@ -64,8 +55,7 @@ bundle <span class="nb">exec </span>md2man-html --help <span class="c"># run it
64
55
 
65
56
  <span class="n">engine</span> <span class="o">=</span> <span class="no">Redcarpet</span><span class="o">::</span><span class="no">Markdown</span><span class="p">.</span><span class="nf">new</span><span class="p">(</span><span class="no">YourManpageRenderer</span><span class="p">,</span> <span class="n">your_options_hash</span><span class="p">)</span>
66
57
  <span class="n">your_roff_output</span> <span class="o">=</span> <span class="n">engine</span><span class="p">.</span><span class="nf">render</span><span class="p">(</span><span class="n">your_markdown_input</span><span class="p">)</span>
67
- </code></pre>
68
- <p>Mix-in your own renderer:</p><pre class="highlight ruby"><code><span class="nb">require</span> <span class="s1">'md2man/roff'</span>
58
+ </code></pre></div><p>Mix-in your own renderer:</p><div class="highlight"><pre class="highlight ruby"><code><span class="nb">require</span> <span class="s1">'md2man/roff'</span>
69
59
 
70
60
  <span class="k">class</span> <span class="nc">YourManpageRenderer</span> <span class="o">&lt;</span> <span class="no">Redcarpet</span><span class="o">::</span><span class="no">Render</span><span class="o">::</span><span class="no">Base</span>
71
61
  <span class="kp">include</span> <span class="no">Md2Man</span><span class="o">::</span><span class="no">Roff</span>
@@ -74,19 +64,15 @@ bundle <span class="nb">exec </span>md2man-html --help <span class="c"># run it
74
64
 
75
65
  <span class="n">engine</span> <span class="o">=</span> <span class="no">Redcarpet</span><span class="o">::</span><span class="no">Markdown</span><span class="p">.</span><span class="nf">new</span><span class="p">(</span><span class="no">YourManpageRenderer</span><span class="p">,</span> <span class="n">your_options_hash</span><span class="p">)</span>
76
66
  <span class="n">your_roff_output</span> <span class="o">=</span> <span class="n">engine</span><span class="p">.</span><span class="nf">render</span><span class="p">(</span><span class="n">your_markdown_input</span><span class="p">)</span>
77
- </code></pre>
78
- <h3 id="for-html-output">For HTML output<a name="for-html-output" href="#for-html-output" class="md2man-permalink" title="permalink"></a></h3><h4 id="at-the-command-line-1">At the command line<a name="at-the-command-line-1" href="#at-the-command-line-1" class="md2man-permalink" title="permalink"></a></h4><p>See <a class="md2man-reference" href="../man1/md2man-html.1.html">md2man-html(1)</a> manual:</p><pre class="highlight shell"><code>md2man-html --help
79
- </code></pre>
80
- <h4 id="inside-a-ruby-script-1">Inside a Ruby script<a name="inside-a-ruby-script-1" href="#inside-a-ruby-script-1" class="md2man-permalink" title="permalink"></a></h4><p>Use the default renderer:</p><pre class="highlight ruby"><code><span class="nb">require</span> <span class="s1">'md2man/html/engine'</span>
67
+ </code></pre></div><h3 id="for-html-output">For HTML output<a name="for-html-output" href="#for-html-output" class="md2man-permalink" title="permalink"></a></h3><h4 id="at-the-command-line-1">At the command line<a name="at-the-command-line-1" href="#at-the-command-line-1" class="md2man-permalink" title="permalink"></a></h4><p>See <a class="md2man-reference" href="../man1/md2man-html.1.html">md2man-html(1)</a> manual:</p><div class="highlight"><pre class="highlight shell"><code>md2man-html <span class="nt">--help</span>
68
+ </code></pre></div><h4 id="inside-a-ruby-script-1">Inside a Ruby script<a name="inside-a-ruby-script-1" href="#inside-a-ruby-script-1" class="md2man-permalink" title="permalink"></a></h4><p>Use the default renderer:</p><div class="highlight"><pre class="highlight ruby"><code><span class="nb">require</span> <span class="s1">'md2man/html/engine'</span>
81
69
 
82
70
  <span class="n">your_html_output</span> <span class="o">=</span> <span class="no">Md2Man</span><span class="o">::</span><span class="no">HTML</span><span class="o">::</span><span class="no">ENGINE</span><span class="p">.</span><span class="nf">render</span><span class="p">(</span><span class="n">your_markdown_input</span><span class="p">)</span>
83
- </code></pre>
84
- <p>Build your own renderer:</p><pre class="highlight ruby"><code><span class="nb">require</span> <span class="s1">'md2man/html/engine'</span>
71
+ </code></pre></div><p>Build your own renderer:</p><div class="highlight"><pre class="highlight ruby"><code><span class="nb">require</span> <span class="s1">'md2man/html/engine'</span>
85
72
 
86
73
  <span class="n">engine</span> <span class="o">=</span> <span class="no">Redcarpet</span><span class="o">::</span><span class="no">Markdown</span><span class="p">.</span><span class="nf">new</span><span class="p">(</span><span class="no">Md2Man</span><span class="o">::</span><span class="no">HTML</span><span class="o">::</span><span class="no">Engine</span><span class="p">,</span> <span class="n">your_options_hash</span><span class="p">)</span>
87
74
  <span class="n">your_html_output</span> <span class="o">=</span> <span class="n">engine</span><span class="p">.</span><span class="nf">render</span><span class="p">(</span><span class="n">your_markdown_input</span><span class="p">)</span>
88
- </code></pre>
89
- <p>Define your own renderer:</p><pre class="highlight ruby"><code><span class="nb">require</span> <span class="s1">'md2man/html/engine'</span>
75
+ </code></pre></div><p>Define your own renderer:</p><div class="highlight"><pre class="highlight ruby"><code><span class="nb">require</span> <span class="s1">'md2man/html/engine'</span>
90
76
 
91
77
  <span class="k">class</span> <span class="nc">YourManpageRenderer</span> <span class="o">&lt;</span> <span class="no">Md2Man</span><span class="o">::</span><span class="no">HTML</span><span class="o">::</span><span class="no">Engine</span>
92
78
  <span class="c1"># ... your stuff here ...</span>
@@ -94,8 +80,7 @@ bundle <span class="nb">exec </span>md2man-html --help <span class="c"># run it
94
80
 
95
81
  <span class="n">engine</span> <span class="o">=</span> <span class="no">Redcarpet</span><span class="o">::</span><span class="no">Markdown</span><span class="p">.</span><span class="nf">new</span><span class="p">(</span><span class="no">YourManpageRenderer</span><span class="p">,</span> <span class="n">your_options_hash</span><span class="p">)</span>
96
82
  <span class="n">your_html_output</span> <span class="o">=</span> <span class="n">engine</span><span class="p">.</span><span class="nf">render</span><span class="p">(</span><span class="n">your_markdown_input</span><span class="p">)</span>
97
- </code></pre>
98
- <p>Mix-in your own renderer:</p><pre class="highlight ruby"><code><span class="nb">require</span> <span class="s1">'md2man/html'</span>
83
+ </code></pre></div><p>Mix-in your own renderer:</p><div class="highlight"><pre class="highlight ruby"><code><span class="nb">require</span> <span class="s1">'md2man/html'</span>
99
84
 
100
85
  <span class="k">class</span> <span class="nc">YourManpageRenderer</span> <span class="o">&lt;</span> <span class="no">Redcarpet</span><span class="o">::</span><span class="no">Render</span><span class="o">::</span><span class="no">Base</span>
101
86
  <span class="kp">include</span> <span class="no">Md2Man</span><span class="o">::</span><span class="no">HTML</span>
@@ -104,20 +89,19 @@ bundle <span class="nb">exec </span>md2man-html --help <span class="c"># run it
104
89
 
105
90
  <span class="n">engine</span> <span class="o">=</span> <span class="no">Redcarpet</span><span class="o">::</span><span class="no">Markdown</span><span class="p">.</span><span class="nf">new</span><span class="p">(</span><span class="no">YourManpageRenderer</span><span class="p">,</span> <span class="n">your_options_hash</span><span class="p">)</span>
106
91
  <span class="n">your_html_output</span> <span class="o">=</span> <span class="n">engine</span><span class="p">.</span><span class="nf">render</span><span class="p">(</span><span class="n">your_markdown_input</span><span class="p">)</span>
107
- </code></pre>
108
- <h3 id="building-manpages">Building manpages<a name="building-manpages" href="#building-manpages" class="md2man-permalink" title="permalink"></a></h3><h4 id="at-the-command-line-2">At the command line<a name="at-the-command-line-2" href="#at-the-command-line-2" class="md2man-permalink" title="permalink"></a></h4><p>See <a class="md2man-reference" href="../man1/md2man-rake.1.html">md2man-rake(1)</a> manual:</p><pre class="highlight shell"><code>md2man-rake --help
109
- </code></pre>
110
- <h4 id="inside-a-ruby-script-2">Inside a Ruby script<a name="inside-a-ruby-script-2" href="#inside-a-ruby-script-2" class="md2man-permalink" title="permalink"></a></h4><p>Add this snippet to your gemspec file:</p><pre class="highlight ruby"><code><span class="n">s</span><span class="p">.</span><span class="nf">files</span> <span class="o">+=</span> <span class="no">Dir</span><span class="p">[</span><span class="s1">'man/man?/*.?'</span><span class="p">]</span> <span class="c1"># UNIX manpages</span>
92
+ </code></pre></div><h3 id="building-manpages">Building manpages<a name="building-manpages" href="#building-manpages" class="md2man-permalink" title="permalink"></a></h3><h4 id="at-the-command-line-2">At the command line<a name="at-the-command-line-2" href="#at-the-command-line-2" class="md2man-permalink" title="permalink"></a></h4><p>See <a class="md2man-reference" href="../man1/md2man-rake.1.html">md2man-rake(1)</a> manual:</p><div class="highlight"><pre class="highlight shell"><code>md2man-rake <span class="nt">--help</span>
93
+ </code></pre></div><h4 id="inside-a-ruby-script-2">Inside a Ruby script<a name="inside-a-ruby-script-2" href="#inside-a-ruby-script-2" class="md2man-permalink" title="permalink"></a></h4><p>Add this snippet to your gemspec file:</p><div class="highlight"><pre class="highlight ruby"><code><span class="n">s</span><span class="p">.</span><span class="nf">files</span> <span class="o">+=</span> <span class="no">Dir</span><span class="p">[</span><span class="s1">'man/man?/*.?'</span><span class="p">]</span> <span class="c1"># UNIX manpages</span>
111
94
  <span class="n">s</span><span class="p">.</span><span class="nf">files</span> <span class="o">+=</span> <span class="no">Dir</span><span class="p">[</span><span class="s1">'man/**/*.{html,css}'</span><span class="p">]</span> <span class="c1"># HTML manpages</span>
112
95
  <span class="n">s</span><span class="p">.</span><span class="nf">add_development_dependency</span> <span class="s1">'md2man'</span><span class="p">,</span> <span class="s1">'~&gt; 5.0'</span>
113
- </code></pre>
114
- <p>Add this line to your Rakefile:</p><pre class="highlight ruby"><code><span class="nb">require</span> <span class="s1">'md2man/rakefile'</span>
115
- </code></pre>
116
- <p>You now have a <code>rake md2man</code> task that builds manual pages from Markdown files
96
+ </code></pre></div><p>Add this line to your Rakefile:</p><div class="highlight"><pre class="highlight ruby"><code><span class="nb">require</span> <span class="s1">'md2man/rakefile'</span>
97
+ </code></pre></div><p>You now have a <code>rake md2man</code> task that builds manual pages from Markdown files
117
98
  (with &quot;.markdown&quot;, &quot;.mkd&quot;, or &quot;.md&quot; extension) inside <code>man/man*/</code> directories.
118
99
  There are also sub-tasks to build manual pages individually as <a href="http://troff.org">roff</a> or HTML.</p><p>If you&#39;re using Bundler, this task also hooks into Bundler&#39;s gem packaging
119
- tasks and ensures that your manual pages are built for packaging into a gem:</p><pre class="highlight ruby"><code><span class="n">bundle</span> <span class="nb">exec</span> <span class="n">rake</span> <span class="n">build</span>
100
+ tasks and ensures that your manual pages are built for packaging into a gem:</p><div class="highlight"><pre class="highlight ruby"><code><span class="n">bundle</span> <span class="nb">exec</span> <span class="n">rake</span> <span class="n">build</span>
120
101
  <span class="n">gem</span> <span class="n">spec</span> <span class="n">pkg</span><span class="o">/*</span><span class="p">.</span><span class="nf">gem</span> <span class="o">|</span> <span class="n">fgrep</span> <span class="n">man</span><span class="o">/</span>
121
- </code></pre>
122
- <h2 id="license">License<a name="license" href="#license" class="md2man-permalink" title="permalink"></a></h2><p>Released under the ISC license. See the LICENSE file for details.</p></div></body>
102
+ </code></pre></div><h2 id="license">License<a name="license" href="#license" class="md2man-permalink" title="permalink"></a></h2>
103
+ <blockquote>
104
+ <p>Like my work? :+1: Please <a href="https://sunaku.github.io/vegan-for-life.html">spare a life</a> today as thanks!
105
+ :cow::pig::chicken::fish::speak<em>no</em>evil::v::revolving_hearts:</p></blockquote>
106
+ <p>Copyright 2011 Suraj N. Kurapati <a href="https://github.com/sunaku">https://github.com/sunaku</a></p><p>Released under the ISC license. See the LICENSE file for details.</p></div></body>
123
107
  </html>
@@ -2,17 +2,26 @@
2
2
  <html>
3
3
  <head>
4
4
  <meta charset="utf-8" />
5
- <meta name="generator" content="md2man 5.1.1 https://github.com/sunaku/md2man" />
5
+ <meta name="generator" content="md2man 5.1.2 https://github.com/sunaku/md2man" />
6
6
  <title>VERSION &mdash; md2man</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#man0">man0</a>/VERSION</span></div></div><div class="container-fluid"><h2 id="version-5-1-1-2016-03-04">Version 5.1.1 (2016-03-04)<a name="version-5-1-1-2016-03-04" href="#version-5-1-1-2016-03-04" class="md2man-permalink" title="permalink"></a></h2><h3 id="patch">Patch:<a name="patch" href="#patch" class="md2man-permalink" title="permalink"></a></h3>
10
+ <body><div class="navbar"><div class="navbar-inner"><span class="brand"><a href="../index.html#man0">man0</a>/VERSION</span></div></div><div class="container-fluid"><h2 id="version-5-1-2-2018-02-04">Version 5.1.2 (2018-02-04)<a name="version-5-1-2-2018-02-04" href="#version-5-1-2-2018-02-04" class="md2man-permalink" title="permalink"></a></h2><h3 id="patch">Patch:<a name="patch" href="#patch" class="md2man-permalink" title="permalink"></a></h3>
11
11
  <ul>
12
- <li><p><a class="md2man-reference" href="../man1/md2man-rake.1.html">md2man-rake(1)</a>: &quot;man&quot; was both a folder name and a task name.</p><pre class="highlight plaintext"><code>rake/invocation_chain.rb:16:in `append': Circular dependency detected:
12
+ <li><p><a class="md2man-reference" href="../man1/md2man-roff.1.html">md2man-roff(1)</a>: fix ordered list numbering for nested list items.</p><p>Thanks to thinca for contributing this patch in pull request #27:
13
+ <a href="https://github.com/sunaku/md2man/pull/27">https://github.com/sunaku/md2man/pull/27</a></p></li>
14
+ </ul>
15
+ <h3 id="other">Other:<a name="other" href="#other" class="md2man-permalink" title="permalink"></a></h3>
16
+ <ul>
17
+ <li><p>Upgrade to Rouge 3.0 for syntax highlighting.</p></li>
18
+ <li><p>Upgrade to Rake 12.0 for build automation.</p></li>
19
+ </ul>
20
+ <h2 id="version-5-1-1-2016-03-04">Version 5.1.1 (2016-03-04)<a name="version-5-1-1-2016-03-04" href="#version-5-1-1-2016-03-04" class="md2man-permalink" title="permalink"></a></h2><h3 id="patch-1">Patch:<a name="patch-1" href="#patch-1" class="md2man-permalink" title="permalink"></a></h3>
21
+ <ul>
22
+ <li><p><a class="md2man-reference" href="../man1/md2man-rake.1.html">md2man-rake(1)</a>: &quot;man&quot; was both a folder name and a task name.</p><div class="highlight"><pre class="highlight plaintext"><code>rake/invocation_chain.rb:16:in `append': Circular dependency detected:
13
23
  TOP =&gt; md2man:man =&gt; man/test_markdown =&gt; man =&gt; md2man:man (RuntimeError)
14
- </code></pre>
15
- <p>Thanks to David Dieulivol (@born4new) for reporting this issue:
24
+ </code></pre></div><p>Thanks to David Dieulivol (@born4new) for reporting this issue:
16
25
  <a href="https://github.com/sunaku/md2man/issues/22">https://github.com/sunaku/md2man/issues/22</a></p></li>
17
26
  </ul>
18
27
  <h2 id="version-5-1-0-2016-02-28">Version 5.1.0 (2016-02-28)<a name="version-5-1-0-2016-02-28" href="#version-5-1-0-2016-02-28" class="md2man-permalink" title="permalink"></a></h2><h3 id="minor">Minor:<a name="minor" href="#minor" class="md2man-permalink" title="permalink"></a></h3>
@@ -23,14 +32,14 @@ and &quot;man/index&quot;, so that users know what project those manuals belong
23
32
  <li><p><a class="md2man-reference" href="../man1/md2man-rake.1.html">md2man-rake(1)</a>: allow running task names without namespace.</p><p>You can now run <code>md2man-rake man</code> instead of <code>md2man-rake md2man:man</code>,
24
33
  and similarly <code>md2man-rake web</code> instead of <code>md2man-rake md2man:web</code>.</p></li>
25
34
  </ul>
26
- <h3 id="patch-1">Patch:<a name="patch-1" href="#patch-1" class="md2man-permalink" title="permalink"></a></h3>
35
+ <h3 id="patch-2">Patch:<a name="patch-2" href="#patch-2" class="md2man-permalink" title="permalink"></a></h3>
27
36
  <ul>
28
37
  <li><p>Clarify optionalness of PATTERN in <code>--help</code> option.</p></li>
29
38
  <li><p><a class="md2man-reference" href="../man5/md2man.5.html">md2man(5)</a>: paragraph types reflect .PP, .TP, .IP.</p></li>
30
39
  <li><p>Link to Markdown website instead of <a class="md2man-reference">markdown(7)</a>.</p></li>
31
40
  </ul>
32
41
  <h2 id="version-5-0-3-2016-02-21">Version 5.0.3 (2016-02-21)<a name="version-5-0-3-2016-02-21" href="#version-5-0-3-2016-02-21" class="md2man-permalink" title="permalink"></a></h2><p>This release fixes a crash, fixes roff bugs, improves CSS styling for HTML
33
- output, and adds a complete manual page example in <a class="md2man-reference" href="../man5/md2man.5.html">md2man(5)</a> documentation.</p><h3 id="patch-2">Patch:<a name="patch-2" href="#patch-2" class="md2man-permalink" title="permalink"></a></h3>
42
+ output, and adds a complete manual page example in <a class="md2man-reference" href="../man5/md2man.5.html">md2man(5)</a> documentation.</p><h3 id="patch-3">Patch:<a name="patch-3" href="#patch-3" class="md2man-permalink" title="permalink"></a></h3>
34
43
  <ul>
35
44
  <li><p>Fix crash upon encountering a sole space <code> </code> or tab <code> </code> in a codespan.</p></li>
36
45
  <li><p><a class="md2man-reference" href="../man1/md2man-rake.1.html">md2man-rake(1)</a>: fix sorting of manual pages in <code>man/index.html</code> listing.
@@ -45,7 +54,7 @@ Previously, such extraneous components were omitted from the output.</p></li>
45
54
  <li><p><a class="md2man-reference" href="../man1/md2man-roff.1.html">md2man-roff(1)</a>: newline before links broke tagged paragraphs.</p></li>
46
55
  <li><p><a class="md2man-reference" href="../man1/md2man-roff.1.html">md2man-roff(1)</a>: don&#39;t squeeze newlines inside code blocks.</p></li>
47
56
  </ul>
48
- <h3 id="other">Other:<a name="other" href="#other" class="md2man-permalink" title="permalink"></a></h3>
57
+ <h3 id="other-1">Other:<a name="other-1" href="#other-1" class="md2man-permalink" title="permalink"></a></h3>
49
58
  <ul>
50
59
  <li><p><a class="md2man-reference" href="../man5/md2man.5.html">md2man(5)</a>: revise paragraph definitions and add complete manpage example.</p></li>
51
60
  <li><p>Document optional regexp argument to <code>-h</code> and <code>--help</code> in all executables.</p></li>
@@ -63,11 +72,11 @@ Previously, such extraneous components were omitted from the output.</p></li>
63
72
  gaps at the beginning of each heading in text-mode browsers like <a class="md2man-reference">w3m(1)</a>.</p></li>
64
73
  <li><p>Upgrade to binman version 5.x.x, which is also a major version bump.</p></li>
65
74
  </ul>
66
- <h3 id="other-1">Other:<a name="other-1" href="#other-1" class="md2man-permalink" title="permalink"></a></h3>
75
+ <h3 id="other-2">Other:<a name="other-2" href="#other-2" class="md2man-permalink" title="permalink"></a></h3>
67
76
  <ul>
68
77
  <li>README: use fenced code blocks to get syntax highlighting on GitHub.</li>
69
78
  </ul>
70
- <h2 id="version-4-0-1-2016-02-10">Version 4.0.1 (2016-02-10)<a name="version-4-0-1-2016-02-10" href="#version-4-0-1-2016-02-10" class="md2man-permalink" title="permalink"></a></h2><h3 id="other-2">Other:<a name="other-2" href="#other-2" class="md2man-permalink" title="permalink"></a></h3>
79
+ <h2 id="version-4-0-1-2016-02-10">Version 4.0.1 (2016-02-10)<a name="version-4-0-1-2016-02-10" href="#version-4-0-1-2016-02-10" class="md2man-permalink" title="permalink"></a></h2><h3 id="other-3">Other:<a name="other-3" href="#other-3" class="md2man-permalink" title="permalink"></a></h3>
71
80
  <ul>
72
81
  <li><p>Make all permalinks appear in the same size.</p></li>
73
82
  <li><p>Change permalink symbols from hearts to stars.</p></li>
@@ -85,19 +94,18 @@ call <code>super()</code> therein to trigger these methods&#39; original impleme
85
94
  <li><code>Md2Man::Document#codespan(code)</code></li>
86
95
  </ul></li>
87
96
  </ul>
88
- <h2 id="version-3-0-2-2014-10-26">Version 3.0.2 (2014-10-26)<a name="version-3-0-2-2014-10-26" href="#version-3-0-2-2014-10-26" class="md2man-permalink" title="permalink"></a></h2><h3 id="patch-3">Patch:<a name="patch-3" href="#patch-3" class="md2man-permalink" title="permalink"></a></h3>
97
+ <h2 id="version-3-0-2-2014-10-26">Version 3.0.2 (2014-10-26)<a name="version-3-0-2-2014-10-26" href="#version-3-0-2-2014-10-26" class="md2man-permalink" title="permalink"></a></h2><h3 id="patch-4">Patch:<a name="patch-4" href="#patch-4" class="md2man-permalink" title="permalink"></a></h3>
89
98
  <ul>
90
99
  <li>Update bootstrap 2.3.2 CDN URL; previous one died.</li>
91
100
  </ul>
92
- <h2 id="version-3-0-1-2014-07-16">Version 3.0.1 (2014-07-16)<a name="version-3-0-1-2014-07-16" href="#version-3-0-1-2014-07-16" class="md2man-permalink" title="permalink"></a></h2><p>This release restores Mac OS X support and fixes a permalink generation bug.</p><h3 id="patch-4">Patch:<a name="patch-4" href="#patch-4" class="md2man-permalink" title="permalink"></a></h3>
101
+ <h2 id="version-3-0-1-2014-07-16">Version 3.0.1 (2014-07-16)<a name="version-3-0-1-2014-07-16" href="#version-3-0-1-2014-07-16" class="md2man-permalink" title="permalink"></a></h2><p>This release restores Mac OS X support and fixes a permalink generation bug.</p><h3 id="patch-5">Patch:<a name="patch-5" href="#patch-5" class="md2man-permalink" title="permalink"></a></h3>
93
102
  <ul>
94
103
  <li><p>GH-13: <a class="md2man-reference">man(1)</a> on Mac OS X could not display URLs.</p><p>The version of groff on Mac OS X is too old: it lacks the an-ext.tmac
95
- macro package that defines styles for email addresses and general URLs.</p><pre class="highlight plaintext"><code>$ groff --version
104
+ macro package that defines styles for email addresses and general URLs.</p><div class="highlight"><pre class="highlight plaintext"><code>$ groff --version
96
105
  ...
97
106
  GNU grops (groff) version 1.19.2
98
107
  GNU troff (groff) version 1.19.2
99
- </code></pre>
100
- <p>This patch drops those URL macros in favor of simpler angled brackets.</p><p>Thanks to Sorin Ionescu for reporting this issue in GH-13:
108
+ </code></pre></div><p>This patch drops those URL macros in favor of simpler angled brackets.</p><p>Thanks to Sorin Ionescu for reporting this issue in GH-13:
101
109
  <a href="https://github.com/sunaku/md2man/issues/13">https://github.com/sunaku/md2man/issues/13</a></p></li>
102
110
  <li><p><a class="md2man-reference" href="../man1/md2man-html.1.html">md2man-html(1)</a>: cross references were escaped in heading permalink IDs.</p></li>
103
111
  </ul>
@@ -111,13 +119,13 @@ have for jumping to specific locations in your HTML manuals after upgrading.</p>
111
119
  <li><p>Make permalink anchors unique by appending a count in <a class="md2man-reference" href="../man1/md2man-html.1.html">md2man-html(1)</a>.</p></li>
112
120
  <li><p>Rename <code>md2man-xref</code> CSS class to <code>md2man-reference</code> in <a class="md2man-reference" href="../man1/md2man-html.1.html">md2man-html(1)</a>.</p></li>
113
121
  </ul>
114
- <h2 id="version-2-1-1-2014-06-21">Version 2.1.1 (2014-06-21)<a name="version-2-1-1-2014-06-21" href="#version-2-1-1-2014-06-21" class="md2man-permalink" title="permalink"></a></h2><h3 id="patch-5">Patch:<a name="patch-5" href="#patch-5" class="md2man-permalink" title="permalink"></a></h3>
122
+ <h2 id="version-2-1-1-2014-06-21">Version 2.1.1 (2014-06-21)<a name="version-2-1-1-2014-06-21" href="#version-2-1-1-2014-06-21" class="md2man-permalink" title="permalink"></a></h2><h3 id="patch-6">Patch:<a name="patch-6" href="#patch-6" class="md2man-permalink" title="permalink"></a></h3>
115
123
  <ul>
116
124
  <li><p>Bootstrap CSS failed to load for HTML manuals served under HTTPS.
117
125
  See <a href="https://github.com/sunaku/readably/pull/3">https://github.com/sunaku/readably/pull/3</a> for the details.</p></li>
118
126
  <li><p>Drop redundant nil check in <code>Md2Man::Roff::Engine.escape()</code>.</p></li>
119
127
  </ul>
120
- <h3 id="other-3">Other:<a name="other-3" href="#other-3" class="md2man-permalink" title="permalink"></a></h3>
128
+ <h3 id="other-4">Other:<a name="other-4" href="#other-4" class="md2man-permalink" title="permalink"></a></h3>
121
129
  <ul>
122
130
  <li><p>GitHub now supports relative links from the README.</p></li>
123
131
  <li><p>README: add links to package, manuals, and GitHub.</p></li>
@@ -128,19 +136,18 @@ See <a href="https://github.com/sunaku/readably/pull/3">https://github.com/sunak
128
136
  makes it easy for readers to bookmark and share direct links to specific
129
137
  sections of your HTML manual pages.</p></li>
130
138
  <li><p><a class="md2man-reference" href="../man1/md2man-html.1.html">md2man-html(1)</a> now wraps individual components of the special <code>.TH</code>
131
- top-level heading in HTML <code>&lt;span&gt;</code> elements with stylable CSS classes:</p><pre class="highlight plaintext"><code>&lt;span class="md2man-title"&gt;...&lt;/span&gt;
139
+ top-level heading in HTML <code>&lt;span&gt;</code> elements with stylable CSS classes:</p><div class="highlight"><pre class="highlight plaintext"><code>&lt;span class="md2man-title"&gt;...&lt;/span&gt;
132
140
  &lt;span class="md2man-section"&gt;...&lt;/span&gt;
133
141
  &lt;span class="md2man-date"&gt;...&lt;/span&gt;
134
142
  &lt;span class="md2man-source"&gt;...&lt;/span&gt;
135
143
  &lt;span class="md2man-manual"&gt;...&lt;/span&gt;
136
- </code></pre>
137
- <p>Thanks to Nick Fagerlund for requesting this feature in <a href="https://github.com/sunaku/md2man/issues/15">GH-15</a>.</p></li>
144
+ </code></pre></div><p>Thanks to Nick Fagerlund for requesting this feature in <a href="https://github.com/sunaku/md2man/issues/15">GH-15</a>.</p></li>
138
145
  </ul>
139
- <h3 id="other-4">Other:<a name="other-4" href="#other-4" class="md2man-permalink" title="permalink"></a></h3>
146
+ <h3 id="other-5">Other:<a name="other-5" href="#other-5" class="md2man-permalink" title="permalink"></a></h3>
140
147
  <ul>
141
148
  <li><p><a class="md2man-reference" href="../man5/md2man.5.html">md2man(5)</a> now documents the special <code>.TH</code> format of top-level headings.</p><p>Thanks to Nick Fagerlund for requesting this documentation in <a href="https://github.com/sunaku/md2man/issues/15">GH-15</a>.</p></li>
142
149
  </ul>
143
- <h2 id="version-2-0-4-2014-04-26">Version 2.0.4 (2014-04-26)<a name="version-2-0-4-2014-04-26" href="#version-2-0-4-2014-04-26" class="md2man-permalink" title="permalink"></a></h2><h3 id="patch-6">Patch:<a name="patch-6" href="#patch-6" class="md2man-permalink" title="permalink"></a></h3>
150
+ <h2 id="version-2-0-4-2014-04-26">Version 2.0.4 (2014-04-26)<a name="version-2-0-4-2014-04-26" href="#version-2-0-4-2014-04-26" class="md2man-permalink" title="permalink"></a></h2><h3 id="patch-7">Patch:<a name="patch-7" href="#patch-7" class="md2man-permalink" title="permalink"></a></h3>
144
151
  <ul>
145
152
  <li><p>GH-16: Redcarpet 3.1 added a third parameter to its <code>header()</code> method.
146
153
  This raised an ArgumentError on &quot;wrong number of arguments (3 for 2)&quot;.</p><p>Thanks to zimbatm for contributing this patch.</p></li>
@@ -148,7 +155,7 @@ This raised an ArgumentError on &quot;wrong number of arguments (3 for 2)&quot;.
148
155
  This fixes a bug where lines beginning with periods or single quotes
149
156
  did not appear when <a class="md2man-reference" href="../man1/md2man-roff.1.html">md2man-roff(1)</a> output was rendered using <a class="md2man-reference">man(1)</a>.</p><p>Thanks to zimbatm for reporting this bug and suggesting how to fix it.</p></li>
150
157
  </ul>
151
- <h2 id="version-2-0-3-2014-01-16">Version 2.0.3 (2014-01-16)<a name="version-2-0-3-2014-01-16" href="#version-2-0-3-2014-01-16" class="md2man-permalink" title="permalink"></a></h2><h3 id="patch-7">Patch:<a name="patch-7" href="#patch-7" class="md2man-permalink" title="permalink"></a></h3>
158
+ <h2 id="version-2-0-3-2014-01-16">Version 2.0.3 (2014-01-16)<a name="version-2-0-3-2014-01-16" href="#version-2-0-3-2014-01-16" class="md2man-permalink" title="permalink"></a></h2><h3 id="patch-8">Patch:<a name="patch-8" href="#patch-8" class="md2man-permalink" title="permalink"></a></h3>
152
159
  <ul>
153
160
  <li><p>Use CSS3 <code>-ch</code> suffix for accurate 80-character width in HTML output.</p><p><a href="http://www.w3.org/TR/css3-values/#font-relative-lengths">http://www.w3.org/TR/css3-values/#font-relative-lengths</a></p></li>
154
161
  </ul>
@@ -1,4 +1,4 @@
1
- .TH MD2MAN\-HTML 1 2016\-03\-04 5.1.1
1
+ .TH MD2MAN\-HTML 1 2018\-02\-04 5.1.2
2
2
  .SH NAME
3
3
  .PP
4
4
  md2man\-html \- convert
@@ -2,26 +2,24 @@
2
2
  <html>
3
3
  <head>
4
4
  <meta charset="utf-8" />
5
- <meta name="generator" content="md2man 5.1.1 https://github.com/sunaku/md2man" />
5
+ <meta name="generator" content="md2man 5.1.2 https://github.com/sunaku/md2man" />
6
6
  <title>md2man-html(1) &mdash; convert md2man(5) flavored Markdown text 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-03-04-5-1-1"><span class="md2man-title">MD2MAN-HTML</span> <span class="md2man-section">1</span> <span class="md2man-date">2016-03-04</span> <span class="md2man-source">5.1.1</span><a name="md2man-html-1-2016-03-04-5-1-1" href="#md2man-html-1-2016-03-04-5-1-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 href="http://daringfireball.net/projects/markdown/syntax">Markdown</a> text 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 the <a class="md2man-reference" href="../man5/md2man.5.html">md2man(5)</a> flavored <a href="http://daringfireball.net/projects/markdown/syntax">Markdown</a> text 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-2018-02-04-5-1-2"><span class="md2man-title">MD2MAN-HTML</span> <span class="md2man-section">1</span> <span class="md2man-date">2018-02-04</span> <span class="md2man-source">5.1.2</span><a name="md2man-html-1-2018-02-04-5-1-2" href="#md2man-html-1-2018-02-04-5-1-2" 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 href="http://daringfireball.net/projects/markdown/syntax">Markdown</a> text 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 the <a class="md2man-reference" href="../man5/md2man.5.html">md2man(5)</a> flavored <a href="http://daringfireball.net/projects/markdown/syntax">Markdown</a> text 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
- 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 class="highlight html"><code><span class="nt">&lt;span</span> <span class="na">class=</span><span class="s">"md2man-title"</span><span class="nt">&gt;</span>...<span class="nt">&lt;/span&gt;</span>
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><div class="highlight"><pre class="highlight html"><code><span class="nt">&lt;span</span> <span class="na">class=</span><span class="s">"md2man-title"</span><span class="nt">&gt;</span>...<span class="nt">&lt;/span&gt;</span>
14
14
  <span class="nt">&lt;span</span> <span class="na">class=</span><span class="s">"md2man-section"</span><span class="nt">&gt;</span>...<span class="nt">&lt;/span&gt;</span>
15
15
  <span class="nt">&lt;span</span> <span class="na">class=</span><span class="s">"md2man-date"</span><span class="nt">&gt;</span>...<span class="nt">&lt;/span&gt;</span>
16
16
  <span class="nt">&lt;span</span> <span class="na">class=</span><span class="s">"md2man-source"</span><span class="nt">&gt;</span>...<span class="nt">&lt;/span&gt;</span>
17
17
  <span class="nt">&lt;span</span> <span class="na">class=</span><span class="s">"md2man-manual"</span><span class="nt">&gt;</span>...<span class="nt">&lt;/span&gt;</span>
18
- </code></pre>
19
- <h3 id="heading-permalinks">Heading permalinks<a name="heading-permalinks" href="#heading-permalinks" class="md2man-permalink" title="permalink"></a></h3><p>Self-referencing hyperlinks (for permanent linking) are added to headings by
18
+ </code></pre></div><h3 id="heading-permalinks">Heading permalinks<a name="heading-permalinks" href="#heading-permalinks" class="md2man-permalink" title="permalink"></a></h3><p>Self-referencing hyperlinks (for permanent linking) are added to headings by
20
19
  converting their labels into URI fragments that are unique (using a counter),
21
- lowercase, and squeezed and stripped of HTML tags and non-word characters.</p><p>For example, a heading labeled <code>Ver&lt;s&gt;iON 3(2&lt;/s&gt;!4)))</code> would be emitted as:</p><pre class="highlight html"><code><span class="nt">&lt;h2</span> <span class="na">id=</span><span class="s">"ver-ion-3-2-4"</span><span class="nt">&gt;</span>Ver<span class="nt">&lt;s&gt;</span>iON 3(2<span class="nt">&lt;/s&gt;</span>!4)))<span class="nt">&lt;a</span> <span class="na">name=</span><span class="s">"ver-ion-3-2-4"</span>
20
+ lowercase, and squeezed and stripped of HTML tags and non-word characters.</p><p>For example, a heading labeled <code>Ver&lt;s&gt;iON 3(2&lt;/s&gt;!4)))</code> would be emitted as:</p><div class="highlight"><pre class="highlight html"><code><span class="nt">&lt;h2</span> <span class="na">id=</span><span class="s">"ver-ion-3-2-4"</span><span class="nt">&gt;</span>Ver<span class="nt">&lt;s&gt;</span>iON 3(2<span class="nt">&lt;/s&gt;</span>!4)))<span class="nt">&lt;a</span> <span class="na">name=</span><span class="s">"ver-ion-3-2-4"</span>
22
21
  <span class="na">href=</span><span class="s">"#ver-ion-3-2-4"</span> <span class="na">class=</span><span class="s">"md2man-permalink"</span> <span class="na">title=</span><span class="s">"permalink"</span><span class="nt">&gt;&lt;/a&gt;&lt;/h2&gt;</span>
23
- </code></pre>
24
- <p>For example, multiple headings labeled <code>Hello, world!</code> would be emitted as:</p><pre class="highlight html"><code><span class="nt">&lt;h2</span> <span class="na">id=</span><span class="s">"hello-world"</span><span class="nt">&gt;</span>Hello, world!<span class="nt">&lt;a</span> <span class="na">name=</span><span class="s">"hello-world"</span>
22
+ </code></pre></div><p>For example, multiple headings labeled <code>Hello, world!</code> would be emitted as:</p><div class="highlight"><pre class="highlight html"><code><span class="nt">&lt;h2</span> <span class="na">id=</span><span class="s">"hello-world"</span><span class="nt">&gt;</span>Hello, world!<span class="nt">&lt;a</span> <span class="na">name=</span><span class="s">"hello-world"</span>
25
23
  <span class="na">href=</span><span class="s">"#hello-world"</span> <span class="na">class=</span><span class="s">"md2man-permalink"</span> <span class="na">title=</span><span class="s">"permalink"</span><span class="nt">&gt;&lt;/a&gt;&lt;/h2&gt;</span>
26
24
 
27
25
  <span class="nt">&lt;h2</span> <span class="na">id=</span><span class="s">"hello-world-1"</span><span class="nt">&gt;</span>Hello, world!<span class="nt">&lt;a</span> <span class="na">name=</span><span class="s">"hello-world-1"</span>
@@ -29,10 +27,8 @@ lowercase, and squeezed and stripped of HTML tags and non-word characters.</p><p
29
27
 
30
28
  <span class="nt">&lt;h2</span> <span class="na">id=</span><span class="s">"hello-world-2"</span><span class="nt">&gt;</span>Hello, world!<span class="nt">&lt;a</span> <span class="na">name=</span><span class="s">"hello-world-2"</span>
31
29
  <span class="na">href=</span><span class="s">"#hello-world-2"</span> <span class="na">class=</span><span class="s">"md2man-permalink"</span> <span class="na">title=</span><span class="s">"permalink"</span><span class="nt">&gt;&lt;/a&gt;&lt;/h2&gt;</span>
32
- </code></pre>
33
- <h3 id="cross-references">Cross references<a name="cross-references" href="#cross-references" class="md2man-permalink" title="permalink"></a></h3><p>Cross references to manual pages are emitted as HTML hyperlinks that have
30
+ </code></pre></div><h3 id="cross-references">Cross references<a name="cross-references" href="#cross-references" class="md2man-permalink" title="permalink"></a></h3><p>Cross references to manual pages are emitted as HTML hyperlinks that have
34
31
  <code>class=&quot;md2man-reference&quot;</code> and <code>href=&quot;../man$SECTION/$PAGE.$SECTION.html&quot;</code>
35
- attributes.</p><p>For example, the <code>printf(3)</code> cross reference would be emitted as this HTML:</p><pre class="highlight html"><code><span class="nt">&lt;a</span> <span class="na">class=</span><span class="s">"md2man-reference"</span> <span class="na">href=</span><span class="s">"../man3/printf.3.html"</span><span class="nt">&gt;</span>printf(3)<span class="nt">&lt;/a&gt;</span>
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> [<em>PATTERN</em>], <code>--help</code> [<em>PATTERN</em>]</dt><dd>Show this help manual and optionally search for <em>PATTERN</em> regular expression.</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>, <a href="http://daringfireball.net/projects/markdown/syntax">Markdown</a></p></div></body>
32
+ attributes.</p><p>For example, the <code>printf(3)</code> cross reference would be emitted as this HTML:</p><div class="highlight"><pre class="highlight html"><code><span class="nt">&lt;a</span> <span class="na">class=</span><span class="s">"md2man-reference"</span> <span class="na">href=</span><span class="s">"../man3/printf.3.html"</span><span class="nt">&gt;</span>printf(3)<span class="nt">&lt;/a&gt;</span>
33
+ </code></pre></div><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 optionally search for <em>PATTERN</em> regular expression.</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>, <a href="http://daringfireball.net/projects/markdown/syntax">Markdown</a></p></div></body>
38
34
  </html>
@@ -1,4 +1,4 @@
1
- .TH MD2MAN\-RAKE 1 2016\-03\-04 5.1.1
1
+ .TH MD2MAN\-RAKE 1 2018\-02\-04 5.1.2
2
2
  .SH NAME
3
3
  .PP
4
4
  md2man\-rake \- run
@@ -2,15 +2,14 @@
2
2
  <html>
3
3
  <head>
4
4
  <meta charset="utf-8" />
5
- <meta name="generator" content="md2man 5.1.1 https://github.com/sunaku/md2man" />
5
+ <meta name="generator" content="md2man 5.1.2 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-03-04-5-1-1"><span class="md2man-title">MD2MAN-RAKE</span> <span class="md2man-section">1</span> <span class="md2man-date">2016-03-04</span> <span class="md2man-source">5.1.1</span><a name="md2man-rake-1-2016-03-04-5-1-1" href="#md2man-rake-1-2016-03-04-5-1-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
11
- to create a special file named <code>Rakefile</code> that contains the following snippet:</p><pre class="highlight plaintext"><code>require 'md2man/rakefile'
12
- </code></pre>
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> or <code>man</code></dt><dd>Builds UNIX manual pages from <code>*.markdown</code>, <code>*.mkd</code>, and <code>*.md</code> files
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-2018-02-04-5-1-2"><span class="md2man-title">MD2MAN-RAKE</span> <span class="md2man-section">1</span> <span class="md2man-date">2018-02-04</span> <span class="md2man-source">5.1.2</span><a name="md2man-rake-1-2018-02-04-5-1-2" href="#md2man-rake-1-2018-02-04-5-1-2" 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
+ to create a special file named <code>Rakefile</code> that contains the following snippet:</p><div class="highlight"><pre class="highlight plaintext"><code>require 'md2man/rakefile'
12
+ </code></pre></div><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> or <code>man</code></dt><dd>Builds UNIX manual pages from <code>*.markdown</code>, <code>*.mkd</code>, and <code>*.md</code> files
14
13
  found in or beneath the <code>man/</code> subdirectory in your working directory.</dd></dl><dl><dt><code>md2man:web</code> or <code>web</code></dt><dd>Builds HTML manual pages from <code>*.markdown</code>, <code>*.mkd</code>, and <code>*.md</code> files
15
14
  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 optionally search for <em>PATTERN</em> regular expression.</dd></dl><dl><dt>...</dt><dd>Anything else is passed to <a class="md2man-reference">rake(1)</a>; run <code>rake --help</code> for documentation.</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">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
15
  </html>
@@ -1,4 +1,4 @@
1
- .TH MD2MAN\-ROFF 1 2016\-03\-04 5.1.1
1
+ .TH MD2MAN\-ROFF 1 2018\-02\-04 5.1.2
2
2
  .SH NAME
3
3
  .PP
4
4
  md2man\-roff \- convert
@@ -2,12 +2,12 @@
2
2
  <html>
3
3
  <head>
4
4
  <meta charset="utf-8" />
5
- <meta name="generator" content="md2man 5.1.1 https://github.com/sunaku/md2man" />
5
+ <meta name="generator" content="md2man 5.1.2 https://github.com/sunaku/md2man" />
6
6
  <title>md2man-roff(1) &mdash; convert md2man(5) flavored Markdown text 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-03-04-5-1-1"><span class="md2man-title">MD2MAN-ROFF</span> <span class="md2man-section">1</span> <span class="md2man-date">2016-03-04</span> <span class="md2man-source">5.1.1</span><a name="md2man-roff-1-2016-03-04-5-1-1" href="#md2man-roff-1-2016-03-04-5-1-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 href="http://daringfireball.net/projects/markdown/syntax">Markdown</a> text 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 the <a class="md2man-reference" href="../man5/md2man.5.html">md2man(5)</a> flavored <a href="http://daringfireball.net/projects/markdown/syntax">Markdown</a> text 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-2018-02-04-5-1-2"><span class="md2man-title">MD2MAN-ROFF</span> <span class="md2man-section">1</span> <span class="md2man-date">2018-02-04</span> <span class="md2man-source">5.1.2</span><a name="md2man-roff-1-2018-02-04-5-1-2" href="#md2man-roff-1-2018-02-04-5-1-2" 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 href="http://daringfireball.net/projects/markdown/syntax">Markdown</a> text 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 the <a class="md2man-reference" href="../man5/md2man.5.html">md2man(5)</a> flavored <a href="http://daringfireball.net/projects/markdown/syntax">Markdown</a> text 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>
@@ -1,4 +1,4 @@
1
- .TH MD2MAN 5 2016\-03\-04 5.1.1
1
+ .TH MD2MAN 5 2018\-02\-04 5.1.2
2
2
  .SH NAME
3
3
  .PP
4
4
  md2man \- UNIX manual page flavoring for Markdown \[la]http://daringfireball.net/projects/markdown/syntax\[ra]
@@ -2,15 +2,15 @@
2
2
  <html>
3
3
  <head>
4
4
  <meta charset="utf-8" />
5
- <meta name="generator" content="md2man 5.1.1 https://github.com/sunaku/md2man" />
5
+ <meta name="generator" content="md2man 5.1.2 https://github.com/sunaku/md2man" />
6
6
  <title>md2man(5) &mdash; UNIX manual page flavoring for Markdown</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-03-04-5-1-1"><span class="md2man-title">MD2MAN</span> <span class="md2man-section">5</span> <span class="md2man-date">2016-03-04</span> <span class="md2man-source">5.1.1</span><a name="md2man-5-2016-03-04-5-1-1" href="#md2man-5-2016-03-04-5-1-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 - UNIX manual page flavoring for <a href="http://daringfireball.net/projects/markdown/syntax">Markdown</a></p><h2 id="description">DESCRIPTION<a name="description" href="#description" class="md2man-permalink" title="permalink"></a></h2><p>md2man makes the <a href="http://daringfireball.net/projects/markdown/syntax">Markdown</a> format more friendly for writing UNIX manual
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-2018-02-04-5-1-2"><span class="md2man-title">MD2MAN</span> <span class="md2man-section">5</span> <span class="md2man-date">2018-02-04</span> <span class="md2man-source">5.1.2</span><a name="md2man-5-2018-02-04-5-1-2" href="#md2man-5-2018-02-04-5-1-2" 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 <a href="http://daringfireball.net/projects/markdown/syntax">Markdown</a></p><h2 id="description">DESCRIPTION<a name="description" href="#description" class="md2man-permalink" title="permalink"></a></h2><p>md2man makes the <a href="http://daringfireball.net/projects/markdown/syntax">Markdown</a> format more friendly for writing UNIX manual
11
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 href="http://daringfireball.net/projects/markdown/syntax">Markdown</a> syntax by recognizing three kinds of paragraphs,
12
12
  analogous to the underlying <code>.PP</code>, <code>.TP</code>, and <code>.IP</code> directives in <a class="md2man-reference">roff(7)</a>.</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
13
- space are considered &quot;normal paragraphs&quot;, analogous to <code>.PP</code> in <a class="md2man-reference">roff(7)</a>:</p><pre class="highlight plaintext"><code>This is a normal paragraph.
13
+ space are considered &quot;normal paragraphs&quot;, analogous to <code>.PP</code> in <a class="md2man-reference">roff(7)</a>:</p><div class="highlight"><pre class="highlight plaintext"><code>This is a normal paragraph.
14
14
 
15
15
  This is also
16
16
  a normal
@@ -23,24 +23,20 @@ this
23
23
  normal
24
24
  paragraph
25
25
  too.
26
- </code></pre>
27
- <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
26
+ </code></pre></div><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
28
27
  whose subsequent lines are all uniformly indented by exactly two additional
29
- spaces are considered &quot;tagged paragraphs&quot;, analogous to <code>.TP</code> in <a class="md2man-reference">roff(7)</a>:</p><pre class="highlight plaintext"><code>This is a
28
+ spaces are considered &quot;tagged paragraphs&quot;, analogous to <code>.TP</code> in <a class="md2man-reference">roff(7)</a>:</p><div class="highlight"><pre class="highlight plaintext"><code>This is a
30
29
  tagged
31
30
  paragraph.
32
- </code></pre>
33
- <h4 id="indented-paragraphs">Indented paragraphs<a name="indented-paragraphs" href="#indented-paragraphs" class="md2man-permalink" title="permalink"></a></h4><p>Paragraphs whose lines are all uniformly indented by exactly two additional
34
- spaces are considered &quot;indented paragraphs&quot;, analogous to <code>.IP</code> in <a class="md2man-reference">roff(7)</a>:</p><pre class="highlight plaintext"><code> This is an
31
+ </code></pre></div><h4 id="indented-paragraphs">Indented paragraphs<a name="indented-paragraphs" href="#indented-paragraphs" class="md2man-permalink" title="permalink"></a></h4><p>Paragraphs whose lines are all uniformly indented by exactly two additional
32
+ spaces are considered &quot;indented paragraphs&quot;, analogous to <code>.IP</code> in <a class="md2man-reference">roff(7)</a>:</p><div class="highlight"><pre class="highlight plaintext"><code> This is an
35
33
  indented
36
34
  paragraph.
37
- </code></pre>
38
- <h3 id="semantics">Semantics<a name="semantics" href="#semantics" class="md2man-permalink" title="permalink"></a></h3><p>md2man extends <a href="http://daringfireball.net/projects/markdown/syntax">Markdown</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
35
+ </code></pre></div><h3 id="semantics">Semantics<a name="semantics" href="#semantics" class="md2man-permalink" title="permalink"></a></h3><p>md2man extends <a href="http://daringfireball.net/projects/markdown/syntax">Markdown</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
39
36
  <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>
40
37
  <blockquote>
41
- <pre class="highlight plaintext"><code>.TH title section date source manual
42
- </code></pre>
43
- <dl><dt>title</dt><dd>The title of the man page, written in all caps (e.g., <code>MAN-PAGES</code>).</dd></dl><dl><dt>section</dt><dd>The section number in which the man page should be placed (e.g., <code>7</code>).</dd></dl><dl><dt>date</dt><dd>The date of the last revision, written in the form YYYY-MM-DD.</dd></dl><dl><dt>source</dt><dd>The source of the command, function, or system call (e.g., <code>Linux</code>).</dd></dl><dl><dt>manual</dt><dd>The title of the manual (e.g., <code>Linux Programmer&#39;s Manual</code>).</dd></dl></blockquote>
38
+ <div class="highlight"><pre class="highlight plaintext"><code>.TH title section date source manual
39
+ </code></pre></div><dl><dt>title</dt><dd>The title of the man page, written in all caps (e.g., <code>MAN-PAGES</code>).</dd></dl><dl><dt>section</dt><dd>The section number in which the man page should be placed (e.g., <code>7</code>).</dd></dl><dl><dt>date</dt><dd>The date of the last revision, written in the form YYYY-MM-DD.</dd></dl><dl><dt>source</dt><dd>The source of the command, function, or system call (e.g., <code>Linux</code>).</dd></dl><dl><dt>manual</dt><dd>The title of the manual (e.g., <code>Linux Programmer&#39;s Manual</code>).</dd></dl></blockquote>
44
40
  <p>Any subsequent top-level headings are treated as second-level <code>&lt;h2&gt;</code> headings.</p><h3 id="extensions">Extensions<a name="extensions" href="#extensions" class="md2man-permalink" title="permalink"></a></h3><p>md2man enables the following [Redcarpet] extensions while reading <a href="http://daringfireball.net/projects/markdown/syntax">Markdown</a>:</p>
45
41
  <ul>
46
42
  <li>tables</li>
@@ -52,7 +48,7 @@ spaces are considered &quot;indented paragraphs&quot;, analogous to <code>.IP</c
52
48
  <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
53
49
  the <a href="http://www.schweikhardt.net/man_page_howto.html">Linux Man Page Howto</a>
54
50
  guide by Jens Schweikhardt. <a href="../man0/EXAMPLE.html">The result of processing</a>
55
- 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 class="highlight markdown"><code><span class="gu">FOO 1 "MARCH 1995" Linux "User Manuals"
51
+ 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><div class="highlight"><pre class="highlight markdown"><code><span class="gu">FOO 1 "MARCH 1995" Linux "User Manuals"
56
52
  =======================================
57
53
  </span>
58
54
  <span class="gh">NAME
@@ -63,7 +59,7 @@ foo - frobnicate the bar library
63
59
  <span class="gh">SYNOPSIS
64
60
  --------
65
61
  </span>
66
- <span class="sb">`foo` [`-bar`] [`-c`</span> <span class="ge">*config-file*</span>] <span class="ge">*file*</span> ...
62
+ <span class="sb">`foo`</span> <span class="p">[</span><span class="nv">`-bar`</span><span class="p">]</span> <span class="p">[</span><span class="ss">`-c` *config-file*</span><span class="p">]</span> <span class="ge">*file*</span> ...
67
63
 
68
64
  <span class="gh">DESCRIPTION
69
65
  -----------
@@ -135,6 +131,5 @@ Jens Schweikhardt <span class="nv">&lt;howto@schweikhardt.net&gt;</span>
135
131
  </span>
136
132
  bar(1), foo(5), xyzzy(1), <span class="p">[</span><span class="nv">Linux Man Page Howto</span><span class="p">](</span>
137
133
  <span class="sx">http://www.schweikhardt.net/man_page_howto.html</span><span class="p">)</span>
138
- </code></pre>
139
- <h2 id="see-also">SEE ALSO<a name="see-also" href="#see-also" class="md2man-permalink" title="permalink"></a></h2><p><a href="http://daringfireball.net/projects/markdown/syntax">Markdown</a>, <a class="md2man-reference">man-pages(7)</a>, <a class="md2man-reference">roff(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></p></div></body>
134
+ </code></pre></div><h2 id="see-also">SEE ALSO<a name="see-also" href="#see-also" class="md2man-permalink" title="permalink"></a></h2><p><a href="http://daringfireball.net/projects/markdown/syntax">Markdown</a>, <a class="md2man-reference">man-pages(7)</a>, <a class="md2man-reference">roff(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></p></div></body>
140
135
  </html>
@@ -1,4 +1,4 @@
1
- # MD2MAN 5 2016-03-04 5.1.1
1
+ # MD2MAN 5 2018-02-04 5.1.2
2
2
 
3
3
  ## NAME
4
4
 
@@ -23,7 +23,7 @@ Gem::Specification.new do |s|
23
23
  s.required_ruby_version = '>= 1.9.1'
24
24
  s.add_runtime_dependency 'binman', '~> 5.0'
25
25
  s.add_runtime_dependency 'redcarpet', '~> 3.0'
26
- s.add_runtime_dependency 'rouge', '~> 1.0'
26
+ s.add_runtime_dependency 'rouge', '~> 3.0'
27
27
  s.add_development_dependency 'minitest', '~> 5.0'
28
- s.add_development_dependency 'rake', '~> 10.1'
28
+ s.add_development_dependency 'rake', '~> 12.0'
29
29
  end
@@ -57,9 +57,8 @@ describe 'html engine' do
57
57
  |
58
58
  | <a class="md2man-reference" href="../man3/printf.3.html">printf(3)</a>
59
59
  INPUT
60
- |<p>For example, the <code>printf(3)</code> cross reference would be emitted as this HTML:</p><pre class="highlight plaintext"><code>&lt;a class="md2man-reference" href="../man3/printf.3.html"&gt;printf(3)&lt;/a&gt;
61
- |</code></pre>
62
- |
60
+ |<p>For example, the <code>printf(3)</code> cross reference would be emitted as this HTML:</p><div class="highlight"><pre class="highlight plaintext"><code>&lt;a class="md2man-reference" href="../man3/printf.3.html"&gt;printf(3)&lt;/a&gt;
61
+ |</code></pre></div>
63
62
  OUTPUT
64
63
  end
65
64
 
@@ -85,11 +84,10 @@ describe 'html engine' do
85
84
  | containing markdown(7),
86
85
  | roff(7), and much more!
87
86
  INPUT
88
- |<pre class="highlight plaintext"><code>this is a code block
87
+ |<div class="highlight"><pre class="highlight plaintext"><code>this is a code block
89
88
  |containing markdown(7),
90
89
  |roff(7), and much more!
91
- |</code></pre>
92
- |
90
+ |</code></pre></div>
93
91
  OUTPUT
94
92
  end
95
93
 
@@ -121,14 +119,13 @@ describe 'html engine' do
121
119
  | \\__/\\____/_/ /_/|_\\
122
120
  | >>>------>
123
121
  INPUT
124
- |<pre class="highlight plaintext"><code>_______ _______
122
+ |<div class="highlight"><pre class="highlight plaintext"><code>_______ _______
125
123
  | ___ /___________ /__
126
124
  | _ __/ __ \\ __/ /_/
127
125
  | / /_/ /_/ / / / ,\\
128
126
  | \\__/\\____/_/ /_/|_\\
129
127
  | &gt;&gt;&gt;------&gt;
130
- |</code></pre>
131
- |
128
+ |</code></pre></div>
132
129
  OUTPUT
133
130
  end
134
131
 
@@ -232,12 +229,11 @@ describe 'html engine' do
232
229
  |
233
230
  |### `PIPES_GET_LAST(CHAIN)`
234
231
  INPUT
235
- |<h3 id="macros">Macros<a name="macros" href="#macros" class="md2man-permalink" title="permalink"></a></h3><pre class="highlight plaintext"><code>#define PIPES_GET_LAST(CHAIN)
232
+ |<h3 id="macros">Macros<a name="macros" href="#macros" class="md2man-permalink" title="permalink"></a></h3><div class="highlight"><pre class="highlight plaintext"><code>#define PIPES_GET_LAST(CHAIN)
236
233
  |#define PIPES_GET_IN(CHAIN)
237
234
  |#define PIPES_GET_OUT(CHAIN)
238
235
  |#define PIPES_GET_ERR(CHAIN)
239
- |</code></pre>
240
- |<h3 id="pipes_get_last-chain"><code>PIPES_GET_LAST(CHAIN)</code><a name="pipes_get_last-chain" href="#pipes_get_last-chain" class="md2man-permalink" title="permalink"></a></h3>
236
+ |</code></pre></div><h3 id="pipes_get_last-chain"><code>PIPES_GET_LAST(CHAIN)</code><a name="pipes_get_last-chain" href="#pipes_get_last-chain" class="md2man-permalink" title="permalink"></a></h3>
241
237
  OUTPUT
242
238
  end
243
239
 
@@ -267,9 +263,8 @@ describe 'html engine' do
267
263
  | Array.new(123, "abc")
268
264
  |```
269
265
  INPUT
270
- |<pre class="highlight plaintext"><code> Array.new(123, "abc")
271
- |</code></pre>
272
- |
266
+ |<div class="highlight"><pre class="highlight plaintext"><code> Array.new(123, "abc")
267
+ |</code></pre></div>
273
268
  OUTPUT
274
269
  end
275
270
 
@@ -279,9 +274,8 @@ describe 'html engine' do
279
274
  | Array.new(123, "abc")
280
275
  |```
281
276
  INPUT
282
- |<pre class="highlight ruby"><code> <span class="no">Array</span><span class="p">.</span><span class="nf">new</span><span class="p">(</span><span class="mi">123</span><span class="p">,</span> <span class="s2">"abc"</span><span class="p">)</span>
283
- |</code></pre>
284
- |
277
+ |<div class="highlight"><pre class="highlight ruby"><code> <span class="no">Array</span><span class="p">.</span><span class="nf">new</span><span class="p">(</span><span class="mi">123</span><span class="p">,</span> <span class="s2">"abc"</span><span class="p">)</span>
278
+ |</code></pre></div>
285
279
  OUTPUT
286
280
  end
287
281
  end
@@ -739,17 +739,20 @@ describe 'roff engine' do
739
739
  @markdown.render(heredoc(<<-INPUT)).must_equal(heredoc(<<-OUTPUT))
740
740
  |Here is an ordered list:
741
741
  |
742
- |1. foo
742
+ |1. foo1
743
+ |2. foo2
743
744
  | 1. bar
744
745
  | 1. baz
745
- |2. qux
746
+ |3. qux
746
747
  INPUT
747
748
  |.PP
748
749
  |Here is an ordered list:
749
750
  |.nr step2 0 1
750
751
  |.RS
751
752
  |.IP \\n+[step2]
752
- |foo
753
+ |foo1
754
+ |.IP \\n+[step2]
755
+ |foo2
753
756
  |.nr step1 0 1
754
757
  |.RS
755
758
  |.IP \\n+[step1]
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: md2man
3
3
  version: !ruby/object:Gem::Version
4
- version: 5.1.1
4
+ version: 5.1.2
5
5
  platform: ruby
6
6
  authors:
7
7
  - Suraj N. Kurapati
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2016-03-05 00:00:00.000000000 Z
11
+ date: 2018-02-04 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: binman
@@ -44,14 +44,14 @@ dependencies:
44
44
  requirements:
45
45
  - - "~>"
46
46
  - !ruby/object:Gem::Version
47
- version: '1.0'
47
+ version: '3.0'
48
48
  type: :runtime
49
49
  prerelease: false
50
50
  version_requirements: !ruby/object:Gem::Requirement
51
51
  requirements:
52
52
  - - "~>"
53
53
  - !ruby/object:Gem::Version
54
- version: '1.0'
54
+ version: '3.0'
55
55
  - !ruby/object:Gem::Dependency
56
56
  name: minitest
57
57
  requirement: !ruby/object:Gem::Requirement
@@ -72,14 +72,14 @@ dependencies:
72
72
  requirements:
73
73
  - - "~>"
74
74
  - !ruby/object:Gem::Version
75
- version: '10.1'
75
+ version: '12.0'
76
76
  type: :development
77
77
  prerelease: false
78
78
  version_requirements: !ruby/object:Gem::Requirement
79
79
  requirements:
80
80
  - - "~>"
81
81
  - !ruby/object:Gem::Version
82
- version: '10.1'
82
+ version: '12.0'
83
83
  description: Converts markdown into UNIX manpages and HTML webpages.
84
84
  email:
85
85
  - https://github.com/sunaku
@@ -150,7 +150,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
150
150
  version: '0'
151
151
  requirements: []
152
152
  rubyforge_project:
153
- rubygems_version: 2.5.1
153
+ rubygems_version: 2.5.2.2
154
154
  signing_key:
155
155
  specification_version: 4
156
156
  summary: markdown to manpage