This release upgrades to md2man 3.0 for improved HTML manuals.
README: add links to package, manuals, and GitHub.
GitHub now supports relative links from the README:
Upgrade to md2man 3.0 for improved HTML manuals.
Patch:
Rescue error when designated opener is not found:
$ binman -h
/gems/opener-0.1.0/lib/opener.rb:97:in `spawn': No such file or directory - xdg-open (Errno::ENOENT)
from /gems/opener-0.1.0/lib/opener.rb:97:in `spawn'
from /gems/binman-3.3.1/lib/binman.rb:57:in `block in show'
from /gems/binman-3.3.1/lib/binman.rb:55:in `each'
from /gems/binman-3.3.1/lib/binman.rb:55:in `show'
from /gems/binman-3.3.1/lib/binman.rb:88:in `help'
from /gems/binman-3.3.1/bin/binman:106:in `<top (required)>'
from /bin/binman:23:in `load'
from /bin/binman:23:in `<main>'
Fix an undefined local variable or method error:
binman: undefined local variable or method `library' for BinMan:Module
Other:
Patch:
Minor:
Add binman-rake(1) script to provide access to binman/rakefile
tasks.
Always try showing HTML manual page in web browser from BinMan.show()
.
Other:
Upgrade to md2man 2.0.0.
Rename HISTORY to VERSION so it sorts after README.
Add man/man0/ subdir containing README and VERSION.
Patch:
Ensure that the binman:web
Rake task works the first time through.
Fix "uninitialized constant Md2Man::VERSION" errors in binman/rakefile
.
Hook into the build
Rake task only if Bundler's Rake tasks are loaded:
https://github.com/sunaku/md2man/pull/7#issuecomment-9467621
Thanks to Postmodern for raising this issue.
Minor:
Other:
Patch:
load() failed when leading comment header missing
lstrip() is too powerful; consume lines carefully
Other:
Minor:
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:
gem install binman --development
tip in BinMan::conv()
with
gem install md2man
tip because the former just hangs in RubyGems 1.8.Other:
Patch:
BinMan.help(): ignore -h
and --help
options after standard --
flag.
BinMan.show(): write temp file because not all systems support man -l
.
Other:
HISTORY: group changes by version number components.
README: add instructions on pre-building man pages.
README: fix installation commands for development.
bundler suggests moving all dev deps into gemspec.
Major:
binman/gemspec
helper library because it did not play well
with Bundler. Use the standard add_runtime_dependency
method instead.
This example shows what work is involved in upgrading.Minor:
binman/Rakefile
helper library now hooks into Bundler's Rake tasks.
Be sure to add the man/**/*
files to your gemspec accordingly.Major:
binman/rake_tasks
helper library. Use
binman/rakefile
instead.Patch:
binman/gemspec
helper library.Other:
Upgraded to md2man v1 for Markdown to UNIX man page conversion.
Do not hard-code the version number in binman/gemspec
helper.
Alert:
binman/rake_tasks
library has been renamed (with deprecation) to
binman/rakefile
. The deprecation warning will be removed in the next
major release.Minor:
binman/gemspec
packaging convenience library which automatically
builds and includes your UNIX man page files in your gem packages and also
adds binman as a runtime and development gem dependency.Major:
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.
Minor:
BinMan::conv()
method and corresponding binman conv
command to
encapsulate the markdown to roff conversion process.Patch:
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.Other:
man/
dir packaging.Minor:
Other:
Extracted BinMan::Renderer
into redcarpet-manpage library.
Forgot to introduce leading comment headers in binman(1) man page.
Minor:
BinMan.read()
now supports embedded document (=begin/=end) comments
also. See binman(1) for the new description of leading comment headers.Patch:
Ignore encoding comment line after shebang line.
roff: fix first paragraphs inside list items.
Other:
gemspec: build man page files before building gem.
binman: raise error and suggest --help option.
README: add link to example of binman markdown.
README: add obligatory screenshot! >:-)
First release! Happy birthday! Woohoo! :-)