binman 3.3.2 → 3.3.3
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.markdown +8 -4
- data/VERSION.markdown +14 -0
- data/bin/binman +1 -1
- data/bin/binman-rake +1 -1
- data/binman.gemspec +2 -2
- data/lib/binman.rb +2 -2
- data/lib/binman/version.rb +1 -1
- data/man/index.html +1 -1
- data/man/man0/EXAMPLE.png +0 -0
- data/man/man0/README.html +27 -20
- data/man/man0/README.markdown +8 -4
- data/man/man0/VERSION.html +25 -19
- data/man/man0/VERSION.markdown +14 -0
- data/man/man1/binman-rake.1 +4 -4
- data/man/man1/binman-rake.1.html +6 -6
- data/man/man1/binman.1 +8 -8
- data/man/man1/binman.1.html +15 -15
- data/man/style.css +22 -3
- metadata +23 -28
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 25bbee995392523cf64aadd135db92cd22ade470
|
4
|
+
data.tar.gz: 343bb4ab6fb0e9856b6a06b9d829a026287b84e8
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 4492b09a30bab9b6b608a691720b554a4c9af34bc2d77c502da19a264b3f4ff80628284417cd932c96e4f3082d5b351aeff0708add2a662c9738f1a0df3680ba
|
7
|
+
data.tar.gz: baf68d5e678bd5e90057976f97cdb865f67e58df4c8471161b611d2f291e9d1db389bb4745bf56cd6f3b357b0e9774eb52f7e321f9358d876a7fbf113ab25bcc
|
data/README.markdown
CHANGED
@@ -2,6 +2,11 @@
|
|
2
2
|
|
3
3
|
[binman] produces UNIX manual pages for executable scripts using [md2man].
|
4
4
|
|
5
|
+
* Package: <https://rubygems.org/gems/binman>
|
6
|
+
* Manuals: <https://sunaku.github.io/binman>
|
7
|
+
* Sources: <https://github.com/sunaku/binman>
|
8
|
+
* Support: <https://github.com/sunaku/binman/issues>
|
9
|
+
|
5
10
|
## Features
|
6
11
|
|
7
12
|
* Supports any scripting language that has multi-line
|
@@ -16,8 +21,7 @@
|
|
16
21
|
|
17
22
|
### Demonstration
|
18
23
|
|
19
|
-
![Obligatory screen-shot of binman(1) in action!](
|
20
|
-
https://raw.github.com/sunaku/binman/master/EXAMPLE.png)
|
24
|
+
![Obligatory screen-shot of binman(1) in action!](EXAMPLE.png)
|
21
25
|
|
22
26
|
Here is [a complete example in Ruby][binman-bin] to help you get started.
|
23
27
|
For examples in other scripting languages, see the "Usage" section below!
|
@@ -30,7 +34,7 @@ If you only want to view pre-built manual pages:
|
|
30
34
|
|
31
35
|
If you also want to build your own manual pages:
|
32
36
|
|
33
|
-
gem install md2man -v '~>
|
37
|
+
gem install md2man -v '~> 3.0'
|
34
38
|
|
35
39
|
### Prerequisites
|
36
40
|
|
@@ -227,7 +231,7 @@ Add this snippet to your gemspec file:
|
|
227
231
|
|
228
232
|
s.files += Dir['man/man?/*.?'] # UNIX man pages
|
229
233
|
s.files += Dir['man/**/*.{html,css,js}'] # HTML man pages
|
230
|
-
s.add_development_dependency 'md2man', '~>
|
234
|
+
s.add_development_dependency 'md2man', '~> 3.0'
|
231
235
|
|
232
236
|
Add the following line to your Rakefile:
|
233
237
|
|
data/VERSION.markdown
CHANGED
@@ -1,3 +1,17 @@
|
|
1
|
+
## Version 3.3.3 (2014-06-22)
|
2
|
+
|
3
|
+
This release upgrades to md2man 3.0 for improved HTML manuals.
|
4
|
+
|
5
|
+
### Other:
|
6
|
+
|
7
|
+
* README: add links to package, manuals, and GitHub.
|
8
|
+
|
9
|
+
* GitHub now supports relative links from the README:
|
10
|
+
|
11
|
+
https://help.github.com/articles/relative-links-in-readmes
|
12
|
+
|
13
|
+
* Upgrade to md2man 3.0 for improved HTML manuals.
|
14
|
+
|
1
15
|
## Version 3.3.2 (2013-08-30)
|
2
16
|
|
3
17
|
Patch:
|
data/bin/binman
CHANGED
data/bin/binman-rake
CHANGED
data/binman.gemspec
CHANGED
@@ -18,8 +18,8 @@ Gem::Specification.new do |s|
|
|
18
18
|
|
19
19
|
s.files += Dir['man/man?/*.?'] # UNIX man pages
|
20
20
|
s.files += Dir['man/**/*.{html,css,js}'] # HTML man pages
|
21
|
-
s.add_development_dependency 'md2man', '~>
|
21
|
+
s.add_development_dependency 'md2man', '~> 3.0'
|
22
22
|
|
23
23
|
s.add_dependency 'opener', '>= 0.1.0', '< 1'
|
24
|
-
s.add_development_dependency 'rake', '
|
24
|
+
s.add_development_dependency 'rake', '~> 10.1'
|
25
25
|
end
|
data/lib/binman.rb
CHANGED
@@ -97,10 +97,10 @@ module BinMan
|
|
97
97
|
# Requires that the correct version of Md2Man is available on this system.
|
98
98
|
def require_md2man
|
99
99
|
require 'rubygems' unless respond_to? :gem
|
100
|
-
gem 'md2man', '~>
|
100
|
+
gem 'md2man', '~> 3.0' if respond_to? :gem
|
101
101
|
require 'md2man/version'
|
102
102
|
rescue LoadError
|
103
|
-
raise 'Run `gem install md2man --version "~>
|
103
|
+
raise 'Run `gem install md2man --version "~> 3.0"` to use BinMan::conv().'
|
104
104
|
end
|
105
105
|
|
106
106
|
private
|
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 3.0.0 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]-->
|
Binary file
|
data/man/man0/README.html
CHANGED
@@ -2,12 +2,19 @@
|
|
2
2
|
<html>
|
3
3
|
<head>
|
4
4
|
<meta charset="utf-8" />
|
5
|
-
<meta name="generator" content="md2man
|
5
|
+
<meta name="generator" content="md2man 3.0.0 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"><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>
|
11
|
+
<ul>
|
12
|
+
<li>Package: <a href="https://rubygems.org/gems/binman">https://rubygems.org/gems/binman</a></li>
|
13
|
+
<li>Manuals: <a href="https://sunaku.github.io/binman">https://sunaku.github.io/binman</a></li>
|
14
|
+
<li>Sources: <a href="https://github.com/sunaku/binman">https://github.com/sunaku/binman</a></li>
|
15
|
+
<li>Support: <a href="https://github.com/sunaku/binman/issues">https://github.com/sunaku/binman/issues</a></li>
|
16
|
+
</ul>
|
17
|
+
<h2 id="features"><a name="features" href="#features" class="md2man-permalink" title="permalink"></a>Features</h2>
|
11
18
|
<ul>
|
12
19
|
<li><p>Supports any scripting language that has multi-line
|
13
20
|
comments or uses <code>#</code> for single-line comments: Ruby,
|
@@ -16,28 +23,28 @@ Perl, Python, Node.js, Tcl, AWK, UNIX shell, and more!</p></li>
|
|
16
23
|
<li><p>Individual extraction, conversion, and display commands.</p></li>
|
17
24
|
<li><p>Implemented in roughly 130 lines of pure Ruby code! :-)</p></li>
|
18
25
|
</ul>
|
19
|
-
<h3 id="
|
20
|
-
For examples in other scripting languages, see the "Usage" section below!</p><h2 id="
|
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 "Usage" 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>
|
21
28
|
<pre><code>gem install binman
|
22
29
|
</code></pre>
|
23
30
|
<p>If you also want to build your own manual pages:</p>
|
24
|
-
<pre><code>gem install md2man -v '~>
|
31
|
+
<pre><code>gem install md2man -v '~> 3.0'
|
25
32
|
</code></pre>
|
26
|
-
<h3 id="
|
33
|
+
<h3 id="prerequisites"><a name="prerequisites" href="#prerequisites" class="md2man-permalink" title="permalink"></a>Prerequisites</h3>
|
27
34
|
<ul>
|
28
35
|
<li>Ruby 1.8.7 or 1.9.2 or newer.</li>
|
29
36
|
</ul>
|
30
|
-
<h3 id="
|
37
|
+
<h3 id="development"><a name="development" href="#development" class="md2man-permalink" title="permalink"></a>Development</h3>
|
31
38
|
<pre><code>git clone git://github.com/sunaku/binman
|
32
39
|
cd binman
|
33
40
|
bundle install
|
34
41
|
bundle exec binman --help # run it directly
|
35
42
|
bundle exec rake --tasks # packaging tasks
|
36
43
|
</code></pre>
|
37
|
-
<h2 id="
|
44
|
+
<h2 id="usage"><a name="usage" href="#usage" class="md2man-permalink" title="permalink"></a>Usage</h2><h3 id="at-the-command-line"><a name="at-the-command-line" href="#at-the-command-line" class="md2man-permalink" title="permalink"></a>At the command line</h3><p>See <a class="md2man-reference" href="../man1/binman.1.html">binman(1)</a> manual:</p>
|
38
45
|
<pre><code>binman --help
|
39
46
|
</code></pre>
|
40
|
-
<h3 id="
|
47
|
+
<h3 id="inside-a-ruby-script"><a name="inside-a-ruby-script" href="#inside-a-ruby-script" class="md2man-permalink" title="permalink"></a>Inside a Ruby script</h3>
|
41
48
|
<pre><code>#!/usr/bin/env ruby
|
42
49
|
# your program's manual page goes here
|
43
50
|
|
@@ -67,7 +74,7 @@ your program's manual page goes here
|
|
67
74
|
your program's manual page goes here
|
68
75
|
=end
|
69
76
|
</code></pre>
|
70
|
-
<p>See the <a href="http://rubydoc.info/gems/binman/frames">API documentation</a> for even more possibilities!</p><h3 id="
|
77
|
+
<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"><a name="inside-a-shell-script" href="#inside-a-shell-script" class="md2man-permalink" title="permalink"></a>Inside a shell script</h3>
|
71
78
|
<pre><code>#!/usr/bin/sh
|
72
79
|
# your program's manual page goes here
|
73
80
|
|
@@ -77,7 +84,7 @@ binman help "$0" "$@" && exit
|
|
77
84
|
# OPTION 2: show manual unconditionally
|
78
85
|
binman show "$0"
|
79
86
|
</code></pre>
|
80
|
-
<h3 id="
|
87
|
+
<h3 id="inside-a-perl-script"><a name="inside-a-perl-script" href="#inside-a-perl-script" class="md2man-permalink" title="permalink"></a>Inside a Perl script</h3>
|
81
88
|
<pre><code>#!/usr/bin/env perl
|
82
89
|
# your program's manual page goes here
|
83
90
|
|
@@ -95,7 +102,7 @@ __END__
|
|
95
102
|
your program's manual page goes here
|
96
103
|
=end
|
97
104
|
</code></pre>
|
98
|
-
<h3 id="
|
105
|
+
<h3 id="inside-a-python-script"><a name="inside-a-python-script" href="#inside-a-python-script" class="md2man-permalink" title="permalink"></a>Inside a Python script</h3>
|
99
106
|
<pre><code>#!/usr/bin/env python
|
100
107
|
# your program's manual page goes here
|
101
108
|
|
@@ -129,7 +136,7 @@ your program's manual page goes here
|
|
129
136
|
=end
|
130
137
|
"""
|
131
138
|
</code></pre>
|
132
|
-
<h3 id="
|
139
|
+
<h3 id="inside-an-awk-script"><a name="inside-an-awk-script" href="#inside-an-awk-script" class="md2man-permalink" title="permalink"></a>Inside an AWK script</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>
|
133
140
|
<pre><code>#!/usr/bin/awk -f
|
134
141
|
# your program's manual page goes here
|
135
142
|
|
@@ -141,7 +148,7 @@ BEGIN {getline c <"/proc/self/cmdline"; sub(".*-f\0",&quo
|
|
141
148
|
BEGIN {getline c <"/proc/self/cmdline"; sub(".*-f\0"," ",c); sub("\0.*","",c);
|
142
149
|
system("binman show" c)}
|
143
150
|
</code></pre>
|
144
|
-
<h3 id="
|
151
|
+
<h3 id="inside-a-tcl-script"><a name="inside-a-tcl-script" href="#inside-a-tcl-script" class="md2man-permalink" title="permalink"></a>Inside a Tcl script</h3>
|
145
152
|
<pre><code>#!/usr/bin/env tclsh
|
146
153
|
# your program's manual page goes here
|
147
154
|
|
@@ -159,7 +166,7 @@ your program's manual page goes here
|
|
159
166
|
=end
|
160
167
|
}
|
161
168
|
</code></pre>
|
162
|
-
<h3 id="
|
169
|
+
<h3 id="inside-a-node-js-script"><a name="inside-a-node-js-script" href="#inside-a-node-js-script" class="md2man-permalink" title="permalink"></a>Inside a Node.js script</h3>
|
163
170
|
<pre><code>/*
|
164
171
|
=begin
|
165
172
|
your program's manual page goes here
|
@@ -170,18 +177,18 @@ var exec = require('child_process').exec;
|
|
170
177
|
|
171
178
|
// OPTION 1: show manual and exit if ARGV has -h or --help except after --
|
172
179
|
exec(['>/dev/tty', 'binman', 'help', __filename].concat(process.argv).
|
173
|
-
join(' '), <a class="md2man-
|
180
|
+
join(' '), <a class="md2man-reference">function(error)</a>{ if (error === null){ process.exit(); } });
|
174
181
|
|
175
182
|
// OPTION 2: show manual unconditionally
|
176
183
|
exec(['>/dev/tty', 'binman', 'show', __filename].join(' '));
|
177
184
|
</code></pre>
|
178
|
-
<h2 id="
|
185
|
+
<h2 id="packaging"><a name="packaging" href="#packaging" class="md2man-permalink" title="permalink"></a>Packaging</h2><h3 id="building-man-pages"><a name="building-man-pages" href="#building-man-pages" class="md2man-permalink" title="permalink"></a>Building man pages</h3><h4 id="at-the-command-line-1"><a name="at-the-command-line-1" href="#at-the-command-line-1" class="md2man-permalink" title="permalink"></a>At the command line</h4><p>See <a class="md2man-reference" href="../man1/binman-rake.1.html">binman-rake(1)</a> manual:</p>
|
179
186
|
<pre><code>binman-rake --help
|
180
187
|
</code></pre>
|
181
|
-
<h4 id="
|
188
|
+
<h4 id="inside-a-ruby-script-1"><a name="inside-a-ruby-script-1" href="#inside-a-ruby-script-1" class="md2man-permalink" title="permalink"></a>Inside a Ruby script</h4><p>Add this snippet to your gemspec file:</p>
|
182
189
|
<pre><code>s.files += Dir['man/man?/*.?'] # UNIX man pages
|
183
190
|
s.files += Dir['man/**/*.{html,css,js}'] # HTML man pages
|
184
|
-
s.add_development_dependency 'md2man', '~>
|
191
|
+
s.add_development_dependency 'md2man', '~> 3.0'
|
185
192
|
</code></pre>
|
186
193
|
<p>Add the following line to your Rakefile:</p>
|
187
194
|
<pre><code>require 'binman/rakefile'
|
@@ -194,5 +201,5 @@ ensures that your UNIX manual pages are pre-built and packaged into your gem:</p
|
|
194
201
|
<pre><code>bundle exec rake build
|
195
202
|
gem spec pkg/*.gem | fgrep man/man
|
196
203
|
</code></pre>
|
197
|
-
<h2 id="
|
204
|
+
<h2 id="license"><a name="license" href="#license" class="md2man-permalink" title="permalink"></a>License</h2><p>Released under the ISC license. See the LICENSE file for details.</p></div></body>
|
198
205
|
</html>
|
data/man/man0/README.markdown
CHANGED
@@ -2,6 +2,11 @@
|
|
2
2
|
|
3
3
|
[binman] produces UNIX manual pages for executable scripts using [md2man].
|
4
4
|
|
5
|
+
* Package: <https://rubygems.org/gems/binman>
|
6
|
+
* Manuals: <https://sunaku.github.io/binman>
|
7
|
+
* Sources: <https://github.com/sunaku/binman>
|
8
|
+
* Support: <https://github.com/sunaku/binman/issues>
|
9
|
+
|
5
10
|
## Features
|
6
11
|
|
7
12
|
* Supports any scripting language that has multi-line
|
@@ -16,8 +21,7 @@
|
|
16
21
|
|
17
22
|
### Demonstration
|
18
23
|
|
19
|
-
![Obligatory screen-shot of binman(1) in action!](
|
20
|
-
https://raw.github.com/sunaku/binman/master/EXAMPLE.png)
|
24
|
+
![Obligatory screen-shot of binman(1) in action!](EXAMPLE.png)
|
21
25
|
|
22
26
|
Here is [a complete example in Ruby][binman-bin] to help you get started.
|
23
27
|
For examples in other scripting languages, see the "Usage" section below!
|
@@ -30,7 +34,7 @@ If you only want to view pre-built manual pages:
|
|
30
34
|
|
31
35
|
If you also want to build your own manual pages:
|
32
36
|
|
33
|
-
gem install md2man -v '~>
|
37
|
+
gem install md2man -v '~> 3.0'
|
34
38
|
|
35
39
|
### Prerequisites
|
36
40
|
|
@@ -227,7 +231,7 @@ Add this snippet to your gemspec file:
|
|
227
231
|
|
228
232
|
s.files += Dir['man/man?/*.?'] # UNIX man pages
|
229
233
|
s.files += Dir['man/**/*.{html,css,js}'] # HTML man pages
|
230
|
-
s.add_development_dependency 'md2man', '~>
|
234
|
+
s.add_development_dependency 'md2man', '~> 3.0'
|
231
235
|
|
232
236
|
Add the following line to your Rakefile:
|
233
237
|
|
data/man/man0/VERSION.html
CHANGED
@@ -2,12 +2,18 @@
|
|
2
2
|
<html>
|
3
3
|
<head>
|
4
4
|
<meta charset="utf-8" />
|
5
|
-
<meta name="generator" content="md2man
|
5
|
+
<meta name="generator" content="md2man 3.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="
|
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-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"><a name="other" href="#other" class="md2man-permalink" title="permalink"></a>Other:</h3>
|
11
|
+
<ul>
|
12
|
+
<li><p>README: add links to package, manuals, and GitHub.</p></li>
|
13
|
+
<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>
|
14
|
+
<li><p>Upgrade to md2man 3.0 for improved HTML manuals.</p></li>
|
15
|
+
</ul>
|
16
|
+
<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>
|
11
17
|
<ul>
|
12
18
|
<li><p>Rescue error when designated opener is not found:</p>
|
13
19
|
<pre><code>$ binman -h
|
@@ -29,13 +35,13 @@
|
|
29
35
|
<ul>
|
30
36
|
<li>Add screenshot to git repo since OmpLoader is dead.</li>
|
31
37
|
</ul>
|
32
|
-
<h2 id="
|
38
|
+
<h2 id="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>Version 3.3.1 (2013-06-01)</h2><p>Patch:</p>
|
33
39
|
<ul>
|
34
40
|
<li>Ensure that md2man 2.0 is loaded before running any BinMan rake tasks.</li>
|
35
41
|
</ul>
|
36
|
-
<h2 id="
|
42
|
+
<h2 id="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>Version 3.3.0 (2013-05-08)</h2><p>Minor:</p>
|
37
43
|
<ul>
|
38
|
-
<li><p>Add <a class="md2man-
|
44
|
+
<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>
|
39
45
|
<li><p>Always try showing HTML manual page in web browser from <code>BinMan.show()</code>.</p></li>
|
40
46
|
</ul>
|
41
47
|
<p>Other:</p>
|
@@ -44,13 +50,13 @@
|
|
44
50
|
<li><p>Rename HISTORY to VERSION so it sorts after README.</p></li>
|
45
51
|
<li><p>Add man/man0/ subdir containing README and VERSION.</p></li>
|
46
52
|
</ul>
|
47
|
-
<h2 id="
|
53
|
+
<h2 id="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>Version 3.2.1 (2013-05-04)</h2><p>Patch:</p>
|
48
54
|
<ul>
|
49
55
|
<li><p>Ensure that the <code>binman:web</code> Rake task works the first time through.</p></li>
|
50
56
|
<li><p>Fix "uninitialized constant Md2Man::VERSION" errors in <code>binman/rakefile</code>.</p></li>
|
51
57
|
<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>
|
52
58
|
</ul>
|
53
|
-
<h2 id="
|
59
|
+
<h2 id="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>Version 3.2.0 (2012-10-14)</h2><p>Minor:</p>
|
54
60
|
<ul>
|
55
61
|
<li>add binman:web task to produce man pages in HTML</li>
|
56
62
|
</ul>
|
@@ -58,7 +64,7 @@
|
|
58
64
|
<ul>
|
59
65
|
<li>gemspec: package only roff files from inside man/</li>
|
60
66
|
</ul>
|
61
|
-
<h2 id="
|
67
|
+
<h2 id="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>Version 3.1.1 (2012-10-13)</h2><p>Patch:</p>
|
62
68
|
<ul>
|
63
69
|
<li><p>load() failed when leading comment header missing</p></li>
|
64
70
|
<li><p>lstrip() is too powerful; consume lines carefully</p></li>
|
@@ -67,7 +73,7 @@
|
|
67
73
|
<ul>
|
68
74
|
<li>fix broken link to redcarpet library home page</li>
|
69
75
|
</ul>
|
70
|
-
<h2 id="
|
76
|
+
<h2 id="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>Version 3.1.0 (2012-02-06)</h2><p>Minor:</p>
|
71
77
|
<ul>
|
72
78
|
<li>Added <code>binman help</code> command for use by non-Ruby bin scripts. See README
|
73
79
|
for usage examples from Perl, Python, Node.js, Tcl, AWK, and UNIX shell!</li>
|
@@ -81,7 +87,7 @@ for usage examples from Perl, Python, Node.js, Tcl, AWK, and UNIX shell!</li>
|
|
81
87
|
<ul>
|
82
88
|
<li>Shorten markdown headings; improve documentation; clean up.</li>
|
83
89
|
</ul>
|
84
|
-
<h2 id="
|
90
|
+
<h2 id="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>Version 3.0.1 (2012-02-02)</h2><p>Patch:</p>
|
85
91
|
<ul>
|
86
92
|
<li><p>BinMan.help(): ignore <code>-h</code> and <code>--help</code> options after standard <code>--</code> flag.</p></li>
|
87
93
|
<li><p>BinMan.show(): write temp file because not all systems support <code>man -l</code>.</p></li>
|
@@ -93,7 +99,7 @@ for usage examples from Perl, Python, Node.js, Tcl, AWK, and UNIX shell!</li>
|
|
93
99
|
<li><p>README: fix installation commands for development.</p></li>
|
94
100
|
<li><p>bundler suggests moving all dev deps into gemspec.</p></li>
|
95
101
|
</ul>
|
96
|
-
<h2 id="
|
102
|
+
<h2 id="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>Version 3.0.0 (2012-01-09)</h2><p>Major:</p>
|
97
103
|
<ul>
|
98
104
|
<li>Removed the <code>binman/gemspec</code> helper library because it did not play well
|
99
105
|
with Bundler. Use the standard <code>add_runtime_dependency</code> method instead.
|
@@ -104,7 +110,7 @@ with Bundler. Use the standard <code>add_runtime_dependency</code> method inste
|
|
104
110
|
<li>The <code>binman/Rakefile</code> helper library now hooks into Bundler's Rake tasks.
|
105
111
|
Be sure to add the <code>man/**/*</code> files to your gemspec <a href="https://github.com/sunaku/md2man/commit/75d7a0064fa86f1c98dd01391ad82245fd387c20">accordingly</a>.</li>
|
106
112
|
</ul>
|
107
|
-
<h2 id="
|
113
|
+
<h2 id="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>Version 2.0.0 (2011-12-06)</h2><p>Major:</p>
|
108
114
|
<ul>
|
109
115
|
<li>Removed the deprecated <code>binman/rake_tasks</code> helper library. Use
|
110
116
|
<code>binman/rakefile</code> instead.</li>
|
@@ -118,7 +124,7 @@ Be sure to add the <code>man/**/*</code> files to your gemspec <a href="https://
|
|
118
124
|
<li><p>Upgraded to md2man v1 for Markdown to UNIX man page conversion.</p></li>
|
119
125
|
<li><p>Do not hard-code the version number in <code>binman/gemspec</code> helper.</p></li>
|
120
126
|
</ul>
|
121
|
-
<h2 id="
|
127
|
+
<h2 id="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>Version 1.1.0 (2011-11-05)</h2><p>Alert:</p>
|
122
128
|
<ul>
|
123
129
|
<li>The <code>binman/rake_tasks</code> library has been renamed (with deprecation) to
|
124
130
|
<code>binman/rakefile</code>. The deprecation warning will be removed in the next
|
@@ -130,7 +136,7 @@ major release.</li>
|
|
130
136
|
builds and includes your UNIX man page files in your gem packages and also
|
131
137
|
adds binman as a runtime and development gem dependency.</li>
|
132
138
|
</ul>
|
133
|
-
<h2 id="
|
139
|
+
<h2 id="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>Version 1.0.0 (2011-10-13)</h2><p>Major:</p>
|
134
140
|
<ul>
|
135
141
|
<li><p>The <code>BinMan::dump()</code> method and corresponding <code>binman dump</code> command now
|
136
142
|
extract the leading comment header from their input before returning the
|
@@ -153,19 +159,19 @@ comment header from the <code>bin/</code> script into a UNIX man page for displa
|
|
153
159
|
<ul>
|
154
160
|
<li>README: explain dev deps and <code>man/</code> dir packaging.</li>
|
155
161
|
</ul>
|
156
|
-
<h2 id="
|
162
|
+
<h2 id="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>Version 0.1.2 (2011-10-13)</h2><p>Minor:</p>
|
157
163
|
<ul>
|
158
164
|
<li>The <a href="https://github.com/tanoku/redcarpet">Redcarpet2</a> library is not a runtime gem dependency anymore.</li>
|
159
165
|
</ul>
|
160
166
|
<p>Other:</p>
|
161
167
|
<ul>
|
162
168
|
<li><p>Extracted <code>BinMan::Renderer</code> into <a href="http://rdoc.info/github/sunaku/redcarpet-manpage">redcarpet-manpage</a> library.</p></li>
|
163
|
-
<li><p>Forgot to introduce leading comment headers in <a class="md2man-
|
169
|
+
<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>
|
164
170
|
</ul>
|
165
|
-
<h2 id="
|
171
|
+
<h2 id="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>Version 0.1.1 (2011-10-13)</h2><p>Minor:</p>
|
166
172
|
<ul>
|
167
173
|
<li><code>BinMan.read()</code> now supports embedded document (=begin/=end) comments
|
168
|
-
also. See <a class="md2man-
|
174
|
+
also. See <a class="md2man-reference" href="../man1/binman.1.html">binman(1)</a> for the new description of leading comment headers.</li>
|
169
175
|
</ul>
|
170
176
|
<p>Patch:</p>
|
171
177
|
<ul>
|
@@ -179,5 +185,5 @@ also. See <a class="md2man-xref" href="../man1/binman.1.html">binman(1)</a> for
|
|
179
185
|
<li><p>README: add link to example of binman markdown.</p></li>
|
180
186
|
<li><p>README: add obligatory screenshot! >:-)</p></li>
|
181
187
|
</ul>
|
182
|
-
<h2 id="
|
188
|
+
<h2 id="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>Version 0.0.1 (2011-10-12)</h2><p>First release! Happy birthday! Woohoo! :-)</p></div></body>
|
183
189
|
</html>
|
data/man/man0/VERSION.markdown
CHANGED
@@ -1,3 +1,17 @@
|
|
1
|
+
## Version 3.3.3 (2014-06-22)
|
2
|
+
|
3
|
+
This release upgrades to md2man 3.0 for improved HTML manuals.
|
4
|
+
|
5
|
+
### Other:
|
6
|
+
|
7
|
+
* README: add links to package, manuals, and GitHub.
|
8
|
+
|
9
|
+
* GitHub now supports relative links from the README:
|
10
|
+
|
11
|
+
https://help.github.com/articles/relative-links-in-readmes
|
12
|
+
|
13
|
+
* Upgrade to md2man 3.0 for improved HTML manuals.
|
14
|
+
|
1
15
|
## Version 3.3.2 (2013-08-30)
|
2
16
|
|
3
17
|
Patch:
|
data/man/man1/binman-rake.1
CHANGED
@@ -1,4 +1,4 @@
|
|
1
|
-
.TH BINMAN\-RAKE 1
|
1
|
+
.TH BINMAN\-RAKE 1 2014\-06\-22 3.3.3
|
2
2
|
.SH NAME
|
3
3
|
.PP
|
4
4
|
binman\-rake \- run
|
@@ -7,7 +7,7 @@ tasks from
|
|
7
7
|
.BR binman (1)
|
8
8
|
.SH SYNOPSIS
|
9
9
|
.PP
|
10
|
-
\fB\fCbinman
|
10
|
+
\fB\fCbinman\-rake\fR [\fIOPTION\fP]... [\fITASK\fP]...
|
11
11
|
.SH DESCRIPTION
|
12
12
|
.PP
|
13
13
|
This program lets you run
|
@@ -46,10 +46,10 @@ 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
|
49
|
+
\fB\fC\-h\fR, \fB\fC\-\-help\fR
|
50
50
|
Show this help manual.
|
51
51
|
.PP
|
52
|
-
Run \fB\fCrake
|
52
|
+
Run \fB\fCrake \-\-help\fR to see more options.
|
53
53
|
.SH SEE ALSO
|
54
54
|
.PP
|
55
55
|
.BR rake (1),
|
data/man/man1/binman-rake.1.html
CHANGED
@@ -2,20 +2,20 @@
|
|
2
2
|
<html>
|
3
3
|
<head>
|
4
4
|
<meta charset="utf-8" />
|
5
|
-
<meta name="generator" content="md2man
|
5
|
+
<meta name="generator" content="md2man 3.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="
|
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-22-3-3-3"><a name="binman-rake-1-2014-06-22-3-3-3" href="#binman-rake-1-2014-06-22-3-3-3" 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-22</span> <span class="md2man-source">3.3.3</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 'binman/rakefile'
|
13
13
|
</code></pre>
|
14
|
-
<p>If no <em>TASK</em> is specified, then the <code>binman</code> task is run by default.</p><h2 id="
|
15
|
-
It also runs the <code>md2man:man</code> task, provided by <a class="md2man-
|
14
|
+
<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
|
+
It also runs the <code>md2man:man</code> task, provided by <a class="md2man-reference">md2man-rake(1)</a>, which
|
16
16
|
builds UNIX manual pages from <code>*.markdown</code>, <code>*.mkd</code>, and <code>*.md</code> files
|
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
|
-
It also runs the <code>md2man:web</code> task, provided by <a class="md2man-
|
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="
|
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>
|
21
21
|
</html>
|
data/man/man1/binman.1
CHANGED
@@ -1,4 +1,4 @@
|
|
1
|
-
.TH BINMAN 1
|
1
|
+
.TH BINMAN 1 2014\-06\-22 3.3.3
|
2
2
|
.SH NAME
|
3
3
|
.PP
|
4
4
|
binman \- man pages for bin scripts
|
@@ -46,20 +46,20 @@ syntax from
|
|
46
46
|
.BR md2man (5):
|
47
47
|
.RS
|
48
48
|
.IP \(bu 2
|
49
|
-
There can be at most one top\-level heading (H1). It is emitted as \fB\fC
|
49
|
+
There can be at most one top\-level heading (H1). It is emitted as \fB\fC\&.TH\fR
|
50
50
|
in the
|
51
51
|
.BR roff (7)
|
52
52
|
output to define the UNIX manual page's header and footer.
|
53
53
|
.IP \(bu 2
|
54
54
|
Paragraphs whose lines are all uniformly indented by two spaces are
|
55
55
|
considered to be "indented paragraphs". They are unindented accordingly
|
56
|
-
before emission as \fB\fC
|
56
|
+
before emission as \fB\fC\&.IP\fR in the
|
57
57
|
.BR roff (7)
|
58
58
|
output.
|
59
59
|
.IP \(bu 2
|
60
60
|
Paragraphs whose subsequent lines (all except the first) are uniformly
|
61
61
|
indented by two spaces are considered to be a "tagged paragraphs". They
|
62
|
-
are unindented accordingly before emission as \fB\fC
|
62
|
+
are unindented accordingly before emission as \fB\fC\&.TP\fR in the
|
63
63
|
.BR roff (7)
|
64
64
|
output.
|
65
65
|
.RE
|
@@ -84,19 +84,19 @@ fenced_code_blocks
|
|
84
84
|
.RE
|
85
85
|
.SH OPTIONS
|
86
86
|
.TP
|
87
|
-
\fB\fC
|
87
|
+
\fB\fC\-h\fR, \fB\fC\-\-help\fR
|
88
88
|
Show this help manual.
|
89
89
|
.SH COMMANDS
|
90
90
|
.TP
|
91
91
|
\fB\fChelp\fR \fIFILE\fP [\fIARGUMENT\fP]...
|
92
|
-
If the given \fIARGUMENT\fP sequence contains \fB\fC
|
93
|
-
\fB\fC
|
92
|
+
If the given \fIARGUMENT\fP sequence contains \fB\fC\-h\fR or \fB\fC\-\-help\fR except after
|
93
|
+
\fB\fC\-\-\fR, then this program extracts the given \fIFILE\fP\&'s leading comment header,
|
94
94
|
converts it into
|
95
95
|
.BR roff (7),
|
96
96
|
and displays it using
|
97
97
|
.BR man (1)
|
98
98
|
before exiting with
|
99
|
-
status code \fB\fC0\fR
|
99
|
+
status code \fB\fC0\fR\&. Otherwise, this program exits with status code \fB\fC111\fR\&.
|
100
100
|
.TP
|
101
101
|
\fB\fCshow\fR [\fIFILE\fP]
|
102
102
|
Use
|
data/man/man1/binman.1.html
CHANGED
@@ -2,14 +2,14 @@
|
|
2
2
|
<html>
|
3
3
|
<head>
|
4
4
|
<meta charset="utf-8" />
|
5
|
-
<meta name="generator" content="md2man
|
5
|
+
<meta name="generator" content="md2man 3.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="
|
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-22-3-3-3"><a name="binman-1-2014-06-22-3-3-3" href="#binman-1-2014-06-22-3-3-3" class="md2man-permalink" title="permalink"></a><span class="md2man-title">BINMAN</span> <span class="md2man-section">1</span> <span class="md2man-date">2014-06-22</span> <span class="md2man-source">3.3.3</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
|
-
<a class="md2man-
|
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>
|
14
14
|
<li><p> A contiguous sequence of single-line comments (which begin with <code>#</code>
|
15
15
|
and optionally continue with a single space followed by any number of
|
@@ -20,19 +20,19 @@ ending at the first single blank line.</p></li>
|
|
20
20
|
begin with the respective delimiters and optionally continue with a single
|
21
21
|
space followed by any number of characters until the end of the line.</p></li>
|
22
22
|
</ol>
|
23
|
-
<h3 id="
|
24
|
-
conv</code> inherits the following additions to <a class="md2man-
|
23
|
+
<h3 id="markdown-processing-divergence"><a name="markdown-processing-divergence" href="#markdown-processing-divergence" class="md2man-permalink" title="permalink"></a>Markdown processing divergence</h3><p>Although your leading comment headers are written in <a class="md2man-reference">markdown(7)</a>, <code>binman
|
24
|
+
conv</code> inherits the following additions to <a class="md2man-reference">markdown(7)</a> syntax from <a class="md2man-reference">md2man(5)</a>:</p>
|
25
25
|
<ul>
|
26
26
|
<li><p>There can be at most one top-level heading (H1). It is emitted as <code>.TH</code>
|
27
|
-
in the <a class="md2man-
|
27
|
+
in the <a class="md2man-reference">roff(7)</a> output to define the UNIX manual page's header and footer.</p></li>
|
28
28
|
<li><p>Paragraphs whose lines are all uniformly indented by two spaces are
|
29
29
|
considered to be "indented paragraphs". They are unindented accordingly
|
30
|
-
before emission as <code>.IP</code> in the <a class="md2man-
|
30
|
+
before emission as <code>.IP</code> in the <a class="md2man-reference">roff(7)</a> output.</p></li>
|
31
31
|
<li><p>Paragraphs whose subsequent lines (all except the first) are uniformly
|
32
32
|
indented by two spaces are considered to be a "tagged paragraphs". They
|
33
|
-
are unindented accordingly before emission as <code>.TP</code> in the <a class="md2man-
|
33
|
+
are unindented accordingly before emission as <code>.TP</code> in the <a class="md2man-reference">roff(7)</a> output.</p></li>
|
34
34
|
</ul>
|
35
|
-
<h3 id="
|
35
|
+
<h3 id="markdown-processing-extensions"><a name="markdown-processing-extensions" href="#markdown-processing-extensions" class="md2man-permalink" title="permalink"></a>Markdown processing extensions</h3><p>The following <a href="https://github.com/vmg/redcarpet">Redcarpet</a> extensions are enabled while processing <a class="md2man-reference">markdown(7)</a>:</p>
|
36
36
|
<ul>
|
37
37
|
<li>tables</li>
|
38
38
|
<li>autolink</li>
|
@@ -40,11 +40,11 @@ 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="
|
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> [<em>ARGUMENT</em>]...</dt><dd>If the given <em>ARGUMENT</em> sequence contains <code>-h</code> or <code>--help</code> except after
|
44
44
|
<code>--</code>, then this program extracts the given <em>FILE</em>'s leading comment header,
|
45
|
-
converts it into <a class="md2man-
|
46
|
-
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>]</dt><dd>Use <a class="md2man-
|
47
|
-
extracted from the given <em>FILE</em> or STDIN.</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-
|
48
|
-
the given <em>FILE</em> or STDIN.</dd></dl><dl><dt><code>conv</code> [<em>FILE</em>]</dt><dd>Print the <a class="md2man-
|
49
|
-
<em>FILE</em> or STDIN.</dd></dl><h2 id="
|
45
|
+
converts it into <a class="md2man-reference">roff(7)</a>, and displays it using <a class="md2man-reference">man(1)</a> before exiting with
|
46
|
+
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>]</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
|
47
|
+
extracted from the given <em>FILE</em> or STDIN.</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
|
48
|
+
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
|
49
|
+
<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>
|
50
50
|
</html>
|
data/man/style.css
CHANGED
@@ -1,4 +1,4 @@
|
|
1
|
-
@import url('
|
1
|
+
@import url('https://netdna.bootstrapcdn.com/twitter-bootstrap/2.3.2/css/bootstrap-combined.no-icons.min.css');
|
2
2
|
|
3
3
|
@media all {
|
4
4
|
h1,
|
@@ -11,7 +11,7 @@
|
|
11
11
|
}
|
12
12
|
|
13
13
|
/* deactivate external manual page cross-references */
|
14
|
-
a.md2man-
|
14
|
+
a.md2man-reference:not([href]) {
|
15
15
|
color: inherit;
|
16
16
|
text-decoration: none;
|
17
17
|
}
|
@@ -21,7 +21,7 @@
|
|
21
21
|
body {
|
22
22
|
font-family: monospace;
|
23
23
|
text-align: justify;
|
24
|
-
max-width:
|
24
|
+
max-width: 83ch; /* 80 chars, +3 for Bootstrap CSS */
|
25
25
|
margin: auto;
|
26
26
|
}
|
27
27
|
|
@@ -31,6 +31,25 @@
|
|
31
31
|
font-size: smaller;
|
32
32
|
text-align: right;
|
33
33
|
}
|
34
|
+
|
35
|
+
h1:first-child > a.md2man-permalink {
|
36
|
+
display: none;
|
37
|
+
}
|
38
|
+
|
39
|
+
a.md2man-permalink {
|
40
|
+
float: left;
|
41
|
+
margin-left: -1em;
|
42
|
+
opacity: 0.25;
|
43
|
+
}
|
44
|
+
|
45
|
+
a.md2man-permalink:before {
|
46
|
+
content: '\2665'; /* ♥ */
|
47
|
+
}
|
48
|
+
|
49
|
+
a.md2man-permalink:hover,
|
50
|
+
*:target > a.md2man-permalink {
|
51
|
+
opacity: initial
|
52
|
+
}
|
34
53
|
}
|
35
54
|
|
36
55
|
@media print {
|
metadata
CHANGED
@@ -1,69 +1,63 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: binman
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 3.3.
|
4
|
+
version: 3.3.3
|
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:
|
11
|
+
date: 2014-06-23 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: md2man
|
15
15
|
requirement: !ruby/object:Gem::Requirement
|
16
16
|
requirements:
|
17
|
-
- - ~>
|
17
|
+
- - "~>"
|
18
18
|
- !ruby/object:Gem::Version
|
19
|
-
version: '
|
19
|
+
version: '3.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: '3.0'
|
27
27
|
- !ruby/object:Gem::Dependency
|
28
28
|
name: opener
|
29
29
|
requirement: !ruby/object:Gem::Requirement
|
30
30
|
requirements:
|
31
|
-
- -
|
31
|
+
- - ">="
|
32
32
|
- !ruby/object:Gem::Version
|
33
33
|
version: 0.1.0
|
34
|
-
- - <
|
34
|
+
- - "<"
|
35
35
|
- !ruby/object:Gem::Version
|
36
36
|
version: '1'
|
37
37
|
type: :runtime
|
38
38
|
prerelease: false
|
39
39
|
version_requirements: !ruby/object:Gem::Requirement
|
40
40
|
requirements:
|
41
|
-
- -
|
41
|
+
- - ">="
|
42
42
|
- !ruby/object:Gem::Version
|
43
43
|
version: 0.1.0
|
44
|
-
- - <
|
44
|
+
- - "<"
|
45
45
|
- !ruby/object:Gem::Version
|
46
46
|
version: '1'
|
47
47
|
- !ruby/object:Gem::Dependency
|
48
48
|
name: rake
|
49
49
|
requirement: !ruby/object:Gem::Requirement
|
50
50
|
requirements:
|
51
|
-
- -
|
51
|
+
- - "~>"
|
52
52
|
- !ruby/object:Gem::Version
|
53
|
-
version:
|
54
|
-
- - <
|
55
|
-
- !ruby/object:Gem::Version
|
56
|
-
version: '1'
|
53
|
+
version: '10.1'
|
57
54
|
type: :development
|
58
55
|
prerelease: false
|
59
56
|
version_requirements: !ruby/object:Gem::Requirement
|
60
57
|
requirements:
|
61
|
-
- -
|
62
|
-
- !ruby/object:Gem::Version
|
63
|
-
version: 0.9.2.2
|
64
|
-
- - <
|
58
|
+
- - "~>"
|
65
59
|
- !ruby/object:Gem::Version
|
66
|
-
version: '1'
|
60
|
+
version: '10.1'
|
67
61
|
description: Produces UNIX manual pages for executable scripts.
|
68
62
|
email:
|
69
63
|
- sunaku@gmail.com
|
@@ -73,7 +67,7 @@ executables:
|
|
73
67
|
extensions: []
|
74
68
|
extra_rdoc_files: []
|
75
69
|
files:
|
76
|
-
- .gitignore
|
70
|
+
- ".gitignore"
|
77
71
|
- EXAMPLE.png
|
78
72
|
- Gemfile
|
79
73
|
- LICENSE
|
@@ -86,15 +80,16 @@ files:
|
|
86
80
|
- lib/binman.rb
|
87
81
|
- lib/binman/rakefile.rb
|
88
82
|
- lib/binman/version.rb
|
83
|
+
- man/index.html
|
84
|
+
- man/man0/EXAMPLE.png
|
85
|
+
- man/man0/README.html
|
89
86
|
- man/man0/README.markdown
|
87
|
+
- man/man0/VERSION.html
|
90
88
|
- man/man0/VERSION.markdown
|
91
89
|
- man/man1/binman-rake.1
|
90
|
+
- man/man1/binman-rake.1.html
|
92
91
|
- man/man1/binman.1
|
93
|
-
- man/index.html
|
94
|
-
- man/man0/VERSION.html
|
95
|
-
- man/man0/README.html
|
96
92
|
- man/man1/binman.1.html
|
97
|
-
- man/man1/binman-rake.1.html
|
98
93
|
- man/style.css
|
99
94
|
homepage: http://github.com/sunaku/binman
|
100
95
|
licenses: []
|
@@ -105,17 +100,17 @@ require_paths:
|
|
105
100
|
- lib
|
106
101
|
required_ruby_version: !ruby/object:Gem::Requirement
|
107
102
|
requirements:
|
108
|
-
- -
|
103
|
+
- - ">="
|
109
104
|
- !ruby/object:Gem::Version
|
110
105
|
version: '0'
|
111
106
|
required_rubygems_version: !ruby/object:Gem::Requirement
|
112
107
|
requirements:
|
113
|
-
- -
|
108
|
+
- - ">="
|
114
109
|
- !ruby/object:Gem::Version
|
115
110
|
version: '0'
|
116
111
|
requirements: []
|
117
112
|
rubyforge_project:
|
118
|
-
rubygems_version: 2.
|
113
|
+
rubygems_version: 2.2.2
|
119
114
|
signing_key:
|
120
115
|
specification_version: 4
|
121
116
|
summary: man pages for bin scripts
|