md2man 3.0.0 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ba2cb14fc6bc77e87921faf1be24560578383756
-  data.tar.gz: 61717778f8a1c0566b89e0a5d8cc773b67ad72c7
+  metadata.gz: 82b0ddc434ba47e852663dab842cdf93dc5b1773
+  data.tar.gz: 89f55d53772ed2f777ad8f8f52ecfc257c60da1f
 SHA512:
-  metadata.gz: 8dbcb51cc2c8c4db1bca6e71e38bfbd1cdd1c57cd2cae6c2cd68706b36381c39758ae2f6e5b272512c91853f1239fa992e956843304be0cf31db93dcb4ba52a2
-  data.tar.gz: 1654542cc6239ba4662a8ce8a83192860265e6d3f4e2af854bacd0e02404b6eef336b68691cd8ba5fd28bb405aa7e3540127fc0959af75faad5f2a71b3bab9d0
+  metadata.gz: 986377215f13ba199fc4bce1e6b146c8e6ebb3da72c412e96bfe925c89b0cd4a1a109506c86522ffed6f7c558502abda77e7004045289b6370ae328e66175318
+  data.tar.gz: d380cce3a30f90f2a5f5bab88b120a5e7324037d076fe9bfe4da73fe0741acac42adcb85719f2b80419e60d9393ed29da427312fcc6605b1861420992279d02a

data/README.markdown

@@ -3,10 +3,10 @@
 md2man is a Ruby library and a set of command-line programs that convert
 [Markdown] into UNIX manual pages (both [roff] and HTML) using [Redcarpet].
 
-* Package: <https://rubygems.org/gems/md2man>
-* Manuals: <https://sunaku.github.io/md2man>
+* Manuals: <https://sunaku.github.io/md2man/man>
 * Sources: <https://github.com/sunaku/md2man>
 * Support: <https://github.com/sunaku/md2man/issues>
+* Package: <https://rubygems.org/gems/md2man>
 
 ## Features
 
@@ -153,7 +153,7 @@ Add this snippet to your gemspec file:
 
     s.files += Dir['man/man?/*.?']            # UNIX man pages
     s.files += Dir['man/**/*.{html,css,js}']  # HTML man pages
-    s.add_development_dependency 'md2man', '~> 2.0'
+    s.add_development_dependency 'md2man', '~> 3.0'
 
 Add this line to your Rakefile:
 

data/VERSION.markdown

@@ -1,3 +1,26 @@
+## Version 3.0.1 (2014-07-16)
+
+This release restores Mac OS X support and fixes a permalink generation bug.
+
+### Patch:
+
+  * GH-13: man(1) on Mac OS X could not display URLs.
+
+    The version of groff on Mac OS X is too old: it lacks the an-ext.tmac
+    macro package that defines styles for email addresses and general URLs.
+
+        $ groff --version
+        ...
+        GNU grops (groff) version 1.19.2
+        GNU troff (groff) version 1.19.2
+
+    This patch drops those URL macros in favor of simpler angled brackets.
+
+    Thanks to Sorin Ionescu for reporting this issue in GH-13:
+    https://github.com/sunaku/md2man/issues/13
+
+  * md2man-html(1): cross references were escaped in heading permalink IDs.
+
 ## Version 3.0.0 (2014-06-22)
 
 This release changes md2man-html(1) heading permalinks to follow GitHub style:

data/bin/md2man-html

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 =begin =======================================================================
 
-# MD2MAN-HTML 1 2014-06-22 3.0.0
+# MD2MAN-HTML 1 2014-07-16 3.0.1
 
 ## NAME
 

data/bin/md2man-rake

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 =begin =======================================================================
 
-# MD2MAN-RAKE 1 2014-06-22 3.0.0
+# MD2MAN-RAKE 1 2014-07-16 3.0.1
 
 ## NAME
 

data/bin/md2man-roff

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 =begin =======================================================================
 
-# MD2MAN-ROFF 1 2014-06-22 3.0.0
+# MD2MAN-ROFF 1 2014-07-16 3.0.1
 
 ## NAME
 

data/lib/md2man/document.rb

@@ -74,8 +74,6 @@ protected
 private
 
   def encode_references text
