binman 4.2.1 → 5.0.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.markdown +122 -57
- data/VERSION.markdown +19 -0
- data/bin/binman +10 -4
- data/bin/binman-rake +1 -1
- data/binman.gemspec +1 -1
- data/lib/binman.rb +41 -28
- data/lib/binman/rakefile.rb +1 -1
- data/lib/binman/version.rb +1 -1
- data/man/index.html +1 -1
- data/man/man0/README.html +140 -75
- data/man/man0/VERSION.html +40 -27
- data/man/man1/binman-rake.1 +1 -1
- data/man/man1/binman-rake.1.html +4 -4
- data/man/man1/binman.1 +13 -3
- data/man/man1/binman.1.html +11 -8
- metadata +3 -3
data/lib/binman/version.rb
CHANGED
data/man/index.html
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
<html>
|
|
3
3
|
<head>
|
|
4
4
|
<meta charset="utf-8" />
|
|
5
|
-
<meta name="generator" content="md2man
|
|
5
|
+
<meta name="generator" content="md2man 5.0.1 https://github.com/sunaku/md2man" />
|
|
6
6
|
<title>man/index</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]-->
|
data/man/man0/README.html
CHANGED
|
@@ -2,16 +2,16 @@
|
|
|
2
2
|
<html>
|
|
3
3
|
<head>
|
|
4
4
|
<meta charset="utf-8" />
|
|
5
|
-
<meta name="generator" content="md2man
|
|
5
|
+
<meta name="generator" content="md2man 5.0.1 https://github.com/sunaku/md2man" />
|
|
6
6
|
<title>README</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>/README</span></div></div><div class="container-fluid"><h1 id="binman-man-pages-for"><
|
|
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"><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><a name="binman-man-pages-for" href="#binman-man-pages-for" class="md2man-permalink" title="permalink"></a></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
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
12
|
top of your script and call <code>binman show</code> to display it as a UNIX manual page!
|
|
13
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
|
|
14
|
+
with <code>-h</code> or <code>--help</code> command-line options. Or, call <code>binman text</code> to extract
|
|
15
15
|
the manual from your script for your own custom processing, outside of binman.
|
|
16
16
|
And that's not all: <a href="https://sunaku.github.io/binman/man/man1/binman.1.html">see the manual page</a> for more possibilities!</p>
|
|
17
17
|
<ul>
|
|
@@ -20,93 +20,158 @@ And that's not all: <a href="https://sunaku.github.io/binman/man/man1/binman
|
|
|
20
20
|
<li>Support: <a href="https://github.com/sunaku/binman/issues">https://github.com/sunaku/binman/issues</a></li>
|
|
21
21
|
<li>Package: <a href="https://rubygems.org/gems/binman">https://rubygems.org/gems/binman</a></li>
|
|
22
22
|
</ul>
|
|
23
|
-
<h2 id="features"
|
|
23
|
+
<h2 id="features">Features<a name="features" href="#features" class="md2man-permalink" title="permalink"></a></h2>
|
|
24
24
|
<ul>
|
|
25
25
|
<li><p>Supports any scripting language that has multi-line
|
|
26
26
|
comments or uses <code>#</code> for single-line comments: Ruby,
|
|
27
27
|
Perl, Python, Node.js, Tcl, AWK, UNIX shell, and more!</p></li>
|
|
28
28
|
<li><p>Provides a Ruby library and a command-line client too.</p></li>
|
|
29
29
|
<li><p>Individual extraction, conversion, and display commands.</p></li>
|
|
30
|
-
<li><p>Implemented in roughly
|
|
30
|
+
<li><p>Implemented in roughly 165 lines of pure Ruby code! :-)</p></li>
|
|
31
31
|
</ul>
|
|
32
|
-
<h3 id="demonstration"
|
|
32
|
+
<h3 id="demonstration">Demonstration<a name="demonstration" href="#demonstration" class="md2man-permalink" title="permalink"></a></h3><p><img src="EXAMPLE.png" alt="Obligatory screen-shot of binman(1) in action!"></p><h4 id="what-can-binman-1-do">What can <a class="md2man-reference" href="../man1/binman.1.html">binman(1)</a> do?<a name="what-can-binman-1-do" href="#what-can-binman-1-do" class="md2man-permalink" title="permalink"></a></h4><p>Here are some real examples of processed bin scripts to help you get started:</p>
|
|
33
33
|
<ul>
|
|
34
|
-
<li><
|
|
35
|
-
<a href="https://
|
|
36
|
-
<a href="https://
|
|
37
|
-
<
|
|
38
|
-
<
|
|
39
|
-
<a href="https://
|
|
40
|
-
<
|
|
41
|
-
<a href="https://
|
|
42
|
-
<
|
|
43
|
-
<
|
|
44
|
-
<a href="https://
|
|
45
|
-
<a href="https://
|
|
46
|
-
<li><
|
|
47
|
-
<a href="https://
|
|
48
|
-
<a href="https://
|
|
49
|
-
<
|
|
50
|
-
<
|
|
51
|
-
<a href="https://sunaku.github.io/tork/man/man1/tork-
|
|
52
|
-
<
|
|
53
|
-
<a href="https://
|
|
54
|
-
<
|
|
55
|
-
<
|
|
56
|
-
<a href="https://
|
|
57
|
-
<a href="https://
|
|
58
|
-
<li><
|
|
59
|
-
<a href="https://
|
|
60
|
-
<a href="https://sunaku.github.io/tork/man/man1/tork-
|
|
61
|
-
<
|
|
62
|
-
<
|
|
63
|
-
<a href="https://
|
|
64
|
-
<
|
|
65
|
-
<a href="https://
|
|
66
|
-
<
|
|
67
|
-
<
|
|
68
|
-
<a href="https://
|
|
69
|
-
<a href="https://sunaku.github.io/
|
|
70
|
-
<li><
|
|
71
|
-
<a href="https://
|
|
72
|
-
<a href="https://
|
|
73
|
-
<
|
|
74
|
-
<
|
|
75
|
-
<a href="https://
|
|
76
|
-
<
|
|
77
|
-
<a href="https://
|
|
78
|
-
<
|
|
79
|
-
<
|
|
80
|
-
<a href="https://
|
|
81
|
-
<a href="https://
|
|
82
|
-
<li><
|
|
83
|
-
<a href="https://
|
|
84
|
-
<a href="https://
|
|
85
|
-
<
|
|
34
|
+
<li><code>binman text</code>
|
|
35
|
+
< <a href="https://raw.github.com/sunaku/tork/master/bin/tork">tork</a>
|
|
36
|
+
> <a href="https://raw.github.com/sunaku/tork/gh-pages/man/man1/tork.1.markdown">tork.1.markdown</a></li>
|
|
37
|
+
<li><code>binman roff</code>
|
|
38
|
+
< <a href="https://raw.github.com/sunaku/tork/master/bin/tork">tork</a>
|
|
39
|
+
> <a href="https://raw.github.com/sunaku/tork/gh-pages/man/man1/tork.1">tork.1</a></li>
|
|
40
|
+
<li><code>binman html</code>
|
|
41
|
+
< <a href="https://raw.github.com/sunaku/tork/master/bin/tork">tork</a>
|
|
42
|
+
> <a href="https://sunaku.github.io/tork/man/man1/tork.1.html">tork.1.html</a></li>
|
|
43
|
+
<li><code>binman text</code>
|
|
44
|
+
< <a href="https://raw.github.com/sunaku/tork/master/bin/tork-runner">tork-runner</a>
|
|
45
|
+
> <a href="https://raw.github.com/sunaku/tork/gh-pages/man/man1/tork-runner.1.markdown">tork-runner.1.markdown</a></li>
|
|
46
|
+
<li><code>binman roff</code>
|
|
47
|
+
< <a href="https://raw.github.com/sunaku/tork/master/bin/tork-runner">tork-runner</a>
|
|
48
|
+
> <a href="https://raw.github.com/sunaku/tork/gh-pages/man/man1/tork-runner.1">tork-runner.1</a></li>
|
|
49
|
+
<li><code>binman html</code>
|
|
50
|
+
< <a href="https://raw.github.com/sunaku/tork/master/bin/tork-runner">tork-runner</a>
|
|
51
|
+
> <a href="https://sunaku.github.io/tork/man/man1/tork-runner.1.html">tork-runner.1.html</a></li>
|
|
52
|
+
<li><code>binman text</code>
|
|
53
|
+
< <a href="https://raw.github.com/sunaku/tork/master/bin/tork-herald">tork-herald</a>
|
|
54
|
+
> <a href="https://raw.github.com/sunaku/tork/gh-pages/man/man1/tork-herald.1.markdown">tork-herald.1.markdown</a></li>
|
|
55
|
+
<li><code>binman roff</code>
|
|
56
|
+
< <a href="https://raw.github.com/sunaku/tork/master/bin/tork-herald">tork-herald</a>
|
|
57
|
+
> <a href="https://raw.github.com/sunaku/tork/gh-pages/man/man1/tork-herald.1">tork-herald.1</a></li>
|
|
58
|
+
<li><code>binman html</code>
|
|
59
|
+
< <a href="https://raw.github.com/sunaku/tork/master/bin/tork-herald">tork-herald</a>
|
|
60
|
+
> <a href="https://sunaku.github.io/tork/man/man1/tork-herald.1.html">tork-herald.1.html</a></li>
|
|
61
|
+
<li><code>binman text</code>
|
|
62
|
+
< <a href="https://raw.github.com/sunaku/tork/master/bin/tork-driver">tork-driver</a>
|
|
63
|
+
> <a href="https://raw.github.com/sunaku/tork/gh-pages/man/man1/tork-driver.1.markdown">tork-driver.1.markdown</a></li>
|
|
64
|
+
<li><code>binman roff</code>
|
|
65
|
+
< <a href="https://raw.github.com/sunaku/tork/master/bin/tork-driver">tork-driver</a>
|
|
66
|
+
> <a href="https://raw.github.com/sunaku/tork/gh-pages/man/man1/tork-driver.1">tork-driver.1</a></li>
|
|
67
|
+
<li><code>binman html</code>
|
|
68
|
+
< <a href="https://raw.github.com/sunaku/tork/master/bin/tork-driver">tork-driver</a>
|
|
69
|
+
> <a href="https://sunaku.github.io/tork/man/man1/tork-driver.1.html">tork-driver.1.html</a></li>
|
|
70
|
+
<li><code>binman text</code>
|
|
71
|
+
< <a href="https://raw.github.com/sunaku/tork/master/bin/tork-engine">tork-engine</a>
|
|
72
|
+
> <a href="https://raw.github.com/sunaku/tork/gh-pages/man/man1/tork-engine.1.markdown">tork-engine.1.markdown</a></li>
|
|
73
|
+
<li><code>binman roff</code>
|
|
74
|
+
< <a href="https://raw.github.com/sunaku/tork/master/bin/tork-engine">tork-engine</a>
|
|
75
|
+
> <a href="https://raw.github.com/sunaku/tork/gh-pages/man/man1/tork-engine.1">tork-engine.1</a></li>
|
|
76
|
+
<li><code>binman html</code>
|
|
77
|
+
< <a href="https://raw.github.com/sunaku/tork/master/bin/tork-engine">tork-engine</a>
|
|
78
|
+
> <a href="https://sunaku.github.io/tork/man/man1/tork-engine.1.html">tork-engine.1.html</a></li>
|
|
79
|
+
<li><code>binman text</code>
|
|
80
|
+
< <a href="https://raw.github.com/sunaku/tork/master/bin/tork-master">tork-master</a>
|
|
81
|
+
> <a href="https://raw.github.com/sunaku/tork/gh-pages/man/man1/tork-master.1.markdown">tork-master.1.markdown</a></li>
|
|
82
|
+
<li><code>binman roff</code>
|
|
83
|
+
< <a href="https://raw.github.com/sunaku/tork/master/bin/tork-master">tork-master</a>
|
|
84
|
+
> <a href="https://raw.github.com/sunaku/tork/gh-pages/man/man1/tork-master.1">tork-master.1</a></li>
|
|
85
|
+
<li><code>binman html</code>
|
|
86
|
+
< <a href="https://raw.github.com/sunaku/tork/master/bin/tork-master">tork-master</a>
|
|
87
|
+
> <a href="https://sunaku.github.io/tork/man/man1/tork-master.1.html">tork-master.1.html</a></li>
|
|
88
|
+
<li><code>binman text</code>
|
|
89
|
+
< <a href="https://raw.github.com/sunaku/tork/master/bin/tork-remote">tork-remote</a>
|
|
90
|
+
> <a href="https://raw.github.com/sunaku/tork/gh-pages/man/man1/tork-remote.1.markdown">tork-remote.1.markdown</a></li>
|
|
91
|
+
<li><code>binman roff</code>
|
|
92
|
+
< <a href="https://raw.github.com/sunaku/tork/master/bin/tork-remote">tork-remote</a>
|
|
93
|
+
> <a href="https://raw.github.com/sunaku/tork/gh-pages/man/man1/tork-remote.1">tork-remote.1</a></li>
|
|
94
|
+
<li><code>binman html</code>
|
|
95
|
+
< <a href="https://raw.github.com/sunaku/tork/master/bin/tork-remote">tork-remote</a>
|
|
96
|
+
> <a href="https://sunaku.github.io/tork/man/man1/tork-remote.1.html">tork-remote.1.html</a></li>
|
|
97
|
+
<li><code>binman text</code>
|
|
98
|
+
< <a href="https://raw.github.com/sunaku/tork/master/bin/tork-notify">tork-notify</a>
|
|
99
|
+
> <a href="https://raw.github.com/sunaku/tork/gh-pages/man/man1/tork-notify.1.markdown">tork-notify.1.markdown</a></li>
|
|
100
|
+
<li><code>binman roff</code>
|
|
101
|
+
< <a href="https://raw.github.com/sunaku/tork/master/bin/tork-notify">tork-notify</a>
|
|
102
|
+
> <a href="https://raw.github.com/sunaku/tork/gh-pages/man/man1/tork-notify.1">tork-notify.1</a></li>
|
|
103
|
+
<li><code>binman html</code>
|
|
104
|
+
< <a href="https://raw.github.com/sunaku/tork/master/bin/tork-notify">tork-notify</a>
|
|
105
|
+
> <a href="https://sunaku.github.io/tork/man/man1/tork-notify.1.html">tork-notify.1.html</a></li>
|
|
106
|
+
<li><code>binman text</code>
|
|
107
|
+
< <a href="https://raw.github.com/sunaku/md2man/master/bin/md2man-roff">md2man-roff</a>
|
|
108
|
+
> <a href="https://raw.github.com/sunaku/md2man/gh-pages/man/man1/md2man-roff.1.markdown">md2man-roff.1.markdown</a></li>
|
|
109
|
+
<li><code>binman roff</code>
|
|
110
|
+
< <a href="https://raw.github.com/sunaku/md2man/master/bin/md2man-roff">md2man-roff</a>
|
|
111
|
+
> <a href="https://raw.github.com/sunaku/md2man/gh-pages/man/man1/md2man-roff.1">md2man-roff.1</a></li>
|
|
112
|
+
<li><code>binman html</code>
|
|
113
|
+
< <a href="https://raw.github.com/sunaku/md2man/master/bin/md2man-roff">md2man-roff</a>
|
|
114
|
+
> <a href="https://sunaku.github.io/md2man/man/man1/md2man-roff.1.html">md2man-roff.1.html</a></li>
|
|
115
|
+
<li><code>binman text</code>
|
|
116
|
+
< <a href="https://raw.github.com/sunaku/md2man/master/bin/md2man-html">md2man-html</a>
|
|
117
|
+
> <a href="https://raw.github.com/sunaku/md2man/gh-pages/man/man1/md2man-html.1.markdown">md2man-html.1.markdown</a></li>
|
|
118
|
+
<li><code>binman roff</code>
|
|
119
|
+
< <a href="https://raw.github.com/sunaku/md2man/master/bin/md2man-html">md2man-html</a>
|
|
120
|
+
> <a href="https://raw.github.com/sunaku/md2man/gh-pages/man/man1/md2man-html.1">md2man-html.1</a></li>
|
|
121
|
+
<li><code>binman html</code>
|
|
122
|
+
< <a href="https://raw.github.com/sunaku/md2man/master/bin/md2man-html">md2man-html</a>
|
|
123
|
+
> <a href="https://sunaku.github.io/md2man/man/man1/md2man-html.1.html">md2man-html.1.html</a></li>
|
|
124
|
+
<li><code>binman text</code>
|
|
125
|
+
< <a href="https://raw.github.com/sunaku/md2man/master/bin/md2man-rake">md2man-rake</a>
|
|
126
|
+
> <a href="https://raw.github.com/sunaku/md2man/gh-pages/man/man1/md2man-rake.1.markdown">md2man-rake.1.markdown</a></li>
|
|
127
|
+
<li><code>binman roff</code>
|
|
128
|
+
< <a href="https://raw.github.com/sunaku/md2man/master/bin/md2man-rake">md2man-rake</a>
|
|
129
|
+
> <a href="https://raw.github.com/sunaku/md2man/gh-pages/man/man1/md2man-rake.1">md2man-rake.1</a></li>
|
|
130
|
+
<li><code>binman html</code>
|
|
131
|
+
< <a href="https://raw.github.com/sunaku/md2man/master/bin/md2man-rake">md2man-rake</a>
|
|
132
|
+
> <a href="https://sunaku.github.io/md2man/man/man1/md2man-rake.1.html">md2man-rake.1.html</a></li>
|
|
133
|
+
<li><code>binman text</code>
|
|
134
|
+
< <a href="https://raw.github.com/sunaku/binman/master/bin/binman">binman</a>
|
|
135
|
+
> <a href="https://raw.github.com/sunaku/binman/gh-pages/man/man1/binman.1.markdown">binman.1.markdown</a></li>
|
|
136
|
+
<li><code>binman roff</code>
|
|
137
|
+
< <a href="https://raw.github.com/sunaku/binman/master/bin/binman">binman</a>
|
|
138
|
+
> <a href="https://raw.github.com/sunaku/binman/gh-pages/man/man1/binman.1">binman.1</a></li>
|
|
139
|
+
<li><code>binman html</code>
|
|
140
|
+
< <a href="https://raw.github.com/sunaku/binman/master/bin/binman">binman</a>
|
|
141
|
+
> <a href="https://sunaku.github.io/binman/man/man1/binman.1.html">binman.1.html</a></li>
|
|
142
|
+
<li><code>binman text</code>
|
|
143
|
+
< <a href="https://raw.github.com/sunaku/binman/master/bin/binman-rake">binman-rake</a>
|
|
144
|
+
> <a href="https://raw.github.com/sunaku/binman/gh-pages/man/man1/binman-rake.1.markdown">binman-rake.1.markdown</a></li>
|
|
145
|
+
<li><code>binman roff</code>
|
|
146
|
+
< <a href="https://raw.github.com/sunaku/binman/master/bin/binman-rake">binman-rake</a>
|
|
147
|
+
> <a href="https://raw.github.com/sunaku/binman/gh-pages/man/man1/binman-rake.1">binman-rake.1</a></li>
|
|
148
|
+
<li><code>binman html</code>
|
|
149
|
+
< <a href="https://raw.github.com/sunaku/binman/master/bin/binman-rake">binman-rake</a>
|
|
150
|
+
> <a href="https://sunaku.github.io/binman/man/man1/binman-rake.1.html">binman-rake.1.html</a></li>
|
|
86
151
|
</ul>
|
|
87
|
-
<p>For examples in even more scripting languages, see the "Usage" section below!</p><h4 id="what-can-binman-rake-1-do"
|
|
152
|
+
<p>For examples in even more scripting languages, see the "Usage" section below!</p><h4 id="what-can-binman-rake-1-do">What can <a class="md2man-reference" href="../man1/binman-rake.1.html">binman-rake(1)</a> do?<a name="what-can-binman-rake-1-do" href="#what-can-binman-rake-1-do" class="md2man-permalink" title="permalink"></a></h4><p>Here are some examples of HTML manual <em>sets</em> produced by <a class="md2man-reference" href="../man1/binman-rake.1.html">binman-rake(1)</a>:</p>
|
|
88
153
|
<ul>
|
|
89
154
|
<li><a href="https://sunaku.github.io/tork/man">https://sunaku.github.io/tork/man</a></li>
|
|
90
155
|
<li><a href="https://sunaku.github.io/binman/man">https://sunaku.github.io/binman/man</a></li>
|
|
91
156
|
<li><a href="https://sunaku.github.io/md2man/man">https://sunaku.github.io/md2man/man</a></li>
|
|
92
157
|
</ul>
|
|
93
|
-
<h2 id="installation"
|
|
158
|
+
<h2 id="installation">Installation<a name="installation" href="#installation" class="md2man-permalink" title="permalink"></a></h2><p>If you only want to view pre-built manual pages:</p><pre><code>gem install binman
|
|
94
159
|
</code></pre>
|
|
95
|
-
<p>If you also want to build your own manual pages:</p><pre><code>gem install md2man -v '~>
|
|
160
|
+
<p>If you also want to build your own manual pages:</p><pre><code>gem install md2man -v '~> 5.0'
|
|
96
161
|
</code></pre>
|
|
97
|
-
<h3 id="prerequisites"
|
|
162
|
+
<h3 id="prerequisites">Prerequisites<a name="prerequisites" href="#prerequisites" class="md2man-permalink" title="permalink"></a></h3>
|
|
98
163
|
<ul>
|
|
99
164
|
<li>Ruby 1.8.7 or 1.9.2 or newer.</li>
|
|
100
165
|
</ul>
|
|
101
|
-
<h3 id="development"
|
|
166
|
+
<h3 id="development">Development<a name="development" href="#development" class="md2man-permalink" title="permalink"></a></h3><pre><code>git clone https://github.com/sunaku/binman
|
|
102
167
|
cd binman
|
|
103
168
|
bundle install
|
|
104
169
|
bundle exec binman --help # run it directly
|
|
105
170
|
bundle exec rake --tasks # packaging tasks
|
|
106
171
|
</code></pre>
|
|
107
|
-
<h2 id="usage"
|
|
172
|
+
<h2 id="usage">Usage<a name="usage" href="#usage" class="md2man-permalink" title="permalink"></a></h2><h3 id="at-the-command-line">At the command line<a name="at-the-command-line" href="#at-the-command-line" class="md2man-permalink" title="permalink"></a></h3><p>See <a class="md2man-reference" href="../man1/binman.1.html">binman(1)</a> manual:</p><pre><code>binman --help
|
|
108
173
|
</code></pre>
|
|
109
|
-
<h3 id="inside-a-ruby-script"
|
|
174
|
+
<h3 id="inside-a-ruby-script">Inside a Ruby script<a name="inside-a-ruby-script" href="#inside-a-ruby-script" class="md2man-permalink" title="permalink"></a></h3><pre><code>#!/usr/bin/env ruby
|
|
110
175
|
# your program's manual page goes here
|
|
111
176
|
|
|
112
177
|
require 'binman'
|
|
@@ -132,7 +197,7 @@ your program's manual page goes here
|
|
|
132
197
|
your program's manual page goes here
|
|
133
198
|
=end
|
|
134
199
|
</code></pre>
|
|
135
|
-
<p>See the <a href="http://rubydoc.info/gems/binman/frames">API documentation</a> for even more possibilities!</p><h3 id="inside-a-shell-script"
|
|
200
|
+
<p>See the <a href="http://rubydoc.info/gems/binman/frames">API documentation</a> for even more possibilities!</p><h3 id="inside-a-shell-script">Inside a shell script<a name="inside-a-shell-script" href="#inside-a-shell-script" class="md2man-permalink" title="permalink"></a></h3><pre><code>#!/usr/bin/sh
|
|
136
201
|
# your program's manual page goes here
|
|
137
202
|
|
|
138
203
|
# OPTION 1: show manual and exit if ARGV has -h or --help except after --
|
|
@@ -141,7 +206,7 @@ binman help "$0" "$@" && exit
|
|
|
141
206
|
# OPTION 2: show manual unconditionally
|
|
142
207
|
binman show "$0"
|
|
143
208
|
</code></pre>
|
|
144
|
-
<h3 id="inside-a-perl-script"
|
|
209
|
+
<h3 id="inside-a-perl-script">Inside a Perl script<a name="inside-a-perl-script" href="#inside-a-perl-script" class="md2man-permalink" title="permalink"></a></h3><pre><code>#!/usr/bin/env perl
|
|
145
210
|
# your program's manual page goes here
|
|
146
211
|
|
|
147
212
|
# OPTION 1: show manual and exit if ARGV has -h or --help except after --
|
|
@@ -157,7 +222,7 @@ __END__
|
|
|
157
222
|
your program's manual page goes here
|
|
158
223
|
=end
|
|
159
224
|
</code></pre>
|
|
160
|
-
<h3 id="inside-a-python-script"
|
|
225
|
+
<h3 id="inside-a-python-script">Inside a Python script<a name="inside-a-python-script" href="#inside-a-python-script" class="md2man-permalink" title="permalink"></a></h3><pre><code>#!/usr/bin/env python
|
|
161
226
|
# your program's manual page goes here
|
|
162
227
|
|
|
163
228
|
import sys, subprocess
|
|
@@ -187,7 +252,7 @@ your program's manual page goes here
|
|
|
187
252
|
=end
|
|
188
253
|
"""
|
|
189
254
|
</code></pre>
|
|
190
|
-
<h3 id="inside-an-awk-script"
|
|
255
|
+
<h3 id="inside-an-awk-script">Inside an AWK script<a name="inside-an-awk-script" href="#inside-an-awk-script" class="md2man-permalink" title="permalink"></a></h3><p>The technique for determining current AWK script file name <a href="http://www.mombu.com/programming/programming/t-the-name-of-script-itself-2040784-print.html">comes from here</a>.</p><pre><code>#!/usr/bin/awk -f
|
|
191
256
|
# your program's manual page goes here
|
|
192
257
|
|
|
193
258
|
# OPTION 1: show manual and exit if ARGV has -h or --help except after --
|
|
@@ -198,7 +263,7 @@ BEGIN {getline c <"/proc/self/cmdline"; sub(".*-f\0",&quo
|
|
|
198
263
|
BEGIN {getline c <"/proc/self/cmdline"; sub(".*-f\0"," ",c); sub("\0.*","",c);
|
|
199
264
|
system("binman show" c)}
|
|
200
265
|
</code></pre>
|
|
201
|
-
<h3 id="inside-a-tcl-script"
|
|
266
|
+
<h3 id="inside-a-tcl-script">Inside a Tcl script<a name="inside-a-tcl-script" href="#inside-a-tcl-script" class="md2man-permalink" title="permalink"></a></h3><pre><code>#!/usr/bin/env tclsh
|
|
202
267
|
# your program's manual page goes here
|
|
203
268
|
|
|
204
269
|
# OPTION 1: show manual and exit if ARGV has -h or --help except after --
|
|
@@ -214,7 +279,7 @@ your program's manual page goes here
|
|
|
214
279
|
=end
|
|
215
280
|
}
|
|
216
281
|
</code></pre>
|
|
217
|
-
<h3 id="inside-a-node-js-script"
|
|
282
|
+
<h3 id="inside-a-node-js-script">Inside a Node.js script<a name="inside-a-node-js-script" href="#inside-a-node-js-script" class="md2man-permalink" title="permalink"></a></h3><pre><code>/*
|
|
218
283
|
=begin
|
|
219
284
|
your program's manual page goes here
|
|
220
285
|
=end
|
|
@@ -229,11 +294,11 @@ join(' '), function(error){ if (error === null){ process.exit(); } });
|
|
|
229
294
|
// OPTION 2: show manual unconditionally
|
|
230
295
|
exec(['>/dev/tty', 'binman', 'show', __filename].join(' '));
|
|
231
296
|
</code></pre>
|
|
232
|
-
<h2 id="packaging"
|
|
297
|
+
<h2 id="packaging">Packaging<a name="packaging" href="#packaging" class="md2man-permalink" title="permalink"></a></h2><h3 id="building-man-pages">Building man pages<a name="building-man-pages" href="#building-man-pages" class="md2man-permalink" title="permalink"></a></h3><h4 id="at-the-command-line-1">At the command line<a name="at-the-command-line-1" href="#at-the-command-line-1" class="md2man-permalink" title="permalink"></a></h4><p>See <a class="md2man-reference" href="../man1/binman-rake.1.html">binman-rake(1)</a> manual:</p><pre><code>binman-rake --help
|
|
233
298
|
</code></pre>
|
|
234
|
-
<h4 id="inside-a-ruby-script-1"
|
|
299
|
+
<h4 id="inside-a-ruby-script-1">Inside a Ruby script<a name="inside-a-ruby-script-1" href="#inside-a-ruby-script-1" class="md2man-permalink" title="permalink"></a></h4><p>Add this snippet to your gemspec file:</p><pre><code>s.files += Dir['man/man?/*.?'] # UNIX man pages
|
|
235
300
|
s.files += Dir['man/**/*.{html,css,js}'] # HTML man pages
|
|
236
|
-
s.add_development_dependency 'md2man', '~>
|
|
301
|
+
s.add_development_dependency 'md2man', '~> 5.0'
|
|
237
302
|
</code></pre>
|
|
238
303
|
<p>Add the following line to your Rakefile:</p><pre><code>require 'binman/rakefile'
|
|
239
304
|
</code></pre>
|
|
@@ -244,5 +309,5 @@ There are also sub-tasks to build manual pages individually as <a href="http://t
|
|
|
244
309
|
ensures that your UNIX manual pages are pre-built and packaged into your gem:</p><pre><code>bundle exec rake build
|
|
245
310
|
gem spec pkg/*.gem | fgrep man/man
|
|
246
311
|
</code></pre>
|
|
247
|
-
<h2 id="license"
|
|
312
|
+
<h2 id="license">License<a name="license" href="#license" class="md2man-permalink" title="permalink"></a></h2><p>Released under the ISC license. See the LICENSE file for details.</p></div></body>
|
|
248
313
|
</html>
|
data/man/man0/VERSION.html
CHANGED
|
@@ -2,20 +2,33 @@
|
|
|
2
2
|
<html>
|
|
3
3
|
<head>
|
|
4
4
|
<meta charset="utf-8" />
|
|
5
|
-
<meta name="generator" content="md2man
|
|
5
|
+
<meta name="generator" content="md2man 5.0.1 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-5-0-1-2016-02-13">Version 5.0.1 (2016-02-13)<a name="version-5-0-1-2016-02-13" href="#version-5-0-1-2016-02-13" class="md2man-permalink" title="permalink"></a></h2><h3 id="major">Major:<a name="major" href="#major" class="md2man-permalink" title="permalink"></a></h3>
|
|
11
|
+
<ul>
|
|
12
|
+
<li><p>Rename <code>binman snip</code> command to <code>binman text</code>.</p></li>
|
|
13
|
+
<li><p>Rename <code>binman conv</code> command to <code>binman roff</code> and make it operate on a bin
|
|
14
|
+
script containing an embedded manual page rather than the extracted latter.</p></li>
|
|
15
|
+
<li><p>Add <code>binman html</code> command which extracts embedded manual page from a given
|
|
16
|
+
bin script, converts it into HTML, and then prints the result to STDOUT.</p></li>
|
|
17
|
+
<li><p><code>binman show</code> now falls back to displaying a temporary HTML manual page if
|
|
18
|
+
<a class="md2man-reference">man(1)</a> fails to display the temporary UNIX manual page. This is useful in
|
|
19
|
+
Windows where there is no <a class="md2man-reference">man(1)</a> reader, but a web browser can be started.</p></li>
|
|
20
|
+
<li><p>When a HTML manual page is shown, <code>binman</code> now blocks until the launched
|
|
21
|
+
web browser exits. Previously, it used to exit immediately (nonblocking).</p></li>
|
|
22
|
+
</ul>
|
|
23
|
+
<h2 id="version-4-2-1-2016-02-12">Version 4.2.1 (2016-02-12)<a name="version-4-2-1-2016-02-12" href="#version-4-2-1-2016-02-12" class="md2man-permalink" title="permalink"></a></h2><h3 id="patch">Patch:<a name="patch" href="#patch" class="md2man-permalink" title="permalink"></a></h3>
|
|
11
24
|
<ul>
|
|
12
25
|
<li><p>Failure when <code>binman show</code> is given input on STDIN.</p><p>binman.rb:51:in `basename': no implicit conversion of IO into String (TypeError)</p></li>
|
|
13
26
|
</ul>
|
|
14
|
-
<h2 id="version-4-2-0-2016-02-12"
|
|
27
|
+
<h2 id="version-4-2-0-2016-02-12">Version 4.2.0 (2016-02-12)<a name="version-4-2-0-2016-02-12" href="#version-4-2-0-2016-02-12" class="md2man-permalink" title="permalink"></a></h2><h3 id="minor">Minor:<a name="minor" href="#minor" class="md2man-permalink" title="permalink"></a></h3>
|
|
15
28
|
<ul>
|
|
16
29
|
<li>Add <code>binman:mkd</code> rake task to extract <code>man/man1/*.1.markdown</code> files.</li>
|
|
17
30
|
</ul>
|
|
18
|
-
<h3 id="patch-1"
|
|
31
|
+
<h3 id="patch-1">Patch:<a name="patch-1" href="#patch-1" class="md2man-permalink" title="permalink"></a></h3>
|
|
19
32
|
<ul>
|
|
20
33
|
<li><p>Shell out to <a class="md2man-reference">md2man-rake(1)</a> for dynamic man pages.</p><p>Requiring the md2man/rakefile.rb script builds Rake tasks only once, so
|
|
21
34
|
it ignores any man page files generated dynamically after the require().</p><p>This fix shells out to <a class="md2man-reference">md2man-rake(1)</a> causing that script to be required
|
|
@@ -23,11 +36,11 @@ every time afresh, so that such dynamically generated files are handled.</p></li
|
|
|
23
36
|
<li><p>Failure when <code>binman help</code> is called without ARGV.</p><p>binman.rb:63:in <code>help': undefined method</code>index' for nil:NilClass (NoMethodError)</p></li>
|
|
24
37
|
<li><p>Failure when <code>binman show</code> is called without ARGV.</p><p>binman.rb:47:in `basename': no implicit conversion of IO into String (TypeError)</p></li>
|
|
25
38
|
</ul>
|
|
26
|
-
<h2 id="version-4-1-0-2016-02-10"
|
|
39
|
+
<h2 id="version-4-1-0-2016-02-10">Version 4.1.0 (2016-02-10)<a name="version-4-1-0-2016-02-10" href="#version-4-1-0-2016-02-10" class="md2man-permalink" title="permalink"></a></h2><h3 id="minor-1">Minor:<a name="minor-1" href="#minor-1" class="md2man-permalink" title="permalink"></a></h3>
|
|
27
40
|
<ul>
|
|
28
41
|
<li>Print path of HTML man page to STDOUT when launching browser.</li>
|
|
29
42
|
</ul>
|
|
30
|
-
<h3 id="patch-2"
|
|
43
|
+
<h3 id="patch-2">Patch:<a name="patch-2" href="#patch-2" class="md2man-permalink" title="permalink"></a></h3>
|
|
31
44
|
<ul>
|
|
32
45
|
<li><p>Revert "ensure 'binman:web' task works the first time thru".</p><p>This reverts commit dd0511e78e02546cac4903b5c6de6243607a8bba,
|
|
33
46
|
which was causing the following error under Ruby 2.3.0p0.</p><dl><dd>% rake build
|
|
@@ -45,7 +58,7 @@ exit 1</dd></dl></li>
|
|
|
45
58
|
<li><p><code>man FILE</code> isn't portable; use <code>man -M ...</code> instead.</p><p><code>man FILE</code> used to work in Debian, but doesn't work under Void Linux.</p><p><code>man -l FILE</code> works in Linux and OpenBSD but not on MacOSX / FreeBSD.</p><p>Therefore, avoid all this portability mess using <code>man -M ...</code> instead.</p></li>
|
|
46
59
|
<li><p>Handle case where roff manual page is missing but HTML version exists.</p></li>
|
|
47
60
|
</ul>
|
|
48
|
-
<h2 id="version-4-0-0-2014-10-26"
|
|
61
|
+
<h2 id="version-4-0-0-2014-10-26">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></h2><h3 id="major-1">Major:<a name="major-1" href="#major-1" class="md2man-permalink" title="permalink"></a></h3>
|
|
49
62
|
<ul>
|
|
50
63
|
<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>
|
|
51
64
|
<ul>
|
|
@@ -55,35 +68,35 @@ exit 1</dd></dl></li>
|
|
|
55
68
|
<li><p>Upgrade to md2man 4.0, which no longer expands cross references in code
|
|
56
69
|
spans and code blocks. Your manuals might be rendered differently now.</p></li>
|
|
57
70
|
</ul>
|
|
58
|
-
<h2 id="version-3-4-1-2014-07-01"
|
|
71
|
+
<h2 id="version-3-4-1-2014-07-01">Version 3.4.1 (2014-07-01)<a name="version-3-4-1-2014-07-01" href="#version-3-4-1-2014-07-01" class="md2man-permalink" title="permalink"></a></h2><p>This release fixes the help options' REGEXP argument under non-Debian systems.</p><h3 id="patch-3">Patch:<a name="patch-3" href="#patch-3" class="md2man-permalink" title="permalink"></a></h3>
|
|
59
72
|
<ul>
|
|
60
73
|
<li><p><a class="md2man-reference">pager(1)</a> isn't a universal command: CentOS uses <code>less -is</code> instead.</p></li>
|
|
61
74
|
<li><p>Silence <a class="md2man-reference">man(1)</a> stderr when displaying dynamically extracted manual.</p></li>
|
|
62
75
|
</ul>
|
|
63
|
-
<h3 id="other"
|
|
76
|
+
<h3 id="other">Other:<a name="other" href="#other" class="md2man-permalink" title="permalink"></a></h3>
|
|
64
77
|
<ul>
|
|
65
78
|
<li><p>README: add intro hook and source+result examples.</p></li>
|
|
66
79
|
<li><p>Document REGEXP argument for help options in <code>bin/*</code>.</p></li>
|
|
67
80
|
<li><p>Refer to REGEXP argument as PATTERN like less does.</p></li>
|
|
68
81
|
</ul>
|
|
69
|
-
<h2 id="version-3-4-0-2014-06-29"
|
|
82
|
+
<h2 id="version-3-4-0-2014-06-29">Version 3.4.0 (2014-06-29)<a name="version-3-4-0-2014-06-29" href="#version-3-4-0-2014-06-29" class="md2man-permalink" title="permalink"></a></h2><h3 id="minor-2">Minor:<a name="minor-2" href="#minor-2" class="md2man-permalink" title="permalink"></a></h3>
|
|
70
83
|
<ul>
|
|
71
84
|
<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
|
|
72
85
|
followed by a regular expression argument that specifies text to search
|
|
73
86
|
for and, if found, jump to inside the displayed UNIX man page. Such a
|
|
74
87
|
regular expression argument can now also be passed into <code>BinMan.show()</code>.</p></li>
|
|
75
88
|
</ul>
|
|
76
|
-
<h3 id="other-1"
|
|
89
|
+
<h3 id="other-1">Other:<a name="other-1" href="#other-1" class="md2man-permalink" title="permalink"></a></h3>
|
|
77
90
|
<ul>
|
|
78
91
|
<li>README: add syntax highlighting to code snippets.</li>
|
|
79
92
|
</ul>
|
|
80
|
-
<h2 id="version-3-3-3-2014-06-22"
|
|
93
|
+
<h2 id="version-3-3-3-2014-06-22">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></h2><p>This release upgrades to md2man 3.0 for improved HTML manuals.</p><h3 id="other-2">Other:<a name="other-2" href="#other-2" class="md2man-permalink" title="permalink"></a></h3>
|
|
81
94
|
<ul>
|
|
82
95
|
<li><p>README: add links to package, manuals, and GitHub.</p></li>
|
|
83
96
|
<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>
|
|
84
97
|
<li><p>Upgrade to md2man 3.0 for improved HTML manuals.</p></li>
|
|
85
98
|
</ul>
|
|
86
|
-
<h2 id="version-3-3-2-2013-08-30"
|
|
99
|
+
<h2 id="version-3-3-2-2013-08-30">Version 3.3.2 (2013-08-30)<a name="version-3-3-2-2013-08-30" href="#version-3-3-2-2013-08-30" class="md2man-permalink" title="permalink"></a></h2><p>Patch:</p>
|
|
87
100
|
<ul>
|
|
88
101
|
<li><p>Rescue error when designated opener is not found:</p><pre><code>$ binman -h
|
|
89
102
|
/gems/opener-0.1.0/lib/opener.rb:97:in `spawn': No such file or directory - xdg-open (Errno::ENOENT)
|
|
@@ -103,11 +116,11 @@ regular expression argument can now also be passed into <code>BinMan.show()</cod
|
|
|
103
116
|
<ul>
|
|
104
117
|
<li>Add screenshot to git repo since OmpLoader is dead.</li>
|
|
105
118
|
</ul>
|
|
106
|
-
<h2 id="version-3-3-1-2013-06-01"
|
|
119
|
+
<h2 id="version-3-3-1-2013-06-01">Version 3.3.1 (2013-06-01)<a name="version-3-3-1-2013-06-01" href="#version-3-3-1-2013-06-01" class="md2man-permalink" title="permalink"></a></h2><p>Patch:</p>
|
|
107
120
|
<ul>
|
|
108
121
|
<li>Ensure that md2man 2.0 is loaded before running any BinMan rake tasks.</li>
|
|
109
122
|
</ul>
|
|
110
|
-
<h2 id="version-3-3-0-2013-05-08"
|
|
123
|
+
<h2 id="version-3-3-0-2013-05-08">Version 3.3.0 (2013-05-08)<a name="version-3-3-0-2013-05-08" href="#version-3-3-0-2013-05-08" class="md2man-permalink" title="permalink"></a></h2><p>Minor:</p>
|
|
111
124
|
<ul>
|
|
112
125
|
<li><p>Add <a class="md2man-reference" href="../man1/binman-rake.1.html">binman-rake(1)</a> script to provide access to <code>binman/rakefile</code> tasks.</p></li>
|
|
113
126
|
<li><p>Always try showing HTML manual page in web browser from <code>BinMan.show()</code>.</p></li>
|
|
@@ -118,13 +131,13 @@ regular expression argument can now also be passed into <code>BinMan.show()</cod
|
|
|
118
131
|
<li><p>Rename HISTORY to VERSION so it sorts after README.</p></li>
|
|
119
132
|
<li><p>Add man/man0/ subdir containing README and VERSION.</p></li>
|
|
120
133
|
</ul>
|
|
121
|
-
<h2 id="version-3-2-1-2013-05-04"
|
|
134
|
+
<h2 id="version-3-2-1-2013-05-04">Version 3.2.1 (2013-05-04)<a name="version-3-2-1-2013-05-04" href="#version-3-2-1-2013-05-04" class="md2man-permalink" title="permalink"></a></h2><p>Patch:</p>
|
|
122
135
|
<ul>
|
|
123
136
|
<li><p>Ensure that the <code>binman:web</code> Rake task works the first time through.</p></li>
|
|
124
137
|
<li><p>Fix "uninitialized constant Md2Man::VERSION" errors in <code>binman/rakefile</code>.</p></li>
|
|
125
138
|
<li><p>Hook into the <code>build</code> Rake task only if Bundler's Rake tasks are loaded:</p><p><a href="https://github.com/sunaku/md2man/pull/7#issuecomment-9467621">https://github.com/sunaku/md2man/pull/7#issuecomment-9467621</a></p><p>Thanks to Postmodern for raising this issue.</p></li>
|
|
126
139
|
</ul>
|
|
127
|
-
<h2 id="version-3-2-0-2012-10-14"
|
|
140
|
+
<h2 id="version-3-2-0-2012-10-14">Version 3.2.0 (2012-10-14)<a name="version-3-2-0-2012-10-14" href="#version-3-2-0-2012-10-14" class="md2man-permalink" title="permalink"></a></h2><p>Minor:</p>
|
|
128
141
|
<ul>
|
|
129
142
|
<li>add binman:web task to produce man pages in HTML</li>
|
|
130
143
|
</ul>
|
|
@@ -132,7 +145,7 @@ regular expression argument can now also be passed into <code>BinMan.show()</cod
|
|
|
132
145
|
<ul>
|
|
133
146
|
<li>gemspec: package only roff files from inside man/</li>
|
|
134
147
|
</ul>
|
|
135
|
-
<h2 id="version-3-1-1-2012-10-13"
|
|
148
|
+
<h2 id="version-3-1-1-2012-10-13">Version 3.1.1 (2012-10-13)<a name="version-3-1-1-2012-10-13" href="#version-3-1-1-2012-10-13" class="md2man-permalink" title="permalink"></a></h2><p>Patch:</p>
|
|
136
149
|
<ul>
|
|
137
150
|
<li><p>load() failed when leading comment header missing</p></li>
|
|
138
151
|
<li><p>lstrip() is too powerful; consume lines carefully</p></li>
|
|
@@ -141,7 +154,7 @@ regular expression argument can now also be passed into <code>BinMan.show()</cod
|
|
|
141
154
|
<ul>
|
|
142
155
|
<li>fix broken link to redcarpet library home page</li>
|
|
143
156
|
</ul>
|
|
144
|
-
<h2 id="version-3-1-0-2012-02-06"
|
|
157
|
+
<h2 id="version-3-1-0-2012-02-06">Version 3.1.0 (2012-02-06)<a name="version-3-1-0-2012-02-06" href="#version-3-1-0-2012-02-06" class="md2man-permalink" title="permalink"></a></h2><p>Minor:</p>
|
|
145
158
|
<ul>
|
|
146
159
|
<li>Added <code>binman help</code> command for use by non-Ruby bin scripts. See README
|
|
147
160
|
for usage examples from Perl, Python, Node.js, Tcl, AWK, and UNIX shell!</li>
|
|
@@ -155,7 +168,7 @@ for usage examples from Perl, Python, Node.js, Tcl, AWK, and UNIX shell!</li>
|
|
|
155
168
|
<ul>
|
|
156
169
|
<li>Shorten markdown headings; improve documentation; clean up.</li>
|
|
157
170
|
</ul>
|
|
158
|
-
<h2 id="version-3-0-1-2012-02-02"
|
|
171
|
+
<h2 id="version-3-0-1-2012-02-02">Version 3.0.1 (2012-02-02)<a name="version-3-0-1-2012-02-02" href="#version-3-0-1-2012-02-02" class="md2man-permalink" title="permalink"></a></h2><p>Patch:</p>
|
|
159
172
|
<ul>
|
|
160
173
|
<li><p>BinMan.help(): ignore <code>-h</code> and <code>--help</code> options after standard <code>--</code> flag.</p></li>
|
|
161
174
|
<li><p>BinMan.show(): write temp file because not all systems support <code>man -l</code>.</p></li>
|
|
@@ -167,7 +180,7 @@ for usage examples from Perl, Python, Node.js, Tcl, AWK, and UNIX shell!</li>
|
|
|
167
180
|
<li><p>README: fix installation commands for development.</p></li>
|
|
168
181
|
<li><p>bundler suggests moving all dev deps into gemspec.</p></li>
|
|
169
182
|
</ul>
|
|
170
|
-
<h2 id="version-3-0-0-2012-01-09"
|
|
183
|
+
<h2 id="version-3-0-0-2012-01-09">Version 3.0.0 (2012-01-09)<a name="version-3-0-0-2012-01-09" href="#version-3-0-0-2012-01-09" class="md2man-permalink" title="permalink"></a></h2><p>Major:</p>
|
|
171
184
|
<ul>
|
|
172
185
|
<li>Removed the <code>binman/gemspec</code> helper library because it did not play well
|
|
173
186
|
with Bundler. Use the standard <code>add_runtime_dependency</code> method instead.
|
|
@@ -178,7 +191,7 @@ with Bundler. Use the standard <code>add_runtime_dependency</code> method inste
|
|
|
178
191
|
<li>The <code>binman/Rakefile</code> helper library now hooks into Bundler's Rake tasks.
|
|
179
192
|
Be sure to add the <code>man/**/*</code> files to your gemspec <a href="https://github.com/sunaku/md2man/commit/75d7a0064fa86f1c98dd01391ad82245fd387c20">accordingly</a>.</li>
|
|
180
193
|
</ul>
|
|
181
|
-
<h2 id="version-2-0-0-2011-12-06"
|
|
194
|
+
<h2 id="version-2-0-0-2011-12-06">Version 2.0.0 (2011-12-06)<a name="version-2-0-0-2011-12-06" href="#version-2-0-0-2011-12-06" class="md2man-permalink" title="permalink"></a></h2><p>Major:</p>
|
|
182
195
|
<ul>
|
|
183
196
|
<li>Removed the deprecated <code>binman/rake_tasks</code> helper library. Use
|
|
184
197
|
<code>binman/rakefile</code> instead.</li>
|
|
@@ -192,7 +205,7 @@ Be sure to add the <code>man/**/*</code> files to your gemspec <a href="https://
|
|
|
192
205
|
<li><p>Upgraded to md2man v1 for Markdown to UNIX man page conversion.</p></li>
|
|
193
206
|
<li><p>Do not hard-code the version number in <code>binman/gemspec</code> helper.</p></li>
|
|
194
207
|
</ul>
|
|
195
|
-
<h2 id="version-1-1-0-2011-11-05"
|
|
208
|
+
<h2 id="version-1-1-0-2011-11-05">Version 1.1.0 (2011-11-05)<a name="version-1-1-0-2011-11-05" href="#version-1-1-0-2011-11-05" class="md2man-permalink" title="permalink"></a></h2><p>Alert:</p>
|
|
196
209
|
<ul>
|
|
197
210
|
<li>The <code>binman/rake_tasks</code> library has been renamed (with deprecation) to
|
|
198
211
|
<code>binman/rakefile</code>. The deprecation warning will be removed in the next
|
|
@@ -204,7 +217,7 @@ major release.</li>
|
|
|
204
217
|
builds and includes your UNIX man page files in your gem packages and also
|
|
205
218
|
adds binman as a runtime and development gem dependency.</li>
|
|
206
219
|
</ul>
|
|
207
|
-
<h2 id="version-1-0-0-2011-10-13"
|
|
220
|
+
<h2 id="version-1-0-0-2011-10-13">Version 1.0.0 (2011-10-13)<a name="version-1-0-0-2011-10-13" href="#version-1-0-0-2011-10-13" class="md2man-permalink" title="permalink"></a></h2><p>Major:</p>
|
|
208
221
|
<ul>
|
|
209
222
|
<li><p>The <code>BinMan::dump()</code> method and corresponding <code>binman dump</code> command now
|
|
210
223
|
extract the leading comment header from their input before returning the
|
|
@@ -227,7 +240,7 @@ comment header from the <code>bin/</code> script into a UNIX man page for displa
|
|
|
227
240
|
<ul>
|
|
228
241
|
<li>README: explain dev deps and <code>man/</code> dir packaging.</li>
|
|
229
242
|
</ul>
|
|
230
|
-
<h2 id="version-0-1-2-2011-10-13"
|
|
243
|
+
<h2 id="version-0-1-2-2011-10-13">Version 0.1.2 (2011-10-13)<a name="version-0-1-2-2011-10-13" href="#version-0-1-2-2011-10-13" class="md2man-permalink" title="permalink"></a></h2><p>Minor:</p>
|
|
231
244
|
<ul>
|
|
232
245
|
<li>The <a href="https://github.com/tanoku/redcarpet">Redcarpet2</a> library is not a runtime gem dependency anymore.</li>
|
|
233
246
|
</ul>
|
|
@@ -236,7 +249,7 @@ comment header from the <code>bin/</code> script into a UNIX man page for displa
|
|
|
236
249
|
<li><p>Extracted <code>BinMan::Renderer</code> into <a href="http://rdoc.info/github/sunaku/redcarpet-manpage">redcarpet-manpage</a> library.</p></li>
|
|
237
250
|
<li><p>Forgot to introduce leading comment headers in <a class="md2man-reference" href="../man1/binman.1.html">binman(1)</a> man page.</p></li>
|
|
238
251
|
</ul>
|
|
239
|
-
<h2 id="version-0-1-1-2011-10-13"
|
|
252
|
+
<h2 id="version-0-1-1-2011-10-13">Version 0.1.1 (2011-10-13)<a name="version-0-1-1-2011-10-13" href="#version-0-1-1-2011-10-13" class="md2man-permalink" title="permalink"></a></h2><p>Minor:</p>
|
|
240
253
|
<ul>
|
|
241
254
|
<li><code>BinMan.read()</code> now supports embedded document (=begin/=end) comments
|
|
242
255
|
also. See <a class="md2man-reference" href="../man1/binman.1.html">binman(1)</a> for the new description of leading comment headers.</li>
|
|
@@ -253,5 +266,5 @@ also. See <a class="md2man-reference" href="../man1/binman.1.html">binman(1)</a
|
|
|
253
266
|
<li><p>README: add link to example of binman markdown.</p></li>
|
|
254
267
|
<li><p>README: add obligatory screenshot! >:-)</p></li>
|
|
255
268
|
</ul>
|
|
256
|
-
<h2 id="version-0-0-1-2011-10-12"
|
|
269
|
+
<h2 id="version-0-0-1-2011-10-12">Version 0.0.1 (2011-10-12)<a name="version-0-0-1-2011-10-12" href="#version-0-0-1-2011-10-12" class="md2man-permalink" title="permalink"></a></h2><p>First release! Happy birthday! Woohoo! :-)</p></div></body>
|
|
257
270
|
</html>
|