man/man0/VERSION.html in binman-5.0.1 vs man/man0/VERSION.html in binman-5.1.0

- old
+ new

@@ -1,16 +1,40 @@ <!DOCTYPE html> <html> <head> <meta charset="utf-8" /> - <meta name="generator" content="md2man 5.0.1 https://github.com/sunaku/md2man" /> - <title>VERSION</title> + <meta name="generator" content="md2man 5.1.0 https://github.com/sunaku/md2man" /> + <title>VERSION &mdash; binman</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-5-0-1-2016-02-13">Version 5.0.1 (2016-02-13)<a name="version-5-0-1-2016-02-13" href="#version-5-0-1-2016-02-13" class="md2man-permalink" title="permalink"></a></h2><h3 id="major">Major:<a name="major" href="#major" class="md2man-permalink" title="permalink"></a></h3> +<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-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><p>This release splits <a class="md2man-reference" href="../man1/binman.1.html">binman(1)</a> into pieces and improves the documentation.</p><h3 id="minor">Minor:<a name="minor" href="#minor" class="md2man-permalink" title="permalink"></a></h3> <ul> +<li><p><a class="md2man-reference" href="../man1/binman.1.html">binman(1)</a> is now deprecated, to be removed in the next major version. +Please run the new binman-* programs, listed below, directly instead.</p></li> +<li><p>Split <a class="md2man-reference" href="../man1/binman.1.html">binman(1)</a> commands into independent programs:</p> +<ul> +<li><a class="md2man-reference" href="../man1/binman-help.1.html">binman-help(1)</a> - add help options to your program</li> +<li><a class="md2man-reference" href="../man1/binman-html.1.html">binman-html(1)</a> - HTML manpage from header comment</li> +<li><a class="md2man-reference" href="../man1/binman-rake.1.html">binman-rake(1)</a> - run <a class="md2man-reference">rake(1)</a> tasks from command line</li> +<li><a class="md2man-reference" href="../man1/binman-roff.1.html">binman-roff(1)</a> - UNIX manpage from header comment</li> +<li><a class="md2man-reference" href="../man1/binman-show.1.html">binman-show(1)</a> - show manpage from header comment</li> +<li><a class="md2man-reference" href="../man1/binman-text.1.html">binman-text(1)</a> - extract embedded manpage sources</li> +</ul></li> +<li><p><a class="md2man-reference" href="../man1/binman-rake.1.html">binman-rake(1)</a>: allow task names without namespace.</p><p>You can now run <code>binman-rake man</code> instead of <code>binman-rake binman:man</code>, +and similarly <code>binman-rake web</code> instead of <code>binman-rake binman:web</code>, +and similarly <code>binman-rake mkd</code> instead of <code>binman-rake binman:mkd</code>.</p></li> +</ul> +<h3 id="patch">Patch:<a name="patch" href="#patch" class="md2man-permalink" title="permalink"></a></h3> +<ul> +<li><p>README: an epic revision; add copy of <a class="md2man-reference" href="../man5/md2man.5.html">md2man(5)</a>.</p></li> +<li><p>README: add dasht manual pages to examples section.</p></li> +<li><p>Clarify optionalness of <em>PATTERN</em> in <code>--help</code> option.</p></li> +<li><p>Upgrade to md2man version 5.1.</p></li> +</ul> +<h2 id="version-5-0-1-2016-02-13">Version 5.0.1 (2016-02-13)<a name="version-5-0-1-2016-02-13" href="#version-5-0-1-2016-02-13" class="md2man-permalink" title="permalink"></a></h2><h3 id="major">Major:<a name="major" href="#major" class="md2man-permalink" title="permalink"></a></h3> +<ul> <li><p>Rename <code>binman snip</code> command to <code>binman text</code>.</p></li> <li><p>Rename <code>binman conv</code> command to <code>binman roff</code> and make it operate on a bin script containing an embedded manual page rather than the extracted latter.</p></li> <li><p>Add <code>binman html</code> command which extracts embedded manual page from a given bin script, converts it into HTML, and then prints the result to STDOUT.</p></li> @@ -18,31 +42,28 @@ <a class="md2man-reference">man(1)</a> fails to display the temporary UNIX manual page. This is useful in Windows where there is no <a class="md2man-reference">man(1)</a> reader, but a web browser can be started.</p></li> <li><p>When a HTML manual page is shown, <code>binman</code> now blocks until the launched web browser exits. Previously, it used to exit immediately (nonblocking).</p></li> </ul> -<h2 id="version-4-2-1-2016-02-12">Version 4.2.1 (2016-02-12)<a name="version-4-2-1-2016-02-12" href="#version-4-2-1-2016-02-12" class="md2man-permalink" title="permalink"></a></h2><h3 id="patch">Patch:<a name="patch" href="#patch" class="md2man-permalink" title="permalink"></a></h3> +<h2 id="version-4-2-1-2016-02-12">Version 4.2.1 (2016-02-12)<a name="version-4-2-1-2016-02-12" href="#version-4-2-1-2016-02-12" class="md2man-permalink" title="permalink"></a></h2><h3 id="minor-1">Minor:<a name="minor-1" href="#minor-1" class="md2man-permalink" title="permalink"></a></h3> <ul> -<li><p>Failure when <code>binman show</code> is given input on STDIN.</p><p>binman.rb:51:in `basename&#39;: no implicit conversion of IO into String (TypeError)</p></li> -</ul> -<h2 id="version-4-2-0-2016-02-12">Version 4.2.0 (2016-02-12)<a name="version-4-2-0-2016-02-12" href="#version-4-2-0-2016-02-12" class="md2man-permalink" title="permalink"></a></h2><h3 id="minor">Minor:<a name="minor" href="#minor" class="md2man-permalink" title="permalink"></a></h3> -<ul> <li>Add <code>binman:mkd</code> rake task to extract <code>man/man1/*.1.markdown</code> files.</li> </ul> <h3 id="patch-1">Patch:<a name="patch-1" href="#patch-1" class="md2man-permalink" title="permalink"></a></h3> <ul> <li><p>Shell out to <a class="md2man-reference">md2man-rake(1)</a> for dynamic man pages.</p><p>Requiring the md2man/rakefile.rb script builds Rake tasks only once, so it ignores any man page files generated dynamically after the require().</p><p>This fix shells out to <a class="md2man-reference">md2man-rake(1)</a> causing that script to be required every time afresh, so that such dynamically generated files are handled.</p></li> <li><p>Failure when <code>binman help</code> is called without ARGV.</p><p>binman.rb:63:in <code>help&#39;: undefined method</code>index&#39; for nil:NilClass (NoMethodError)</p></li> <li><p>Failure when <code>binman show</code> is called without ARGV.</p><p>binman.rb:47:in `basename&#39;: no implicit conversion of IO into String (TypeError)</p></li> +<li><p>Failure when <code>binman show</code> is given input on STDIN.</p><p>binman.rb:51:in `basename&#39;: no implicit conversion of IO into String (TypeError)</p></li> </ul> -<h2 id="version-4-1-0-2016-02-10">Version 4.1.0 (2016-02-10)<a name="version-4-1-0-2016-02-10" href="#version-4-1-0-2016-02-10" class="md2man-permalink" title="permalink"></a></h2><h3 id="minor-1">Minor:<a name="minor-1" href="#minor-1" class="md2man-permalink" title="permalink"></a></h3> +<h3 id="patch-2">Patch:<a name="patch-2" href="#patch-2" class="md2man-permalink" title="permalink"></a></h3><h2 id="version-4-1-0-2016-02-10">Version 4.1.0 (2016-02-10)<a name="version-4-1-0-2016-02-10" href="#version-4-1-0-2016-02-10" class="md2man-permalink" title="permalink"></a></h2><h3 id="minor-2">Minor:<a name="minor-2" href="#minor-2" class="md2man-permalink" title="permalink"></a></h3> <ul> <li>Print path of HTML man page to STDOUT when launching browser.</li> </ul> -<h3 id="patch-2">Patch:<a name="patch-2" href="#patch-2" class="md2man-permalink" title="permalink"></a></h3> +<h3 id="patch-3">Patch:<a name="patch-3" href="#patch-3" class="md2man-permalink" title="permalink"></a></h3> <ul> <li><p>Revert &quot;ensure &#39;binman:web&#39; task works the first time thru&quot;.</p><p>This reverts commit dd0511e78e02546cac4903b5c6de6243607a8bba, which was causing the following error under Ruby 2.3.0p0.</p><dl><dd>% rake build mkdir -p man/man1 rake aborted! @@ -66,22 +87,22 @@ <li>We no longer require a specific md2man version at runtime; any will do.</li> </ul></li> <li><p>Upgrade to md2man 4.0, which no longer expands cross references in code spans and code blocks. Your manuals might be rendered differently now.</p></li> </ul> -<h2 id="version-3-4-1-2014-07-01">Version 3.4.1 (2014-07-01)<a name="version-3-4-1-2014-07-01" href="#version-3-4-1-2014-07-01" class="md2man-permalink" title="permalink"></a></h2><p>This release fixes the help options&#39; REGEXP argument under non-Debian systems.</p><h3 id="patch-3">Patch:<a name="patch-3" href="#patch-3" class="md2man-permalink" title="permalink"></a></h3> +<h2 id="version-3-4-1-2014-07-01">Version 3.4.1 (2014-07-01)<a name="version-3-4-1-2014-07-01" href="#version-3-4-1-2014-07-01" class="md2man-permalink" title="permalink"></a></h2><p>This release fixes the help options&#39; REGEXP argument under non-Debian systems.</p><h3 id="patch-4">Patch:<a name="patch-4" href="#patch-4" class="md2man-permalink" title="permalink"></a></h3> <ul> <li><p><a class="md2man-reference">pager(1)</a> isn&#39;t a universal command: CentOS uses <code>less -is</code> instead.</p></li> <li><p>Silence <a class="md2man-reference">man(1)</a> stderr when displaying dynamically extracted manual.</p></li> </ul> <h3 id="other">Other:<a name="other" href="#other" class="md2man-permalink" title="permalink"></a></h3> <ul> <li><p>README: add intro hook and source+result examples.</p></li> <li><p>Document REGEXP argument for help options in <code>bin/*</code>.</p></li> <li><p>Refer to REGEXP argument as PATTERN like less does.</p></li> </ul> -<h2 id="version-3-4-0-2014-06-29">Version 3.4.0 (2014-06-29)<a name="version-3-4-0-2014-06-29" href="#version-3-4-0-2014-06-29" class="md2man-permalink" title="permalink"></a></h2><h3 id="minor-2">Minor:<a name="minor-2" href="#minor-2" class="md2man-permalink" title="permalink"></a></h3> +<h2 id="version-3-4-0-2014-06-29">Version 3.4.0 (2014-06-29)<a name="version-3-4-0-2014-06-29" href="#version-3-4-0-2014-06-29" class="md2man-permalink" title="permalink"></a></h2><h3 id="minor-3">Minor:<a name="minor-3" href="#minor-3" class="md2man-permalink" title="permalink"></a></h3> <ul> <li><p>GH-3: add optional regexp argument to <code>-h</code>/<code>--help</code> to search in <a class="md2man-reference">man(1)</a>.</p><p>The <code>-h</code> and <code>--help</code> options in <code>BinMan.help()</code> can now be optionally followed by a regular expression argument that specifies text to search for and, if found, jump to inside the displayed UNIX man page. Such a regular expression argument can now also be passed into <code>BinMan.show()</code>.</p></li> @@ -96,21 +117,21 @@ <li><p>GitHub now supports relative links from the README:</p><p><a href="https://help.github.com/articles/relative-links-in-readmes">https://help.github.com/articles/relative-links-in-readmes</a></p></li> <li><p>Upgrade to md2man 3.0 for improved HTML manuals.</p></li> </ul> <h2 id="version-3-3-2-2013-08-30">Version 3.3.2 (2013-08-30)<a name="version-3-3-2-2013-08-30" href="#version-3-3-2-2013-08-30" class="md2man-permalink" title="permalink"></a></h2><p>Patch:</p> <ul> -<li><p>Rescue error when designated opener is not found:</p><pre><code>$ binman -h -/gems/opener-0.1.0/lib/opener.rb:97:in `spawn&#39;: No such file or directory - xdg-open (Errno::ENOENT) - from /gems/opener-0.1.0/lib/opener.rb:97:in `spawn&#39; - from /gems/binman-3.3.1/lib/binman.rb:57:in `block in show&#39; - from /gems/binman-3.3.1/lib/binman.rb:55:in `each&#39; - from /gems/binman-3.3.1/lib/binman.rb:55:in `show&#39; - from /gems/binman-3.3.1/lib/binman.rb:88:in `help&#39; - from /gems/binman-3.3.1/bin/binman:106:in `&lt;top (required)&gt;&#39; - from /bin/binman:23:in `load&#39; - from /bin/binman:23:in `&lt;main&gt;&#39; +<li><p>Rescue error when designated opener is not found:</p><pre class="highlight plaintext"><code>$ binman -h +/gems/opener-0.1.0/lib/opener.rb:97:in `spawn': No such file or directory - xdg-open (Errno::ENOENT) + from /gems/opener-0.1.0/lib/opener.rb:97:in `spawn' + from /gems/binman-3.3.1/lib/binman.rb:57:in `block in show' + from /gems/binman-3.3.1/lib/binman.rb:55:in `each' + from /gems/binman-3.3.1/lib/binman.rb:55:in `show' + from /gems/binman-3.3.1/lib/binman.rb:88:in `help' + from /gems/binman-3.3.1/bin/binman:106:in `&lt;top (required)&gt;' + from /bin/binman:23:in `load' + from /bin/binman:23:in `&lt;main&gt;' </code></pre></li> -<li><p>Fix an undefined local variable or method error:</p><pre><code>binman: undefined local variable or method `library&#39; for BinMan:Module +<li><p>Fix an undefined local variable or method error:</p><pre class="highlight plaintext"><code>binman: undefined local variable or method `library' for BinMan:Module </code></pre></li> </ul> <p>Other:</p> <ul> <li>Add screenshot to git repo since OmpLoader is dead.</li>