-    # the [^\n\S] captures all non-newline whitespace
-    # basically, it's meant to be \s but excluding \n
     text.gsub(/(?<page>[\w\-\.]+)\((?<section>\w+)\)/) do
       match = $~
       key = encode(match)
@@ -86,7 +84,9 @@ private
 
   def decode_references text
     @references.delete_if do |key, match|
-      text.sub! /#{Regexp.escape key}(?<addendum>\S*[^\n\S]*)/ do
+      # the [^\S\n] captures all non-newline whitespace
+      # basically, it's meant to be \s but excluding \n
+      text.sub! /#{Regexp.escape key}(?<addendum>\S*[^\S\n]*)/ do
         reference match, $~
       end
     end

data/lib/md2man/html.rb

@@ -44,6 +44,9 @@ module Md2Man::HTML
       end.compact.join(' ')
     end
 
+    # decode here, since we will emit this heading below as raw HTML anyway
+    text = decode_references(text)
+
     # strip all HTML tags, squeeze all non-word characters, and lowercase it
     id = text.gsub(/<.+?>/, '-').gsub(/\W+/, '-').gsub(/^-|-$/, '').downcase
 

data/lib/md2man/roff.rb

@@ -177,11 +177,7 @@ module Md2Man::Roff
   end
 
   def autolink link, link_type
-    if link_type == :email
-      "\n.MT #{link.chomp}\n.ME "
-    else
-      "\n.UR #{link.chomp}\n.UE "
-    end
+    "\n\\[la]#{link.chomp}\\[ra]"
   end
 
   def image link, title, alt_text

data/lib/md2man/version.rb

@@ -1,3 +1,3 @@
 module Md2Man
-  VERSION = "3.0.0"
+  VERSION = "3.0.1"
 end

data/man/index.html

@@ -2,7 +2,7 @@
 <html>
 <head>
   <meta charset="utf-8" />
-  <meta name="generator" content="md2man 3.0.0 https://github.com/sunaku/md2man" />
+  <meta name="generator" content="md2man 3.0.1 https://github.com/sunaku/md2man" />
   <title>man/index</title>
   <link rel="stylesheet" href="style.css"/>
   <!--[if lt IE 9]><script src="http://html5shiv.googlecode.com/svn/trunk/html5.js"></script><![endif]-->

data/man/man0/README.html

@@ -2,7 +2,7 @@
 <html>
 <head>
   <meta charset="utf-8" />
-  <meta name="generator" content="md2man 3.0.0 https://github.com/sunaku/md2man" />
+  <meta name="generator" content="md2man 3.0.1 https://github.com/sunaku/md2man" />
   <title>README</title>
   <link rel="stylesheet" href="../style.css"/>
   <!--[if lt IE 9]><script src="http://html5shiv.googlecode.com/svn/trunk/html5.js"></script><![endif]-->
@@ -10,10 +10,10 @@
 <body><div class="navbar"><div class="navbar-inner"><span class="brand"><a href="../index.html#man0">man0</a>/README</span></div></div><div class="container-fluid"><h1 id="md2man-markdown-to-manpage"><a name="md2man-markdown-to-manpage" href="#md2man-markdown-to-manpage" class="md2man-permalink" title="permalink"></a><span class="md2man-title">md2man</span> <span class="md2man-section">-</span> <span class="md2man-date">markdown</span> <span class="md2man-source">to</span> <span class="md2man-manual">manpage</span></h1><p>md2man is a Ruby library and a set of command-line programs that convert
 <a href="http://daringfireball.net/projects/markdown/">Markdown</a> into UNIX manual pages (both <a href="http://troff.org">roff</a> and HTML) using <a href="https://github.com/vmg/redcarpet">Redcarpet</a>.</p>
 <ul>
-<li>Package: <a href="https://rubygems.org/gems/md2man">https://rubygems.org/gems/md2man</a></li>
-<li>Manuals: <a href="https://sunaku.github.io/md2man">https://sunaku.github.io/md2man</a></li>
+<li>Manuals: <a href="https://sunaku.github.io/md2man/man">https://sunaku.github.io/md2man/man</a></li>
 <li>Sources: <a href="https://github.com/sunaku/md2man">https://github.com/sunaku/md2man</a></li>
 <li>Support: <a href="https://github.com/sunaku/md2man/issues">https://github.com/sunaku/md2man/issues</a></li>
