[ANN] binman 1.0.0

ruby-talk
1

Hello,

Sorry for the frequent release announcements. Now my enthusiasm is
nearly depleted, so hopefully this will be the last one for a while!

Cheers.

···

====================================================================

          binman - UNIX man pages for Ruby bin/ scripts
             https://github.com/sunaku/binman#readme

--------------------------------------------------------------------
What is it?
--------------------------------------------------------------------

binman produces UNIX man pages for your Ruby `bin/` scripts using
markdown(7), roff(7), [Redcarpet2] for conversion thereof, and man(1).

Here is an obligatory screen-shot of binman in action:
http://ompldr.org/vYXNlNg

Here is an example bin/ script to help you get started:
https://raw.github.com/sunaku/binman/master/bin/binman

[Redcarpet2]: https://github.com/tanoku/redcarpet
[redcarpet-manpage]: http://rdoc.info/github/sunaku/redcarpet-manpage

--------------------------------------------------------------------
What is new?
--------------------------------------------------------------------

Incompatible changes:

* The `BinMan::dump()` method and corresponding `binman dump`
  command now extract the leading comment header from their input
  before returning the markdown to roff conversion thereof.

* The `BinMan::read()` method and corresponding `binman read`
  command have been renamed to `BinMan::load()` and `binman load`
  respectively.

New features:

* Added `BinMan::conv()` method and corresponding `binman conv`
  command to encapsulate the markdown to roff conversion process.

Bug fixes:

* Pre-built man pages included alongside a `bin/` script were not
  displayed. Instead, binman was (incorrectly) always trying to
  convert the leading comment header from the `bin/` script into a
  UNIX man page for display.

Housekeeping:

* README: explain dev deps and `man/` dir packaging.

--
You will always find something in the last place you look.

2

hmm, interesting. now, if only i could combine this w ara's main...

···

On Fri, Oct 14, 2011 at 1:21 PM, Suraj N. Kurapati <sunaku@gmail.com> wrote:

     binman \- UNIX man pages for Ruby bin/ scripts
3

You could write a Rake task to mimic binman's Rake task which pre-compiles
man page files from bin/ scripts. Instead of parsing the leading comment
header from your bin/ scripts, like binman does, run your main-using bin/
scripts to grab their help output, convert that to Markdown, and then use
BinMan::conv() to convert them into Roff and save them in the man/
directory.

The idea is that, if you can ship a man/ directory containing pre-built man
page files in your gem or release package, then binman can show them
directly to the user when they ask for --help.

···

On Friday, October 14, 2011 1:42:07 AM UTC-7, botp wrote:

On Fri, Oct 14, 2011 at 1:21 PM, Suraj N. Kurapati wrote:
> binman - UNIX man pages for Ruby bin/ scripts

hmm, interesting. now, if only i could combine this w ara's main...