RubyGems - binman - Versions diffs - 3.4.0 → 3.4.1 - Mend

binman 3.4.0 → 3.4.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (16) hide show

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 727b7b3c6721e902b36563fd5330fe05fa5707a9
-  data.tar.gz: 94d7d927939cb06625b4423f8358370b8a69e8aa
+  metadata.gz: d6becc92c0aa066561bb49848c692097ac293ad0
+  data.tar.gz: ff7adbef6a482c095b42f99a245985022433c29c
 SHA512:
-  metadata.gz: 96478840dc759fb9b9f62083ab9656a433d20c19be07fece5f3f4f62e55d05fa7d877fe49faddc00ba42fda7b25be693bc3404a56fcb0e84db8041a5b19d2e7b
-  data.tar.gz: a987be972eabdcb0521ae9ba85ccd9172f4cbdfe8e72cbf7d92c300a82ab33b9c659c5b8a4d293af3214f3de39571f3a7c97baf42556f139482aa95a62b9a0ed
+  metadata.gz: 0a309791584f5a2abe6c74ed132a4112b6f62c0b722beca8c3b2a3066207af24e1709a32bd95708ab3104d365231a37ed72507fd9eecc64b62a885312dc3176c
+  data.tar.gz: fb221b25276afd2bc34fea9bbfe18d793787e8ae1eeb3ca8bf09478f9249d07f1f2aace1224ce1898ce4c0bb35c2f8244e27c848f92034b8eefb9297b0479fd3

data/README.markdown CHANGED Viewed

@@ -1,6 +1,12 @@
 # binman - man pages for bin scripts
 [binman] produces UNIX manual pages for executable scripts using [md2man].
+Simply [document your script in Markdown][md2man-markdown] as a comment at the
+top of your script and call `binman show` to display it as a UNIX manual page!
+Or, call `binman help` to display your manual _only_ when your script receives
+with `-h` or `--help` command-line options.  Or, call `binman load` to extract
+the manual from your script for your own custom processing, outside of binman.
+And that's not all: [see the manual][binman-man] for even more possibilities!
 * Manuals: <https://sunaku.github.io/binman/man>
 * Sources: <https://github.com/sunaku/binman>
@@ -23,7 +29,61 @@
 ![Obligatory screen-shot of binman(1) in action!](EXAMPLE.png)
