README.markdown in binman-3.4.1 vs README.markdown in binman-4.0.0
- old
+ new
@@ -2,13 +2,13 @@
[binman] produces UNIX manual pages for executable scripts using [md2man].
Simply [document your script in Markdown][md2man-markdown] as a comment at the
top of your script and call `binman show` to display it as a UNIX manual page!
Or, call `binman help` to display your manual _only_ when your script receives
-with `-h` or `--help` command-line options. Or, call `binman load` to extract
+with `-h` or `--help` command-line options. Or, call `binman snip` to extract
the manual from your script for your own custom processing, outside of binman.
-And that's not all: [see the manual][binman-man] for even more possibilities!
+And that's not all: [see the manual page][binman-man] for more possibilities!
* Manuals: <https://sunaku.github.io/binman/man>
* Sources: <https://github.com/sunaku/binman>
* Support: <https://github.com/sunaku/binman/issues>
* Package: <https://rubygems.org/gems/binman>
@@ -27,67 +27,77 @@
### Demonstration
-Here are some working examples of Ruby bin scripts to help you get started:
+#### What can binman(1) do?
-* tork(1):
- [Ruby source](https://raw.github.com/sunaku/tork/master/bin/tork) →
- [HTML result](https://sunaku.github.io/tork/man/man1/tork.1.html) +
- [roff result](https://sunaku.github.io/tork/man/man1/tork.1)
-* tork-runner(1):
- [Ruby source](https://raw.github.com/sunaku/tork/master/bin/tork-runner) →
- [HTML result](https://sunaku.github.io/tork/man/man1/tork-runner.1.html) +
- [roff result](https://sunaku.github.io/tork/man/man1/tork-runner.1)
-* tork-herald(1):
- [Ruby source](https://raw.github.com/sunaku/tork/master/bin/tork-herald) →
- [HTML result](https://sunaku.github.io/tork/man/man1/tork-herald.1.html) +
- [roff result](https://sunaku.github.io/tork/man/man1/tork-herald.1)
-* tork-driver(1):
- [Ruby source](https://raw.github.com/sunaku/tork/master/bin/tork-driver) →
- [HTML result](https://sunaku.github.io/tork/man/man1/tork-driver.1.html) +
- [roff result](https://sunaku.github.io/tork/man/man1/tork-driver.1)
-* tork-engine(1):
- [Ruby source](https://raw.github.com/sunaku/tork/master/bin/tork-engine) →
- [HTML result](https://sunaku.github.io/tork/man/man1/tork-engine.1.html) +
- [roff result](https://sunaku.github.io/tork/man/man1/tork-engine.1)
-* tork-master(1):
- [Ruby source](https://raw.github.com/sunaku/tork/master/bin/tork-master) →
- [HTML result](https://sunaku.github.io/tork/man/man1/tork-master.1.html) +
- [roff result](https://sunaku.github.io/tork/man/man1/tork-master.1)
-* tork-remote(1):
- [Ruby source](https://raw.github.com/sunaku/tork/master/bin/tork-remote) →
- [HTML result](https://sunaku.github.io/tork/man/man1/tork-remote.1.html) +
- [roff result](https://sunaku.github.io/tork/man/man1/tork-remote.1)
-* tork-notify(1):
- [Ruby source](https://raw.github.com/sunaku/tork/master/bin/tork-notify) →
- [HTML result](https://sunaku.github.io/tork/man/man1/tork-notify.1.html) +
- [roff result](https://sunaku.github.io/tork/man/man1/tork-notify.1)
-* md2man-roff(1):
- [Ruby source](https://raw.github.com/sunaku/md2man/master/bin/md2man-roff) →
- [HTML result](https://sunaku.github.io/md2man/man/man1/md2man-roff.1.html) +
- [roff result](https://sunaku.github.io/md2man/man/man1/md2man-roff.1)
-* md2man-html(1):
- [Ruby source](https://raw.github.com/sunaku/md2man/master/bin/md2man-html) →
- [HTML result](https://sunaku.github.io/md2man/man/man1/md2man-html.1.html) +
- [roff result](https://sunaku.github.io/md2man/man/man1/md2man-html.1)
-* md2man-rake(1):
- [Ruby source](https://raw.github.com/sunaku/md2man/master/bin/md2man-rake) →
- [HTML result](https://sunaku.github.io/md2man/man/man1/md2man-rake.1.html) +
- [roff result](https://sunaku.github.io/md2man/man/man1/md2man-rake.1)
-* binman(1):
- [Ruby source](https://raw.github.com/sunaku/binman/master/bin/binman) →
- [HTML result](https://sunaku.github.io/binman/man/man1/binman.1.html) +
- [roff result](https://sunaku.github.io/binman/man/man1/binman.1)
-* binman-rake(1):
- [Ruby source](https://raw.github.com/sunaku/binman/master/bin/binman-rake) →
- [HTML result](https://sunaku.github.io/binman/man/man1/binman-rake.1.html) +
- [roff result](https://sunaku.github.io/binman/man/man1/binman-rake.1)
+Here are some real examples of processed bin scripts to help you get started:
-For examples in other scripting languages, see the "Usage" section below!
+* [bin/tork](https://raw.github.com/sunaku/tork/master/bin/tork) ⇒
+ [tork.1.markdown](https://sunaku.github.io/tork/man/man1/tork.1.markdown) ⇒
+ [tork.1](https://sunaku.github.io/tork/man/man1/tork.1) +
+ [tork.1.html](https://sunaku.github.io/tork/man/man1/tork.1.html)
+* [bin/tork-runner](https://raw.github.com/sunaku/tork/master/bin/tork-runner) ⇒
+ [tork-runner.1.markdown](https://sunaku.github.io/tork/man/man1/tork-runner.1.markdown) ⇒
+ [tork-runner.1](https://sunaku.github.io/tork/man/man1/tork-runner.1) +
+ [tork-runner.1.html](https://sunaku.github.io/tork/man/man1/tork-runner.1.html)
+* [bin/tork-herald](https://raw.github.com/sunaku/tork/master/bin/tork-herald) ⇒
+ [tork-herald.1.markdown](https://sunaku.github.io/tork/man/man1/tork-herald.1.markdown) ⇒
+ [tork-herald.1](https://sunaku.github.io/tork/man/man1/tork-herald.1) +
+ [tork-herald.1.html](https://sunaku.github.io/tork/man/man1/tork-herald.1.html)
+* [bin/tork-driver](https://raw.github.com/sunaku/tork/master/bin/tork-driver) ⇒
+ [tork-driver.1.markdown](https://sunaku.github.io/tork/man/man1/tork-driver.1.markdown) ⇒
+ [tork-driver.1](https://sunaku.github.io/tork/man/man1/tork-driver.1) +
+ [tork-driver.1.html](https://sunaku.github.io/tork/man/man1/tork-driver.1.html)
+* [bin/tork-engine](https://raw.github.com/sunaku/tork/master/bin/tork-engine) ⇒
+ [tork-engine.1.markdown](https://sunaku.github.io/tork/man/man1/tork-engine.1.markdown) ⇒
+ [tork-engine.1](https://sunaku.github.io/tork/man/man1/tork-engine.1) +
+ [tork-engine.1.html](https://sunaku.github.io/tork/man/man1/tork-engine.1.html)
+* [bin/tork-master](https://raw.github.com/sunaku/tork/master/bin/tork-master) ⇒
+ [tork-master.1.markdown](https://sunaku.github.io/tork/man/man1/tork-master.1.markdown) ⇒
+ [tork-master.1](https://sunaku.github.io/tork/man/man1/tork-master.1) +
+ [tork-master.1.html](https://sunaku.github.io/tork/man/man1/tork-master.1.html)
+* [bin/tork-remote](https://raw.github.com/sunaku/tork/master/bin/tork-remote) ⇒
+ [tork-remote.1.markdown](https://sunaku.github.io/tork/man/man1/tork-remote.1.markdown) ⇒
+ [tork-remote.1](https://sunaku.github.io/tork/man/man1/tork-remote.1) +
+ [tork-remote.1.html](https://sunaku.github.io/tork/man/man1/tork-remote.1.html)
+* [bin/tork-notify](https://raw.github.com/sunaku/tork/master/bin/tork-notify) ⇒
+ [tork-notify.1.markdown](https://sunaku.github.io/tork/man/man1/tork-notify.1.markdown) ⇒
+ [tork-notify.1](https://sunaku.github.io/tork/man/man1/tork-notify.1) +
+ [tork-notify.1.html](https://sunaku.github.io/tork/man/man1/tork-notify.1.html)
+* [bin/md2man-roff](https://raw.github.com/sunaku/md2man/master/bin/md2man-roff) ⇒
+ [md2man-roff.1.markdown](https://sunaku.github.io/md2man/man/man1/md2man-roff.1.markdown) ⇒
+ [md2man-roff.1](https://sunaku.github.io/md2man/man/man1/md2man-roff.1) +
+ [md2man-roff.1.html](https://sunaku.github.io/md2man/man/man1/md2man-roff.1.html)
+* [bin/md2man-html](https://raw.github.com/sunaku/md2man/master/bin/md2man-html) ⇒
+ [md2man-html.1.markdown](https://sunaku.github.io/md2man/man/man1/md2man-html.1.markdown) ⇒
+ [md2man-html.1](https://sunaku.github.io/md2man/man/man1/md2man-html.1) +
+ [md2man-html.1.html](https://sunaku.github.io/md2man/man/man1/md2man-html.1.html)
+* [bin/md2man-rake](https://raw.github.com/sunaku/md2man/master/bin/md2man-rake) ⇒
+ [md2man-rake.1.markdown](https://sunaku.github.io/md2man/man/man1/md2man-rake.1.markdown) ⇒
+ [md2man-rake.1](https://sunaku.github.io/md2man/man/man1/md2man-rake.1) +
+ [md2man-rake.1.html](https://sunaku.github.io/md2man/man/man1/md2man-rake.1.html)
+* [bin/binman](https://raw.github.com/sunaku/binman/master/bin/binman) ⇒
+ [binman.1.markdown](https://sunaku.github.io/binman/man/man1/binman.1.markdown) ⇒
+ [binman.1](https://sunaku.github.io/binman/man/man1/binman.1) +
+ [binman.1.html](https://sunaku.github.io/binman/man/man1/binman.1.html)
+* [bin/binman-rake](https://raw.github.com/sunaku/binman/master/bin/binman-rake) ⇒
+ [binman-rake.1.markdown](https://sunaku.github.io/binman/man/man1/binman-rake.1.markdown) ⇒
+ [binman-rake.1](https://sunaku.github.io/binman/man/man1/binman-rake.1) +
+ [binman-rake.1.html](https://sunaku.github.io/binman/man/man1/binman-rake.1.html)
+For examples in even more scripting languages, see the "Usage" section below!
+
+#### What can binman-rake(1) do?
+
+Here are some examples of HTML manual _sets_ produced by binman-rake(1):
+
+* https://sunaku.github.io/tork/man
+* https://sunaku.github.io/binman/man
+* https://sunaku.github.io/md2man/man
+
## Installation
If you only want to view pre-built manual pages:
```sh
@@ -95,11 +105,11 @@
```
If you also want to build your own manual pages:
```sh
-gem install md2man -v '~> 3.0'
+gem install md2man -v '~> 4.0'
```
### Prerequisites
* Ruby 1.8.7 or 1.9.2 or newer.
@@ -330,10 +340,10 @@
Add this snippet to your gemspec file:
```ruby
s.files += Dir['man/man?/*.?'] # UNIX man pages
s.files += Dir['man/**/*.{html,css,js}'] # HTML man pages
-s.add_development_dependency 'md2man', '~> 3.0'
+s.add_development_dependency 'md2man', '~> 4.0'
```
Add the following line to your Rakefile:
```ruby