binman 1.1.0 → 2.0.0

data/HISTORY.markdown

@@ -1,3 +1,22 @@
+------------------------------------------------------------------------------
+Version 2.0.0 (2011-12-06)
+------------------------------------------------------------------------------
+
+Breaking changes:
+
+* Removed the deprecated `binman/rake_tasks` helper library.  Use
+  `binman/rakefile` instead.
+
+External changes:
+
+* Fixed infinite looping in the `binman/gemspec` helper library.
+
+Internal changes:
+
+* Upgraded to md2man v1 for Markdown to UNIX man page conversion.
+
+* Do not hard-code the version number in `binman/gemspec` helper.
+
 ------------------------------------------------------------------------------
 Version 1.1.0 (2011-11-05)
 ------------------------------------------------------------------------------

data/bin/binman

@@ -2,8 +2,8 @@
 # encoding: utf-8
 =begin
 
-BINMAN 1 "2011-11-05" "1.1.0" "Ruby User Manuals"
-=================================================
+BINMAN 1 "2011-12-06" "2.0.0"
+=============================
 
 NAME
 ----
@@ -20,7 +20,7 @@ DESCRIPTION
 
 [binman] produces UNIX man pages for your Ruby `bin/` scripts.  It can extract
 their leading comment headers (defined below), convert them from markdown(7)
-into roff(7) using [Redcarpet2], and display them using man(1).
+into roff(7) using [md2man] and [Redcarpet2], and display them using man(1).
 
 ### Leading Comment Headers
 
@@ -32,24 +32,32 @@ A leading comment header can be one of the following two things:
 
 2. First embedded document delimited by `=begin` and `=end` lines.
 
+### Markdown Processing Divergence
+
+Although your leading comment headers are written in markdown(7), `binman
+conv` introduces the following additions to markdown(7) syntax via [md2man]:
+
+  * There can be at most one top-level heading (H1).  It is emitted as `.TH`
+    in the roff(7) output, specifying the UNIX man page's header and footer.
+
+  * Paragraphs whose lines are all uniformly indented by two spaces are
+    considered to be "indented paragraphs".  They are unindented accordingly
+    before emission as `.IP` in the roff(7) output.
+
+  * Paragraphs whose subsequent lines (all except the first) are uniformly
+    indented by two spaces are considered to be a "tagged paragraphs".  They
+    are unindented accordingly before emission as `.TP` in the roff(7) output.
+
 ### Markdown Processing Extensions
 
-The following [Redcarpet2] markdown processing extensions are enabled:
+The following [Redcarpet2] extensions for markdown(7) are enabled:
 
+* tables
 * autolink
+* superscript
+* strikethrough
 * no_intra_emphasis
 * fenced_code_blocks
-* space_after_headers
-
-### Markdown Processing Divergence
-
-Although your leading comment headers are written in markdown(7), `binman`
-introduces the following additional conventions to simplify common tasks:
-
-1. Paragraphs beginning with bold/italic and followed by at least
-   one two-space indented line are considered to be definitions.
-   The first line of such a paragraph is the term being defined and
-   the subsequent two-space indented lines are the definition body.
 
 OPTIONS
 -------
@@ -81,6 +89,7 @@ SEE ALSO
 man(1), roff(7), markdown(7)
 
 [binman]: https://github.com/sunaku/binman
+[md2man]: https://github.com/sunaku/md2man
 [Redcarpet2]: https://github.com/tanoku/redcarpet
 
 =end =========================================================================

data/binman.gemspec

@@ -20,5 +20,5 @@ Gem::Specification.new do |s|
   # specify any dependencies here; for example:
   # s.add_development_dependency "rspec"
   # s.add_runtime_dependency "rest-client"
-  s.add_development_dependency "redcarpet-manpage", ">= 0.0.1"
+  s.add_development_dependency "md2man", "~> 1"
 end

data/lib/binman.rb

@@ -31,9 +31,8 @@ module BinMan
 
   # Converts given markdown(7) source into roff(7).
   def conv source=nil