-Here is [a complete example in Ruby][binman-bin] to help you get started.
+Here are some working examples of Ruby bin scripts to help you get started:
+* tork(1):
+  [Ruby source](https://raw.github.com/sunaku/tork/master/bin/tork) &rarr;
+  [HTML result](https://sunaku.github.io/tork/man/man1/tork.1.html) +
+  [roff result](https://sunaku.github.io/tork/man/man1/tork.1)
+* tork-runner(1):
+  [Ruby source](https://raw.github.com/sunaku/tork/master/bin/tork-runner) &rarr;
+  [HTML result](https://sunaku.github.io/tork/man/man1/tork-runner.1.html) +
+  [roff result](https://sunaku.github.io/tork/man/man1/tork-runner.1)
+* tork-herald(1):
+  [Ruby source](https://raw.github.com/sunaku/tork/master/bin/tork-herald) &rarr;
+  [HTML result](https://sunaku.github.io/tork/man/man1/tork-herald.1.html) +
+  [roff result](https://sunaku.github.io/tork/man/man1/tork-herald.1)
+* tork-driver(1):
+  [Ruby source](https://raw.github.com/sunaku/tork/master/bin/tork-driver) &rarr;
+  [HTML result](https://sunaku.github.io/tork/man/man1/tork-driver.1.html) +
+  [roff result](https://sunaku.github.io/tork/man/man1/tork-driver.1)
+* tork-engine(1):
+  [Ruby source](https://raw.github.com/sunaku/tork/master/bin/tork-engine) &rarr;
+  [HTML result](https://sunaku.github.io/tork/man/man1/tork-engine.1.html) +
+  [roff result](https://sunaku.github.io/tork/man/man1/tork-engine.1)
+* tork-master(1):
+  [Ruby source](https://raw.github.com/sunaku/tork/master/bin/tork-master) &rarr;
+  [HTML result](https://sunaku.github.io/tork/man/man1/tork-master.1.html) +
+  [roff result](https://sunaku.github.io/tork/man/man1/tork-master.1)
+* tork-remote(1):
+  [Ruby source](https://raw.github.com/sunaku/tork/master/bin/tork-remote) &rarr;
+  [HTML result](https://sunaku.github.io/tork/man/man1/tork-remote.1.html) +
+  [roff result](https://sunaku.github.io/tork/man/man1/tork-remote.1)
+* tork-notify(1):
+  [Ruby source](https://raw.github.com/sunaku/tork/master/bin/tork-notify) &rarr;
+  [HTML result](https://sunaku.github.io/tork/man/man1/tork-notify.1.html) +
+  [roff result](https://sunaku.github.io/tork/man/man1/tork-notify.1)
+* md2man-roff(1):
+  [Ruby source](https://raw.github.com/sunaku/md2man/master/bin/md2man-roff) &rarr;
+  [HTML result](https://sunaku.github.io/md2man/man/man1/md2man-roff.1.html) +
+  [roff result](https://sunaku.github.io/md2man/man/man1/md2man-roff.1)
+* md2man-html(1):
+  [Ruby source](https://raw.github.com/sunaku/md2man/master/bin/md2man-html) &rarr;
+  [HTML result](https://sunaku.github.io/md2man/man/man1/md2man-html.1.html) +
+  [roff result](https://sunaku.github.io/md2man/man/man1/md2man-html.1)
+* md2man-rake(1):
+  [Ruby source](https://raw.github.com/sunaku/md2man/master/bin/md2man-rake) &rarr;
+  [HTML result](https://sunaku.github.io/md2man/man/man1/md2man-rake.1.html) +
+  [roff result](https://sunaku.github.io/md2man/man/man1/md2man-rake.1)
+* binman(1):
+  [Ruby source](https://raw.github.com/sunaku/binman/master/bin/binman) &rarr;
+  [HTML result](https://sunaku.github.io/binman/man/man1/binman.1.html) +
+  [roff result](https://sunaku.github.io/binman/man/man1/binman.1)
+* binman-rake(1):
+  [Ruby source](https://raw.github.com/sunaku/binman/master/bin/binman-rake) &rarr;
+  [HTML result](https://sunaku.github.io/binman/man/man1/binman-rake.1.html) +
+  [roff result](https://sunaku.github.io/binman/man/man1/binman-rake.1)
 For examples in other scripting languages, see the "Usage" section below!
 ## Installation
@@ -300,6 +360,7 @@ Released under the ISC license.  See the LICENSE file for details.
 [roff]: http://troff.org
 [binman]: https://github.com/sunaku/binman
+[binman-man]: https://sunaku.github.io/binman/man/man1/binman.1.html
 [binman-api]: http://rubydoc.info/gems/binman/frames
-[binman-bin]: https://raw.github.com/sunaku/binman/master/bin/binman
 [md2man]: https://github.com/sunaku/md2man
+[md2man-markdown]: https://sunaku.github.io/md2man/man/man5/md2man.5.html

data/VERSION.markdown CHANGED Viewed

@@ -1,3 +1,21 @@
+## Version 3.4.1 (2014-07-01)
+This release fixes the help options' REGEXP argument under non-Debian systems.
+### Patch:
+  * pager(1) isn't a universal command: CentOS uses `less -is` instead.
+  * Silence man(1) stderr when displaying dynamically extracted manual.
+### Other:
+  * README: add intro hook and source+result examples.
+  * Document REGEXP argument for help options in `bin/*`.
+  * Refer to REGEXP argument as PATTERN like less does.
 ## Version 3.4.0 (2014-06-29)
 ### Minor:

data/bin/binman CHANGED Viewed

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 =begin =======================================================================
-# BINMAN 1 2014-06-29 3.4.0
+# BINMAN 1 2014-07-01 3.4.1
 ## NAME
@@ -59,22 +59,22 @@ The following [Redcarpet] extensions are enabled while processing markdown(7):
 ## OPTIONS
-`-h`, `--help`
-  Show this help manual.
+`-h` [*PATTERN*], `--help` [*PATTERN*]
+  Show this help manual and search for *PATTERN* regular expression therein.
 ## COMMANDS
-`help` *FILE* ... [`-h`|`--help` [*REGEXP*]] ... [`--`] ...
+`help` *FILE* ... [`-h`|`--help` [*PATTERN*]] ... [`--`] ...
   If the given argument sequence contains `-h` or `--help`, except after
-  `--`, optionally followed by a *REGEXP* regular expression that specifies
+  `--`, optionally followed by a *PATTERN* regular expression that specifies
   text to search for and, if found, jump to inside the displayed man page,
   then this program extracts the given *FILE*'s leading comment header,
   converts it into roff(7), displays it using man(1), and finally exits with
   status code `0`.  Otherwise, this program exits with status code `111`.
-`show` [*FILE*] [*REGEXP*]
+`show` [*FILE*] [*PATTERN*]
   Use man(1) to display the roff(7) conversion of the leading comment header
-  extracted from the given *FILE* or STDIN.  If *REGEXP* is given, search for
+  extracted from the given *FILE* or STDIN.  If *PATTERN* is given, search for
   it within the output displayed by man(1) and jump to first match if found.
 `load` [*FILE*]

data/bin/binman-rake CHANGED Viewed

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 =begin =======================================================================
-# BINMAN-RAKE 1 2014-06-29 3.4.0
+# BINMAN-RAKE 1 2014-07-01 3.4.1
 ## NAME
@@ -39,10 +39,11 @@ If no *TASK* is specified, then the `binman` task is run by default.
 ## OPTIONS
-`-h`, `--help`
-  Show this help manual.
+`-h` [*REGEXP*], `--help` [*REGEXP*]
+  Show this help manual and search for *REGEXP* regular expression therein.
-Run `rake --help` to see more options.
+...
+  Anything else is passed to rake(1); run `rake --help` for documentation.
 ## SEE ALSO

data/lib/binman.rb CHANGED Viewed

@@ -77,7 +77,7 @@ module BinMan
       Tempfile.open 'binman' do |temp|
         temp.write roff
         temp.close
-        view query, temp.path
+        view query, temp.path, 2 => :close
       end
     rescue => error
       warn "binman: #{error}"
@@ -113,20 +113,13 @@ private
   # query (if given) within.  If man(1) is not able to launch with the search
   # capability, then it tries launching man(1) without the search capability.
   def view query, *argv
-    if query
-      # man(1) uses `pager -s` as the pager command by default and both of the
-      # more(1) and less(1) pagers support the "+/pattern" command-line option
-      status = system('man', '-P', "pager -s +/#{query.shellescape}", *argv)
-      # exit status 3 means man(1) couldn't launch with the search capability:
-      #
-      #   man: can't execute pager: No such file or directory
-      #
-      # so don't return and try launching man(1) without the search capability
-      return status unless $?.exitstatus == 3
-    end
-    system 'man', *argv
+    # man(1) defaults to `pager -s` under Debian but `less -is` under CentOS
+    # so try different pagers, but always fall back to using no pager at all.
+    # See https://www.debian-administration.org/article/246/ for pager list.
+    query and %w[ pager less most more ].any? do |pager|
+      # the `-s` and `+/pattern` options are universally supported by pagers
+      system 'man', '-P', "#{pager} -s +/#{query.shellescape}", *argv
+    end or system 'man', *argv
   end
   # Returns contents of given source I/O, file name, or string.

data/lib/binman/version.rb CHANGED Viewed

@@ -1,3 +1,3 @@
 module BinMan
-  VERSION = "3.4.0"
+  VERSION = "3.4.1"
 end

data/man/man0/README.html CHANGED Viewed

@@ -7,7 +7,13 @@
   <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>/README</span></div></div><div class="container-fluid"><h1 id="binman-man-pages-for"><a name="binman-man-pages-for" href="#binman-man-pages-for" class="md2man-permalink" title="permalink"></a><span class="md2man-title">binman</span> <span class="md2man-section">-</span> <span class="md2man-date">man</span> <span class="md2man-source">pages</span> <span class="md2man-manual">for</span></h1><p><a href="https://github.com/sunaku/binman">binman</a> produces UNIX manual pages for executable scripts using <a href="https://github.com/sunaku/md2man">md2man</a>.</p>
+<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="binman-man-pages-for"><a name="binman-man-pages-for" href="#binman-man-pages-for" class="md2man-permalink" title="permalink"></a><span class="md2man-title">binman</span> <span class="md2man-section">-</span> <span class="md2man-date">man</span> <span class="md2man-source">pages</span> <span class="md2man-manual">for</span></h1><p><a href="https://github.com/sunaku/binman">binman</a> produces UNIX manual pages for executable scripts using <a href="https://github.com/sunaku/md2man">md2man</a>.
+Simply <a href="https://sunaku.github.io/md2man/man/man5/md2man.5.html">document your script in Markdown</a> as a comment at the
+top of your script and call <code>binman show</code> to display it as a UNIX manual page!
+Or, call <code>binman help</code> to display your manual <em>only</em> when your script receives
+with <code>-h</code> or <code>--help</code> command-line options.  Or, call <code>binman load</code> to extract
+the manual from your script for your own custom processing, outside of binman.
+And that&#39;s not all: <a href="https://sunaku.github.io/binman/man/man1/binman.1.html">see the manual</a> for even more possibilities!</p>
 <ul>
 <li>Manuals: <a href="https://sunaku.github.io/binman/man">https://sunaku.github.io/binman/man</a></li>
 <li>Sources: <a href="https://github.com/sunaku/binman">https://github.com/sunaku/binman</a></li>
@@ -23,8 +29,62 @@ Perl, Python, Node.js, Tcl, AWK, UNIX shell, and more!</p></li>
 <li><p>Individual extraction, conversion, and display commands.</p></li>
 <li><p>Implemented in roughly 150 lines of pure Ruby code! :-)</p></li>
 </ul>
-<h3 id="demonstration"><a name="demonstration" href="#demonstration" class="md2man-permalink" title="permalink"></a>Demonstration</h3><p><img src="EXAMPLE.png" alt="Obligatory screen-shot of binman(1) in action!"></p><p>Here is <a href="https://raw.github.com/sunaku/binman/master/bin/binman">a complete example in Ruby</a> to help you get started.
-For examples in other scripting languages, see the &quot;Usage&quot; section below!</p><h2 id="installation"><a name="installation" href="#installation" class="md2man-permalink" title="permalink"></a>Installation</h2><p>If you only want to view pre-built manual pages:</p>
+<h3 id="demonstration"><a name="demonstration" href="#demonstration" class="md2man-permalink" title="permalink"></a>Demonstration</h3><p><img src="EXAMPLE.png" alt="Obligatory screen-shot of binman(1) in action!"></p><p>Here are some working examples of Ruby bin scripts to help you get started:</p>
+<ul>
+<li><a class="md2man-reference">tork(1)</a>:
+<a href="https://raw.github.com/sunaku/tork/master/bin/tork">Ruby source</a> &rarr;
+<a href="https://sunaku.github.io/tork/man/man1/tork.1.html">HTML result</a> +
+<a href="https://sunaku.github.io/tork/man/man1/tork.1">roff result</a></li>
+<li><a class="md2man-reference">tork-runner(1)</a>:
+<a href="https://raw.github.com/sunaku/tork/master/bin/tork-runner">Ruby source</a> &rarr;
+<a href="https://sunaku.github.io/tork/man/man1/tork-runner.1.html">HTML result</a> +
+<a href="https://sunaku.github.io/tork/man/man1/tork-runner.1">roff result</a></li>
+<li><a class="md2man-reference">tork-herald(1)</a>:
+<a href="https://raw.github.com/sunaku/tork/master/bin/tork-herald">Ruby source</a> &rarr;
+<a href="https://sunaku.github.io/tork/man/man1/tork-herald.1.html">HTML result</a> +
+<a href="https://sunaku.github.io/tork/man/man1/tork-herald.1">roff result</a></li>
+<li><a class="md2man-reference">tork-driver(1)</a>:
+<a href="https://raw.github.com/sunaku/tork/master/bin/tork-driver">Ruby source</a> &rarr;
+<a href="https://sunaku.github.io/tork/man/man1/tork-driver.1.html">HTML result</a> +
+<a href="https://sunaku.github.io/tork/man/man1/tork-driver.1">roff result</a></li>
+<li><a class="md2man-reference">tork-engine(1)</a>:
+<a href="https://raw.github.com/sunaku/tork/master/bin/tork-engine">Ruby source</a> &rarr;
+<a href="https://sunaku.github.io/tork/man/man1/tork-engine.1.html">HTML result</a> +
+<a href="https://sunaku.github.io/tork/man/man1/tork-engine.1">roff result</a></li>
+<li><a class="md2man-reference">tork-master(1)</a>:
+<a href="https://raw.github.com/sunaku/tork/master/bin/tork-master">Ruby source</a> &rarr;
+<a href="https://sunaku.github.io/tork/man/man1/tork-master.1.html">HTML result</a> +
+<a href="https://sunaku.github.io/tork/man/man1/tork-master.1">roff result</a></li>
+<li><a class="md2man-reference">tork-remote(1)</a>:
+<a href="https://raw.github.com/sunaku/tork/master/bin/tork-remote">Ruby source</a> &rarr;
+<a href="https://sunaku.github.io/tork/man/man1/tork-remote.1.html">HTML result</a> +
+<a href="https://sunaku.github.io/tork/man/man1/tork-remote.1">roff result</a></li>
+<li><a class="md2man-reference">tork-notify(1)</a>:
+<a href="https://raw.github.com/sunaku/tork/master/bin/tork-notify">Ruby source</a> &rarr;
+<a href="https://sunaku.github.io/tork/man/man1/tork-notify.1.html">HTML result</a> +
+<a href="https://sunaku.github.io/tork/man/man1/tork-notify.1">roff result</a></li>
+<li><a class="md2man-reference">md2man-roff(1)</a>:
+<a href="https://raw.github.com/sunaku/md2man/master/bin/md2man-roff">Ruby source</a> &rarr;
+<a href="https://sunaku.github.io/md2man/man/man1/md2man-roff.1.html">HTML result</a> +
+<a href="https://sunaku.github.io/md2man/man/man1/md2man-roff.1">roff result</a></li>
+<li><a class="md2man-reference">md2man-html(1)</a>:
+<a href="https://raw.github.com/sunaku/md2man/master/bin/md2man-html">Ruby source</a> &rarr;
+<a href="https://sunaku.github.io/md2man/man/man1/md2man-html.1.html">HTML result</a> +
+<a href="https://sunaku.github.io/md2man/man/man1/md2man-html.1">roff result</a></li>
+<li><a class="md2man-reference">md2man-rake(1)</a>:
+<a href="https://raw.github.com/sunaku/md2man/master/bin/md2man-rake">Ruby source</a> &rarr;
+<a href="https://sunaku.github.io/md2man/man/man1/md2man-rake.1.html">HTML result</a> +
+<a href="https://sunaku.github.io/md2man/man/man1/md2man-rake.1">roff result</a></li>
+<li><a class="md2man-reference" href="../man1/binman.1.html">binman(1)</a>:
+<a href="https://raw.github.com/sunaku/binman/master/bin/binman">Ruby source</a> &rarr;
+<a href="https://sunaku.github.io/binman/man/man1/binman.1.html">HTML result</a> +
+<a href="https://sunaku.github.io/binman/man/man1/binman.1">roff result</a></li>
+<li><a class="md2man-reference" href="../man1/binman-rake.1.html">binman-rake(1)</a>:
+<a href="https://raw.github.com/sunaku/binman/master/bin/binman-rake">Ruby source</a> &rarr;
+<a href="https://sunaku.github.io/binman/man/man1/binman-rake.1.html">HTML result</a> +
+<a href="https://sunaku.github.io/binman/man/man1/binman-rake.1">roff result</a></li>
+</ul>
+<p>For examples in other scripting languages, see the &quot;Usage&quot; section below!</p><h2 id="installation"><a name="installation" href="#installation" class="md2man-permalink" title="permalink"></a>Installation</h2><p>If you only want to view pre-built manual pages:</p>
 <pre><code class="sh">gem install binman
 </code></pre>
 <p>If you also want to build your own manual pages:</p>

data/man/man0/README.markdown CHANGED Viewed

@@ -1,6 +1,12 @@
 # binman - man pages for bin scripts
 [binman] produces UNIX manual pages for executable scripts using [md2man].
+Simply [document your script in Markdown][md2man-markdown] as a comment at the
+top of your script and call `binman show` to display it as a UNIX manual page!
+Or, call `binman help` to display your manual _only_ when your script receives
+with `-h` or `--help` command-line options.  Or, call `binman load` to extract
+the manual from your script for your own custom processing, outside of binman.
+And that's not all: [see the manual][binman-man] for even more possibilities!
 * Manuals: <https://sunaku.github.io/binman/man>
 * Sources: <https://github.com/sunaku/binman>
@@ -23,7 +29,61 @@
 ![Obligatory screen-shot of binman(1) in action!](EXAMPLE.png)
-Here is [a complete example in Ruby][binman-bin] to help you get started.
+Here are some working examples of Ruby bin scripts to help you get started:
+* tork(1):
+  [Ruby source](https://raw.github.com/sunaku/tork/master/bin/tork) &rarr;
+  [HTML result](https://sunaku.github.io/tork/man/man1/tork.1.html) +
+  [roff result](https://sunaku.github.io/tork/man/man1/tork.1)
+* tork-runner(1):
+  [Ruby source](https://raw.github.com/sunaku/tork/master/bin/tork-runner) &rarr;
+  [HTML result](https://sunaku.github.io/tork/man/man1/tork-runner.1.html) +
+  [roff result](https://sunaku.github.io/tork/man/man1/tork-runner.1)
+* tork-herald(1):
+  [Ruby source](https://raw.github.com/sunaku/tork/master/bin/tork-herald) &rarr;
+  [HTML result](https://sunaku.github.io/tork/man/man1/tork-herald.1.html) +
+  [roff result](https://sunaku.github.io/tork/man/man1/tork-herald.1)
+* tork-driver(1):
+  [Ruby source](https://raw.github.com/sunaku/tork/master/bin/tork-driver) &rarr;
+  [HTML result](https://sunaku.github.io/tork/man/man1/tork-driver.1.html) +
+  [roff result](https://sunaku.github.io/tork/man/man1/tork-driver.1)
+* tork-engine(1):
+  [Ruby source](https://raw.github.com/sunaku/tork/master/bin/tork-engine) &rarr;
+  [HTML result](https://sunaku.github.io/tork/man/man1/tork-engine.1.html) +
+  [roff result](https://sunaku.github.io/tork/man/man1/tork-engine.1)
+* tork-master(1):
+  [Ruby source](https://raw.github.com/sunaku/tork/master/bin/tork-master) &rarr;
+  [HTML result](https://sunaku.github.io/tork/man/man1/tork-master.1.html) +
+  [roff result](https://sunaku.github.io/tork/man/man1/tork-master.1)
+* tork-remote(1):
+  [Ruby source](https://raw.github.com/sunaku/tork/master/bin/tork-remote) &rarr;
+  [HTML result](https://sunaku.github.io/tork/man/man1/tork-remote.1.html) +
+  [roff result](https://sunaku.github.io/tork/man/man1/tork-remote.1)
+* tork-notify(1):
+  [Ruby source](https://raw.github.com/sunaku/tork/master/bin/tork-notify) &rarr;
+  [HTML result](https://sunaku.github.io/tork/man/man1/tork-notify.1.html) +
+  [roff result](https://sunaku.github.io/tork/man/man1/tork-notify.1)
+* md2man-roff(1):
+  [Ruby source](https://raw.github.com/sunaku/md2man/master/bin/md2man-roff) &rarr;
+  [HTML result](https://sunaku.github.io/md2man/man/man1/md2man-roff.1.html) +
+  [roff result](https://sunaku.github.io/md2man/man/man1/md2man-roff.1)
+* md2man-html(1):
+  [Ruby source](https://raw.github.com/sunaku/md2man/master/bin/md2man-html) &rarr;
+  [HTML result](https://sunaku.github.io/md2man/man/man1/md2man-html.1.html) +
+  [roff result](https://sunaku.github.io/md2man/man/man1/md2man-html.1)
+* md2man-rake(1):
+  [Ruby source](https://raw.github.com/sunaku/md2man/master/bin/md2man-rake) &rarr;
+  [HTML result](https://sunaku.github.io/md2man/man/man1/md2man-rake.1.html) +
+  [roff result](https://sunaku.github.io/md2man/man/man1/md2man-rake.1)
+* binman(1):
+  [Ruby source](https://raw.github.com/sunaku/binman/master/bin/binman) &rarr;
+  [HTML result](https://sunaku.github.io/binman/man/man1/binman.1.html) +
+  [roff result](https://sunaku.github.io/binman/man/man1/binman.1)
+* binman-rake(1):
+  [Ruby source](https://raw.github.com/sunaku/binman/master/bin/binman-rake) &rarr;
+  [HTML result](https://sunaku.github.io/binman/man/man1/binman-rake.1.html) +
+  [roff result](https://sunaku.github.io/binman/man/man1/binman-rake.1)
 For examples in other scripting languages, see the "Usage" section below!
 ## Installation
@@ -300,6 +360,7 @@ Released under the ISC license.  See the LICENSE file for details.
 [roff]: http://troff.org
 [binman]: https://github.com/sunaku/binman
+[binman-man]: https://sunaku.github.io/binman/man/man1/binman.1.html
 [binman-api]: http://rubydoc.info/gems/binman/frames
-[binman-bin]: https://raw.github.com/sunaku/binman/master/bin/binman
 [md2man]: https://github.com/sunaku/md2man
+[md2man-markdown]: https://sunaku.github.io/md2man/man/man5/md2man.5.html

data/man/man0/VERSION.html CHANGED Viewed

@@ -7,18 +7,29 @@
   <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-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>Version 3.4.0 (2014-06-29)</h2><h3 id="minor"><a name="minor" href="#minor" class="md2man-permalink" title="permalink"></a>Minor:</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-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>Version 3.4.1 (2014-07-01)</h2><p>This release fixes the help options&#39; REGEXP argument under non-Debian systems.</p><h3 id="patch"><a name="patch" href="#patch" class="md2man-permalink" title="permalink"></a>Patch:</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"><a name="other" href="#other" class="md2man-permalink" title="permalink"></a>Other:</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"><a name="version-3-4-0-2014-06-29" href="#version-3-4-0-2014-06-29" class="md2man-permalink" title="permalink"></a>Version 3.4.0 (2014-06-29)</h2><h3 id="minor"><a name="minor" href="#minor" class="md2man-permalink" title="permalink"></a>Minor:</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>
 </ul>
-<h3 id="other"><a name="other" href="#other" class="md2man-permalink" title="permalink"></a>Other:</h3>
+<h3 id="other-1"><a name="other-1" href="#other-1" class="md2man-permalink" title="permalink"></a>Other:</h3>
 <ul>
 <li>README: add syntax highlighting to code snippets.</li>
 </ul>
-<h2 id="version-3-3-3-2014-06-22"><a name="version-3-3-3-2014-06-22" href="#version-3-3-3-2014-06-22" class="md2man-permalink" title="permalink"></a>Version 3.3.3 (2014-06-22)</h2><p>This release upgrades to md2man 3.0 for improved HTML manuals.</p><h3 id="other-1"><a name="other-1" href="#other-1" class="md2man-permalink" title="permalink"></a>Other:</h3>
+<h2 id="version-3-3-3-2014-06-22"><a name="version-3-3-3-2014-06-22" href="#version-3-3-3-2014-06-22" class="md2man-permalink" title="permalink"></a>Version 3.3.3 (2014-06-22)</h2><p>This release upgrades to md2man 3.0 for improved HTML manuals.</p><h3 id="other-2"><a name="other-2" href="#other-2" class="md2man-permalink" title="permalink"></a>Other:</h3>
 <ul>
 <li><p>README: add links to package, manuals, and GitHub.</p></li>
 <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>

data/man/man0/VERSION.markdown CHANGED Viewed

@@ -1,3 +1,21 @@
+## Version 3.4.1 (2014-07-01)
+This release fixes the help options' REGEXP argument under non-Debian systems.
+### Patch:
+  * pager(1) isn't a universal command: CentOS uses `less -is` instead.
+  * Silence man(1) stderr when displaying dynamically extracted manual.
+### Other:
+  * README: add intro hook and source+result examples.
+  * Document REGEXP argument for help options in `bin/*`.
+  * Refer to REGEXP argument as PATTERN like less does.
 ## Version 3.4.0 (2014-06-29)
 ### Minor:

data/man/man1/binman-rake.1 CHANGED Viewed

@@ -1,4 +1,4 @@
-.TH BINMAN\-RAKE 1 2014\-06\-29 3.4.0
+.TH BINMAN\-RAKE 1 2014\-07\-01 3.4.1
 .SH NAME
 .PP
 binman\-rake \- run
@@ -46,10 +46,13 @@ builds HTML manual pages from \fB\fC*.markdown\fR, \fB\fC*.mkd\fR, and \fB\fC*.m
 found in or beneath the \fB\fCman/\fR subdirectory in your working directory.
 .SH OPTIONS
 .TP
-\fB\fC\-h\fR, \fB\fC\-\-help\fR
-Show this help manual.
-.PP
-Run \fB\fCrake \-\-help\fR to see more options.
+\fB\fC\-h\fR [\fIREGEXP\fP], \fB\fC\-\-help\fR [\fIREGEXP\fP]
+Show this help manual and search for \fIREGEXP\fP regular expression therein.
+.TP
+\&...
+Anything else is passed to
+.BR rake (1);
+run \fB\fCrake \-\-help\fR for documentation.
 .SH SEE ALSO
 .PP
 .BR rake (1),

data/man/man1/binman-rake.1.html CHANGED Viewed

@@ -7,7 +7,7 @@
   <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>/binman-rake.1</span></div></div><div class="container-fluid"><h1 id="binman-rake-1-2014-06-29-3-4-0"><a name="binman-rake-1-2014-06-29-3-4-0" href="#binman-rake-1-2014-06-29-3-4-0" class="md2man-permalink" title="permalink"></a><span class="md2man-title">BINMAN-RAKE</span> <span class="md2man-section">1</span> <span class="md2man-date">2014-06-29</span> <span class="md2man-source">3.4.0</span></h1><h2 id="name"><a name="name" href="#name" class="md2man-permalink" title="permalink"></a>NAME</h2><p>binman-rake - run <a class="md2man-reference">rake(1)</a> tasks from <a class="md2man-reference" href="../man1/binman.1.html">binman(1)</a></p><h2 id="synopsis"><a name="synopsis" href="#synopsis" class="md2man-permalink" title="permalink"></a>SYNOPSIS</h2><p><code>binman-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" href="../man1/binman.1.html">binman(1)</a> without having
+<body><div class="navbar"><div class="navbar-inner"><span class="brand"><a href="../index.html#man1">man1</a>/binman-rake.1</span></div></div><div class="container-fluid"><h1 id="binman-rake-1-2014-07-01-3-4-1"><a name="binman-rake-1-2014-07-01-3-4-1" href="#binman-rake-1-2014-07-01-3-4-1" class="md2man-permalink" title="permalink"></a><span class="md2man-title">BINMAN-RAKE</span> <span class="md2man-section">1</span> <span class="md2man-date">2014-07-01</span> <span class="md2man-source">3.4.1</span></h1><h2 id="name"><a name="name" href="#name" class="md2man-permalink" title="permalink"></a>NAME</h2><p>binman-rake - run <a class="md2man-reference">rake(1)</a> tasks from <a class="md2man-reference" href="../man1/binman.1.html">binman(1)</a></p><h2 id="synopsis"><a name="synopsis" href="#synopsis" class="md2man-permalink" title="permalink"></a>SYNOPSIS</h2><p><code>binman-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" href="../man1/binman.1.html">binman(1)</a> without having
 to create a special file named <code>Rakefile</code> that contains the following snippet:</p>
 <pre><code>require &#39;binman/rakefile&#39;
 </code></pre>
@@ -17,5 +17,5 @@ builds UNIX manual pages from <code>*.markdown</code>, <code>*.mkd</code>, and <
 found in or beneath the <code>man/</code> subdirectory in your working directory.</dd></dl><dl><dt><code>binman:web</code></dt><dd>Builds HTML manual pages from scripts found in your <code>bin/</code> directory.
 It also runs the <code>md2man:web</code> task, provided by <a class="md2man-reference">md2man-rake(1)</a>, which
 builds HTML manual pages from <code>*.markdown</code>, <code>*.mkd</code>, and <code>*.md</code> files
-found in or beneath the <code>man/</code> subdirectory in your working directory.</dd></dl><h2 id="options"><a name="options" href="#options" class="md2man-permalink" title="permalink"></a>OPTIONS</h2><dl><dt><code>-h</code>, <code>--help</code></dt><dd>Show this help manual.</dd></dl><p>Run <code>rake --help</code> to see more options.</p><h2 id="see-also"><a name="see-also" href="#see-also" class="md2man-permalink" title="permalink"></a>SEE ALSO</h2><p><a class="md2man-reference">rake(1)</a>, <a class="md2man-reference" href="../man1/binman.1.html">binman(1)</a>, <a class="md2man-reference">md2man-rake(1)</a></p></div></body>
+found in or beneath the <code>man/</code> subdirectory in your working directory.</dd></dl><h2 id="options"><a name="options" href="#options" class="md2man-permalink" title="permalink"></a>OPTIONS</h2><dl><dt><code>-h</code> [<em>REGEXP</em>], <code>--help</code> [<em>REGEXP</em>]</dt><dd>Show this help manual and search for <em>REGEXP</em> regular expression therein.</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"><a name="see-also" href="#see-also" class="md2man-permalink" title="permalink"></a>SEE ALSO</h2><p><a class="md2man-reference">rake(1)</a>, <a class="md2man-reference" href="../man1/binman.1.html">binman(1)</a>, <a class="md2man-reference">md2man-rake(1)</a></p></div></body>
 </html>

data/man/man1/binman.1 CHANGED Viewed

@@ -1,4 +1,4 @@
-.TH BINMAN 1 2014\-06\-29 3.4.0
+.TH BINMAN 1 2014\-07\-01 3.4.1
 .SH NAME
 .PP
 binman \- man pages for bin scripts
@@ -84,13 +84,13 @@ fenced_code_blocks
 .RE
 .SH OPTIONS
 .TP
-\fB\fC\-h\fR, \fB\fC\-\-help\fR
-Show this help manual.
+\fB\fC\-h\fR [\fIPATTERN\fP], \fB\fC\-\-help\fR [\fIPATTERN\fP]
+Show this help manual and search for \fIPATTERN\fP regular expression therein.
 .SH COMMANDS
 .TP
-\fB\fChelp\fR \fIFILE\fP ... [\fB\fC\-h\fR|\fB\fC\-\-help\fR [\fIREGEXP\fP]] ... [\fB\fC\-\-\fR] ...
+\fB\fChelp\fR \fIFILE\fP ... [\fB\fC\-h\fR|\fB\fC\-\-help\fR [\fIPATTERN\fP]] ... [\fB\fC\-\-\fR] ...
 If the given argument sequence contains \fB\fC\-h\fR or \fB\fC\-\-help\fR, except after
-\fB\fC\-\-\fR, optionally followed by a \fIREGEXP\fP regular expression that specifies
+\fB\fC\-\-\fR, optionally followed by a \fIPATTERN\fP regular expression that specifies
 text to search for and, if found, jump to inside the displayed man page,
 then this program extracts the given \fIFILE\fP\&'s leading comment header,
 converts it into
@@ -100,13 +100,13 @@ displays it using
 and finally exits with
 status code \fB\fC0\fR\&.  Otherwise, this program exits with status code \fB\fC111\fR\&.
 .TP
-\fB\fCshow\fR [\fIFILE\fP] [\fIREGEXP\fP]
+\fB\fCshow\fR [\fIFILE\fP] [\fIPATTERN\fP]
 Use
 .BR man (1)
 to display the
 .BR roff (7)
 conversion of the leading comment header
-extracted from the given \fIFILE\fP or STDIN.  If \fIREGEXP\fP is given, search for
+extracted from the given \fIFILE\fP or STDIN.  If \fIPATTERN\fP is given, search for
 it within the output displayed by
 .BR man (1)
 and jump to first match if found.

data/man/man1/binman.1.html CHANGED Viewed

@@ -7,7 +7,7 @@
   <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>/binman.1</span></div></div><div class="container-fluid"><h1 id="binman-1-2014-06-29-3-4-0"><a name="binman-1-2014-06-29-3-4-0" href="#binman-1-2014-06-29-3-4-0" class="md2man-permalink" title="permalink"></a><span class="md2man-title">BINMAN</span> <span class="md2man-section">1</span> <span class="md2man-date">2014-06-29</span> <span class="md2man-source">3.4.0</span></h1><h2 id="name"><a name="name" href="#name" class="md2man-permalink" title="permalink"></a>NAME</h2><p>binman - man pages for bin scripts</p><h2 id="synopsis"><a name="synopsis" href="#synopsis" class="md2man-permalink" title="permalink"></a>SYNOPSIS</h2><p><code>binman</code> [<em>OPTION</em>]... <em>COMMAND</em></p><h2 id="description"><a name="description" href="#description" class="md2man-permalink" title="permalink"></a>DESCRIPTION</h2><p><a href="https://github.com/sunaku/binman">binman</a> produces UNIX manual pages for your executable scripts. It can
+<body><div class="navbar"><div class="navbar-inner"><span class="brand"><a href="../index.html#man1">man1</a>/binman.1</span></div></div><div class="container-fluid"><h1 id="binman-1-2014-07-01-3-4-1"><a name="binman-1-2014-07-01-3-4-1" href="#binman-1-2014-07-01-3-4-1" class="md2man-permalink" title="permalink"></a><span class="md2man-title">BINMAN</span> <span class="md2man-section">1</span> <span class="md2man-date">2014-07-01</span> <span class="md2man-source">3.4.1</span></h1><h2 id="name"><a name="name" href="#name" class="md2man-permalink" title="permalink"></a>NAME</h2><p>binman - man pages for bin scripts</p><h2 id="synopsis"><a name="synopsis" href="#synopsis" class="md2man-permalink" title="permalink"></a>SYNOPSIS</h2><p><code>binman</code> [<em>OPTION</em>]... <em>COMMAND</em></p><h2 id="description"><a name="description" href="#description" class="md2man-permalink" title="permalink"></a>DESCRIPTION</h2><p><a href="https://github.com/sunaku/binman">binman</a> produces UNIX manual pages for your executable scripts. It can
 extract their leading comment headers (defined below), convert them from
 <a class="md2man-reference">markdown(7)</a> into <a class="md2man-reference">roff(7)</a> using <a href="https://github.com/sunaku/md2man">md2man</a>, and display them using <a class="md2man-reference">man(1)</a>.</p><h3 id="leading-comment-headers"><a name="leading-comment-headers" href="#leading-comment-headers" class="md2man-permalink" title="permalink"></a>Leading comment headers</h3><p>A leading comment header can be one of the following two things:</p>
 <ol>
@@ -40,13 +40,13 @@ are unindented accordingly before emission as <code>.TP</code> in the <a class="
 <li>strikethrough</li>
 <li>fenced_code_blocks</li>
 </ul>
-<h2 id="options"><a name="options" href="#options" class="md2man-permalink" title="permalink"></a>OPTIONS</h2><dl><dt><code>-h</code>, <code>--help</code></dt><dd>Show this help manual.</dd></dl><h2 id="commands"><a name="commands" href="#commands" class="md2man-permalink" title="permalink"></a>COMMANDS</h2><dl><dt><code>help</code> <em>FILE</em> ... [<code>-h</code>|<code>--help</code> [<em>REGEXP</em>]] ... [<code>--</code>] ...</dt><dd>If the given argument sequence contains <code>-h</code> or <code>--help</code>, except after
-<code>--</code>, optionally followed by a <em>REGEXP</em> regular expression that specifies
+<h2 id="options"><a name="options" href="#options" class="md2man-permalink" title="permalink"></a>OPTIONS</h2><dl><dt><code>-h</code> [<em>PATTERN</em>], <code>--help</code> [<em>PATTERN</em>]</dt><dd>Show this help manual and search for <em>PATTERN</em> regular expression therein.</dd></dl><h2 id="commands"><a name="commands" href="#commands" class="md2man-permalink" title="permalink"></a>COMMANDS</h2><dl><dt><code>help</code> <em>FILE</em> ... [<code>-h</code>|<code>--help</code> [<em>PATTERN</em>]] ... [<code>--</code>] ...</dt><dd>If the given argument sequence contains <code>-h</code> or <code>--help</code>, except after
+<code>--</code>, optionally followed by a <em>PATTERN</em> regular expression that specifies
 text to search for and, if found, jump to inside the displayed man page,
 then this program extracts the given <em>FILE</em>&#39;s leading comment header,
 converts it into <a class="md2man-reference">roff(7)</a>, displays it using <a class="md2man-reference">man(1)</a>, and finally exits with
-status code <code>0</code>.  Otherwise, this program exits with status code <code>111</code>.</dd></dl><dl><dt><code>show</code> [<em>FILE</em>] [<em>REGEXP</em>]</dt><dd>Use <a class="md2man-reference">man(1)</a> to display the <a class="md2man-reference">roff(7)</a> conversion of the leading comment header
-extracted from the given <em>FILE</em> or STDIN.  If <em>REGEXP</em> is given, search for
+status code <code>0</code>.  Otherwise, this program exits with status code <code>111</code>.</dd></dl><dl><dt><code>show</code> [<em>FILE</em>] [<em>PATTERN</em>]</dt><dd>Use <a class="md2man-reference">man(1)</a> to display the <a class="md2man-reference">roff(7)</a> conversion of the leading comment header
+extracted from the given <em>FILE</em> or STDIN.  If <em>PATTERN</em> is given, search for
 it within the output displayed by <a class="md2man-reference">man(1)</a> and jump to first match if found.</dd></dl><dl><dt><code>load</code> [<em>FILE</em>]</dt><dd>Print the leading comment header extracted from the given <em>FILE</em> or STDIN.</dd></dl><dl><dt><code>dump</code> [<em>FILE</em>]</dt><dd>Print the <a class="md2man-reference">roff(7)</a> conversion of the leading comment header extracted from
 the given <em>FILE</em> or STDIN.</dd></dl><dl><dt><code>conv</code> [<em>FILE</em>]</dt><dd>Print the <a class="md2man-reference">roff(7)</a> conversion of the <a class="md2man-reference">markdown(7)</a> document read from the given
 <em>FILE</em> or STDIN.</dd></dl><h2 id="see-also"><a name="see-also" href="#see-also" class="md2man-permalink" title="permalink"></a>SEE ALSO</h2><p><a class="md2man-reference" href="../man1/binman-rake.1.html">binman-rake(1)</a>, <a class="md2man-reference">man(1)</a>, <a class="md2man-reference">roff(7)</a>, <a class="md2man-reference">markdown(7)</a></p></div></body>

metadata CHANGED Viewed

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