binman 3.4.0 → 3.4.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (16) hide show
  1. checksums.yaml +4 -4
  2. data/README.markdown +63 -2
  3. data/VERSION.markdown +18 -0
  4. data/bin/binman +7 -7
  5. data/bin/binman-rake +5 -4
  6. data/lib/binman.rb +8 -15
  7. data/lib/binman/version.rb +1 -1
  8. data/man/man0/README.html +63 -3
  9. data/man/man0/README.markdown +63 -2
  10. data/man/man0/VERSION.html +14 -3
  11. data/man/man0/VERSION.markdown +18 -0
  12. data/man/man1/binman-rake.1 +8 -5
  13. data/man/man1/binman-rake.1.html +2 -2
  14. data/man/man1/binman.1 +7 -7
  15. data/man/man1/binman.1.html +5 -5
  16. metadata +2 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 727b7b3c6721e902b36563fd5330fe05fa5707a9
4
- data.tar.gz: 94d7d927939cb06625b4423f8358370b8a69e8aa
3
+ metadata.gz: d6becc92c0aa066561bb49848c692097ac293ad0
4
+ data.tar.gz: ff7adbef6a482c095b42f99a245985022433c29c
5
5
  SHA512:
6
- metadata.gz: 96478840dc759fb9b9f62083ab9656a433d20c19be07fece5f3f4f62e55d05fa7d877fe49faddc00ba42fda7b25be693bc3404a56fcb0e84db8041a5b19d2e7b
7
- data.tar.gz: a987be972eabdcb0521ae9ba85ccd9172f4cbdfe8e72cbf7d92c300a82ab33b9c659c5b8a4d293af3214f3de39571f3a7c97baf42556f139482aa95a62b9a0ed
6
+ metadata.gz: 0a309791584f5a2abe6c74ed132a4112b6f62c0b722beca8c3b2a3066207af24e1709a32bd95708ab3104d365231a37ed72507fd9eecc64b62a885312dc3176c
7
+ data.tar.gz: fb221b25276afd2bc34fea9bbfe18d793787e8ae1eeb3ca8bf09478f9249d07f1f2aace1224ce1898ce4c0bb35c2f8244e27c848f92034b8eefb9297b0479fd3
data/README.markdown CHANGED
@@ -1,6 +1,12 @@
1
1
  # binman - man pages for bin scripts
2
2
 
3
3
  [binman] produces UNIX manual pages for executable scripts using [md2man].
4
+ Simply [document your script in Markdown][md2man-markdown] as a comment at the
5
+ top of your script and call `binman show` to display it as a UNIX manual page!
6
+ Or, call `binman help` to display your manual _only_ when your script receives
7
+ with `-h` or `--help` command-line options. Or, call `binman load` to extract
8
+ the manual from your script for your own custom processing, outside of binman.
9
+ And that's not all: [see the manual][binman-man] for even more possibilities!
4
10
 
5
11
  * Manuals: <https://sunaku.github.io/binman/man>
6
12
  * Sources: <https://github.com/sunaku/binman>
@@ -23,7 +29,61 @@
23
29
 
24
30
  ![Obligatory screen-shot of binman(1) in action!](EXAMPLE.png)
25
31
 