-    header = read(source)
-    require 'redcarpet-manpage'
-    RedcarpetManpage::RENDERER.render(header)
+    require 'md2man'
+    Md2Man::ENGINE.render(read(source))
   rescue LoadError
     raise 'Run `gem install binman --development` to use BinMan::conv().'
   end

data/lib/binman/gemspec.rb

@@ -6,15 +6,16 @@ class Gem::Specification
     _582ab9fd_ffc8_4972_b37f_1a46031a9163(*args, &block)
 
     # pre-build man page files
-    require 'binman/rake_tasks'
+    require 'binman/rakefile'
     Rake::Task[:binman].invoke
 
     # and add them to the gem
     self.files += Dir['man/**/*']
 
     # add binman as dependency
-    unless self.name == 'binman'
-      binman_gem = ['binman', '~> 1']
+    if self.name and self.name != 'binman'
+      require 'binman/version'
+      binman_gem = ['binman', "~> #{BinMan::VERSION[/\d+/]}"]
       self.add_runtime_dependency(*binman_gem)
       binman_vers = Gem::Dependency.new(*binman_gem)
       binman_spec = Gem::SpecFetcher.fetcher.fetch(binman_vers).flatten.first

data/lib/binman/version.rb

@@ -1,3 +1,3 @@
 module BinMan
-  VERSION = "1.1.0"
+  VERSION = "2.0.0"
 end

data/man/man1/binman.1

@@ -1,61 +1,98 @@
-.TH BINMAN 1 "2011-11-05" "1.1.0" "Ruby User Manuals"
+.TH BINMAN 1 "2011\-12\-06" "2.0.0"
 .SH NAME
 .PP
-binman \- UNIX man pages for Ruby \fBbin/\fP scripts
+binman \- UNIX man pages for Ruby \fB\fCbin/\fR scripts
 .SH SYNOPSIS
 .PP
-\fBbinman\fP [\fIOPTION\fP]... \fICOMMAND\fP
+\fB\fCbinman\fR [\fIOPTION\fP]... \fICOMMAND\fP
 .SH DESCRIPTION
 .PP
-\fBbinman\fP \fIhttps://github.com/sunaku/binman\fP produces UNIX man pages for your Ruby \fBbin/\fP scripts.  It can extract
+binman
+.UR https://github.com/sunaku/binman
+.UE
+produces UNIX man pages for your Ruby \fB\fCbin/\fR scripts.  It can extract
 their leading comment headers (defined below), convert them from 
 .BR markdown (7)
 into 
 .BR roff (7) 
-using \fBRedcarpet2\fP \fIhttps://github.com/tanoku/redcarpet\fP, and display them using 
+using md2man
+.UR https://github.com/sunaku/md2man
+.UE
+and Redcarpet2
+.UR https://github.com/tanoku/redcarpet
+.UE , and display them using 
 .BR man (1).
 .SS Leading Comment Headers
 .PP
 A leading comment header can be one of the following two things:
-.nr step 0 1
-.IP \n+[step]
-A contiguous sequence of single-line comments starting at the
+.nr step0 0 1
+.RS
+.IP \n+[step0]
+A contiguous sequence of single\-line comments starting at the
 beginning of the file (after shebang and encoding comments plus
 optional blank lines) and ending at the first single blank line.