+<li>Package: <a href="https://rubygems.org/gems/md2man">https://rubygems.org/gems/md2man</a></li>
 </ul>
 <h2 id="features"><a name="features" href="#features" class="md2man-permalink" title="permalink"></a>Features</h2>
 <ul>
@@ -117,7 +117,7 @@ your_html_output = <a class="md2man-reference">engine.render(your_markdown_input
 <h4 id="inside-a-ruby-script-2"><a name="inside-a-ruby-script-2" href="#inside-a-ruby-script-2" class="md2man-permalink" title="permalink"></a>Inside a Ruby script</h4><p>Add this snippet to your gemspec file:</p>
 <pre><code>s.files += Dir[&#39;man/man?/*.?&#39;]            # UNIX man pages
 s.files += Dir[&#39;man/**/*.{html,css,js}&#39;]  # HTML man pages
-s.add_development_dependency &#39;md2man&#39;, &#39;~&gt; 2.0&#39;
+s.add_development_dependency &#39;md2man&#39;, &#39;~&gt; 3.0&#39;
 </code></pre>
 <p>Add this line to your Rakefile:</p>
 <pre><code>require &#39;md2man/rakefile&#39;

data/man/man0/README.markdown

@@ -3,10 +3,10 @@
 md2man is a Ruby library and a set of command-line programs that convert
 [Markdown] into UNIX manual pages (both [roff] and HTML) using [Redcarpet].
 
-* Package: <https://rubygems.org/gems/md2man>
-* Manuals: <https://sunaku.github.io/md2man>
+* Manuals: <https://sunaku.github.io/md2man/man>
 * Sources: <https://github.com/sunaku/md2man>
 * Support: <https://github.com/sunaku/md2man/issues>
+* Package: <https://rubygems.org/gems/md2man>
 
 ## Features
 
@@ -153,7 +153,7 @@ Add this snippet to your gemspec file:
 
     s.files += Dir['man/man?/*.?']            # UNIX man pages
     s.files += Dir['man/**/*.{html,css,js}']  # HTML man pages
-    s.add_development_dependency 'md2man', '~> 2.0'
+    s.add_development_dependency 'md2man', '~> 3.0'
 
 Add this line to your Rakefile:
 

data/man/man0/VERSION.html

@@ -2,12 +2,25 @@
 <html>
 <head>
   <meta charset="utf-8" />
-  <meta name="generator" content="md2man 3.0.0 https://github.com/sunaku/md2man" />
+  <meta name="generator" content="md2man 3.0.1 https://github.com/sunaku/md2man" />
   <title>VERSION</title>
   <link rel="stylesheet" href="../style.css"/>
   <!--[if lt IE 9]><script src="http://html5shiv.googlecode.com/svn/trunk/html5.js"></script><![endif]-->
 </head>
-<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-3-0-0-2014-06-22"><a name="version-3-0-0-2014-06-22" href="#version-3-0-0-2014-06-22" class="md2man-permalink" title="permalink"></a>Version 3.0.0 (2014-06-22)</h2><p>This release changes <a class="md2man-reference" href="../man1/md2man-html.1.html">md2man-html(1)</a> heading permalinks to follow GitHub style:
+<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-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>Version 3.0.1 (2014-07-16)</h2><p>This release restores Mac OS X support and fixes a permalink generation bug.</p><h3 id="patch"><a name="patch" href="#patch" class="md2man-permalink" title="permalink"></a>Patch:</h3>
+<ul>
+<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
+macro package that defines styles for email addresses and general URLs.</p>
+<pre><code>$ groff --version
+...
+GNU grops (groff) version 1.19.2
+GNU troff (groff) version 1.19.2
+</code></pre>
+<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:
+<a href="https://github.com/sunaku/md2man/issues/13">https://github.com/sunaku/md2man/issues/13</a></p></li>
+<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>
+</ul>
+<h2 id="version-3-0-0-2014-06-22"><a name="version-3-0-0-2014-06-22" href="#version-3-0-0-2014-06-22" class="md2man-permalink" title="permalink"></a>Version 3.0.0 (2014-06-22)</h2><p>This release changes <a class="md2man-reference" href="../man1/md2man-html.1.html">md2man-html(1)</a> heading permalinks to follow GitHub style:
 unique, lowercase, and squeezed and stripped of HTML tags and non-word chars.
 In addition, it renames the <code>md2man-xref</code> CSS class to <code>md2man-reference</code>.</p><p>Please make sure to update any existing bookmarks and/or hyperlinks you may
 have for jumping to specific locations in your HTML manuals after upgrading.</p><h3 id="major"><a name="major" href="#major" class="md2man-permalink" title="permalink"></a>Major:</h3>
@@ -17,7 +30,7 @@ have for jumping to specific locations in your HTML manuals after upgrading.</p>
 <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>
 <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>
 </ul>
-<h2 id="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>Version 2.1.1 (2014-06-21)</h2><h3 id="patch"><a name="patch" href="#patch" class="md2man-permalink" title="permalink"></a>Patch:</h3>
+<h2 id="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>Version 2.1.1 (2014-06-21)</h2><h3 id="patch-1"><a name="patch-1" href="#patch-1" class="md2man-permalink" title="permalink"></a>Patch:</h3>
 <ul>
 <li><p>Bootstrap CSS failed to load for HTML manuals served under HTTPS.
 See <a href="https://github.com/sunaku/readably/pull/3">https://github.com/sunaku/readably/pull/3</a> for the details.</p></li>
@@ -47,7 +60,7 @@ top-level heading in HTML <code>&lt;span&gt;</code> elements with stylable CSS c
 <ul>
 <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>
 </ul>
-<h2 id="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>Version 2.0.4 (2014-04-26)</h2><h3 id="patch-1"><a name="patch-1" href="#patch-1" class="md2man-permalink" title="permalink"></a>Patch:</h3>
+<h2 id="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>Version 2.0.4 (2014-04-26)</h2><h3 id="patch-2"><a name="patch-2" href="#patch-2" class="md2man-permalink" title="permalink"></a>Patch:</h3>
 <ul>
 <li><p>GH-16: Redcarpet 3.1 added a third parameter to its <code>header()</code> method.
 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>
@@ -55,7 +68,7 @@ This raised an ArgumentError on &quot;wrong number of arguments (3 for 2)&quot;.
 This fixes a bug where lines beginning with periods or single quotes
 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>
 </ul>
-<h2 id="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>Version 2.0.3 (2014-01-16)</h2><h3 id="patch-2"><a name="patch-2" href="#patch-2" class="md2man-permalink" title="permalink"></a>Patch:</h3>
+<h2 id="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>Version 2.0.3 (2014-01-16)</h2><h3 id="patch-3"><a name="patch-3" href="#patch-3" class="md2man-permalink" title="permalink"></a>Patch:</h3>
 <ul>
 <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>
 </ul>

data/man/man0/VERSION.markdown

@@ -1,3 +1,26 @@
+## Version 3.0.1 (2014-07-16)
+
+This release restores Mac OS X support and fixes a permalink generation bug.
+
+### Patch:
+
+  * GH-13: man(1) on Mac OS X could not display URLs.
+
+    The version of groff on Mac OS X is too old: it lacks the an-ext.tmac
+    macro package that defines styles for email addresses and general URLs.
+
+        $ groff --version
+        ...
+        GNU grops (groff) version 1.19.2
+        GNU troff (groff) version 1.19.2
+
+    This patch drops those URL macros in favor of simpler angled brackets.
+
+    Thanks to Sorin Ionescu for reporting this issue in GH-13:
+    https://github.com/sunaku/md2man/issues/13
+
+  * md2man-html(1): cross references were escaped in heading permalink IDs.
+
 ## Version 3.0.0 (2014-06-22)
 
 This release changes md2man-html(1) heading permalinks to follow GitHub style:

data/man/man1/md2man-html.1

@@ -1,4 +1,4 @@
-.TH MD2MAN\-HTML 1 2014\-06\-22 3.0.0
+.TH MD2MAN\-HTML 1 2014\-07\-16 3.0.1
 .SH NAME
 .PP
 md2man\-html \- convert 

data/man/man1/md2man-html.1.html

@@ -2,12 +2,12 @@
 <html>
 <head>
   <meta charset="utf-8" />
-  <meta name="generator" content="md2man 3.0.0 https://github.com/sunaku/md2man" />
+  <meta name="generator" content="md2man 3.0.1 https://github.com/sunaku/md2man" />
   <title>md2man-html(1) &mdash; convert md2man(5) flavored markdown(7) into HTML</title>
   <link rel="stylesheet" href="../style.css"/>
   <!--[if lt IE 9]><script src="http://html5shiv.googlecode.com/svn/trunk/html5.js"></script><![endif]-->
 </head>
-<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-2014-06-22-3-0-0"><a name="md2man-html-1-2014-06-22-3-0-0" href="#md2man-html-1-2014-06-22-3-0-0" class="md2man-permalink" title="permalink"></a><span class="md2man-title">MD2MAN-HTML</span> <span class="md2man-section">1</span> <span class="md2man-date">2014-06-22</span> <span class="md2man-source">3.0.0</span></h1><h2 id="name"><a name="name" href="#name" class="md2man-permalink" title="permalink"></a>NAME</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"><a name="synopsis" href="#synopsis" class="md2man-permalink" title="permalink"></a>SYNOPSIS</h2><p><code>md2man-html</code> [<em>OPTION</em>]... [<em>FILE</em>]</p><h2 id="description"><a name="description" href="#description" class="md2man-permalink" title="permalink"></a>DESCRIPTION</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
+<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-2014-07-16-3-0-1"><a name="md2man-html-1-2014-07-16-3-0-1" href="#md2man-html-1-2014-07-16-3-0-1" class="md2man-permalink" title="permalink"></a><span class="md2man-title">MD2MAN-HTML</span> <span class="md2man-section">1</span> <span class="md2man-date">2014-07-16</span> <span class="md2man-source">3.0.1</span></h1><h2 id="name"><a name="name" href="#name" class="md2man-permalink" title="permalink"></a>NAME</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"><a name="synopsis" href="#synopsis" class="md2man-permalink" title="permalink"></a>SYNOPSIS</h2><p><code>md2man-html</code> [<em>OPTION</em>]... [<em>FILE</em>]</p><h2 id="description"><a name="description" href="#description" class="md2man-permalink" title="permalink"></a>DESCRIPTION</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
 <em>FILE</em> into HTML and then prints the result to the standard output stream.
 If <em>FILE</em> is not given, then the standard input stream is read in its place.</p><h3 id="top-level-headings"><a name="top-level-headings" href="#top-level-headings" class="md2man-permalink" title="permalink"></a>Top-level headings</h3><p>Each component of the <code>.TH</code> directive in <a class="md2man-reference">roff(7)</a>, described under &quot;Top-level
 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>

data/man/man1/md2man-rake.1

@@ -1,4 +1,4 @@
-.TH MD2MAN\-RAKE 1 2014\-06\-22 3.0.0
+.TH MD2MAN\-RAKE 1 2014\-07\-16 3.0.1
 .SH NAME
 .PP
 md2man\-rake \- run 

data/man/man1/md2man-rake.1.html

@@ -2,12 +2,12 @@
 <html>
 <head>
   <meta charset="utf-8" />
-  <meta name="generator" content="md2man 3.0.0 https://github.com/sunaku/md2man" />
+  <meta name="generator" content="md2man 3.0.1 https://github.com/sunaku/md2man" />
   <title>md2man-rake(1) &mdash; run rake(1) tasks from md2man(1)</title>
   <link rel="stylesheet" href="../style.css"/>
   <!--[if lt IE 9]><script src="http://html5shiv.googlecode.com/svn/trunk/html5.js"></script><![endif]-->
 </head>
-<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-2014-06-22-3-0-0"><a name="md2man-rake-1-2014-06-22-3-0-0" href="#md2man-rake-1-2014-06-22-3-0-0" class="md2man-permalink" title="permalink"></a><span class="md2man-title">MD2MAN-RAKE</span> <span class="md2man-section">1</span> <span class="md2man-date">2014-06-22</span> <span class="md2man-source">3.0.0</span></h1><h2 id="name"><a name="name" href="#name" class="md2man-permalink" title="permalink"></a>NAME</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"><a name="synopsis" href="#synopsis" class="md2man-permalink" title="permalink"></a>SYNOPSIS</h2><p><code>md2man-rake</code> [<em>OPTION</em>]... [<em>TASK</em>]...</p><h2 id="description"><a name="description" href="#description" class="md2man-permalink" title="permalink"></a>DESCRIPTION</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
+<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-2014-07-16-3-0-1"><a name="md2man-rake-1-2014-07-16-3-0-1" href="#md2man-rake-1-2014-07-16-3-0-1" class="md2man-permalink" title="permalink"></a><span class="md2man-title">MD2MAN-RAKE</span> <span class="md2man-section">1</span> <span class="md2man-date">2014-07-16</span> <span class="md2man-source">3.0.1</span></h1><h2 id="name"><a name="name" href="#name" class="md2man-permalink" title="permalink"></a>NAME</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"><a name="synopsis" href="#synopsis" class="md2man-permalink" title="permalink"></a>SYNOPSIS</h2><p><code>md2man-rake</code> [<em>OPTION</em>]... [<em>TASK</em>]...</p><h2 id="description"><a name="description" href="#description" class="md2man-permalink" title="permalink"></a>DESCRIPTION</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
 to create a special file named <code>Rakefile</code> that contains the following snippet:</p>
 <pre><code>require &#39;md2man/rakefile&#39;
 </code></pre>

data/man/man1/md2man-roff.1

@@ -1,4 +1,4 @@
-.TH MD2MAN\-ROFF 1 2014\-06\-22 3.0.0
+.TH MD2MAN\-ROFF 1 2014\-07\-16 3.0.1
 .SH NAME
 .PP
 md2man\-roff \- convert 
@@ -24,9 +24,7 @@ If \fIFILE\fP is not given, then the standard input stream is read in its place.
 .SS Limitations
 .PP
 This program does not convert the following Redcarpet
-.UR https://github.com/vmg/redcarpet
-.UE
-nodes into 
+\[la]https://github.com/vmg/redcarpet\[ra] nodes into 
 .BR roff (7):
 .RS
 .IP \(bu 2

data/man/man1/md2man-roff.1.html

@@ -2,12 +2,12 @@
 <html>
 <head>
   <meta charset="utf-8" />
-  <meta name="generator" content="md2man 3.0.0 https://github.com/sunaku/md2man" />
+  <meta name="generator" content="md2man 3.0.1 https://github.com/sunaku/md2man" />
   <title>md2man-roff(1) &mdash; convert md2man(5) flavored markdown(7) into roff(7)</title>
   <link rel="stylesheet" href="../style.css"/>
   <!--[if lt IE 9]><script src="http://html5shiv.googlecode.com/svn/trunk/html5.js"></script><![endif]-->
 </head>
-<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-2014-06-22-3-0-0"><a name="md2man-roff-1-2014-06-22-3-0-0" href="#md2man-roff-1-2014-06-22-3-0-0" class="md2man-permalink" title="permalink"></a><span class="md2man-title">MD2MAN-ROFF</span> <span class="md2man-section">1</span> <span class="md2man-date">2014-06-22</span> <span class="md2man-source">3.0.0</span></h1><h2 id="name"><a name="name" href="#name" class="md2man-permalink" title="permalink"></a>NAME</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"><a name="synopsis" href="#synopsis" class="md2man-permalink" title="permalink"></a>SYNOPSIS</h2><p><code>md2man-roff</code> [<em>OPTION</em>]... [<em>FILE</em>]</p><h2 id="description"><a name="description" href="#description" class="md2man-permalink" title="permalink"></a>DESCRIPTION</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
+<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-2014-07-16-3-0-1"><a name="md2man-roff-1-2014-07-16-3-0-1" href="#md2man-roff-1-2014-07-16-3-0-1" class="md2man-permalink" title="permalink"></a><span class="md2man-title">MD2MAN-ROFF</span> <span class="md2man-section">1</span> <span class="md2man-date">2014-07-16</span> <span class="md2man-source">3.0.1</span></h1><h2 id="name"><a name="name" href="#name" class="md2man-permalink" title="permalink"></a>NAME</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"><a name="synopsis" href="#synopsis" class="md2man-permalink" title="permalink"></a>SYNOPSIS</h2><p><code>md2man-roff</code> [<em>OPTION</em>]... [<em>FILE</em>]</p><h2 id="description"><a name="description" href="#description" class="md2man-permalink" title="permalink"></a>DESCRIPTION</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
 <em>FILE</em> into <a class="md2man-reference">roff(7)</a> and then prints the result to the standard output stream.
 If <em>FILE</em> is not given, then the standard input stream is read in its place.</p><h3 id="limitations"><a name="limitations" href="#limitations" class="md2man-permalink" title="permalink"></a>Limitations</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>
 <ul>

data/man/man5/md2man.5

@@ -1,4 +1,4 @@
-.TH MD2MAN 5 2014\-06\-22 3.0.0
+.TH MD2MAN 5 2014\-07\-16 3.0.1
 .SH NAME
 .PP
 md2man \- manual page flavoring for the 
@@ -7,9 +7,7 @@ file format
 .SH DESCRIPTION
 .PP
 md2man
-.UR https://github.com/sunaku/md2man
-.UE
-makes the 
+\[la]https://github.com/sunaku/md2man\[ra] makes the 
 .BR markdown (7) 
 file format friendly for writing UNIX manual
 pages by extending its syntax, semantics, and assumed processing extensions.
@@ -117,9 +115,7 @@ Any subsequent top\-level headings are treated as second\-level \fB\fC<h2>\fR he
 .SS Extensions
 .PP
 md2man enables the following Redcarpet
-.UR https://github.com/vmg/redcarpet
-.UE
-extensions while reading 
+\[la]https://github.com/vmg/redcarpet\[ra] extensions while reading 
 .BR markdown (7):
 .RS
 .IP \(bu 2

data/man/man5/md2man.5.html

@@ -2,12 +2,12 @@
 <html>
 <head>
   <meta charset="utf-8" />
-  <meta name="generator" content="md2man 3.0.0 https://github.com/sunaku/md2man" />
+  <meta name="generator" content="md2man 3.0.1 https://github.com/sunaku/md2man" />
   <title>md2man(5) &mdash; manual page flavoring for the markdown(7) file format</title>
   <link rel="stylesheet" href="../style.css"/>
   <!--[if lt IE 9]><script src="http://html5shiv.googlecode.com/svn/trunk/html5.js"></script><![endif]-->
 </head>
-<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-2014-06-22-3-0-0"><a name="md2man-5-2014-06-22-3-0-0" href="#md2man-5-2014-06-22-3-0-0" class="md2man-permalink" title="permalink"></a><span class="md2man-title">MD2MAN</span> <span class="md2man-section">5</span> <span class="md2man-date">2014-06-22</span> <span class="md2man-source">3.0.0</span></h1><h2 id="name"><a name="name" href="#name" class="md2man-permalink" title="permalink"></a>NAME</h2><p>md2man - manual page flavoring for the <a class="md2man-reference">markdown(7)</a> file format</p><h2 id="description"><a name="description" href="#description" class="md2man-permalink" title="permalink"></a>DESCRIPTION</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
+<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-2014-07-16-3-0-1"><a name="md2man-5-2014-07-16-3-0-1" href="#md2man-5-2014-07-16-3-0-1" class="md2man-permalink" title="permalink"></a><span class="md2man-title">MD2MAN</span> <span class="md2man-section">5</span> <span class="md2man-date">2014-07-16</span> <span class="md2man-source">3.0.1</span></h1><h2 id="name"><a name="name" href="#name" class="md2man-permalink" title="permalink"></a>NAME</h2><p>md2man - manual page flavoring for the <a class="md2man-reference">markdown(7)</a> file format</p><h2 id="description"><a name="description" href="#description" class="md2man-permalink" title="permalink"></a>DESCRIPTION</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
 pages by extending its syntax, semantics, and assumed processing extensions.</p><h3 id="syntax"><a name="syntax" href="#syntax" class="md2man-permalink" title="permalink"></a>Syntax</h3><p>md2man extends <a class="md2man-reference">markdown(7)</a> syntax by defining three kinds of paragraphs.</p>
 <pre><code>This is a
 normal

data/man/man5/md2man.5.markdown

@@ -1,4 +1,4 @@
-# MD2MAN 5 2014-06-22 3.0.0
+# MD2MAN 5 2014-07-16 3.0.1
 
 ## NAME
 

data/test/md2man/html_test.rb

@@ -133,7 +133,7 @@ describe 'html engine' do
     OUTPUT
   end
 
-  it 'adds ID attributes on headings for permalinking' do
+  it 'adds permalinks to headings' do
     @markdown.render(heredoc(<<-INPUT)).must_equal(heredoc(<<-OUTPUT))
       |# foo *BAR*
       |## bar BAZ
@@ -156,4 +156,18 @@ describe 'html engine' do
 <h4 id="bar-baz-4"><a name="bar-baz-4" href="#bar-baz-4" class="md2man-permalink" title="permalink"></a>-bar--BAZ---</h4>
     OUTPUT
   end
+
+  it 'adds permalinks to headings that contain man page references' do
+    @markdown.render(heredoc(<<-INPUT)).must_equal(heredoc(<<-OUTPUT))
+      |## here is-a-reference(3) to another man page
+      |
+      |here is a paragraph containing is-a-reference(3) again
+      |
+      |here is another paragraph containing is-a-reference(3) yet again
+    INPUT
+<h2 id="here-is-a-reference-3-to-another-man-page"><a name="here-is-a-reference-3-to-another-man-page" href="#here-is-a-reference-3-to-another-man-page" class="md2man-permalink" title="permalink"></a>here <a class="md2man-reference" href="../man3/is-a-reference.3.html">is-a-reference(3)</a> to another man page</h2>\
+<p>here is a paragraph containing <a class="md2man-reference" href="../man3/is-a-reference.3.html">is-a-reference(3)</a> again</p>\
+<p>here is another paragraph containing <a class="md2man-reference" href="../man3/is-a-reference.3.html">is-a-reference(3)</a> yet again</p>
+    OUTPUT
+  end
 end

data/test/md2man/roff_test.rb

@@ -587,8 +587,7 @@ describe 'roff engine' do
     INPUT
       |.PP
       |Send me
-      |.MT foo@bar.baz
-      |.ME , e\\-mail.
+      |\\[la]foo@bar.baz\\[ra], e\\-mail.
     OUTPUT
 
     @markdown.render(heredoc(<<-INPUT)).must_equal(heredoc(<<-OUTPUT))
@@ -596,8 +595,7 @@ describe 'roff engine' do
     INPUT
       |.PP
       |Take me
-      |.UR http://myself
-      |.UE , somewhere.
+      |\\[la]http://myself\\[ra], somewhere.
     OUTPUT
 
     @markdown.render(heredoc(<<-INPUT)).must_equal(heredoc(<<-OUTPUT))
@@ -605,9 +603,7 @@ describe 'roff engine' do
     INPUT
       |.PP
       |Mail me#{SPACE}
-      |.MT foo@bar.baz
-      |.ME
-      |now.
+      |\\[la]foo@bar.baz\\[ra] now.
     OUTPUT
 
     @markdown.render(heredoc(<<-INPUT)).must_equal(heredoc(<<-OUTPUT))
@@ -615,9 +611,7 @@ describe 'roff engine' do
     INPUT
       |.PP
       |Take me#{SPACE}
-      |.UR http://www.somewhere
-      |.UE
-      |now.
+      |\\[la]http://www.somewhere\\[ra] now.
     OUTPUT
   end
 
@@ -921,8 +915,7 @@ describe 'roff engine' do
       |[Obligatory screenshot of#{SPACE}
       |.BR md2man-roff (1)#{SPACE}
       |in action!](
-      |.UR https://raw.github.com/sunaku/md2man/master/EXAMPLE.png
-      |.UE )
+      |\\[la]https://raw.github.com/sunaku/md2man/master/EXAMPLE.png\\[ra])
     OUTPUT
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: md2man
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.0.1
 platform: ruby
 authors:
 - Suraj N. Kurapati
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-23 00:00:00.000000000 Z
+date: 2014-07-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: binman