binman 3.2.1 → 3.3.0

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.
@@ -0,0 +1,157 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <meta charset="utf-8" />
5
+ <meta name="generator" content="md2man 2.0.0 https://github.com/sunaku/md2man" />
6
+ <title>VERSION</title>
7
+ <link rel="stylesheet" href="../style.css"/>
8
+ <!--[if lt IE 9]><script src="http://html5shiv.googlecode.com/svn/trunk/html5.js"></script><![endif]-->
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-3-0-2013-05-08">Version 3.3.0 (2013-05-08)</h2><p>Minor:</p>
11
+ <ul>
12
+ <li><p>Add <a class="md2man-xref" href="../man1/binman-rake.1.html">binman-rake(1)</a> script to provide access to <code>binman/rakefile</code> tasks.</p></li>
13
+ <li><p>Always try showing HTML manual page in web browser from <code>BinMan.show()</code>.</p></li>
14
+ </ul>
15
+ <p>Other:</p>
16
+ <ul>
17
+ <li><p>Upgrade to md2man 2.0.0.</p></li>
18
+ <li><p>Rename HISTORY to VERSION so it sorts after README.</p></li>
19
+ <li><p>Add man/man0/ subdir containing README and VERSION.</p></li>
20
+ </ul>
21
+ <h2 id="Version-3-2-1-2013-05-04">Version 3.2.1 (2013-05-04)</h2><p>Patch:</p>
22
+ <ul>
23
+ <li><p>Ensure that the <code>binman:web</code> Rake task works the first time through.</p></li>
24
+ <li><p>Fix &quot;uninitialized constant Md2Man::VERSION&quot; errors in <code>binman/rakefile</code>.</p></li>
25
+ <li><p>Hook into the <code>build</code> Rake task only if Bundler&#39;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>
26
+ </ul>
27
+ <h2 id="Version-3-2-0-2012-10-14">Version 3.2.0 (2012-10-14)</h2><p>Minor:</p>
28
+ <ul>
29
+ <li>add binman:web task to produce man pages in HTML</li>
30
+ </ul>
31
+ <p>Other:</p>
32
+ <ul>
33
+ <li>gemspec: package only roff files from inside man/</li>
34
+ </ul>
35
+ <h2 id="Version-3-1-1-2012-10-13">Version 3.1.1 (2012-10-13)</h2><p>Patch:</p>
36
+ <ul>
37
+ <li><p>load() failed when leading comment header missing</p></li>
38
+ <li><p>lstrip() is too powerful; consume lines carefully</p></li>
39
+ </ul>
40
+ <p>Other:</p>
41
+ <ul>
42
+ <li>fix broken link to redcarpet library home page</li>
43
+ </ul>
44
+ <h2 id="Version-3-1-0-2012-02-06">Version 3.1.0 (2012-02-06)</h2><p>Minor:</p>
45
+ <ul>
46
+ <li>Added <code>binman help</code> command for use by non-Ruby bin scripts. See README
47
+ for usage examples from Perl, Python, Node.js, Tcl, AWK, and UNIX shell!</li>
48
+ </ul>
49
+ <p>Patch:</p>
50
+ <ul>
51
+ <li>Replace <code>gem install binman --development</code> tip in <code>BinMan::conv()</code> with
52
+ <code>gem install md2man</code> tip because the former just hangs in RubyGems 1.8.</li>
53
+ </ul>
54
+ <p>Other:</p>
55
+ <ul>
56
+ <li>Shorten markdown headings; improve documentation; clean up.</li>
57
+ </ul>
58
+ <h2 id="Version-3-0-1-2012-02-02">Version 3.0.1 (2012-02-02)</h2><p>Patch:</p>
59
+ <ul>
60
+ <li><p>BinMan.help(): ignore <code>-h</code> and <code>--help</code> options after standard <code>--</code> flag.</p></li>
61
+ <li><p>BinMan.show(): write temp file because not all systems support <code>man -l</code>.</p></li>
62
+ </ul>
63
+ <p>Other:</p>
64
+ <ul>
65
+ <li><p>HISTORY: group changes by version number components.</p></li>
66
+ <li><p>README: add instructions on pre-building man pages.</p></li>
67
+ <li><p>README: fix installation commands for development.</p></li>
68
+ <li><p>bundler suggests moving all dev deps into gemspec.</p></li>
69
+ </ul>
70
+ <h2 id="Version-3-0-0-2012-01-09">Version 3.0.0 (2012-01-09)</h2><p>Major:</p>
71
+ <ul>
72
+ <li>Removed the <code>binman/gemspec</code> helper library because it did not play well
73
+ with Bundler. Use the standard <code>add_runtime_dependency</code> method instead.
74
+ <a href="https://github.com/sunaku/md2man/commit/75d7a0064fa86f1c98dd01391ad82245fd387c20">This example</a> shows what work is involved in upgrading.</li>
75
+ </ul>
76
+ <p>Minor:</p>
77
+ <ul>
78
+ <li>The <code>binman/Rakefile</code> helper library now hooks into Bundler&#39;s Rake tasks.
79
+ Be sure to add the <code>man/**/*</code> files to your gemspec <a href="https://github.com/sunaku/md2man/commit/75d7a0064fa86f1c98dd01391ad82245fd387c20">accordingly</a>.</li>
80
+ </ul>
81
+ <h2 id="Version-2-0-0-2011-12-06">Version 2.0.0 (2011-12-06)</h2><p>Major:</p>
82
+ <ul>
83
+ <li>Removed the deprecated <code>binman/rake_tasks</code> helper library. Use
84
+ <code>binman/rakefile</code> instead.</li>
85
+ </ul>
86
+ <p>Patch:</p>
87
+ <ul>
88
+ <li>Fixed infinite looping in the <code>binman/gemspec</code> helper library.</li>
89
+ </ul>
90
+ <p>Other:</p>
91
+ <ul>
92
+ <li><p>Upgraded to md2man v1 for Markdown to UNIX man page conversion.</p></li>
93
+ <li><p>Do not hard-code the version number in <code>binman/gemspec</code> helper.</p></li>
94
+ </ul>
95
+ <h2 id="Version-1-1-0-2011-11-05">Version 1.1.0 (2011-11-05)</h2><p>Alert:</p>
96
+ <ul>
97
+ <li>The <code>binman/rake_tasks</code> library has been renamed (with deprecation) to
98
+ <code>binman/rakefile</code>. The deprecation warning will be removed in the next
99
+ major release.</li>
100
+ </ul>
101
+ <p>Minor:</p>
102
+ <ul>
103
+ <li>Add <code>binman/gemspec</code> packaging convenience library which automatically
104
+ builds and includes your UNIX man page files in your gem packages and also
105
+ adds binman as a runtime and development gem dependency.</li>
106
+ </ul>
107
+ <h2 id="Version-1-0-0-2011-10-13">Version 1.0.0 (2011-10-13)</h2><p>Major:</p>
108
+ <ul>
109
+ <li><p>The <code>BinMan::dump()</code> method and corresponding <code>binman dump</code> command now
110
+ extract the leading comment header from their input before returning the
111
+ markdown to roff conversion thereof.</p></li>
112
+ <li><p>The <code>BinMan::read()</code> method and corresponding <code>binman read</code> command have
113
+ been renamed to <code>BinMan::load()</code> and <code>binman load</code> respectively.</p></li>
114
+ </ul>
115
+ <p>Minor:</p>
116
+ <ul>
117
+ <li>Added <code>BinMan::conv()</code> method and corresponding <code>binman conv</code> command to
118
+ encapsulate the markdown to roff conversion process.</li>
119
+ </ul>
120
+ <p>Patch:</p>
121
+ <ul>
122
+ <li>Pre-built man pages included alongside a <code>bin/</code> script were not displayed.
123
+ Instead, binman was (incorrectly) always trying to convert the leading
124
+ comment header from the <code>bin/</code> script into a UNIX man page for display.</li>
125
+ </ul>
126
+ <p>Other:</p>
127
+ <ul>
128
+ <li>README: explain dev deps and <code>man/</code> dir packaging.</li>
129
+ </ul>
130
+ <h2 id="Version-0-1-2-2011-10-13">Version 0.1.2 (2011-10-13)</h2><p>Minor:</p>
131
+ <ul>
132
+ <li>The <a href="https://github.com/tanoku/redcarpet">Redcarpet2</a> library is not a runtime gem dependency anymore.</li>
133
+ </ul>
134
+ <p>Other:</p>
135
+ <ul>
136
+ <li><p>Extracted <code>BinMan::Renderer</code> into <a href="http://rdoc.info/github/sunaku/redcarpet-manpage">redcarpet-manpage</a> library.</p></li>
137
+ <li><p>Forgot to introduce leading comment headers in <a class="md2man-xref" href="../man1/binman.1.html">binman(1)</a> man page.</p></li>
138
+ </ul>
139
+ <h2 id="Version-0-1-1-2011-10-13">Version 0.1.1 (2011-10-13)</h2><p>Minor:</p>
140
+ <ul>
141
+ <li><code>BinMan.read()</code> now supports embedded document (=begin/=end) comments
142
+ also. See <a class="md2man-xref" href="../man1/binman.1.html">binman(1)</a> for the new description of leading comment headers.</li>
143
+ </ul>
144
+ <p>Patch:</p>
145
+ <ul>
146
+ <li><p>Ignore encoding comment line after shebang line.</p></li>
147
+ <li><p>roff: fix first paragraphs inside list items.</p></li>
148
+ </ul>
149
+ <p>Other:</p>
150
+ <ul>
151
+ <li><p>gemspec: build man page files before building gem.</p></li>
152
+ <li><p>binman: raise error and suggest --help option.</p></li>
153
+ <li><p>README: add link to example of binman markdown.</p></li>
154
+ <li><p>README: add obligatory screenshot! &gt;:-)</p></li>
155
+ </ul>
156
+ <h2 id="Version-0-0-1-2011-10-12">Version 0.0.1 (2011-10-12)</h2><p>First release! Happy birthday! Woohoo! :-)</p></div></body>
157
+ </html>
@@ -0,0 +1,199 @@
1
+ ## Version 3.3.0 (2013-05-08)
2
+
3
+ Minor:
4
+
5
+ * Add binman-rake(1) script to provide access to `binman/rakefile` tasks.
6
+
7
+ * Always try showing HTML manual page in web browser from `BinMan.show()`.
8
+
9
+ Other:
10
+
11
+ * Upgrade to md2man 2.0.0.
12
+
13
+ * Rename HISTORY to VERSION so it sorts after README.
14
+
15
+ * Add man/man0/ subdir containing README and VERSION.
16
+
17
+ ## Version 3.2.1 (2013-05-04)
18
+
19
+ Patch:
20
+
21
+ * Ensure that the `binman:web` Rake task works the first time through.
22
+
23
+ * Fix "uninitialized constant Md2Man::VERSION" errors in `binman/rakefile`.
24
+
25
+ * Hook into the `build` Rake task only if Bundler's Rake tasks are loaded:
26
+
27
+ https://github.com/sunaku/md2man/pull/7#issuecomment-9467621
28
+
29
+ Thanks to Postmodern for raising this issue.
30
+
31
+ ## Version 3.2.0 (2012-10-14)
32
+
33
+ Minor:
34
+
35
+ * add binman:web task to produce man pages in HTML
36
+
37
+ Other:
38
+
39
+ * gemspec: package only roff files from inside man/
40
+
41
+ ## Version 3.1.1 (2012-10-13)
42
+
43
+ Patch:
44
+
45
+ * load() failed when leading comment header missing
46
+
47
+ * lstrip() is too powerful; consume lines carefully
48
+
49
+ Other:
50
+
51
+ * fix broken link to redcarpet library home page
52
+
53
+ ## Version 3.1.0 (2012-02-06)
54
+
55
+ Minor:
56
+
57
+ * Added `binman help` command for use by non-Ruby bin scripts. See README
58
+ for usage examples from Perl, Python, Node.js, Tcl, AWK, and UNIX shell!
59
+
60
+ Patch:
61
+
62
+ * Replace `gem install binman --development` tip in `BinMan::conv()` with
63
+ `gem install md2man` tip because the former just hangs in RubyGems 1.8.
64
+
65
+ Other:
66
+
67
+ * Shorten markdown headings; improve documentation; clean up.
68
+
69
+ ## Version 3.0.1 (2012-02-02)
70
+
71
+ Patch:
72
+
73
+ * BinMan.help(): ignore `-h` and `--help` options after standard `--` flag.
74
+
75
+ * BinMan.show(): write temp file because not all systems support `man -l`.
76
+
77
+ Other:
78
+
79
+ * HISTORY: group changes by version number components.
80
+
81
+ * README: add instructions on pre-building man pages.
82
+
83
+ * README: fix installation commands for development.
84
+
85
+ * bundler suggests moving all dev deps into gemspec.
86
+
87
+ ## Version 3.0.0 (2012-01-09)
88
+
89
+ Major:
90
+
91
+ * Removed the `binman/gemspec` helper library because it did not play well
92
+ with Bundler. Use the standard `add_runtime_dependency` method instead.
93
+ [This example][1] shows what work is involved in upgrading.
94
+
95
+ Minor:
96
+
97
+ * The `binman/Rakefile` helper library now hooks into Bundler's Rake tasks.
98
+ Be sure to add the `man/**/*` files to your gemspec [accordingly][1].
99
+
100
+ [1]: https://github.com/sunaku/md2man/commit/75d7a0064fa86f1c98dd01391ad82245fd387c20
101
+
102
+ ## Version 2.0.0 (2011-12-06)
103
+
104
+ Major:
105
+
106
+ * Removed the deprecated `binman/rake_tasks` helper library. Use
107
+ `binman/rakefile` instead.
108
+
109
+ Patch:
110
+
111
+ * Fixed infinite looping in the `binman/gemspec` helper library.
112
+
113
+ Other:
114
+
115
+ * Upgraded to md2man v1 for Markdown to UNIX man page conversion.
116
+
117
+ * Do not hard-code the version number in `binman/gemspec` helper.
118
+
119
+ ## Version 1.1.0 (2011-11-05)
120
+
121
+ Alert:
122
+
123
+ * The `binman/rake_tasks` library has been renamed (with deprecation) to
124
+ `binman/rakefile`. The deprecation warning will be removed in the next
125
+ major release.
126
+
127
+ Minor:
128
+
129
+ * Add `binman/gemspec` packaging convenience library which automatically
130
+ builds and includes your UNIX man page files in your gem packages and also
131
+ adds binman as a runtime and development gem dependency.
132
+
133
+ ## Version 1.0.0 (2011-10-13)
134
+
135
+ Major:
136
+
137
+ * The `BinMan::dump()` method and corresponding `binman dump` command now
138
+ extract the leading comment header from their input before returning the
139
+ markdown to roff conversion thereof.
140
+
141
+ * The `BinMan::read()` method and corresponding `binman read` command have
142
+ been renamed to `BinMan::load()` and `binman load` respectively.
143
+
144
+ Minor:
145
+
146
+ * Added `BinMan::conv()` method and corresponding `binman conv` command to
147
+ encapsulate the markdown to roff conversion process.
148
+
149
+ Patch:
150
+
151
+ * Pre-built man pages included alongside a `bin/` script were not displayed.
152
+ Instead, binman was (incorrectly) always trying to convert the leading
153
+ comment header from the `bin/` script into a UNIX man page for display.
154
+
155
+ Other:
156
+
157
+ * README: explain dev deps and `man/` dir packaging.
158
+
159
+ ## Version 0.1.2 (2011-10-13)
160
+
161
+ Minor:
162
+
163
+ * The [Redcarpet2] library is not a runtime gem dependency anymore.
164
+
165
+ Other:
166
+
167
+ * Extracted `BinMan::Renderer` into [redcarpet-manpage] library.
168
+
169
+ * Forgot to introduce leading comment headers in binman(1) man page.
170
+
171
+ [Redcarpet2]: https://github.com/tanoku/redcarpet
172
+ [redcarpet-manpage]: http://rdoc.info/github/sunaku/redcarpet-manpage
173
+
174
+ ## Version 0.1.1 (2011-10-13)
175
+
176
+ Minor:
177
+
178
+ * `BinMan.read()` now supports embedded document (=begin/=end) comments
179
+ also. See binman(1) for the new description of leading comment headers.
180
+
181
+ Patch:
182
+
183
+ * Ignore encoding comment line after shebang line.
184
+
185
+ * roff: fix first paragraphs inside list items.
186
+
187
+ Other:
188
+
189
+ * gemspec: build man page files before building gem.
190
+
191
+ * binman: raise error and suggest --help option.
192
+
193
+ * README: add link to example of binman markdown.
194
+
195
+ * README: add obligatory screenshot! >:-)
196
+
197
+ ## Version 0.0.1 (2011-10-12)
198
+
199
+ First release! Happy birthday! Woohoo! :-)
@@ -0,0 +1,57 @@
1
+ .TH BINMAN\-RAKE 1 2013\-05\-08 3.3.0
2
+ .SH NAME
3
+ .PP
4
+ binman\-rake \- run
5
+ .BR rake (1)
6
+ tasks from
7
+ .BR binman (1)
8
+ .SH SYNOPSIS
9
+ .PP
10
+ \fB\fCbinman-rake\fR [\fIOPTION\fP]... [\fITASK\fP]...
11
+ .SH DESCRIPTION
12
+ .PP
13
+ This program lets you run
14
+ .BR rake (1)
15
+ tasks provided by
16
+ .BR binman (1)
17
+ without having
18
+ to create a special file named \fB\fCRakefile\fR that contains the following snippet:
19
+ .PP
20
+ .RS
21
+ .nf
22
+ require 'binman/rakefile'
23
+ .fi
24
+ .RE
25
+ .PP
26
+ If no \fITASK\fP is specified, then the \fB\fCbinman\fR task is run by default.
27
+ .SH TASKS
28
+ .TP
29
+ \fB\fCbinman\fR
30
+ Runs the \fB\fCbinman:man\fR and \fB\fCbinman:web\fR tasks, in that order.
31
+ .TP
32
+ \fB\fCbinman:man\fR
33
+ Builds UNIX manual pages from scripts found in your \fB\fCbin/\fR directory.
34
+ It also runs the \fB\fCmd2man:man\fR task, provided by
35
+ .BR md2man-rake (1),
36
+ which
37
+ builds UNIX manual pages from \fB\fC*.markdown\fR, \fB\fC*.mkd\fR, and \fB\fC*.md\fR files
38
+ found in or beneath the \fB\fCman/\fR subdirectory in your working directory.
39
+ .TP
40
+ \fB\fCbinman:web\fR
41
+ Builds HTML manual pages from scripts found in your \fB\fCbin/\fR directory.
42
+ It also runs the \fB\fCmd2man:web\fR task, provided by
43
+ .BR md2man-rake (1),
44
+ which
45
+ builds HTML manual pages from \fB\fC*.markdown\fR, \fB\fC*.mkd\fR, and \fB\fC*.md\fR files
46
+ found in or beneath the \fB\fCman/\fR subdirectory in your working directory.
47
+ .SH OPTIONS
48
+ .TP
49
+ \fB\fC-h\fR, \fB\fC--help\fR
50
+ Show this help manual.
51
+ .PP
52
+ Run \fB\fCrake --help\fR to see more options.
53
+ .SH SEE ALSO
54
+ .PP
55
+ .BR rake (1),
56
+ .BR binman (1),
57
+ .BR md2man-rake (1)
@@ -0,0 +1,21 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <meta charset="utf-8" />
5
+ <meta name="generator" content="md2man 2.0.0 https://github.com/sunaku/md2man" />
6
+ <title>binman-rake(1) &mdash; run rake(1) tasks from binman(1)</title>
7
+ <link rel="stylesheet" href="../style.css"/>
8
+ <!--[if lt IE 9]><script src="http://html5shiv.googlecode.com/svn/trunk/html5.js"></script><![endif]-->
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-2013-05-08-3-3-0">BINMAN-RAKE 1 2013-05-08 3.3.0</h1><h2 id="NAME">NAME</h2><p>binman-rake - run <a class="md2man-xref">rake(1)</a> tasks from <a class="md2man-xref" href="../man1/binman.1.html">binman(1)</a></p><h2 id="SYNOPSIS">SYNOPSIS</h2><p><code>binman-rake</code> [<em>OPTION</em>]... [<em>TASK</em>]...</p><h2 id="DESCRIPTION">DESCRIPTION</h2><p>This program lets you run <a class="md2man-xref">rake(1)</a> tasks provided by <a class="md2man-xref" href="../man1/binman.1.html">binman(1)</a> without having
11
+ to create a special file named <code>Rakefile</code> that contains the following snippet:</p>
12
+ <pre><code>require &#39;binman/rakefile&#39;
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="TASKS">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-xref">md2man-rake(1)</a>, which
16
+ builds UNIX manual pages from <code>*.markdown</code>, <code>*.mkd</code>, and <code>*.md</code> files
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-xref">md2man-rake(1)</a>, which
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="OPTIONS">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">SEE ALSO</h2><p><a class="md2man-xref">rake(1)</a>, <a class="md2man-xref" href="../man1/binman.1.html">binman(1)</a>, <a class="md2man-xref">md2man-rake(1)</a></p></div></body>
21
+ </html>
data/man/man1/binman.1 CHANGED
@@ -1,4 +1,4 @@
1
- .TH BINMAN 1 2013\-05\-04 3.2.1
1
+ .TH BINMAN 1 2013\-05\-08 3.3.0
2
2
  .SH NAME
3
3
  .PP
4
4
  binman \- man pages for bin scripts
@@ -81,9 +81,9 @@ superscript
81
81
  .IP \(bu 2
82
82
  strikethrough
83
83
  .IP \(bu 2
84
- no\fIintra\fPemphasis
84
+ no_intra_emphasis
85
85
  .IP \(bu 2
86
- fenced\fIcode\fPblocks
86
+ fenced_code_blocks
87
87
  .RE
88
88
  .SH OPTIONS
89
89
  .TP