md2man 1.0.1 → 1.0.2

data/EXAMPLE.markdown

@@ -0,0 +1,83 @@
+FOO 1 "MARCH 1995" Linux "User Manuals"
+=======================================
+
+NAME
+----
+
+foo - frobnicate the bar library
+
+SYNOPSIS
+--------
+
+`foo` [`-bar`] [`-c` *config-file* ] *file* ...
+
+DESCRIPTION
+-----------
+
+`foo` frobnicates the bar library by tweaking internal symbol tables. By
+default it parses all baz segments and rearranges them in reverse order by
+time for the xyzzy(1) linker to find them. The symdef entry is then compressed
+using the WBG (Whiz-Bang-Gizmo) algorithm. All files are processed in the
+order specified.
+
+OPTIONS
+-------
+
+`-b`
+  Do not write "busy" to stdout while processing.
+
+`-c` *config-file*
+  Use the alternate system wide *config-file* instead of */etc/foo.conf*. This
+  overrides any `FOOCONF` environment variable.
+
+`-a`
+  In addition to the baz segments, also parse the blurfl headers.
+
+`-r`
+  Recursive mode. Operates as fast as lightning at the expense of a megabyte
+  of virtual memory.
+
+FILES
+-----
+
+*/etc/foo.conf*
+  The system wide configuration file. See foo(5) for further details.
+
+*~/.foorc*
+  Per user configuration file. See foo(5) for further details.
+
+ENVIRONMENT
+-----------
+
+`FOOCONF`
+  If non-null the full pathname for an alternate system wide */etc/foo.conf*.
+  Overridden by the `-c` option.
+
+DIAGNOSTICS
+-----------
+
+The following diagnostics may be issued on stderr:
+
+**Bad magic number.**
+  The input file does not look like an archive file.
+
+**Old style baz segments.**
+  `foo` can only handle new style baz segments. COBOL object libraries are not
+  supported in this version.
+
+BUGS
+----
+
+The command name should have been chosen more carefully to reflect its
+purpose.
+
+AUTHOR
+------
+
+Jens Schweikhardt <howto@schweikhardt.net>
+
+SEE ALSO
+--------
+
+bar(1), foo(5), xyzzy(1), [Linux Man Page Howto](
+http://www.schweikhardt.net/man_page_howto.html)

data/HISTORY.markdown

@@ -1,3 +1,21 @@
+------------------------------------------------------------------------------
+Version 1.0.2 (2012-01-09)
+------------------------------------------------------------------------------
+
+External changes:
+
+* Blockquote's leading paragraph regexp was not anchored.
+
+* Added example input file from the Linux Man Page Howto.
+
+Internal changes:
+
+* Upgraded to Binman 3 for better interoperability with Bundler.
+
+* Freezing internal constants prevents monkeypatching.
+
+* Forgot to change project slogan in the gem package.
+
 ------------------------------------------------------------------------------
 Version 1.0.1 (2011-12-06)
 ------------------------------------------------------------------------------

data/README.markdown

@@ -7,6 +7,17 @@ documents into UNIX man pages (really [Roff] documents) using [Redcarpet2].
 [Roff]: http://troff.org
 [Markdown]: http://daringfireball.net/projects/markdown/
 [Redcarpet2]: https://github.com/tanoku/redcarpet
+[example]: https://raw.github.com/sunaku/md2man/master/EXAMPLE.markdown
+
+------------------------------------------------------------------------------
+Demonstration
+------------------------------------------------------------------------------
+
+Try converting [this example Markdown file][example] into a UNIX man page:
+
+    md2man EXAMPLE.markdown | man -l -
+
+![Obligatory screenshot of md2man(1) in action!](http://ompldr.org/vYnFvbw)
 
 ------------------------------------------------------------------------------
 Installation

data/Rakefile

@@ -1 +1,2 @@
 require "bundler/gem_tasks"
+require "binman/rakefile"

data/bin/md2man

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 =begin
 
-MD2MAN 1 "2011-12-06" "1.0.1"
+MD2MAN 1 "2012-01-09" "1.0.2"
 =============================
 
 NAME

data/lib/md2man/roff.rb

@@ -51,7 +51,7 @@ module Roff
   end
 
   def block_quote quote
-    "\n.RS\n#{quote.sub(/\n\.PP\n/, '').chomp}\n.RE\n"
+    "\n.RS\n#{remove_leading_pp(quote).chomp}\n.RE\n"
   end
 
   def block_html html
@@ -93,7 +93,7 @@ module Roff
         "\\(bu 2"
       end
 
-    ".IP #{designator}\n#{text.sub(/\A\n\.PP\n/, '').lstrip.chomp}\n"
+    ".IP #{designator}\n#{remove_leading_pp(text).lstrip.chomp}\n"
   end
 
   def table header, body
@@ -203,6 +203,10 @@ module Roff
 
 private
 
+  def remove_leading_pp text
+    text.sub(/\A\n\.PP\n/, '')
+  end
+
   TABLE_COL_DELIM = ' '
   TABLE_ROW_DELIM = "\n"
   TABLE_CELL_DELIM = "\t"
@@ -501,7 +505,7 @@ private
     '♣'    => 0x2663,
     '♥'   => 0x2665,
     '♦'    => 0x2666,
-  }.freeze
+  }
 
   # see groff_char(7) and "Special Characters" in groff(7)
   UNICODE_TO_GLYPH = {
@@ -845,7 +849,7 @@ private
     0x2713  => "\\[OK]",
     0x27e8  => "\\[la]",
     0x27e9  => "\\[ra]",
-  }.freeze
+  }
 
 end
 end

