binman - man pages for bin scripts
What is it?
binman produces UNIX manual pages for executable scripts using md2man.
It supports any scripting language that has multi-line comments or
uses #
for single-line comments. Supported languages include:
Ruby, Perl, Python, Node.js, Tcl, AWK, UNIX shell, and more!
Here is a complete example in Ruby to help you get started:
https://raw.github.com/sunaku/binman/master/bin/binman
For examples in other scripting languages, see the README.
What is new?
Version 3.1.0 (2012-02-06)
Minor:
- Added
binman help
command for use by non-Ruby bin scripts. See
README for usage examples from Perl, Python, Node.js, Tcl, AWK, and
UNIX shell!
Patch:
- Replace
gem install binman --development
tip inBinMan::conv()
withgem install md2man
tip because the former just hangs in
RubyGems 1.8.
Other:
- Shorten markdown headings; improve documentation; clean up.