binman 4.2.1 → 5.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- 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/man/man1/binman-rake.1
CHANGED
data/man/man1/binman-rake.1.html
CHANGED
|
@@ -2,15 +2,15 @@
|
|
|
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>binman-rake(1) — run rake(1) tasks from binman(1)</title>
|
|
7
7
|
<link rel="stylesheet" href="../style.css"/>
|
|
8
8
|
<!--[if lt IE 9]><script src="http://html5shiv.googlecode.com/svn/trunk/html5.js"></script><![endif]-->
|
|
9
9
|
</head>
|
|
10
|
-
<body><div class="navbar"><div class="navbar-inner"><span class="brand"><a href="../index.html#man1">man1</a>/binman-rake.1</span></div></div><div class="container-fluid"><h1 id="binman-rake-1-2016-02-
|
|
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-2016-02-13-5-0-1"><span class="md2man-title">BINMAN-RAKE</span> <span class="md2man-section">1</span> <span class="md2man-date">2016-02-13</span> <span class="md2man-source">5.0.1</span><a name="binman-rake-1-2016-02-13-5-0-1" href="#binman-rake-1-2016-02-13-5-0-1" class="md2man-permalink" title="permalink"></a></h1><h2 id="name">NAME<a name="name" href="#name" class="md2man-permalink" title="permalink"></a></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">SYNOPSIS<a name="synopsis" href="#synopsis" class="md2man-permalink" title="permalink"></a></h2><p><code>binman-rake</code> [<em>OPTION</em>]... [<em>TASK</em>]...</p><h2 id="description">DESCRIPTION<a name="description" href="#description" class="md2man-permalink" title="permalink"></a></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><pre><code>require 'binman/rakefile'
|
|
12
12
|
</code></pre>
|
|
13
|
-
<p>If no <em>TASK</em> is specified, then the <code>binman</code> task is run by default.</p><h2 id="tasks"
|
|
13
|
+
<p>If no <em>TASK</em> is specified, then the <code>binman</code> task is run by default.</p><h2 id="tasks">TASKS<a name="tasks" href="#tasks" class="md2man-permalink" title="permalink"></a></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:mkd</code></dt><dd>Extracts manual page sources embedded in scripts found in your <code>bin/</code>
|
|
14
14
|
directory and saves them as <code>man/man1/*.1.markdown</code> files, which can
|
|
15
15
|
then be rendered as HTML or UNIX manual pages using <a class="md2man-reference">md2man-rake(1)</a>.</dd></dl><dl><dt><code>binman:man</code></dt><dd>Builds UNIX manual pages from scripts found in your <code>bin/</code> directory.
|
|
16
16
|
It also runs the <code>md2man:man</code> task, provided by <a class="md2man-reference">md2man-rake(1)</a>, which
|
|
@@ -18,5 +18,5 @@ builds UNIX manual pages from <code>*.markdown</code>, <code>*.mkd</code>, and <
|
|
|
18
18
|
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.
|
|
19
19
|
It also runs the <code>md2man:web</code> task, provided by <a class="md2man-reference">md2man-rake(1)</a>, which
|
|
20
20
|
builds HTML manual pages from <code>*.markdown</code>, <code>*.mkd</code>, and <code>*.md</code> files
|
|
21
|
-
found in or beneath the <code>man/</code> subdirectory in your working directory.</dd></dl><h2 id="options"
|
|
21
|
+
found in or beneath the <code>man/</code> subdirectory in your working directory.</dd></dl><h2 id="options">OPTIONS<a name="options" href="#options" class="md2man-permalink" title="permalink"></a></h2><dl><dt><code>-h</code> [<em>REGEXP</em>], <code>--help</code> [<em>REGEXP</em>]</dt><dd>Show this help manual and search for <em>REGEXP</em> regular expression therein.</dd></dl><dl><dt>...</dt><dd>Anything else is passed to <a class="md2man-reference">rake(1)</a>; run <code>rake --help</code> for documentation.</dd></dl><h2 id="see-also">SEE ALSO<a name="see-also" href="#see-also" class="md2man-permalink" title="permalink"></a></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>
|
|
22
22
|
</html>
|
data/man/man1/binman.1
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
.TH BINMAN 1 2016\-02\-
|
|
1
|
+
.TH BINMAN 1 2016\-02\-13 5.0.1
|
|
2
2
|
.SH NAME
|
|
3
3
|
.PP
|
|
4
4
|
binman \- man pages for bin scripts
|
|
@@ -83,15 +83,19 @@ fenced_code_blocks
|
|
|
83
83
|
Show this help manual and search for \fIPATTERN\fP regular expression therein.
|
|
84
84
|
.SH COMMANDS
|
|
85
85
|
.TP
|
|
86
|
-
\fB\
|
|
86
|
+
\fB\fCtext\fR [\fIFILE\fP]
|
|
87
87
|
Print the leading comment header extracted from the given \fIFILE\fP or STDIN.
|
|
88
88
|
.TP
|
|
89
|
-
\fB\
|
|
89
|
+
\fB\fCroff\fR [\fIFILE\fP]
|
|
90
90
|
Print the
|
|
91
91
|
.BR roff (7)
|
|
92
92
|
conversion of the leading comment header extracted from
|
|
93
93
|
the given \fIFILE\fP or STDIN.
|
|
94
94
|
.TP
|
|
95
|
+
\fB\fChtml\fR [\fIFILE\fP]
|
|
96
|
+
Print the HTML conversion of the leading comment header extracted from
|
|
97
|
+
the given \fIFILE\fP or STDIN.
|
|
98
|
+
.TP
|
|
95
99
|
\fB\fCshow\fR [\fIFILE\fP] [\fIPATTERN\fP]
|
|
96
100
|
Use
|
|
97
101
|
.BR man (1)
|
|
@@ -102,6 +106,12 @@ extracted from the given \fIFILE\fP or STDIN. If \fIPATTERN\fP is given, search
|
|
|
102
106
|
it within the output displayed by
|
|
103
107
|
.BR man (1)
|
|
104
108
|
and jump to first match if found.
|
|
109
|
+
If
|
|
110
|
+
.BR man (1)
|
|
111
|
+
cannot display the
|
|
112
|
+
.BR roff (1)
|
|
113
|
+
conversion, fall back to the showing
|
|
114
|
+
the HTML conversion; if that fails too, display the extracted text as\-is.
|
|
105
115
|
.TP
|
|
106
116
|
\fB\fChelp\fR \fIFILE\fP ... [\fB\fC\-h\fR|\fB\fC\-\-help\fR [\fIPATTERN\fP]] ... [\fB\fC\-\-\fR] ...
|
|
107
117
|
If the given argument sequence contains \fB\fC\-h\fR or \fB\fC\-\-help\fR, except after
|
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 5.0.1 https://github.com/sunaku/md2man" />
|
|
6
6
|
<title>binman(1) — man pages for bin scripts</title>
|
|
7
7
|
<link rel="stylesheet" href="../style.css"/>
|
|
8
8
|
<!--[if lt IE 9]><script src="http://html5shiv.googlecode.com/svn/trunk/html5.js"></script><![endif]-->
|
|
9
9
|
</head>
|
|
10
|
-
<body><div class="navbar"><div class="navbar-inner"><span class="brand"><a href="../index.html#man1">man1</a>/binman.1</span></div></div><div class="container-fluid"><h1 id="binman-1-2016-02-
|
|
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-2016-02-13-5-0-1"><span class="md2man-title">BINMAN</span> <span class="md2man-section">1</span> <span class="md2man-date">2016-02-13</span> <span class="md2man-source">5.0.1</span><a name="binman-1-2016-02-13-5-0-1" href="#binman-1-2016-02-13-5-0-1" class="md2man-permalink" title="permalink"></a></h1><h2 id="name">NAME<a name="name" href="#name" class="md2man-permalink" title="permalink"></a></h2><p>binman - man pages for bin scripts</p><h2 id="synopsis">SYNOPSIS<a name="synopsis" href="#synopsis" class="md2man-permalink" title="permalink"></a></h2><p><code>binman</code> [<em>OPTION</em>]... <em>COMMAND</em></p><h2 id="description">DESCRIPTION<a name="description" href="#description" class="md2man-permalink" title="permalink"></a></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-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"
|
|
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">Leading comment headers<a name="leading-comment-headers" href="#leading-comment-headers" class="md2man-permalink" title="permalink"></a></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,7 +20,7 @@ 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="markdown-processing-divergence"
|
|
23
|
+
<h3 id="markdown-processing-divergence">Markdown processing divergence<a name="markdown-processing-divergence" href="#markdown-processing-divergence" class="md2man-permalink" title="permalink"></a></h3><p>Although your leading comment headers are written in <a class="md2man-reference">markdown(7)</a>, <code>binman
|
|
24
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>
|
|
@@ -32,7 +32,7 @@ before emission as <code>.IP</code> in the <a class="md2man-reference">roff(7)</
|
|
|
32
32
|
indented by two spaces are considered to be a "tagged paragraphs". They
|
|
33
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="markdown-processing-extensions"
|
|
35
|
+
<h3 id="markdown-processing-extensions">Markdown processing extensions<a name="markdown-processing-extensions" href="#markdown-processing-extensions" class="md2man-permalink" title="permalink"></a></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,13 +40,16 @@ 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"
|
|
43
|
+
<h2 id="options">OPTIONS<a name="options" href="#options" class="md2man-permalink" title="permalink"></a></h2><dl><dt><code>-h</code> [<em>PATTERN</em>], <code>--help</code> [<em>PATTERN</em>]</dt><dd>Show this help manual and search for <em>PATTERN</em> regular expression therein.</dd></dl><h2 id="commands">COMMANDS<a name="commands" href="#commands" class="md2man-permalink" title="permalink"></a></h2><dl><dt><code>text</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>roff</code> [<em>FILE</em>]</dt><dd>Print the <a class="md2man-reference">roff(7)</a> conversion of the leading comment header extracted from
|
|
44
|
+
the given <em>FILE</em> or STDIN.</dd></dl><dl><dt><code>html</code> [<em>FILE</em>]</dt><dd>Print the HTML conversion of the leading comment header extracted from
|
|
44
45
|
the given <em>FILE</em> or STDIN.</dd></dl><dl><dt><code>show</code> [<em>FILE</em>] [<em>PATTERN</em>]</dt><dd>Use <a class="md2man-reference">man(1)</a> to display the <a class="md2man-reference">roff(7)</a> conversion of the leading comment header
|
|
45
46
|
extracted from the given <em>FILE</em> or STDIN. If <em>PATTERN</em> is given, search for
|
|
46
|
-
it within the output displayed by <a class="md2man-reference">man(1)</a> and jump to first match if found
|
|
47
|
+
it within the output displayed by <a class="md2man-reference">man(1)</a> and jump to first match if found.
|
|
48
|
+
If <a class="md2man-reference">man(1)</a> cannot display the <a class="md2man-reference">roff(1)</a> conversion, fall back to the showing
|
|
49
|
+
the HTML conversion; if that fails too, display the extracted text as-is.</dd></dl><dl><dt><code>help</code> <em>FILE</em> ... [<code>-h</code>|<code>--help</code> [<em>PATTERN</em>]] ... [<code>--</code>] ...</dt><dd>If the given argument sequence contains <code>-h</code> or <code>--help</code>, except after
|
|
47
50
|
<code>--</code>, optionally followed by a <em>PATTERN</em> regular expression that specifies
|
|
48
51
|
text to search for and, if found, jump to inside the displayed man page,
|
|
49
52
|
then this program extracts the given <em>FILE</em>'s leading comment header,
|
|
50
53
|
converts it into <a class="md2man-reference">roff(7)</a>, displays it using <a class="md2man-reference">man(1)</a>, and finally exits with
|
|
51
|
-
status code <code>0</code>. Otherwise, this program exits with status code <code>111</code>.</dd></dl><h2 id="see-also"
|
|
54
|
+
status code <code>0</code>. Otherwise, this program exits with status code <code>111</code>.</dd></dl><h2 id="see-also">SEE ALSO<a name="see-also" href="#see-also" class="md2man-permalink" title="permalink"></a></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>
|
|
52
55
|
</html>
|
metadata
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: binman
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version:
|
|
4
|
+
version: 5.0.1
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Suraj N. Kurapati
|
|
@@ -16,14 +16,14 @@ dependencies:
|
|
|
16
16
|
requirements:
|
|
17
17
|
- - "~>"
|
|
18
18
|
- !ruby/object:Gem::Version
|
|
19
|
-
version: '
|
|
19
|
+
version: '5.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: '5.0'
|
|
27
27
|
- !ruby/object:Gem::Dependency
|
|
28
28
|
name: opener
|
|
29
29
|
requirement: !ruby/object:Gem::Requirement
|