binman 3.4.1 → 4.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.markdown +70 -60
- data/VERSION.markdown +13 -0
- data/bin/binman +14 -18
- data/bin/binman-rake +1 -1
- data/binman.gemspec +1 -1
- data/lib/binman.rb +12 -19
- data/lib/binman/rakefile.rb +1 -3
- data/lib/binman/version.rb +1 -1
- data/man/index.html +1 -1
- data/man/man0/README.html +87 -104
- data/man/man0/README.markdown +70 -60
- data/man/man0/VERSION.html +14 -6
- data/man/man0/VERSION.markdown +13 -0
- data/man/man1/binman-rake.1 +1 -1
- data/man/man1/binman-rake.1.html +3 -4
- data/man/man1/binman.1 +23 -36
- data/man/man1/binman.1.html +7 -8
- data/man/style.css +1 -1
- metadata +4 -4
data/man/man0/README.markdown
CHANGED
|
@@ -4,9 +4,9 @@
|
|
|
4
4
|
Simply [document your script in Markdown][md2man-markdown] as a comment at the
|
|
5
5
|
top of your script and call `binman show` to display it as a UNIX manual page!
|
|
6
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
|
|
7
|
+
with `-h` or `--help` command-line options. Or, call `binman snip` to extract
|
|
8
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
|
|
9
|
+
And that's not all: [see the manual page][binman-man] for more possibilities!
|
|
10
10
|
|
|
11
11
|
* Manuals: <https://sunaku.github.io/binman/man>
|
|
12
12
|
* Sources: <https://github.com/sunaku/binman>
|
|
@@ -29,62 +29,72 @@ And that's not all: [see the manual][binman-man] for even more possibilities!
|
|
|
29
29
|
|
|
30
30
|
|
|
31
31
|
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
[
|
|
38
|
-
|
|
39
|
-
[
|
|
40
|
-
|
|
41
|
-
[
|
|
42
|
-
|
|
43
|
-
[
|
|
44
|
-
|
|
45
|
-
[
|
|
46
|
-
|
|
47
|
-
[
|
|
48
|
-
|
|
49
|
-
[
|
|
50
|
-
|
|
51
|
-
[
|
|
52
|
-
|
|
53
|
-
[
|
|
54
|
-
|
|
55
|
-
[
|
|
56
|
-
|
|
57
|
-
[
|
|
58
|
-
|
|
59
|
-
[
|
|
60
|
-
|
|
61
|
-
[
|
|
62
|
-
|
|
63
|
-
[
|
|
64
|
-
|
|
65
|
-
[
|
|
66
|
-
|
|
67
|
-
[
|
|
68
|
-
|
|
69
|
-
[roff
|
|
70
|
-
|
|
71
|
-
[
|
|
72
|
-
|
|
73
|
-
[
|
|
74
|
-
|
|
75
|
-
[
|
|
76
|
-
|
|
77
|
-
[
|
|
78
|
-
|
|
79
|
-
[
|
|
80
|
-
|
|
81
|
-
[
|
|
82
|
-
|
|
83
|
-
[
|
|
84
|
-
|
|
85
|
-
[
|
|
86
|
-
|
|
87
|
-
|
|
32
|
+
#### What can binman(1) do?
|
|
33
|
+
|
|
34
|
+
Here are some real examples of processed bin scripts to help you get started:
|
|
35
|
+
|
|
36
|
+
* [bin/tork](https://raw.github.com/sunaku/tork/master/bin/tork) ⇒
|
|
37
|
+
[tork.1.markdown](https://sunaku.github.io/tork/man/man1/tork.1.markdown) ⇒
|
|
38
|
+
[tork.1](https://sunaku.github.io/tork/man/man1/tork.1) +
|
|
39
|
+
[tork.1.html](https://sunaku.github.io/tork/man/man1/tork.1.html)
|
|
40
|
+
* [bin/tork-runner](https://raw.github.com/sunaku/tork/master/bin/tork-runner) ⇒
|
|
41
|
+
[tork-runner.1.markdown](https://sunaku.github.io/tork/man/man1/tork-runner.1.markdown) ⇒
|
|
42
|
+
[tork-runner.1](https://sunaku.github.io/tork/man/man1/tork-runner.1) +
|
|
43
|
+
[tork-runner.1.html](https://sunaku.github.io/tork/man/man1/tork-runner.1.html)
|
|
44
|
+
* [bin/tork-herald](https://raw.github.com/sunaku/tork/master/bin/tork-herald) ⇒
|
|
45
|
+
[tork-herald.1.markdown](https://sunaku.github.io/tork/man/man1/tork-herald.1.markdown) ⇒
|
|
46
|
+
[tork-herald.1](https://sunaku.github.io/tork/man/man1/tork-herald.1) +
|
|
47
|
+
[tork-herald.1.html](https://sunaku.github.io/tork/man/man1/tork-herald.1.html)
|
|
48
|
+
* [bin/tork-driver](https://raw.github.com/sunaku/tork/master/bin/tork-driver) ⇒
|
|
49
|
+
[tork-driver.1.markdown](https://sunaku.github.io/tork/man/man1/tork-driver.1.markdown) ⇒
|
|
50
|
+
[tork-driver.1](https://sunaku.github.io/tork/man/man1/tork-driver.1) +
|
|
51
|
+
[tork-driver.1.html](https://sunaku.github.io/tork/man/man1/tork-driver.1.html)
|
|
52
|
+
* [bin/tork-engine](https://raw.github.com/sunaku/tork/master/bin/tork-engine) ⇒
|
|
53
|
+
[tork-engine.1.markdown](https://sunaku.github.io/tork/man/man1/tork-engine.1.markdown) ⇒
|
|
54
|
+
[tork-engine.1](https://sunaku.github.io/tork/man/man1/tork-engine.1) +
|
|
55
|
+
[tork-engine.1.html](https://sunaku.github.io/tork/man/man1/tork-engine.1.html)
|
|
56
|
+
* [bin/tork-master](https://raw.github.com/sunaku/tork/master/bin/tork-master) ⇒
|
|
57
|
+
[tork-master.1.markdown](https://sunaku.github.io/tork/man/man1/tork-master.1.markdown) ⇒
|
|
58
|
+
[tork-master.1](https://sunaku.github.io/tork/man/man1/tork-master.1) +
|
|
59
|
+
[tork-master.1.html](https://sunaku.github.io/tork/man/man1/tork-master.1.html)
|
|
60
|
+
* [bin/tork-remote](https://raw.github.com/sunaku/tork/master/bin/tork-remote) ⇒
|
|
61
|
+
[tork-remote.1.markdown](https://sunaku.github.io/tork/man/man1/tork-remote.1.markdown) ⇒
|
|
62
|
+
[tork-remote.1](https://sunaku.github.io/tork/man/man1/tork-remote.1) +
|
|
63
|
+
[tork-remote.1.html](https://sunaku.github.io/tork/man/man1/tork-remote.1.html)
|
|
64
|
+
* [bin/tork-notify](https://raw.github.com/sunaku/tork/master/bin/tork-notify) ⇒
|
|
65
|
+
[tork-notify.1.markdown](https://sunaku.github.io/tork/man/man1/tork-notify.1.markdown) ⇒
|
|
66
|
+
[tork-notify.1](https://sunaku.github.io/tork/man/man1/tork-notify.1) +
|
|
67
|
+
[tork-notify.1.html](https://sunaku.github.io/tork/man/man1/tork-notify.1.html)
|
|
68
|
+
* [bin/md2man-roff](https://raw.github.com/sunaku/md2man/master/bin/md2man-roff) ⇒
|
|
69
|
+
[md2man-roff.1.markdown](https://sunaku.github.io/md2man/man/man1/md2man-roff.1.markdown) ⇒
|
|
70
|
+
[md2man-roff.1](https://sunaku.github.io/md2man/man/man1/md2man-roff.1) +
|
|
71
|
+
[md2man-roff.1.html](https://sunaku.github.io/md2man/man/man1/md2man-roff.1.html)
|
|
72
|
+
* [bin/md2man-html](https://raw.github.com/sunaku/md2man/master/bin/md2man-html) ⇒
|
|
73
|
+
[md2man-html.1.markdown](https://sunaku.github.io/md2man/man/man1/md2man-html.1.markdown) ⇒
|
|
74
|
+
[md2man-html.1](https://sunaku.github.io/md2man/man/man1/md2man-html.1) +
|
|
75
|
+
[md2man-html.1.html](https://sunaku.github.io/md2man/man/man1/md2man-html.1.html)
|
|
76
|
+
* [bin/md2man-rake](https://raw.github.com/sunaku/md2man/master/bin/md2man-rake) ⇒
|
|
77
|
+
[md2man-rake.1.markdown](https://sunaku.github.io/md2man/man/man1/md2man-rake.1.markdown) ⇒
|
|
78
|
+
[md2man-rake.1](https://sunaku.github.io/md2man/man/man1/md2man-rake.1) +
|
|
79
|
+
[md2man-rake.1.html](https://sunaku.github.io/md2man/man/man1/md2man-rake.1.html)
|
|
80
|
+
* [bin/binman](https://raw.github.com/sunaku/binman/master/bin/binman) ⇒
|
|
81
|
+
[binman.1.markdown](https://sunaku.github.io/binman/man/man1/binman.1.markdown) ⇒
|
|
82
|
+
[binman.1](https://sunaku.github.io/binman/man/man1/binman.1) +
|
|
83
|
+
[binman.1.html](https://sunaku.github.io/binman/man/man1/binman.1.html)
|
|
84
|
+
* [bin/binman-rake](https://raw.github.com/sunaku/binman/master/bin/binman-rake) ⇒
|
|
85
|
+
[binman-rake.1.markdown](https://sunaku.github.io/binman/man/man1/binman-rake.1.markdown) ⇒
|
|
86
|
+
[binman-rake.1](https://sunaku.github.io/binman/man/man1/binman-rake.1) +
|
|
87
|
+
[binman-rake.1.html](https://sunaku.github.io/binman/man/man1/binman-rake.1.html)
|
|
88
|
+
|
|
89
|
+
For examples in even more scripting languages, see the "Usage" section below!
|
|
90
|
+
|
|
91
|
+
#### What can binman-rake(1) do?
|
|
92
|
+
|
|
93
|
+
Here are some examples of HTML manual _sets_ produced by binman-rake(1):
|
|
94
|
+
|
|
95
|
+
* https://sunaku.github.io/tork/man
|
|
96
|
+
* https://sunaku.github.io/binman/man
|
|
97
|
+
* https://sunaku.github.io/md2man/man
|
|
88
98
|
|
|
89
99
|
## Installation
|
|
90
100
|
|
|
@@ -97,7 +107,7 @@ gem install binman
|
|
|
97
107
|
If you also want to build your own manual pages:
|
|
98
108
|
|
|
99
109
|
```sh
|
|
100
|
-
gem install md2man -v '~>
|
|
110
|
+
gem install md2man -v '~> 4.0'
|
|
101
111
|
```
|
|
102
112
|
|
|
103
113
|
### Prerequisites
|
|
@@ -332,7 +342,7 @@ Add this snippet to your gemspec file:
|
|
|
332
342
|
```ruby
|
|
333
343
|
s.files += Dir['man/man?/*.?'] # UNIX man pages
|
|
334
344
|
s.files += Dir['man/**/*.{html,css,js}'] # HTML man pages
|
|
335
|
-
s.add_development_dependency 'md2man', '~>
|
|
345
|
+
s.add_development_dependency 'md2man', '~> 4.0'
|
|
336
346
|
```
|
|
337
347
|
|
|
338
348
|
Add the following line to your Rakefile:
|
data/man/man0/VERSION.html
CHANGED
|
@@ -2,12 +2,22 @@
|
|
|
2
2
|
<html>
|
|
3
3
|
<head>
|
|
4
4
|
<meta charset="utf-8" />
|
|
5
|
-
<meta name="generator" content="md2man
|
|
5
|
+
<meta name="generator" content="md2man 4.0.0 https://github.com/sunaku/md2man" />
|
|
6
6
|
<title>VERSION</title>
|
|
7
7
|
<link rel="stylesheet" href="../style.css"/>
|
|
8
8
|
<!--[if lt IE 9]><script src="http://html5shiv.googlecode.com/svn/trunk/html5.js"></script><![endif]-->
|
|
9
9
|
</head>
|
|
10
|
-
<body><div class="navbar"><div class="navbar-inner"><span class="brand"><a href="../index.html#man0">man0</a>/VERSION</span></div></div><div class="container-fluid"><h2 id="version-
|
|
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-4-0-0-2014-10-26"><a name="version-4-0-0-2014-10-26" href="#version-4-0-0-2014-10-26" class="md2man-permalink" title="permalink"></a>Version 4.0.0 (2014-10-26)</h2><h3 id="major"><a name="major" href="#major" class="md2man-permalink" title="permalink"></a>Major:</h3>
|
|
11
|
+
<ul>
|
|
12
|
+
<li><p><a class="md2man-reference" href="../man1/binman.1.html">binman(1)</a>: Rename the <code>load</code> command to <code>snip</code> and remove <code>conv</code>.</p>
|
|
13
|
+
<ul>
|
|
14
|
+
<li>The <code>binman conv</code> command has been removed; use <code>md2man-roff</code> instead.</li>
|
|
15
|
+
<li>We no longer require a specific md2man version at runtime; any will do.</li>
|
|
16
|
+
</ul></li>
|
|
17
|
+
<li><p>Upgrade to md2man 4.0, which no longer expands cross references in code
|
|
18
|
+
spans and code blocks. Your manuals might be rendered differently now.</p></li>
|
|
19
|
+
</ul>
|
|
20
|
+
<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' REGEXP argument under non-Debian systems.</p><h3 id="patch"><a name="patch" href="#patch" class="md2man-permalink" title="permalink"></a>Patch:</h3>
|
|
11
21
|
<ul>
|
|
12
22
|
<li><p><a class="md2man-reference">pager(1)</a> isn't a universal command: CentOS uses <code>less -is</code> instead.</p></li>
|
|
13
23
|
<li><p>Silence <a class="md2man-reference">man(1)</a> stderr when displaying dynamically extracted manual.</p></li>
|
|
@@ -37,8 +47,7 @@ regular expression argument can now also be passed into <code>BinMan.show()</cod
|
|
|
37
47
|
</ul>
|
|
38
48
|
<h2 id="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>Version 3.3.2 (2013-08-30)</h2><p>Patch:</p>
|
|
39
49
|
<ul>
|
|
40
|
-
<li><p>Rescue error when designated opener is not found:</p
|
|
41
|
-
<pre><code>$ binman -h
|
|
50
|
+
<li><p>Rescue error when designated opener is not found:</p><pre><code>$ binman -h
|
|
42
51
|
/gems/opener-0.1.0/lib/opener.rb:97:in `spawn': No such file or directory - xdg-open (Errno::ENOENT)
|
|
43
52
|
from /gems/opener-0.1.0/lib/opener.rb:97:in `spawn'
|
|
44
53
|
from /gems/binman-3.3.1/lib/binman.rb:57:in `block in show'
|
|
@@ -49,8 +58,7 @@ regular expression argument can now also be passed into <code>BinMan.show()</cod
|
|
|
49
58
|
from /bin/binman:23:in `load'
|
|
50
59
|
from /bin/binman:23:in `<main>'
|
|
51
60
|
</code></pre></li>
|
|
52
|
-
<li><p>Fix an undefined local variable or method error:</p>
|
|
53
|
-
<pre><code>binman: undefined local variable or method `library' for BinMan:Module
|
|
61
|
+
<li><p>Fix an undefined local variable or method error:</p><pre><code>binman: undefined local variable or method `library' for BinMan:Module
|
|
54
62
|
</code></pre></li>
|
|
55
63
|
</ul>
|
|
56
64
|
<p>Other:</p>
|
data/man/man0/VERSION.markdown
CHANGED
|
@@ -1,3 +1,16 @@
|
|
|
1
|
+
## Version 4.0.0 (2014-10-26)
|
|
2
|
+
|
|
3
|
+
### Major:
|
|
4
|
+
|
|
5
|
+
* binman(1): Rename the `load` command to `snip` and remove `conv`.
|
|
6
|
+
|
|
7
|
+
* The `binman conv` command has been removed; use `md2man-roff` instead.
|
|
8
|
+
|
|
9
|
+
* We no longer require a specific md2man version at runtime; any will do.
|
|
10
|
+
|
|
11
|
+
* Upgrade to md2man 4.0, which no longer expands cross references in code
|
|
12
|
+
spans and code blocks. Your manuals might be rendered differently now.
|
|
13
|
+
|
|
1
14
|
## Version 3.4.1 (2014-07-01)
|
|
2
15
|
|
|
3
16
|
This release fixes the help options' REGEXP argument under non-Debian systems.
|
data/man/man1/binman-rake.1
CHANGED
data/man/man1/binman-rake.1.html
CHANGED
|
@@ -2,14 +2,13 @@
|
|
|
2
2
|
<html>
|
|
3
3
|
<head>
|
|
4
4
|
<meta charset="utf-8" />
|
|
5
|
-
<meta name="generator" content="md2man
|
|
5
|
+
<meta name="generator" content="md2man 4.0.0 https://github.com/sunaku/md2man" />
|
|
6
6
|
<title>binman-rake(1) — run rake(1) tasks from binman(1)</title>
|
|
7
7
|
<link rel="stylesheet" href="../style.css"/>
|
|
8
8
|
<!--[if lt IE 9]><script src="http://html5shiv.googlecode.com/svn/trunk/html5.js"></script><![endif]-->
|
|
9
9
|
</head>
|
|
10
|
-
<body><div class="navbar"><div class="navbar-inner"><span class="brand"><a href="../index.html#man1">man1</a>/binman-rake.1</span></div></div><div class="container-fluid"><h1 id="binman-rake-1-2014-
|
|
11
|
-
to create a special file named <code>Rakefile</code> that contains the following snippet:</p>
|
|
12
|
-
<pre><code>require 'binman/rakefile'
|
|
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-10-26-4-0-0"><a name="binman-rake-1-2014-10-26-4-0-0" href="#binman-rake-1-2014-10-26-4-0-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-10-26</span> <span class="md2man-source">4.0.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
|
|
11
|
+
to create a special file named <code>Rakefile</code> that contains the following snippet:</p><pre><code>require 'binman/rakefile'
|
|
13
12
|
</code></pre>
|
|
14
13
|
<p>If no <em>TASK</em> is specified, then the <code>binman</code> task is run by default.</p><h2 id="tasks"><a name="tasks" href="#tasks" class="md2man-permalink" title="permalink"></a>TASKS</h2><dl><dt><code>binman</code></dt><dd>Runs the <code>binman:man</code> and <code>binman:web</code> tasks, in that order.</dd></dl><dl><dt><code>binman:man</code></dt><dd>Builds UNIX manual pages from scripts found in your <code>bin/</code> directory.
|
|
15
14
|
It also runs the <code>md2man:man</code> task, provided by <a class="md2man-reference">md2man-rake(1)</a>, which
|
data/man/man1/binman.1
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
.TH BINMAN 1 2014\-
|
|
1
|
+
.TH BINMAN 1 2014\-10\-26 4.0.0
|
|
2
2
|
.SH NAME
|
|
3
3
|
.PP
|
|
4
4
|
binman \- man pages for bin scripts
|
|
@@ -8,16 +8,13 @@ binman \- man pages for bin scripts
|
|
|
8
8
|
.SH DESCRIPTION
|
|
9
9
|
.PP
|
|
10
10
|
binman
|
|
11
|
-
|
|
12
|
-
.UE
|
|
13
|
-
produces UNIX manual pages for your executable scripts. It can
|
|
11
|
+
\[la]https://github.com/sunaku/binman\[ra] produces UNIX manual pages for your executable scripts. It can
|
|
14
12
|
extract their leading comment headers (defined below), convert them from
|
|
15
13
|
.BR markdown (7)
|
|
16
14
|
into
|
|
17
15
|
.BR roff (7)
|
|
18
16
|
using md2man
|
|
19
|
-
|
|
20
|
-
.UE , and display them using
|
|
17
|
+
\[la]https://github.com/sunaku/md2man\[ra], and display them using
|
|
21
18
|
.BR man (1).
|
|
22
19
|
.SS Leading comment headers
|
|
23
20
|
.PP
|
|
@@ -66,9 +63,7 @@ output.
|
|
|
66
63
|
.SS Markdown processing extensions
|
|
67
64
|
.PP
|
|
68
65
|
The following Redcarpet
|
|
69
|
-
|
|
70
|
-
.UE
|
|
71
|
-
extensions are enabled while processing
|
|
66
|
+
\[la]https://github.com/vmg/redcarpet\[ra] extensions are enabled while processing
|
|
72
67
|
.BR markdown (7):
|
|
73
68
|
.RS
|
|
74
69
|
.IP \(bu 2
|
|
@@ -88,17 +83,14 @@ fenced_code_blocks
|
|
|
88
83
|
Show this help manual and search for \fIPATTERN\fP regular expression therein.
|
|
89
84
|
.SH COMMANDS
|
|
90
85
|
.TP
|
|
91
|
-
\fB\
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
.BR man (1),
|
|
100
|
-
and finally exits with
|
|
101
|
-
status code \fB\fC0\fR\&. Otherwise, this program exits with status code \fB\fC111\fR\&.
|
|
86
|
+
\fB\fCsnip\fR [\fIFILE\fP]
|
|
87
|
+
Print the leading comment header extracted from the given \fIFILE\fP or STDIN.
|
|
88
|
+
.TP
|
|
89
|
+
\fB\fCdump\fR [\fIFILE\fP]
|
|
90
|
+
Print the
|
|
91
|
+
.BR roff (7)
|
|
92
|
+
conversion of the leading comment header extracted from
|
|
93
|
+
the given \fIFILE\fP or STDIN.
|
|
102
94
|
.TP
|
|
103
95
|
\fB\fCshow\fR [\fIFILE\fP] [\fIPATTERN\fP]
|
|
104
96
|
Use
|
|
@@ -111,22 +103,17 @@ it within the output displayed by
|
|
|
111
103
|
.BR man (1)
|
|
112
104
|
and jump to first match if found.
|
|
113
105
|
.TP
|
|
114
|
-
\fB\
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
.
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
.BR roff (7)
|
|
126
|
-
conversion of the
|
|
127
|
-
.BR markdown (7)
|
|
128
|
-
document read from the given
|
|
129
|
-
\fIFILE\fP or STDIN.
|
|
106
|
+
\fB\fChelp\fR \fIFILE\fP ... [\fB\fC\-h\fR|\fB\fC\-\-help\fR [\fIPATTERN\fP]] ... [\fB\fC\-\-\fR] ...
|
|
107
|
+
If the given argument sequence contains \fB\fC\-h\fR or \fB\fC\-\-help\fR, except after
|
|
108
|
+
\fB\fC\-\-\fR, optionally followed by a \fIPATTERN\fP regular expression that specifies
|
|
109
|
+
text to search for and, if found, jump to inside the displayed man page,
|
|
110
|
+
then this program extracts the given \fIFILE\fP\&'s leading comment header,
|
|
111
|
+
converts it into
|
|
112
|
+
.BR roff (7),
|
|
113
|
+
displays it using
|
|
114
|
+
.BR man (1),
|
|
115
|
+
and finally exits with
|
|
116
|
+
status code \fB\fC0\fR\&. Otherwise, this program exits with status code \fB\fC111\fR\&.
|
|
130
117
|
.SH SEE ALSO
|
|
131
118
|
.PP
|
|
132
119
|
.BR binman-rake (1),
|
data/man/man1/binman.1.html
CHANGED
|
@@ -2,12 +2,12 @@
|
|
|
2
2
|
<html>
|
|
3
3
|
<head>
|
|
4
4
|
<meta charset="utf-8" />
|
|
5
|
-
<meta name="generator" content="md2man
|
|
5
|
+
<meta name="generator" content="md2man 4.0.0 https://github.com/sunaku/md2man" />
|
|
6
6
|
<title>binman(1) — man pages for bin scripts</title>
|
|
7
7
|
<link rel="stylesheet" href="../style.css"/>
|
|
8
8
|
<!--[if lt IE 9]><script src="http://html5shiv.googlecode.com/svn/trunk/html5.js"></script><![endif]-->
|
|
9
9
|
</head>
|
|
10
|
-
<body><div class="navbar"><div class="navbar-inner"><span class="brand"><a href="../index.html#man1">man1</a>/binman.1</span></div></div><div class="container-fluid"><h1 id="binman-1-2014-
|
|
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-10-26-4-0-0"><a name="binman-1-2014-10-26-4-0-0" href="#binman-1-2014-10-26-4-0-0" class="md2man-permalink" title="permalink"></a><span class="md2man-title">BINMAN</span> <span class="md2man-section">1</span> <span class="md2man-date">2014-10-26</span> <span class="md2man-source">4.0.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
|
|
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,14 +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> [<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>
|
|
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>snip</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
|
|
44
|
+
the given <em>FILE</em> or STDIN.</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
|
|
45
|
+
extracted from the given <em>FILE</em> or STDIN. If <em>PATTERN</em> is given, search for
|
|
46
|
+
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>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
47
|
<code>--</code>, optionally followed by a <em>PATTERN</em> regular expression that specifies
|
|
45
48
|
text to search for and, if found, jump to inside the displayed man page,
|
|
46
49
|
then this program extracts the given <em>FILE</em>'s leading comment header,
|
|
47
50
|
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><
|
|
49
|
-
extracted from the given <em>FILE</em> or STDIN. If <em>PATTERN</em> is given, search for
|
|
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
|
-
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
|
-
<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>
|
|
51
|
+
status code <code>0</code>. Otherwise, this program exits with status code <code>111</code>.</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>
|
|
53
52
|
</html>
|
data/man/style.css
CHANGED
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:
|
|
4
|
+
version: 4.0.0
|
|
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-
|
|
11
|
+
date: 2014-10-26 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: md2man
|
|
@@ -16,14 +16,14 @@ dependencies:
|
|
|
16
16
|
requirements:
|
|
17
17
|
- - "~>"
|
|
18
18
|
- !ruby/object:Gem::Version
|
|
19
|
-
version: '
|
|
19
|
+
version: '4.0'
|
|
20
20
|
type: :development
|
|
21
21
|
prerelease: false
|
|
22
22
|
version_requirements: !ruby/object:Gem::Requirement
|
|
23
23
|
requirements:
|
|
24
24
|
- - "~>"
|
|
25
25
|
- !ruby/object:Gem::Version
|
|
26
|
-
version: '
|
|
26
|
+
version: '4.0'
|
|
27
27
|
- !ruby/object:Gem::Dependency
|
|
28
28
|
name: opener
|
|
29
29
|
requirement: !ruby/object:Gem::Requirement
|