binman produces UNIX manual pages for executable scripts using
md2man. It supports any scripting language that either has
multi-line comments or uses # for single-line comments, such
as Ruby, Perl, Python, Node.js, Tcl, AWK, UNIX shell, and more!
How to use it?
Simply document your script in 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 the manual from your script for
your own custom processing. And that’s just the beginning: see
the manual for even 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
Version 3.4.1 (2014-07-01)
This release fixes the help options’ REGEXP argument under non-Debian
systems.
Patch:
-
pager(1) isn’t a universal command: CentOS uses
less -isinstead. -
Silence man(1) stderr when displaying dynamically extracted manual.
Other:
-
README: add intro hook and source+result examples.
-
Document REGEXP argument for help options in
bin/*. -
Refer to REGEXP argument as PATTERN like less does.