data/lib/md2man/version.rb

@@ -1,3 +1,3 @@
 module Md2Man
-  VERSION = "1.0.1"
+  VERSION = "1.0.2"
 end

data/man/man1/md2man.1

@@ -1,4 +1,4 @@
-.TH MD2MAN 1 "2011\-12\-06" "1.0.1"
+.TH MD2MAN 1 "2012\-01\-09" "1.0.2"
 .SH NAME
 .PP
 md2man \- convert 

data/md2man.gemspec

@@ -1,25 +1,22 @@
 # -*- encoding: utf-8 -*-
 $:.push File.expand_path("../lib", __FILE__)
 require "md2man/version"
-require "binman/gemspec"
 
 Gem::Specification.new do |s|
-  s.name        = "md2man"
-  s.version     = Md2Man::VERSION
+  s.name          = "md2man"
+  s.version       = Md2Man::VERSION
   s.authors,
-  s.email       = File.read('LICENSE').scan(/Copyright \d+ (.+) <(.+?)>/).transpose
-  s.homepage    = "http://github.com/sunaku/md2man"
-  s.summary     = "UNIX man pages using Redcarpet2"
-  s.description = nil
+  s.email         = File.read('LICENSE').scan(/Copyright \d+ (.+) <(.+?)>/).transpose
+  s.homepage      = "http://github.com/sunaku/md2man"
+  s.summary       = "write UNIX man pages in Markdown"
+  s.description   = nil
 
-  s.files         = `git ls-files`.split("\n")
+  s.files         = `git ls-files`.split("\n") + Dir["man/**/*"]
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  # specify any dependencies here; for example:
-  # s.add_development_dependency "rspec"
-  # s.add_runtime_dependency "rest-client"
+  s.add_runtime_dependency "binman", "~> 3"
   s.add_runtime_dependency "redcarpet", ">= 2.0.0b5", "< 3"
   s.add_development_dependency "minitest", ">= 2.7.0", "< 3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: md2man
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,69 +9,47 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-07 00:00:00.000000000 Z
+date: 2012-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: redcarpet
-  requirement: &17975560 !ruby/object:Gem::Requirement
+  name: binman
+  requirement: &19172000 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 2.0.0b5
-    - - <
+    - - ~>
       - !ruby/object:Gem::Version
         version: '3'
   type: :runtime
   prerelease: false
-  version_requirements: *17975560
+  version_requirements: *19172000
 - !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: &17970340 !ruby/object:Gem::Requirement
+  name: redcarpet
+  requirement: &19171460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 2.7.0
+        version: 2.0.0b5
     - - <
       - !ruby/object:Gem::Version
         version: '3'
-  type: :development
-  prerelease: false
-  version_requirements: *17970340
-- !ruby/object:Gem::Dependency
-  name: binman
-  requirement: &22522240 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '2'
   type: :runtime
   prerelease: false
-  version_requirements: *22522240
+  version_requirements: *19171460
 - !ruby/object:Gem::Dependency
-  name: binman
-  requirement: &27521920 !ruby/object:Gem::Requirement
+  name: minitest
+  requirement: &19170380 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: '2'
-  type: :development
-  prerelease: false
-  version_requirements: *27521920
-- !ruby/object:Gem::Dependency
-  name: md2man
-  requirement: &27521380 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
+        version: 2.7.0
+    - - <
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '3'
   type: :development
   prerelease: false
-  version_requirements: *27521380
+  version_requirements: *19170380
 description: ''
 email:
 - sunaku@gmail.com
@@ -81,6 +59,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- EXAMPLE.markdown
 - Gemfile
 - HISTORY.markdown
 - LICENSE
@@ -118,7 +97,7 @@ rubyforge_project:
 rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
-summary: UNIX man pages using Redcarpet2
+summary: write UNIX man pages in Markdown
 test_files:
 - test/md2man/roff_test.rb
 - test/test_helper.rb