-.IP \n+[step]
-First embedded document delimited by \fB=begin\fP and \fB=end\fP lines.
+.IP \n+[step0]
+First embedded document delimited by \fB\fC=begin\fR and \fB\fC=end\fR lines.
+.RE
+.SS Markdown Processing Divergence
+.PP
+Although your leading comment headers are written in 
+.BR markdown (7), 
+\fB\fCbinman
+conv\fR introduces the following additions to 
+.BR markdown (7) 
+syntax via md2man
+.UR https://github.com/sunaku/md2man
+.UE :
+.RS
+.IP \(bu 2
+There can be at most one top\-level heading (H1).  It is emitted as \fB\fC.TH\fR
+in the 
+.BR roff (7) 
+output, specifying the UNIX man page's header and footer.
+.IP \(bu 2
+Paragraphs whose lines are all uniformly indented by two spaces are
+considered to be "indented paragraphs".  They are unindented accordingly
+before emission as \fB\fC.IP\fR in the 
+.BR roff (7) 
+output.
+.IP \(bu 2
+Paragraphs whose subsequent lines (all except the first) are uniformly
+indented by two spaces are considered to be a "tagged paragraphs".  They
+are unindented accordingly before emission as \fB\fC.TP\fR in the 
+.BR roff (7) 
+output.
+.RE
 .SS Markdown Processing Extensions
 .PP
-The following \fBRedcarpet2\fP \fIhttps://github.com/tanoku/redcarpet\fP markdown processing extensions are enabled:
-.
-.IP \[bu] 2 
+The following Redcarpet2
+.UR https://github.com/tanoku/redcarpet
+.UE
+extensions for 
+.BR markdown (7) 
+are enabled:
+.RS
+.IP \(bu 2
+tables
+.IP \(bu 2
 autolink
-.IP \[bu] 2 
+.IP \(bu 2
+superscript
+.IP \(bu 2
+strikethrough
+.IP \(bu 2
 no_intra_emphasis
-.IP \[bu] 2 
+.IP \(bu 2
 fenced_code_blocks
-.IP \[bu] 2 
-space_after_headers
-.SS Markdown Processing Divergence
-.PP
-Although your leading comment headers are written in 
-.BR markdown (7), 
-\fBbinman\fP
-introduces the following additional conventions to simplify common tasks:
-.nr step 0 1
-.IP \n+[step]
-Paragraphs beginning with bold/italic and followed by at least
-one two-space indented line are considered to be definitions.
-The first line of such a paragraph is the term being defined and
-the subsequent two-space indented lines are the definition body.
+.RE
 .SH OPTIONS
 .TP
-\fB-h\fP, \fB--help\fP
+\fB\fC-h\fR, \fB\fC--help\fR
 Display this help manual using 
 .BR man (1).
 .SH COMMANDS
 .TP
-\fBshow\fP [\fIFILE\fP]
+\fB\fCshow\fR [\fIFILE\fP]
 Use 
 .BR man (1) 
 to display the 
@@ -63,16 +100,16 @@ to display the
 conversion of the leading comment header
 extracted from the given \fIFILE\fP or STDIN.
 .TP
-\fBload\fP [\fIFILE\fP]
+\fB\fCload\fR [\fIFILE\fP]
 Print the leading comment header extracted from the given \fIFILE\fP or STDIN.
 .TP
-\fBdump\fP [\fIFILE\fP]
+\fB\fCdump\fR [\fIFILE\fP]
 Print the 
 .BR roff (7) 
 conversion of the leading comment header extracted from
 the given \fIFILE\fP or STDIN.
 .TP
-\fBconv\fP [\fIFILE\fP]
+\fB\fCconv\fR [\fIFILE\fP]
 Print the 
 .BR roff (7) 
 conversion of the 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: binman
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 2.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,19 +9,19 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-05 00:00:00.000000000 Z
+date: 2011-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: redcarpet-manpage
-  requirement: &20757380 !ruby/object:Gem::Requirement
+  name: md2man
+  requirement: &13240480 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 0.0.1
+        version: '1'
   type: :development
   prerelease: false
-  version_requirements: *20757380
+  version_requirements: *13240480
 description: ''
 email:
 - sunaku@gmail.com
@@ -40,7 +40,6 @@ files:
 - binman.gemspec
 - lib/binman.rb
 - lib/binman/gemspec.rb
-- lib/binman/rake_tasks.rb
 - lib/binman/rakefile.rb
 - lib/binman/version.rb
 - man/man1/binman.1

data/lib/binman/rake_tasks.rb

@@ -1,2 +0,0 @@
-warn 'binman: "binman/rake_tasks" is deprecated; use "binman/rakefile" instead'
-require 'binman/rakefile'