26
- Here is [a complete example in Ruby][binman-bin] to help you get started.
32
+ Here are some working examples of Ruby bin scripts to help you get started:
33
+
34
+ * tork(1):
35
+ [Ruby source](https://raw.github.com/sunaku/tork/master/bin/tork) &rarr;
36
+ [HTML result](https://sunaku.github.io/tork/man/man1/tork.1.html) +
37
+ [roff result](https://sunaku.github.io/tork/man/man1/tork.1)
38
+ * tork-runner(1):
39
+ [Ruby source](https://raw.github.com/sunaku/tork/master/bin/tork-runner) &rarr;
40
+ [HTML result](https://sunaku.github.io/tork/man/man1/tork-runner.1.html) +
41
+ [roff result](https://sunaku.github.io/tork/man/man1/tork-runner.1)
42
+ * tork-herald(1):
43
+ [Ruby source](https://raw.github.com/sunaku/tork/master/bin/tork-herald) &rarr;
44
+ [HTML result](https://sunaku.github.io/tork/man/man1/tork-herald.1.html) +
45
+ [roff result](https://sunaku.github.io/tork/man/man1/tork-herald.1)
46
+ * tork-driver(1):
47
+ [Ruby source](https://raw.github.com/sunaku/tork/master/bin/tork-driver) &rarr;
48
+ [HTML result](https://sunaku.github.io/tork/man/man1/tork-driver.1.html) +
49
+ [roff result](https://sunaku.github.io/tork/man/man1/tork-driver.1)
50
+ * tork-engine(1):
51
+ [Ruby source](https://raw.github.com/sunaku/tork/master/bin/tork-engine) &rarr;
52
+ [HTML result](https://sunaku.github.io/tork/man/man1/tork-engine.1.html) +
53
+ [roff result](https://sunaku.github.io/tork/man/man1/tork-engine.1)
54
+ * tork-master(1):
55
+ [Ruby source](https://raw.github.com/sunaku/tork/master/bin/tork-master) &rarr;
56
+ [HTML result](https://sunaku.github.io/tork/man/man1/tork-master.1.html) +
57
+ [roff result](https://sunaku.github.io/tork/man/man1/tork-master.1)
58
+ * tork-remote(1):
59
+ [Ruby source](https://raw.github.com/sunaku/tork/master/bin/tork-remote) &rarr;
60
+ [HTML result](https://sunaku.github.io/tork/man/man1/tork-remote.1.html) +
61
+ [roff result](https://sunaku.github.io/tork/man/man1/tork-remote.1)
62
+ * tork-notify(1):
63
+ [Ruby source](https://raw.github.com/sunaku/tork/master/bin/tork-notify) &rarr;
64
+ [HTML result](https://sunaku.github.io/tork/man/man1/tork-notify.1.html) +
65
+ [roff result](https://sunaku.github.io/tork/man/man1/tork-notify.1)
66
+ * md2man-roff(1):
67
+ [Ruby source](https://raw.github.com/sunaku/md2man/master/bin/md2man-roff) &rarr;
68
+ [HTML result](https://sunaku.github.io/md2man/man/man1/md2man-roff.1.html) +
69
+ [roff result](https://sunaku.github.io/md2man/man/man1/md2man-roff.1)
70
+ * md2man-html(1):
71
+ [Ruby source](https://raw.github.com/sunaku/md2man/master/bin/md2man-html) &rarr;
72
+ [HTML result](https://sunaku.github.io/md2man/man/man1/md2man-html.1.html) +
73
+ [roff result](https://sunaku.github.io/md2man/man/man1/md2man-html.1)
74
+ * md2man-rake(1):
75
+ [Ruby source](https://raw.github.com/sunaku/md2man/master/bin/md2man-rake) &rarr;
76
+ [HTML result](https://sunaku.github.io/md2man/man/man1/md2man-rake.1.html) +
77
+ [roff result](https://sunaku.github.io/md2man/man/man1/md2man-rake.1)
78
+ * binman(1):
79
+ [Ruby source](https://raw.github.com/sunaku/binman/master/bin/binman) &rarr;
80
+ [HTML result](https://sunaku.github.io/binman/man/man1/binman.1.html) +
81
+ [roff result](https://sunaku.github.io/binman/man/man1/binman.1)
82
+ * binman-rake(1):
83
+ [Ruby source](https://raw.github.com/sunaku/binman/master/bin/binman-rake) &rarr;
84
+ [HTML result](https://sunaku.github.io/binman/man/man1/binman-rake.1.html) +
85
+ [roff result](https://sunaku.github.io/binman/man/man1/binman-rake.1)
86
+
27
87
  For examples in other scripting languages, see the "Usage" section below!
28
88
 
29
89
  ## Installation
@@ -300,6 +360,7 @@ Released under the ISC license. See the LICENSE file for details.
300
360
 
301
361
  [roff]: http://troff.org
302
362
  [binman]: https://github.com/sunaku/binman
363
+ [binman-man]: https://sunaku.github.io/binman/man/man1/binman.1.html
303
364
  [binman-api]: http://rubydoc.info/gems/binman/frames
304
- [binman-bin]: https://raw.github.com/sunaku/binman/master/bin/binman
305
365
  [md2man]: https://github.com/sunaku/md2man
366
+ [md2man-markdown]: https://sunaku.github.io/md2man/man/man5/md2man.5.html
data/VERSION.markdown CHANGED
@@ -1,3 +1,21 @@
1
+ ## Version 3.4.1 (2014-07-01)
2
+
3
+ This release fixes the help options' REGEXP argument under non-Debian systems.
4
+
5
+ ### Patch:
6
+
7
+ * pager(1) isn't a universal command: CentOS uses `less -is` instead.
8
+
9
+ * Silence man(1) stderr when displaying dynamically extracted manual.
10
+
11
+ ### Other:
12
+
13
+ * README: add intro hook and source+result examples.
14
+
15
+ * Document REGEXP argument for help options in `bin/*`.
16
+
17
+ * Refer to REGEXP argument as PATTERN like less does.
18
+
1
19
  ## Version 3.4.0 (2014-06-29)
2
20
 
3
21
  ### Minor:
data/bin/binman CHANGED
@@ -1,7 +1,7 @@
1
1
  #!/usr/bin/env ruby
2
2
  =begin =======================================================================
3
3
 
4
- # BINMAN 1 2014-06-29 3.4.0
4
+ # BINMAN 1 2014-07-01 3.4.1
5
5
 
6
6
  ## NAME
7
7
 
@@ -59,22 +59,22 @@ The following [Redcarpet] extensions are enabled while processing markdown(7):
59
59
 
60
60
  ## OPTIONS
61
61
 
62
- `-h`, `--help`
63
- Show this help manual.
62
+ `-h` [*PATTERN*], `--help` [*PATTERN*]
63
+ Show this help manual and search for *PATTERN* regular expression therein.
64
64
 
65
65
  ## COMMANDS
66
66
 
67
- `help` *FILE* ... [`-h`|`--help` [*REGEXP*]] ... [`--`] ...
67
+ `help` *FILE* ... [`-h`|`--help` [*PATTERN*]] ... [`--`] ...
68
68
  If the given argument sequence contains `-h` or `--help`, except after
69
- `--`, optionally followed by a *REGEXP* regular expression that specifies
69
+ `--`, optionally followed by a *PATTERN* regular expression that specifies
70
70
  text to search for and, if found, jump to inside the displayed man page,
71
71
  then this program extracts the given *FILE*'s leading comment header,
72
72
  converts it into roff(7), displays it using man(1), and finally exits with
73
73
  status code `0`. Otherwise, this program exits with status code `111`.
74
74
 
75
- `show` [*FILE*] [*REGEXP*]
75
+ `show` [*FILE*] [*PATTERN*]
76
76
  Use man(1) to display the roff(7) conversion of the leading comment header
77
- extracted from the given *FILE* or STDIN. If *REGEXP* is given, search for
77
+ extracted from the given *FILE* or STDIN. If *PATTERN* is given, search for
78
78
  it within the output displayed by man(1) and jump to first match if found.
79
79
 
80
80
  `load` [*FILE*]
data/bin/binman-rake CHANGED
@@ -1,7 +1,7 @@
1
1
  #!/usr/bin/env ruby
2
2
  =begin =======================================================================
3
3
 
4
- # BINMAN-RAKE 1 2014-06-29 3.4.0
4
+ # BINMAN-RAKE 1 2014-07-01 3.4.1
5
5
 
6
6
  ## NAME
7
7
 
@@ -39,10 +39,11 @@ If no *TASK* is specified, then the `binman` task is run by default.
39
39
 
40
40
  ## OPTIONS
41
41
 
42
- `-h`, `--help`
43
- Show this help manual.
42
+ `-h` [*REGEXP*], `--help` [*REGEXP*]
43
+ Show this help manual and search for *REGEXP* regular expression therein.
44
44
 
45
- Run `rake --help` to see more options.
45
+ ...
46
+ Anything else is passed to rake(1); run `rake --help` for documentation.
46
47
 
47
48
  ## SEE ALSO
48
49
 
data/lib/binman.rb CHANGED
@@ -77,7 +77,7 @@ module BinMan
77
77
  Tempfile.open 'binman' do |temp|
78
78
  temp.write roff
79
79
  temp.close
80
- view query, temp.path
80
+ view query, temp.path, 2 => :close
81
81
  end
82
82
  rescue => error
83
83
  warn "binman: #{error}"
@@ -113,20 +113,13 @@ private
113
113
  # query (if given) within. If man(1) is not able to launch with the search
114
114
  # capability, then it tries launching man(1) without the search capability.
115
115
  def view query, *argv
116
- if query
117
- # man(1) uses `pager -s` as the pager command by default and both of the
118
- # more(1) and less(1) pagers support the "+/pattern" command-line option
119
- status = system('man', '-P', "pager -s +/#{query.shellescape}", *argv)
120
-
121
- # exit status 3 means man(1) couldn't launch with the search capability:
122
- #
123
- # man: can't execute pager: No such file or directory
124
- #
125
- # so don't return and try launching man(1) without the search capability
126
- return status unless $?.exitstatus == 3
127
- end
128
-
129
- system 'man', *argv
116
+ # man(1) defaults to `pager -s` under Debian but `less -is` under CentOS
117
+ # so try different pagers, but always fall back to using no pager at all.
118
+ # See https://www.debian-administration.org/article/246/ for pager list.
119
+ query and %w[ pager less most more ].any? do |pager|
120
+ # the `-s` and `+/pattern` options are universally supported by pagers
121
+ system 'man', '-P', "#{pager} -s +/#{query.shellescape}", *argv
122
+ end or system 'man', *argv
130
123
  end
131
124
 
132
125
  # Returns contents of given source I/O, file name, or string.
data/lib/binman/version.rb CHANGED
@@ -1,3 +1,3 @@
1
1
  module BinMan
2
- VERSION = "3.4.0"
2
+ VERSION = "3.4.1"
3
3
  end
data/man/man0/README.html CHANGED
@@ -7,7 +7,13 @@
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>/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>
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="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>.
11
+ Simply <a href="https://sunaku.github.io/md2man/man/man5/md2man.5.html">document your script in Markdown</a> as a comment at the
12
+ top of your script and call <code>binman show</code> to display it as a UNIX manual page!
13
+ Or, call <code>binman help</code> to display your manual <em>only</em> when your script receives
14
+ with <code>-h</code> or <code>--help</code> command-line options. Or, call <code>binman load</code> to extract
15
+ the manual from your script for your own custom processing, outside of binman.
16
+ 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>
11
17
  <ul>
12
18
  <li>Manuals: <a href="https://sunaku.github.io/binman/man">https://sunaku.github.io/binman/man</a></li>
13
19
  <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>
23
29
  <li><p>Individual extraction, conversion, and display commands.</p></li>
24
30
  <li><p>Implemented in roughly 150 lines of pure Ruby code! :-)</p></li>
25
31
  </ul>
26
- <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.
27
- 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>
32
+ <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>
33
+ <ul>
34
+ <li><a class="md2man-reference">tork(1)</a>:
35
+ <a href="https://raw.github.com/sunaku/tork/master/bin/tork">Ruby source</a> &rarr;
36
+ <a href="https://sunaku.github.io/tork/man/man1/tork.1.html">HTML result</a> +
37
+ <a href="https://sunaku.github.io/tork/man/man1/tork.1">roff result</a></li>
38
+ <li><a class="md2man-reference">tork-runner(1)</a>:
39
+ <a href="https://raw.github.com/sunaku/tork/master/bin/tork-runner">Ruby source</a> &rarr;
40
+ <a href="https://sunaku.github.io/tork/man/man1/tork-runner.1.html">HTML result</a> +
41
+ <a href="https://sunaku.github.io/tork/man/man1/tork-runner.1">roff result</a></li>
42
+ <li><a class="md2man-reference">tork-herald(1)</a>:
43
+ <a href="https://raw.github.com/sunaku/tork/master/bin/tork-herald">Ruby source</a> &rarr;
44
+ <a href="https://sunaku.github.io/tork/man/man1/tork-herald.1.html">HTML result</a> +
45
+ <a href="https://sunaku.github.io/tork/man/man1/tork-herald.1">roff result</a></li>
46
+ <li><a class="md2man-reference">tork-driver(1)</a>:
47
+ <a href="https://raw.github.com/sunaku/tork/master/bin/tork-driver">Ruby source</a> &rarr;
48
+ <a href="https://sunaku.github.io/tork/man/man1/tork-driver.1.html">HTML result</a> +
49
+ <a href="https://sunaku.github.io/tork/man/man1/tork-driver.1">roff result</a></li>
50
+ <li><a class="md2man-reference">tork-engine(1)</a>:
51
+ <a href="https://raw.github.com/sunaku/tork/master/bin/tork-engine">Ruby source</a> &rarr;
52
+ <a href="https://sunaku.github.io/tork/man/man1/tork-engine.1.html">HTML result</a> +
53
+ <a href="https://sunaku.github.io/tork/man/man1/tork-engine.1">roff result</a></li>
54
+ <li><a class="md2man-reference">tork-master(1)</a>:
55
+ <a href="https://raw.github.com/sunaku/tork/master/bin/tork-master">Ruby source</a> &rarr;
56
+ <a href="https://sunaku.github.io/tork/man/man1/tork-master.1.html">HTML result</a> +
57
+ <a href="https://sunaku.github.io/tork/man/man1/tork-master.1">roff result</a></li>
58
+ <li><a class="md2man-reference">tork-remote(1)</a>:
59
+ <a href="https://raw.github.com/sunaku/tork/master/bin/tork-remote">Ruby source</a> &rarr;
60
+ <a href="https://sunaku.github.io/tork/man/man1/tork-remote.1.html">HTML result</a> +
61
+ <a href="https://sunaku.github.io/tork/man/man1/tork-remote.1">roff result</a></li>
62
+ <li><a class="md2man-reference">tork-notify(1)</a>:
63
+ <a href="https://raw.github.com/sunaku/tork/master/bin/tork-notify">Ruby source</a> &rarr;
64
+ <a href="https://sunaku.github.io/tork/man/man1/tork-notify.1.html">HTML result</a> +
65
+ <a href="https://sunaku.github.io/tork/man/man1/tork-notify.1">roff result</a></li>
66
+ <li><a class="md2man-reference">md2man-roff(1)</a>:
67
+ <a href="https://raw.github.com/sunaku/md2man/master/bin/md2man-roff">Ruby source</a> &rarr;
68
+ <a href="https://sunaku.github.io/md2man/man/man1/md2man-roff.1.html">HTML result</a> +
69
+ <a href="https://sunaku.github.io/md2man/man/man1/md2man-roff.1">roff result</a></li>
70
+ <li><a class="md2man-reference">md2man-html(1)</a>:
71
+ <a href="https://raw.github.com/sunaku/md2man/master/bin/md2man-html">Ruby source</a> &rarr;
72
+ <a href="https://sunaku.github.io/md2man/man/man1/md2man-html.1.html">HTML result</a> +
73
+ <a href="https://sunaku.github.io/md2man/man/man1/md2man-html.1">roff result</a></li>
74
+ <li><a class="md2man-reference">md2man-rake(1)</a>:
75
+ <a href="https://raw.github.com/sunaku/md2man/master/bin/md2man-rake">Ruby source</a> &rarr;
76
+ <a href="https://sunaku.github.io/md2man/man/man1/md2man-rake.1.html">HTML result</a> +
77
+ <a href="https://sunaku.github.io/md2man/man/man1/md2man-rake.1">roff result</a></li>
78
+ <li><a class="md2man-reference" href="../man1/binman.1.html">binman(1)</a>:
79
+ <a href="https://raw.github.com/sunaku/binman/master/bin/binman">Ruby source</a> &rarr;
80
+ <a href="https://sunaku.github.io/binman/man/man1/binman.1.html">HTML result</a> +
81
+ <a href="https://sunaku.github.io/binman/man/man1/binman.1">roff result</a></li>
82
+ <li><a class="md2man-reference" href="../man1/binman-rake.1.html">binman-rake(1)</a>:
83
+ <a href="https://raw.github.com/sunaku/binman/master/bin/binman-rake">Ruby source</a> &rarr;
84
+ <a href="https://sunaku.github.io/binman/man/man1/binman-rake.1.html">HTML result</a> +
85
+ <a href="https://sunaku.github.io/binman/man/man1/binman-rake.1">roff result</a></li>
86
+ </ul>
87
+ <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>
28
88
  <pre><code class="sh">gem install binman
29
89
  </code></pre>
30
90
  <p>If you also want to build your own manual pages:</p>
data/man/man0/README.markdown CHANGED
@@ -1,6 +1,12 @@
1
1
  # binman - man pages for bin scripts
2
2
 
3
3
  [binman] produces UNIX manual pages for executable scripts using [md2man].
4
+ Simply [document your script in Markdown][md2man-markdown] as a comment at the
5
+ top of your script and call `binman show` to display it as a UNIX manual page!
6
+ Or, call `binman help` to display your manual _only_ when your script receives
7
+ with `-h` or `--help` command-line options. Or, call `binman load` to extract
8
+ the manual from your script for your own custom processing, outside of binman.
9
+ And that's not all: [see the manual][binman-man] for even more possibilities!
4
10
 
5
11
  * Manuals: <https://sunaku.github.io/binman/man>
6
12
  * Sources: <https://github.com/sunaku/binman>
@@ -23,7 +29,61 @@
23
29
 
24
30
  ![Obligatory screen-shot of binman(1) in action!](EXAMPLE.png)
25
31
 
26
- Here is [a complete example in Ruby][binman-bin] to help you get started.
32
+ Here are some working examples of Ruby bin scripts to help you get started:
33
+
34
+ * tork(1):
35
+ [Ruby source](https://raw.github.com/sunaku/tork/master/bin/tork) &rarr;
36
+ [HTML result](https://sunaku.github.io/tork/man/man1/tork.1.html) +
37
+ [roff result](https://sunaku.github.io/tork/man/man1/tork.1)
38
+ * tork-runner(1):
39
+ [Ruby source](https://raw.github.com/sunaku/tork/master/bin/tork-runner) &rarr;
40
+ [HTML result](https://sunaku.github.io/tork/man/man1/tork-runner.1.html) +
41
+ [roff result](https://sunaku.github.io/tork/man/man1/tork-runner.1)
42
+ * tork-herald(1):
43
+ [Ruby source](https://raw.github.com/sunaku/tork/master/bin/tork-herald) &rarr;
44
+ [HTML result](https://sunaku.github.io/tork/man/man1/tork-herald.1.html) +
45
+ [roff result](https://sunaku.github.io/tork/man/man1/tork-herald.1)
46
+ * tork-driver(1):
47
+ [Ruby source](https://raw.github.com/sunaku/tork/master/bin/tork-driver) &rarr;
48
+ [HTML result](https://sunaku.github.io/tork/man/man1/tork-driver.1.html) +
49
+ [roff result](https://sunaku.github.io/tork/man/man1/tork-driver.1)
50
+ * tork-engine(1):
51
+ [Ruby source](https://raw.github.com/sunaku/tork/master/bin/tork-engine) &rarr;
52
+ [HTML result](https://sunaku.github.io/tork/man/man1/tork-engine.1.html) +
53
+ [roff result](https://sunaku.github.io/tork/man/man1/tork-engine.1)
54
+ * tork-master(1):
55
+ [Ruby source](https://raw.github.com/sunaku/tork/master/bin/tork-master) &rarr;
56
+ [HTML result](https://sunaku.github.io/tork/man/man1/tork-master.1.html) +
57
+ [roff result](https://sunaku.github.io/tork/man/man1/tork-master.1)
58
+ * tork-remote(1):
59
+ [Ruby source](https://raw.github.com/sunaku/tork/master/bin/tork-remote) &rarr;
60
+ [HTML result](https://sunaku.github.io/tork/man/man1/tork-remote.1.html) +
61
+ [roff result](https://sunaku.github.io/tork/man/man1/tork-remote.1)
62
+ * tork-notify(1):
63
+ [Ruby source](https://raw.github.com/sunaku/tork/master/bin/tork-notify) &rarr;
64
+ [HTML result](https://sunaku.github.io/tork/man/man1/tork-notify.1.html) +
65
+ [roff result](https://sunaku.github.io/tork/man/man1/tork-notify.1)
66
+ * md2man-roff(1):
67
+ [Ruby source](https://raw.github.com/sunaku/md2man/master/bin/md2man-roff) &rarr;
68
+ [HTML result](https://sunaku.github.io/md2man/man/man1/md2man-roff.1.html) +
69
+ [roff result](https://sunaku.github.io/md2man/man/man1/md2man-roff.1)
70
+ * md2man-html(1):
71
+ [Ruby source](https://raw.github.com/sunaku/md2man/master/bin/md2man-html) &rarr;
72
+ [HTML result](https://sunaku.github.io/md2man/man/man1/md2man-html.1.html) +
73
+ [roff result](https://sunaku.github.io/md2man/man/man1/md2man-html.1)
74
+ * md2man-rake(1):
75
+ [Ruby source](https://raw.github.com/sunaku/md2man/master/bin/md2man-rake) &rarr;
76
+ [HTML result](https://sunaku.github.io/md2man/man/man1/md2man-rake.1.html) +
77
+ [roff result](https://sunaku.github.io/md2man/man/man1/md2man-rake.1)
78
+ * binman(1):
79
+ [Ruby source](https://raw.github.com/sunaku/binman/master/bin/binman) &rarr;
80
+ [HTML result](https://sunaku.github.io/binman/man/man1/binman.1.html) +
81
+ [roff result](https://sunaku.github.io/binman/man/man1/binman.1)
82
+ * binman-rake(1):
83
+ [Ruby source](https://raw.github.com/sunaku/binman/master/bin/binman-rake) &rarr;
84
+ [HTML result](https://sunaku.github.io/binman/man/man1/binman-rake.1.html) +
85
+ [roff result](https://sunaku.github.io/binman/man/man1/binman-rake.1)
86
+
27
87
  For examples in other scripting languages, see the "Usage" section below!
28
88
 
29
89
  ## Installation
@@ -300,6 +360,7 @@ Released under the ISC license. See the LICENSE file for details.
300
360
 
301
361
  [roff]: http://troff.org
302
362
  [binman]: https://github.com/sunaku/binman
363
+ [binman-man]: https://sunaku.github.io/binman/man/man1/binman.1.html
303
364
  [binman-api]: http://rubydoc.info/gems/binman/frames
304
- [binman-bin]: https://raw.github.com/sunaku/binman/master/bin/binman
305
365
  [md2man]: https://github.com/sunaku/md2man
366
+ [md2man-markdown]: https://sunaku.github.io/md2man/man/man5/md2man.5.html
data/man/man0/VERSION.html CHANGED
@@ -7,18 +7,29 @@
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-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>
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-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>
11
+ <ul>
12
+ <li><p><a class="md2man-reference">pager(1)</a> isn&#39;t a universal command: CentOS uses <code>less -is</code> instead.</p></li>
13
+ <li><p>Silence <a class="md2man-reference">man(1)</a> stderr when displaying dynamically extracted manual.</p></li>
14
+ </ul>
15
+ <h3 id="other"><a name="other" href="#other" class="md2man-permalink" title="permalink"></a>Other:</h3>
16
+ <ul>
17
+ <li><p>README: add intro hook and source+result examples.</p></li>
18
+ <li><p>Document REGEXP argument for help options in <code>bin/*</code>.</p></li>
19
+ <li><p>Refer to REGEXP argument as PATTERN like less does.</p></li>
20
+ </ul>
21
+ <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>
11
22
  <ul>
12
23
  <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
13
24
  followed by a regular expression argument that specifies text to search
14
25
  for and, if found, jump to inside the displayed UNIX man page. Such a
15
26
  regular expression argument can now also be passed into <code>BinMan.show()</code>.</p></li>
16
27
  </ul>
17
- <h3 id="other"><a name="other" href="#other" class="md2man-permalink" title="permalink"></a>Other:</h3>
28
+ <h3 id="other-1"><a name="other-1" href="#other-1" class="md2man-permalink" title="permalink"></a>Other:</h3>
18
29
  <ul>
19
30
  <li>README: add syntax highlighting to code snippets.</li>
20
31
  </ul>
21
- <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>
32
+ <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>
22
33
  <ul>
23
34
  <li><p>README: add links to package, manuals, and GitHub.</p></li>
24
35
  <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
@@ -1,3 +1,21 @@
1
+ ## Version 3.4.1 (2014-07-01)
2
+
3
+ This release fixes the help options' REGEXP argument under non-Debian systems.
4
+
5
+ ### Patch:
6
+
7
+ * pager(1) isn't a universal command: CentOS uses `less -is` instead.
8
+
9
+ * Silence man(1) stderr when displaying dynamically extracted manual.
10
+
11
+ ### Other:
12
+
13
+ * README: add intro hook and source+result examples.
14
+
15
+ * Document REGEXP argument for help options in `bin/*`.
16
+
17
+ * Refer to REGEXP argument as PATTERN like less does.
18
+
1
19
  ## Version 3.4.0 (2014-06-29)
2
20
 
3
21
  ### Minor:
data/man/man1/binman-rake.1 CHANGED
@@ -1,4 +1,4 @@
1
- .TH BINMAN\-RAKE 1 2014\-06\-29 3.4.0
1
+ .TH BINMAN\-RAKE 1 2014\-07\-01 3.4.1
2
2
  .SH NAME
3
3
  .PP
4
4
  binman\-rake \- run
@@ -46,10 +46,13 @@ builds HTML manual pages from \fB\fC*.markdown\fR, \fB\fC*.mkd\fR, and \fB\fC*.m
46
46
  found in or beneath the \fB\fCman/\fR subdirectory in your working directory.
47
47
  .SH OPTIONS
48
48
  .TP
49
- \fB\fC\-h\fR, \fB\fC\-\-help\fR
50
- Show this help manual.
51
- .PP
52
- Run \fB\fCrake \-\-help\fR to see more options.
49
+ \fB\fC\-h\fR [\fIREGEXP\fP], \fB\fC\-\-help\fR [\fIREGEXP\fP]
50
+ Show this help manual and search for \fIREGEXP\fP regular expression therein.
51
+ .TP
52
+ \&...
53
+ Anything else is passed to
54
+ .BR rake (1);
55
+ run \fB\fCrake \-\-help\fR for documentation.
53
56
  .SH SEE ALSO
54
57
  .PP
55
58
  .BR rake (1),
data/man/man1/binman-rake.1.html CHANGED
@@ -7,7 +7,7 @@
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>/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
10
+ <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
11
11
  to create a special file named <code>Rakefile</code> that contains the following snippet:</p>
12
12
  <pre><code>require &#39;binman/rakefile&#39;
13
13
  </code></pre>
@@ -17,5 +17,5 @@ builds UNIX manual pages from <code>*.markdown</code>, <code>*.mkd</code>, and <
17
17
  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.
18
18
  It also runs the <code>md2man:web</code> task, provided by <a class="md2man-reference">md2man-rake(1)</a>, which
19
19
  builds HTML manual pages from <code>*.markdown</code>, <code>*.mkd</code>, and <code>*.md</code> files
20
- 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>
20
+ 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>
21
21
  </html>
data/man/man1/binman.1 CHANGED
@@ -1,4 +1,4 @@
1
- .TH BINMAN 1 2014\-06\-29 3.4.0
1
+ .TH BINMAN 1 2014\-07\-01 3.4.1
2
2
  .SH NAME
3
3
  .PP
4
4
  binman \- man pages for bin scripts
@@ -84,13 +84,13 @@ fenced_code_blocks
84
84
  .RE
85
85
  .SH OPTIONS
86
86
  .TP
87
- \fB\fC\-h\fR, \fB\fC\-\-help\fR
88
- Show this help manual.
87
+ \fB\fC\-h\fR [\fIPATTERN\fP], \fB\fC\-\-help\fR [\fIPATTERN\fP]
88
+ Show this help manual and search for \fIPATTERN\fP regular expression therein.
89
89
  .SH COMMANDS
90
90
  .TP
91
- \fB\fChelp\fR \fIFILE\fP ... [\fB\fC\-h\fR|\fB\fC\-\-help\fR [\fIREGEXP\fP]] ... [\fB\fC\-\-\fR] ...
91
+ \fB\fChelp\fR \fIFILE\fP ... [\fB\fC\-h\fR|\fB\fC\-\-help\fR [\fIPATTERN\fP]] ... [\fB\fC\-\-\fR] ...
92
92
  If the given argument sequence contains \fB\fC\-h\fR or \fB\fC\-\-help\fR, except after
93
- \fB\fC\-\-\fR, optionally followed by a \fIREGEXP\fP regular expression that specifies
93
+ \fB\fC\-\-\fR, optionally followed by a \fIPATTERN\fP regular expression that specifies
94
94
  text to search for and, if found, jump to inside the displayed man page,
95
95
  then this program extracts the given \fIFILE\fP\&'s leading comment header,
96
96
  converts it into
@@ -100,13 +100,13 @@ displays it using
100
100
  and finally exits with
101
101
  status code \fB\fC0\fR\&. Otherwise, this program exits with status code \fB\fC111\fR\&.
102
102
  .TP
103
- \fB\fCshow\fR [\fIFILE\fP] [\fIREGEXP\fP]
103
+ \fB\fCshow\fR [\fIFILE\fP] [\fIPATTERN\fP]
104
104
  Use
105
105
  .BR man (1)
106
106
  to display the
107
107
  .BR roff (7)
108
108
  conversion of the leading comment header
109
- extracted from the given \fIFILE\fP or STDIN. If \fIREGEXP\fP is given, search for
109
+ extracted from the given \fIFILE\fP or STDIN. If \fIPATTERN\fP is given, search for
110
110
  it within the output displayed by
111
111
  .BR man (1)
112
112
  and jump to first match if found.
data/man/man1/binman.1.html CHANGED
@@ -7,7 +7,7 @@
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>/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
10
+ <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
11
11
  extract their leading comment headers (defined below), convert them from
12
12
  <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>
13
13
  <ol>
@@ -40,13 +40,13 @@ are unindented accordingly before emission as <code>.TP</code> in the <a class="
40
40
  <li>strikethrough</li>
41
41
  <li>fenced_code_blocks</li>
42
42
  </ul>
43
- <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
44
- <code>--</code>, optionally followed by a <em>REGEXP</em> regular expression that specifies
43
+ <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
44
+ <code>--</code>, optionally followed by a <em>PATTERN</em> regular expression that specifies
45
45
  text to search for and, if found, jump to inside the displayed man page,
46
46
  then this program extracts the given <em>FILE</em>&#39;s leading comment header,
47
47
  converts it into <a class="md2man-reference">roff(7)</a>, displays it using <a class="md2man-reference">man(1)</a>, and finally exits with
48
- 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
49
- extracted from the given <em>FILE</em> or STDIN. If <em>REGEXP</em> is given, search for
48
+ 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
49
+ extracted from the given <em>FILE</em> or STDIN. If <em>PATTERN</em> is given, search for
50
50
  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
51
51
  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
52
52
  <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
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: binman
3
3
  version: !ruby/object:Gem::Version
4
- version: 3.4.0
4
+ version: 3.4.1
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: 2014-06-29 00:00:00.000000000 Z
11
+ date: 2014-07-02 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: md2man