binman 3.3.3 → 3.4.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.markdown +155 -109
- data/VERSION.markdown +15 -0
- data/bin/binman +10 -7
- data/bin/binman-rake +1 -1
- data/lib/binman.rb +32 -8
- data/lib/binman/version.rb +1 -1
- data/man/man0/README.html +26 -26
- data/man/man0/README.markdown +155 -109
- data/man/man0/VERSION.html +12 -1
- data/man/man0/VERSION.markdown +15 -0
- data/man/man1/binman-rake.1 +1 -1
- data/man/man1/binman-rake.1.html +1 -1
- data/man/man1/binman.1 +14 -9
- data/man/man1/binman.1.html +9 -6
- metadata +2 -2
data/man/man0/VERSION.html
CHANGED
|
@@ -7,7 +7,18 @@
|
|
|
7
7
|
<link rel="stylesheet" href="../style.css"/>
|
|
8
8
|
<!--[if lt IE 9]><script src="http://html5shiv.googlecode.com/svn/trunk/html5.js"></script><![endif]-->
|
|
9
9
|
</head>
|
|
10
|
-
<body><div class="navbar"><div class="navbar-inner"><span class="brand"><a href="../index.html#man0">man0</a>/VERSION</span></div></div><div class="container-fluid"><h2 id="version-3-
|
|
10
|
+
<body><div class="navbar"><div class="navbar-inner"><span class="brand"><a href="../index.html#man0">man0</a>/VERSION</span></div></div><div class="container-fluid"><h2 id="version-3-4-0-2014-06-29"><a name="version-3-4-0-2014-06-29" href="#version-3-4-0-2014-06-29" class="md2man-permalink" title="permalink"></a>Version 3.4.0 (2014-06-29)</h2><h3 id="minor"><a name="minor" href="#minor" class="md2man-permalink" title="permalink"></a>Minor:</h3>
|
|
11
|
+
<ul>
|
|
12
|
+
<li><p>GH-3: add optional regexp argument to <code>-h</code>/<code>--help</code> to search in <a class="md2man-reference">man(1)</a>.</p><p>The <code>-h</code> and <code>--help</code> options in <code>BinMan.help()</code> can now be optionally
|
|
13
|
+
followed by a regular expression argument that specifies text to search
|
|
14
|
+
for and, if found, jump to inside the displayed UNIX man page. Such a
|
|
15
|
+
regular expression argument can now also be passed into <code>BinMan.show()</code>.</p></li>
|
|
16
|
+
</ul>
|
|
17
|
+
<h3 id="other"><a name="other" href="#other" class="md2man-permalink" title="permalink"></a>Other:</h3>
|
|
18
|
+
<ul>
|
|
19
|
+
<li>README: add syntax highlighting to code snippets.</li>
|
|
20
|
+
</ul>
|
|
21
|
+
<h2 id="version-3-3-3-2014-06-22"><a name="version-3-3-3-2014-06-22" href="#version-3-3-3-2014-06-22" class="md2man-permalink" title="permalink"></a>Version 3.3.3 (2014-06-22)</h2><p>This release upgrades to md2man 3.0 for improved HTML manuals.</p><h3 id="other-1"><a name="other-1" href="#other-1" class="md2man-permalink" title="permalink"></a>Other:</h3>
|
|
11
22
|
<ul>
|
|
12
23
|
<li><p>README: add links to package, manuals, and GitHub.</p></li>
|
|
13
24
|
<li><p>GitHub now supports relative links from the README:</p><p><a href="https://help.github.com/articles/relative-links-in-readmes">https://help.github.com/articles/relative-links-in-readmes</a></p></li>
|
data/man/man0/VERSION.markdown
CHANGED
|
@@ -1,3 +1,18 @@
|
|
|
1
|
+
## Version 3.4.0 (2014-06-29)
|
|
2
|
+
|
|
3
|
+
### Minor:
|
|
4
|
+
|
|
5
|
+
* GH-3: add optional regexp argument to `-h`/`--help` to search in man(1).
|
|
6
|
+
|
|
7
|
+
The `-h` and `--help` options in `BinMan.help()` can now be optionally
|
|
8
|
+
followed by a regular expression argument that specifies text to search
|
|
9
|
+
for and, if found, jump to inside the displayed UNIX man page. Such a
|
|
10
|
+
regular expression argument can now also be passed into `BinMan.show()`.
|
|
11
|
+
|
|
12
|
+
### Other:
|
|
13
|
+
|
|
14
|
+
* README: add syntax highlighting to code snippets.
|
|
15
|
+
|
|
1
16
|
## Version 3.3.3 (2014-06-22)
|
|
2
17
|
|
|
3
18
|
This release upgrades to md2man 3.0 for improved HTML manuals.
|
data/man/man1/binman-rake.1
CHANGED
data/man/man1/binman-rake.1.html
CHANGED
|
@@ -7,7 +7,7 @@
|
|
|
7
7
|
<link rel="stylesheet" href="../style.css"/>
|
|
8
8
|
<!--[if lt IE 9]><script src="http://html5shiv.googlecode.com/svn/trunk/html5.js"></script><![endif]-->
|
|
9
9
|
</head>
|
|
10
|
-
<body><div class="navbar"><div class="navbar-inner"><span class="brand"><a href="../index.html#man1">man1</a>/binman-rake.1</span></div></div><div class="container-fluid"><h1 id="binman-rake-1-2014-06-
|
|
10
|
+
<body><div class="navbar"><div class="navbar-inner"><span class="brand"><a href="../index.html#man1">man1</a>/binman-rake.1</span></div></div><div class="container-fluid"><h1 id="binman-rake-1-2014-06-29-3-4-0"><a name="binman-rake-1-2014-06-29-3-4-0" href="#binman-rake-1-2014-06-29-3-4-0" class="md2man-permalink" title="permalink"></a><span class="md2man-title">BINMAN-RAKE</span> <span class="md2man-section">1</span> <span class="md2man-date">2014-06-29</span> <span class="md2man-source">3.4.0</span></h1><h2 id="name"><a name="name" href="#name" class="md2man-permalink" title="permalink"></a>NAME</h2><p>binman-rake - run <a class="md2man-reference">rake(1)</a> tasks from <a class="md2man-reference" href="../man1/binman.1.html">binman(1)</a></p><h2 id="synopsis"><a name="synopsis" href="#synopsis" class="md2man-permalink" title="permalink"></a>SYNOPSIS</h2><p><code>binman-rake</code> [<em>OPTION</em>]... [<em>TASK</em>]...</p><h2 id="description"><a name="description" href="#description" class="md2man-permalink" title="permalink"></a>DESCRIPTION</h2><p>This program lets you run <a class="md2man-reference">rake(1)</a> tasks provided by <a class="md2man-reference" href="../man1/binman.1.html">binman(1)</a> without having
|
|
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>
|
data/man/man1/binman.1
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
.TH BINMAN 1 2014\-06\-
|
|
1
|
+
.TH BINMAN 1 2014\-06\-29 3.4.0
|
|
2
2
|
.SH NAME
|
|
3
3
|
.PP
|
|
4
4
|
binman \- man pages for bin scripts
|
|
@@ -88,23 +88,28 @@ fenced_code_blocks
|
|
|
88
88
|
Show this help manual.
|
|
89
89
|
.SH COMMANDS
|
|
90
90
|
.TP
|
|
91
|
-
\fB\fChelp\fR \fIFILE\fP [\
|
|
92
|
-
If the given
|
|
93
|
-
\fB\fC\-\-\fR,
|
|
91
|
+
\fB\fChelp\fR \fIFILE\fP ... [\fB\fC\-h\fR|\fB\fC\-\-help\fR [\fIREGEXP\fP]] ... [\fB\fC\-\-\fR] ...
|
|
92
|
+
If the given argument sequence contains \fB\fC\-h\fR or \fB\fC\-\-help\fR, except after
|
|
93
|
+
\fB\fC\-\-\fR, optionally followed by a \fIREGEXP\fP regular expression that specifies
|
|
94
|
+
text to search for and, if found, jump to inside the displayed man page,
|
|
95
|
+
then this program extracts the given \fIFILE\fP\&'s leading comment header,
|
|
94
96
|
converts it into
|
|
95
97
|
.BR roff (7),
|
|
96
|
-
|
|
97
|
-
.BR man (1)
|
|
98
|
-
|
|
98
|
+
displays it using
|
|
99
|
+
.BR man (1),
|
|
100
|
+
and finally exits with
|
|
99
101
|
status code \fB\fC0\fR\&. Otherwise, this program exits with status code \fB\fC111\fR\&.
|
|
100
102
|
.TP
|
|
101
|
-
\fB\fCshow\fR [\fIFILE\fP]
|
|
103
|
+
\fB\fCshow\fR [\fIFILE\fP] [\fIREGEXP\fP]
|
|
102
104
|
Use
|
|
103
105
|
.BR man (1)
|
|
104
106
|
to display the
|
|
105
107
|
.BR roff (7)
|
|
106
108
|
conversion of the leading comment header
|
|
107
|
-
extracted from the given \fIFILE\fP or STDIN.
|
|
109
|
+
extracted from the given \fIFILE\fP or STDIN. If \fIREGEXP\fP is given, search for
|
|
110
|
+
it within the output displayed by
|
|
111
|
+
.BR man (1)
|
|
112
|
+
and jump to first match if found.
|
|
108
113
|
.TP
|
|
109
114
|
\fB\fCload\fR [\fIFILE\fP]
|
|
110
115
|
Print the leading comment header extracted from the given \fIFILE\fP or STDIN.
|
data/man/man1/binman.1.html
CHANGED
|
@@ -7,7 +7,7 @@
|
|
|
7
7
|
<link rel="stylesheet" href="../style.css"/>
|
|
8
8
|
<!--[if lt IE 9]><script src="http://html5shiv.googlecode.com/svn/trunk/html5.js"></script><![endif]-->
|
|
9
9
|
</head>
|
|
10
|
-
<body><div class="navbar"><div class="navbar-inner"><span class="brand"><a href="../index.html#man1">man1</a>/binman.1</span></div></div><div class="container-fluid"><h1 id="binman-1-2014-06-
|
|
10
|
+
<body><div class="navbar"><div class="navbar-inner"><span class="brand"><a href="../index.html#man1">man1</a>/binman.1</span></div></div><div class="container-fluid"><h1 id="binman-1-2014-06-29-3-4-0"><a name="binman-1-2014-06-29-3-4-0" href="#binman-1-2014-06-29-3-4-0" class="md2man-permalink" title="permalink"></a><span class="md2man-title">BINMAN</span> <span class="md2man-section">1</span> <span class="md2man-date">2014-06-29</span> <span class="md2man-source">3.4.0</span></h1><h2 id="name"><a name="name" href="#name" class="md2man-permalink" title="permalink"></a>NAME</h2><p>binman - man pages for bin scripts</p><h2 id="synopsis"><a name="synopsis" href="#synopsis" class="md2man-permalink" title="permalink"></a>SYNOPSIS</h2><p><code>binman</code> [<em>OPTION</em>]... <em>COMMAND</em></p><h2 id="description"><a name="description" href="#description" class="md2man-permalink" title="permalink"></a>DESCRIPTION</h2><p><a href="https://github.com/sunaku/binman">binman</a> produces UNIX manual pages for your executable scripts. It can
|
|
11
11
|
extract their leading comment headers (defined below), convert them from
|
|
12
12
|
<a class="md2man-reference">markdown(7)</a> into <a class="md2man-reference">roff(7)</a> using <a href="https://github.com/sunaku/md2man">md2man</a>, and display them using <a class="md2man-reference">man(1)</a>.</p><h3 id="leading-comment-headers"><a name="leading-comment-headers" href="#leading-comment-headers" class="md2man-permalink" title="permalink"></a>Leading comment headers</h3><p>A leading comment header can be one of the following two things:</p>
|
|
13
13
|
<ol>
|
|
@@ -40,11 +40,14 @@ are unindented accordingly before emission as <code>.TP</code> in the <a class="
|
|
|
40
40
|
<li>strikethrough</li>
|
|
41
41
|
<li>fenced_code_blocks</li>
|
|
42
42
|
</ul>
|
|
43
|
-
<h2 id="options"><a name="options" href="#options" class="md2man-permalink" title="permalink"></a>OPTIONS</h2><dl><dt><code>-h</code>, <code>--help</code></dt><dd>Show this help manual.</dd></dl><h2 id="commands"><a name="commands" href="#commands" class="md2man-permalink" title="permalink"></a>COMMANDS</h2><dl><dt><code>help</code> <em>FILE</em> [<em>
|
|
44
|
-
<code>--</code>,
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
43
|
+
<h2 id="options"><a name="options" href="#options" class="md2man-permalink" title="permalink"></a>OPTIONS</h2><dl><dt><code>-h</code>, <code>--help</code></dt><dd>Show this help manual.</dd></dl><h2 id="commands"><a name="commands" href="#commands" class="md2man-permalink" title="permalink"></a>COMMANDS</h2><dl><dt><code>help</code> <em>FILE</em> ... [<code>-h</code>|<code>--help</code> [<em>REGEXP</em>]] ... [<code>--</code>] ...</dt><dd>If the given argument sequence contains <code>-h</code> or <code>--help</code>, except after
|
|
44
|
+
<code>--</code>, optionally followed by a <em>REGEXP</em> regular expression that specifies
|
|
45
|
+
text to search for and, if found, jump to inside the displayed man page,
|
|
46
|
+
then this program extracts the given <em>FILE</em>'s leading comment header,
|
|
47
|
+
converts it into <a class="md2man-reference">roff(7)</a>, displays it using <a class="md2man-reference">man(1)</a>, and finally exits with
|
|
48
|
+
status code <code>0</code>. Otherwise, this program exits with status code <code>111</code>.</dd></dl><dl><dt><code>show</code> [<em>FILE</em>] [<em>REGEXP</em>]</dt><dd>Use <a class="md2man-reference">man(1)</a> to display the <a class="md2man-reference">roff(7)</a> conversion of the leading comment header
|
|
49
|
+
extracted from the given <em>FILE</em> or STDIN. If <em>REGEXP</em> is given, search for
|
|
50
|
+
it within the output displayed by <a class="md2man-reference">man(1)</a> and jump to first match if found.</dd></dl><dl><dt><code>load</code> [<em>FILE</em>]</dt><dd>Print the leading comment header extracted from the given <em>FILE</em> or STDIN.</dd></dl><dl><dt><code>dump</code> [<em>FILE</em>]</dt><dd>Print the <a class="md2man-reference">roff(7)</a> conversion of the leading comment header extracted from
|
|
48
51
|
the given <em>FILE</em> or STDIN.</dd></dl><dl><dt><code>conv</code> [<em>FILE</em>]</dt><dd>Print the <a class="md2man-reference">roff(7)</a> conversion of the <a class="md2man-reference">markdown(7)</a> document read from the given
|
|
49
52
|
<em>FILE</em> or STDIN.</dd></dl><h2 id="see-also"><a name="see-also" href="#see-also" class="md2man-permalink" title="permalink"></a>SEE ALSO</h2><p><a class="md2man-reference" href="../man1/binman-rake.1.html">binman-rake(1)</a>, <a class="md2man-reference">man(1)</a>, <a class="md2man-reference">roff(7)</a>, <a class="md2man-reference">markdown(7)</a></p></div></body>
|
|
50
53
|
</html>
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: binman
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 3.
|
|
4
|
+
version: 3.4.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Suraj N. Kurapati
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2014-06-
|
|
11
|
+
date: 2014-06-29 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: md2man
|