kramdown-man 0.1.7

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 880a3d1dd1e58aa950685bf312a66797f2d39d33c436eb9d67525289ce8abf45
+  data.tar.gz: e2f259869cb035f4868dab9ac584da53eafacbccc76b3323c3c32deb3133163c
+SHA512:
+  metadata.gz: 7d2b3f3a3fa1d58fc40e980fe8a6193746c2d6b4b38ddbbe4682b7c209128df67cc30090d08deaad0c2e59d62bec6fa3226ab7670d8d13c499c431a21a2feec9
+  data.tar.gz: 14630b3b4ba02083266fc248b7179d409c79937f20fb81bb2feb0bf61c657b88999a8ec95e6912e1bd0bd7d0c012927d3cc58386f5cb95e4246745b698ccf0bc

data/.document

@@ -0,0 +1,4 @@
+- 
+ChangeLog.md
+LICENSE.txt
+man/kramdown-man.1.md

data/.gitignore

@@ -0,0 +1,3 @@
+Gemfile.lock
+doc/
+pkg/

data/.rspec

@@ -0,0 +1 @@
+--colour --format documentation

data/.travis.yml

@@ -0,0 +1,11 @@
+---
+before_install:
+  - gem update --system
+  - gem install bundler -v "~> 2.0"
+language: ruby
+rvm:
+  - 2.5
+  - 2.6
+  - 2.7
+  - jruby
+script: bundle exec rake spec

data/.yardopts

@@ -0,0 +1 @@
+--markup markdown --markup-provider kramdown --title "kramdown-man Documentation" --protected

data/ChangeLog.md

@@ -0,0 +1,45 @@
+### 0.1.7 / 2020-07-22
+
+* Fixed a bug where kramdown's version of `kramdown/converter/man` was being
+  loaded instead of kramdown-man's version.
+
+### 0.1.6 / 2015-12-25
+
+* Commented out duplicate Hash entries that were causing warnings.
+
+### 0.1.5 / 2013-05-19
+
+* Translate unicode symbols into roff glyphs.
+* Convert typographic symbols and smart quotes into glyphs.
+* Simplify `\fB\fC` as `\fC` (Colin Watson).
+* Use `\fB` for codespans (Colin Watson).
+* Escape `--` as `\-\-` (Colin Watson).
+* Escape `\` as `\e` (Colin Watson).
+* Emit `.TP` or `.HP` if the paragraph begins with a strong element.
+
+### 0.1.4 / 2013-05-05
+
+* Improve detection of tagged paragraphs.
+* Support emitted a hanging paragraph (`.HP`) for command synopsis lines.
+* Strip leading whitespace from each line of emitted text.
+
+### 0.1.3 / 2013-05-05
+
+* Initial release:
+  * Converts markdown to [roff]:
+    * Supports codespans, emphasis and strong fonts.
+    * Supports normal and tagged paragraphs.
+    * Supports bullet lists.
+    * Supports multi-paragraph list items and blockquotes.
+    * Supports horizontal rules.
+    * Supports converting `[bash](man:bash(1))` links into man page references.
+  * Provides Rake task for converting `man/*.md` into man pages.
+  * Uses the pure-Ruby [Kramdown][kramdown] markdown parser.
+  * Supports [Ruby] 1.8.x, 1.9.x, 2.0.x, [JRuby], [Rubinius].
+
+[kramdown]: http://kramdown.rubyforge.org/
+[roff]: http://en.wikipedia.org/wiki/Roff
+
+[Ruby]: http://www.ruby-lang.org/
+[JRuby]: http://jruby.org/
+[Rubinius]: http://rubini.us/

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org/'
+
+gemspec
+
+group :development do
+  gem 'rake'
+  gem 'rubygems-tasks', '~> 0.2'
+  gem 'rspec', '~> 3.0'
+  gem 'yard', '~> 0.9'
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2013-2020 Hal Brodigan
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,181 @@
+# kramdown-man
+
+* [Homepage](https://github.com/postmodern/kramdown-man#readme)
+* [Issues](https://github.com/postmodern/kramdown-man/issues)
+* [Documentation](http://rubydoc.info/gems/kramdown-man/frames)
+* [Email](mailto:postmodern.mod3 at gmail.com)
+
+[![Build Status](https://secure.travis-ci.org/postmodern/kramdown-man.png?branch=master)](https://travis-ci.org/postmodern/kramdown-man)
+
+## Description
+
+A [Kramdown][kramdown] convert for converting Markdown files into man pages.
+
+## Features
+
+* Converts markdown to [roff]:
+  * Supports codespans, emphasis and strong fonts.
+  * Supports normal, hanging and tagged paragraphs.
+  * Supports bullet lists.
+  * Supports multi-paragraph list items and blockquotes.
+  * Supports horizontal rules.
+  * Supports converting `[bash](man:bash(1))` links into man page references.
+* Provides Rake task for converting `man/*.md` into man pages.
+* Uses the pure-Ruby [Kramdown][kramdown] markdown parser.
+* Supports [Ruby] 2.0 and [JRuby].
+
+## Synopsis
+
+Render a man page from markdown:
+
+    $ kramdown-man <man/myprog.1.md >man/myprog.1
+
+## Examples
+
+Render a man page from a markdown file:
+
+    require 'kramdown/man'
+
+    doc = Kramdown::Document.new(File.read('man/kramdown-man.1.md'))
+    File.write('man/kramdown-man.1',doc.to_man)
+
+    system 'man', 'man/kramdown-man.1'
+
+Define a `man` and file tasks which render all `*.md` files within the
+`man/` directory:
+
+    require 'kramdown/man/task'
+    Kramdown::Man::Task.new
+
+## Syntax
+
+### Formatting
+
+    `code`
+
+`code`
+
+    *emphasis*
+
+*emphasis*
+
+    **strong**
+
+**strong**
+
+### Paragraphs
+
+    Normal paragraph.
+
+Normal paragraph.
+
+    `command` [`--foo`] *FILE*
+
+`command` [`--foo`] *FILE*
+
+    `--tagged`
+      Text here.
+
+`--tagged`
+  Text here.
+
+### Links
+
+    [website](http://example.com/)
+
+[website](http://example.com/)
+
+    [bash](man:bash(1))
+
+[bash](man:bash(1))
+
+    Email <bob@example.com>
+
+Email <bob@example.com>
+
+### Lists
+
+    * one
+    * two
+    * three
+    
+      extra paragraph
+    
+
+* one
+* two
+* three
+
+  extra paragraph
+
+    1. one
+    2. two
+    3. three
+    
+       extra paragraph
+    
+1. one
+2. two
+3. three
+
+   extra paragraph
+
+### Horizontal Rule
+
+    -------------------------------------------------------------------------------
+
+-------------------------------------------------------------------------------
+
+### Blockquotes
+
+    > Perfection is achieved, not when there is nothing more to add, but when there is nothing left to take away.
+    >
+    > --Antoine de Saint-Exupéry
+
+> Perfection is achieved, not when there is nothing more to add, but when there is nothing left to take away.
+>
+> --Antoine de Saint-Exupéry
+
+### Code Blocks
+
+        #include <stdio.h>
+    
+        int main()
+        {
+    	    printf("hello world\n");
+    	    return 0;
+        }
+
+    #include <stdio.h>
+
+    int main()
+    {
+	    printf("hello world\n");
+	    return 0;
+    }
+
+## Requirements
+
+* [kramdown] ~> 1.0
+
+## Install
+
+    $ gem install kramdown-man
+
+## Alternatives
+
+* [Redcarpet::Render::ManPage](http://rubydoc.info/gems/redcarpet/Redcarpet/Render/ManPage)
+* [ronn](https://github.com/rtomayko/ronn#readme)
+* [md2man](https://github.com/sunaku/md2man#readme)
+
+## Copyright
+
+Copyright (c) 2013-2020 Hal Brodigan
+
+See {file:LICENSE.txt} for details.
+
+[kramdown]: http://kramdown.gettalong.org/
+[roff]: http://en.wikipedia.org/wiki/Roff
+
+[Ruby]: http://www.ruby-lang.org/
+[JRuby]: http://jruby.org/

data/Rakefile

@@ -0,0 +1,23 @@
+# encoding: utf-8
+
+begin
+  require 'bundler/setup'
+rescue LoadError => error
+  abort error.message
+end
+
+require 'rake'
+require 'rubygems/tasks'
+Gem::Tasks.new
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new
+task :test    => :spec
+task :default => :spec
+
+require 'yard'
+YARD::Rake::YardocTask.new  
+task :doc => :yard
+
+require 'kramdown/man/task'
+Kramdown::Man::Task.new

data/bin/kramdown-man

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+
+lib_dir = File.expand_path('../lib',File.dirname(__FILE__))
+$LOAD_PATH.unshift(lib_dir) unless $LOAD_PATH.include?(lib_dir)
+
+require 'kramdown'
+require 'kramdown/man'
+
+case ARGV[0]
+when '-h', '--help'
+  warn "usage: #{File.dirname($0)} <INPUT.md >OUTPUT"
+  exit
+end
+
+doc = Kramdown::Document.new(ARGF.read)
+puts doc.to_man

data/gemspec.yml

@@ -0,0 +1,13 @@
+name: kramdown-man
+summary: Converts markdown to man pages
+description: A Kramdown converter for converting Markdown files into man pages.
+license: MIT
+authors: Postmodern
+email: postmodern.mod3@gmail.com
+homepage: https://github.com/postmodern/kramdown-man#readme
+
+dependencies:
+  kramdown: ~> 1.0
+
+development_dependencies:
+  bundler: ~> 2.0

data/kramdown-man.gemspec

@@ -0,0 +1,60 @@
+# encoding: utf-8
+
+require 'yaml'
+
+Gem::Specification.new do |gem|
+  gemspec = YAML.load_file('gemspec.yml')
+
+  gem.name    = gemspec.fetch('name')
+  gem.version = gemspec.fetch('version') do
+                  lib_dir = File.join(File.dirname(__FILE__),'lib')
+                  $LOAD_PATH << lib_dir unless $LOAD_PATH.include?(lib_dir)
+
+                  require 'kramdown/man/version'
+                  Kramdown::Man::VERSION
+                end
+
+  gem.summary     = gemspec['summary']
+  gem.description = gemspec['description']
+  gem.licenses    = Array(gemspec['license'])
+  gem.authors     = Array(gemspec['authors'])
+  gem.email       = gemspec['email']
+  gem.homepage    = gemspec['homepage']
+
+  glob = lambda { |patterns| gem.files & Dir[*patterns] }
+
+  gem.files = `git ls-files`.split($/)
+  gem.files = glob[gemspec['files']] if gemspec['files']
+
+  gem.executables = gemspec.fetch('executables') do
+    glob['bin/*'].map { |path| File.basename(path) }
+  end
+  gem.default_executable = gem.executables.first if Gem::VERSION < '1.7.'
+
+  gem.extensions       = glob[gemspec['extensions'] || 'ext/**/extconf.rb']
+  gem.test_files       = glob[gemspec['test_files'] || '{test/{**/}*_test.rb']
+  gem.extra_rdoc_files = glob[gemspec['extra_doc_files'] || '*.{txt,md}']
+
+  gem.require_paths = Array(gemspec.fetch('require_paths') {
+    %w[ext lib].select { |dir| File.directory?(dir) }
+  })
+
+  gem.requirements              = gemspec['requirements']
+  gem.required_ruby_version     = gemspec['required_ruby_version']
+  gem.required_rubygems_version = gemspec['required_rubygems_version']
+  gem.post_install_message      = gemspec['post_install_message']
+
+  split = lambda { |string| string.split(/,\s*/) }
+
+  if gemspec['dependencies']
+    gemspec['dependencies'].each do |name,versions|
+      gem.add_dependency(name,split[versions])
+    end
+  end
+
+  if gemspec['development_dependencies']
+    gemspec['development_dependencies'].each do |name,versions|
+      gem.add_development_dependency(name,split[versions])
+    end
+  end
+end

data/lib/kramdown/converter/man.rb

@@ -0,0 +1,811 @@
+# encoding: utf-8
+require_relative '../man/version'
+
+require 'kramdown/converter/base'
+
+module Kramdown
+  module Converter
+    #
+    # Converts markdown into a roff man-page.
+    #
+    class Man < ::Kramdown::Converter::Base
+
+      # Comment header
+      HEADER = [
+        ".\\\" Generated by kramdown-man #{::Kramdown::Man::VERSION}",
+        ".\\\" https://github.com/postmodern/kramdown-man#readme"
+      ].join("\n")
+
+      # Typographic Symbols and their UTF8 chars
+      TYPOGRAPHIC_SYMS = {
+        :ndash       => '\-\-',
+        :mdash       => '\[em]',
+        :hellip      => '\.\.\.',
+        :laquo       => '\[Fo]',
+        :raquo       => '\[Fc]',
+        :laquo_space => '\[Fo]',
+        :raquo_space => '\[Fc]'
+      }
+
+      # Smart Quotes and their UTF8 chars
+      SMART_QUOTES = {
+        :lsquo => '\[oq]',
+        :rsquo => '\[cq]',
+        :ldquo => '\[lq]',
+        :rdquo => '\[rq]'
+      }
+
+      GLYPHS = {
+        'Ð' => '\[-D]',
+        'ð' => '\[Sd]',
+        'Þ' => '\[TP]',
+        'þ' => '\[Tp]',
+        'ß' => '\[ss]',
+        # Ligatures and Other Latin Glyphs
+        'ff' => '\[ff]',
+        'fi' => '\[fi]',
+        'fl' => '\[fl]',
+        'ffi' => '\[Fi]',
+        'ffl' => '\[Fl]',
+        'Ł' => '\[/L]',
+        'ł' => '\[/l]',
+        'Ø' => '\[/O]',
+        'ø' => '\[/o]',
+        'Æ' => '\[AE]',
+        'æ' => '\[ae]',
+        'Œ' => '\[OE]',
+        'œ' => '\[oe]',
+        'IJ' => '\[IJ]',
+        'ij' => '\[ij]',
+        'ı' => '\[.i]',
+        'ȷ' => '\[.j]',
+        # Accented Characters
+        'Á' => '\[\'A]',
+        'Ć' => '\[\'C]',
+        'É' => '\[\'E]',
+        'Í' => '\[\'I]',
+        'Ó' => '\[\'O]',
+        'Ú' => '\[\'U]',
+        'Ý' => '\[\'Y]',
+        'á' => '\[\'a]',
+        'ć' => '\[\'c]',
+        'é' => '\[\'e]',
+        'í' => '\[\'i]',
+        'ó' => '\[\'o]',
+        'ú' => '\[\'u]',
+        'ý' => '\[\'y]',
+        'Ä' => '\[:A]',
+        'Ë' => '\[:E]',
+        'Ï' => '\[:I]',
+        'Ö' => '\[:O]',
+        'Ü' => '\[:U]',
+        'Ÿ' => '\[:Y]',
+        'ä' => '\[:a]',
+        'ë' => '\[:e]',
+        'ï' => '\[:i]',
+        'ö' => '\[:o]',
+        'ü' => '\[:u]',
+        'ÿ' => '\[:y]',
+        'Â' => '\[^A]',
+        'Ê' => '\[^E]',
+        'Î' => '\[^I]',
+        'Ô' => '\[^O]',
+        'Û' => '\[^U]',
+        'â' => '\[^a]',
+        'ê' => '\[^e]',
+        'î' => '\[^i]',
+        'ô' => '\[^o]',
+        'û' => '\[^u]',
+        'À' => '\[`A]',
+        'È' => '\[`E]',
+        'Ì' => '\[`I]',
+        'Ò' => '\[`O]',
+        'Ù' => '\[`U]',
+        'à' => '\[`a]',
+        'è' => '\[`e]',
+        'ì' => '\[`i]',
+        'ò' => '\[`o]',
+        'ù' => '\[`u]',
+        'Ã' => '\[~A]',
+        'Ñ' => '\[~N]',
+        'Õ' => '\[~O]',
+        'ã' => '\[~a]',
+        'ñ' => '\[~n]',
+        'õ' => '\[~o]',
+        'Š' => '\[vS]',
+        'š' => '\[vs]',
+        'Ž' => '\[vZ]',
+        'ž' => '\[vz]',
+        'Ç' => '\[,C]',
+        'ç' => '\[,c]',
+        'Å' => '\[oA]',
+        'å' => '\[oa]',
+        # Accents
+        '˝' => '\[a"]',
+        '¯' => '\[a-]',
+        '˙' => '\[a.]',
+        # '^' => '\[a^]',
+        '´' => "\\´",
+        '`' => '\`',
+        '˘' => '\[ab]',
+        '¸' => '\[ac]',
+        '¨' => '\[ad]',
+        'ˇ' => '\[ah]',
+        '˚' => '\[ao]',
+        # '~' => '\(ti',
+        '˛' => '\[ho]',
+        '^' => '\(ha',
+        '~' => '\[ti]',
+        # Quotes
+        '„' => '\[Bq]',
+        '‚' => '\[bq]',
+        '“' => '\[lq]',
+        '”' => '\[rq]',
+        '‘' => '\[oq]',
+        '’' => '\[cq]',
+        "'" => '\(aq',
+        '"' => '\[dq]',
+        '«' => '\[Fo]',
+        '»' => '\[Fc]',
+        '‹' => '\[fo]',
+        '›' => '\[fc]',
+        # Punctuation
+        '.' => '\.',
+        '¡' => '\[r!]',
+        '¿' => '\[r?]',
+        '—' => '\[em]',
+        '–' => '\[en]',
+        '‐' => '\[hy]',
+        # Brackets
+        '[' => '\[lB]',
+        ']' => '\[rB]',
+        '{' => '\[lC]',
+        '}' => '\[rC]',
+        '⟨' => '\[la]',
+        '⟩' => '\[ra]',
+        # '⎪' => '\[bv]',
+        # '⎪' => '\[braceex]',
+        '⎡' => '\[bracketlefttp]',
+        '⎣' => '\[bracketleftbt]',
+        '⎢' => '\[bracketleftex]',
+        '⎤' => '\[bracketrighttp]',
+        '⎦' => '\[bracketrightbt]',
+        '⎥' => '\[bracketrightex]',
+        '╭' => '\[lt]',
+        '⎧' => '\[bracelefttp]',
+        '┥' => '\[lk]',
+        '⎨' => '\[braceleftmid]',
+        '╰' => '\[lb]',
+        '⎩' => '\[braceleftbt]',
+        # '⎪' => '\[braceleftex]',
+        '╮' => '\[rt]',
+        '⎫' => '\[bracerighttp]',
+        '┝' => '\[rk]',
+        '⎬' => '\[bracerightmid]',
+        '╯' => '\[rb]',
+        '⎭' => '\[bracerightbt]',
+        '⎪' => '\[bracerightex]',
+        '⎛' => '\[parenlefttp]',
+        '⎝' => '\[parenleftbt]',
+        '⎜' => '\[parenleftex]',
+        '⎞' => '\[parenrighttp]',
+        '⎠' => '\[parenrightbt]',
+        '⎟' => '\[parenrightex]',
+        # Arrows
+        '←' => '\[<-]',
+        '→' => '\[->]',
+        '↔' => '\[<>]',
+        '↓' => '\[da]',
+        '↑' => '\[ua]',
+        '↕' => '\[va]',
+        '⇐' => '\[lA]',
+        '⇒' => '\[rA]',
+        '⇔' => '\[hA]',
+        '⇓' => '\[dA]',
+        '⇑' => '\[uA]',
+        '⇕' => '\[vA]',
+        '⎯' => '\[an]',
+        # Lines
+        # '|' => '\[ba]',
+        '│' => '\[br]',
+        # '_' => '\[ul]',
+        '‾' => '\[rn]',
+        '_' => '\[ru]',
+        '¦' => '\[bb]',
+        '/' => '\[sl]',
+        '\\' => '\e',
+        # Text markers
+        '○' => '\[ci]',
+        # '·' => '\[bu]',
+        '‡' => '\[dd]',
+        '†' => '\[dg]',
+        '◊' => '\[lz]',
+        '□' => '\[sq]',
+        '¶' => '\[ps]',
+        '§' => '\[sc]',
+        '☜' => '\[lh]',
+        '☞' => '\[rh]',
+        '@' => '\[at]',
+        '#' => '\[sh]',
+        '↵' => '\[CR]',
+        '✓' => '\[OK]',
+        # Legal Symbols
+        '©' => '\[co]',
+        '®' => '\[rg]',
+        '™' => '\[tm]',
+        # Currency symbols
+        '$' => '\[Do]',
+        '¢' => '\[ct]',
+        # '€' => '\[eu]',
+        '€' => '\[Eu]',
+        '¥' => '\[Ye]',
+        '£' => '\[Po]',
+        '¤' => '\[Cs]',
+        'ƒ' => '\[Fn]',
+        # Units
+        '°' => '\[de]',
+        '‰' => '\[%0]',
+        '′' => '\[fm]',
+        '″' => '\[sd]',
+        'µ' => '\[mc]',
+        'ª' => '\[Of]',
+        'º' => '\[Om]',
+        # Logical Symbols
+        '∧' => '\[AN]',
+        '∨' => '\[OR]',
+        # '¬' => '\[no]',
+        '¬' => '\[tno]',
+        '∃' => '\[te]',
+        '∀' => '\[fa]',
+        '∋' => '\[st]',
+        # '∴' => '\[3d]',
+        '∴' => '\[tf]',
+        '|' => '\[or]',
+        # Mathematical Symbols
+        '½' => '\[12]',
+        '¼' => '\[14]',
+        '¾' => '\[34]',
+        '⅛' => '\[18]',
+        '⅜' => '\[38]',
+        '⅝' => '\[58]',
+        '⅞' => '\[78]',
+        '¹' => '\[S1]',
+        '²' => '\[S2]',
+        '³' => '\[S3]',
+        '+' => '\[pl]',
+        '-' => '\-',
+        '−' => '\[mi]',
+        '∓' => '\[-+]',
+        # '±' => '\[+-]',
+        '±' => '\[t+-]',
+        '·' => '\[pc]',
+        '⋅' => '\[md]',
+        # '×' => '\[mu]',
+        '×' => '\[tmu]',
+        '⊗' => '\[c*]',
+        '⊕' => '\[c+]',
+        # '÷' => '\[di]',
+        '÷' => '\[tdi]',
+        '⁄' => '\[f/]',
+        '∗' => '\[**]',
+        '≤' => '\[<=]',
+        '≥' => '\[>=]',
+        '≪' => '\[<<]',
+        '≫' => '\[>>]',
+        '=' => '\[eq]',
+        '≠' => '\[!=]',
+        '≡' => '\[==]',
+        '≢' => '\[ne]',
+        '≅' => '\[=~]',
+        '≃' => '\[|=]',
+        '∼' => '\[ap]',
+        # '≈' => '\[~~]',
+        '≈' => '\[~=]',
+        '∝' => '\[pt]',
+        '∅' => '\[es]',
+        '∈' => '\[mo]',
+        '∉' => '\[nm]',
+        '⊂' => '\[sb]',
+        '⊄' => '\[nb]',
+        '⊃' => '\[sp]',
+        '⊅' => '\[nc]',
+        '⊆' => '\[ib]',
+        '⊇' => '\[ip]',
+        '∩' => '\[ca]',
+        '∪' => '\[cu]',
+        '∠' => '\[/_]',
+        '⊥' => '\[pp]',
+        # '∫' => '\[is]',
+        '∫' => '\[integral]',
+        '∑' => '\[sum]',
+        '∏' => '\[product]',
+        '∐' => '\[coproduct]',
+        '∇' => '\[gr]',
+        # '√' => '\[sr]',
+        '√' => '\[sqrt]',
+        '⌈' => '\[lc]',
+        '⌉' => '\[rc]',
+        '⌊' => '\[lf]',
+        '⌋' => '\[rf]',
+        '∞' => '\[if]',
+        'ℵ' => '\[Ah]',
+        'ℑ' => '\[Im]',
+        'ℜ' => '\[Re]',
+        '℘' => '\[wp]',
+        '∂' => '\[pd]',
+        # 'ℏ' => '\[-h]',
+        'ℏ' => '\[hbar]',
+        # Greek glyphs
+        'Α' => '\[*A]',
+        'Β' => '\[*B]',
+        'Γ' => '\[*G]',
+        'Δ' => '\[*D]',
+        'Ε' => '\[*E]',
+        'Ζ' => '\[*Z]',
+        'Η' => '\[*Y]',
+        'Θ' => '\[*H]',
+        'Ι' => '\[*I]',
+        'Κ' => '\[*K]',
+        'Λ' => '\[*L]',
+        'Μ' => '\[*M]',
+        'Ν' => '\[*N]',
+        'Ξ' => '\[*C]',
+        'Ο' => '\[*O]',
+        'Π' => '\[*P]',
+        'Ρ' => '\[*R]',
+        'Σ' => '\[*S]',
+        'Τ' => '\[*T]',
+        'Υ' => '\[*U]',
+        'Φ' => '\[*F]',
+        'Χ' => '\[*X]',
+        'Ψ' => '\[*Q]',
+        'Ω' => '\[*W]',
+        'α' => '\[*a]',
+        'β' => '\[*b]',
+        'γ' => '\[*g]',
+        'δ' => '\[*d]',
+        'ε' => '\[*e]',
+        'ζ' => '\[*z]',
+        'η' => '\[*y]',
+        'θ' => '\[*h]',
+        'ι' => '\[*i]',
+        'κ' => '\[*k]',
+        'λ' => '\[*l]',
+        'μ' => '\[*m]',
+        'ν' => '\[*n]',
+        'ξ' => '\[*c]',
+        'ο' => '\[*o]',
+        'π' => '\[*p]',
+        'ρ' => '\[*r]',
+        'ς' => '\[ts]',
+        'σ' => '\[*s]',
+        'τ' => '\[*t]',
+        'υ' => '\[*u]',
+        'ϕ' => '\[*f]',
+        'χ' => '\[*x]',
+        'ψ' => '\[*q]',
+        'ω' => '\[*w]',
+        'ϑ' => '\[+h]',
+        'φ' => '\[+f]',
+        'ϖ' => '\[+p]',
+        'ϵ' => '\[+e]',
+        # Card symbols
+        '♣' => '\[CL]',
+        '♠' => '\[SP]',
+        '♥' => '\[HE]',
+        '♡' => '\[u2661]',
+        '♦' => '\[DI]',
+        '♢' => '\[u2662]'
+      }
+
+      # Regular expression to convert unicode characters into glyphs
+      GLYPH_REGEXP = Regexp.union(GLYPHS.keys)
+
+      #
+      # Initializes the converter.
+      #
+      # @param [Kramdown::Element] root
+      #   The root of the markdown document.
+      #
+      # @param [Hash] options
+      #   Markdown options.
+      #
+      def initialize(root,options)
+        super(root,options)
+
+        @ol_index = 0
+      end
+
+      #
+      # Converts the markdown document into a man-page.
+      #
+      # @param [Kramdown::Element] root
+      #   The root of a markdown document.
+      #
+      # @return [String]
+      #   The roff output.
+      #
+      def convert(root)
+        "#{HEADER}\n#{convert_root(root)}"
+      end
+
+      #
+      # Converts the root of a markdown document.
+      #
+      # @param [Kramdown::Element] root
+      #   The root of the markdown document.
+      #
+      # @return [String]
+      #   The roff output.
+      #
+      def convert_root(root)
+        root.children.map { |child|
+          convert_element(child)
+        }.compact.join("\n")
+      end
+
+      #
+      # Converts an element.
+      #
+      # @param [Kramdown::Element] element
+      #   An arbitrary element within the markdown document.
+      #
+      # @return [String]
+      #   The roff output.
+      #
+      def convert_element(element)
+        method = "convert_#{element.type}"
+        send(method,element) if respond_to?(method)
+      end
+
+      #
+      # Converts a `kd:blank` element.
+      #
+      # @param [Kramdown::Element] blank
+      #   A `kd:blank` element.
+      #
+      # @return [String]
+      #   The roff output.
+      #
+      def convert_blank(blank)
+        '.LP'
+      end
+
+      #
+      # Converts a `kd:text` element.
+      #
+      # @param [Kramdown::Element] text
+      #   A `kd:text` element.
+      #
+      # @return [String]
+      #   The roff output.
+      #
+      def convert_text(text)
+        escape(text.value.gsub(/^(  +|\t)/,''))
+      end
+
+      #
+      # Converts a `kd:typographic_sym` element.
+      #
+      # @param [Kramdown::Element] sym
+      #   A `kd:typographic_sym` element.
+      #
+      # @return [String]
+      #   The roff output.
+      #
+      def convert_typographic_sym(sym)
+        TYPOGRAPHIC_SYMS[sym.value]
+      end
+
+      #
+      # Converts a `kd:smart_quote` element.
+      #
+      # @param [Kramdown::Element] quote
+      #   A `kd:smart_quote` element.
+      #
+      # @return [String]
+      #   The roff output.
+      #
+      def convert_smart_quote(quote)
+        SMART_QUOTES[quote.value]
+      end
+
+      #
+      # Converts a `kd:header` element.
+      #
+      # @param [Kramdown::Element] header
+      #   A `kd:header` element.
+      #
+      # @return [String]
+      #   The roff output.
+      #
+      def convert_header(header)
+        text = header.options[:raw_text]
+
+        case header.options[:level]
+        when 1 then ".TH #{text}"
+        when 2 then ".SH #{text}"
+        else        ".SS #{text}"
+        end
+      end
+
+      #
+      # Converts a `kd:hr` element.
+      #
+      # @param [Kramdown::Element] hr
+      #   A `kd:hr` element.
+      #
+      # @return [String]
+      #   The roff output.
+      #
+      def convert_hr(hr)
+        ".ti 0\n\\l'\\n(.lu'"
+      end
+
+      #
+      # Converts a `kd:ul` element.
+      #
+      # @param [Kramdown::Element] ul
+      #   A `kd:ul` element.
+      #
+      # @return [String]
+      #   The roff output.
+      #
+      def convert_ul(ul)
+        content = ul.children.map { |li| convert_ul_li(li) }.join("\n")
+
+        return ".RS\n#{content}\n.RE"
+      end
+
+      #
+      # Converts a `kd:li` element within a `kd:ul` list.
+      #
+      # @param [Kramdown::Element] li
+      #   A `kd:li` element.
+      #
+      # @return [String]
+      #   The roff output.
+      #
+      def convert_ul_li(li)
+        li.children.each_with_index.map { |child,index|
+          if child.type == :p
+            content = convert_children(child.children)
+
+            if index == 0 then ".IP \\(bu 2\n#{content}"
+            else               ".IP \\( 2\n#{content}"
+            end
+          end
+        }.compact.join("\n")
+      end
+
+      #
+      # Converts a `kd:ol` element.
+      #
+      # @param [Kramdown::Element] ol
+      #   A `kd:ol` element.
+      #
+      # @return [String]
+      #   The roff output.
+      #
+      def convert_ol(ol)
+        @ol_index += 1
+
+        header  = ".nr step#{@ol_index} 0 1"
+        content = ol.children.map { |li| convert_ol_li(li) }.join("\n")
+
+        return "#{header}\n.RS\n#{content}\n.RE"
+      end
+
+      #
+      # Converts a `kd:li` element within a `kd:ol` list.
+      #
+      # @param [Kramdown::Element] li
+      #   A `kd:li` element.
+      #
+      # @return [String]
+      #   The roff output.
+      #
+      def convert_ol_li(li)
+        li.children.each_with_index.map { |child,index|
+          if child.type == :p
+            content = convert_children(child.children)
+
+            if index == 0 then ".IP \\n+[step#{@ol_index}]\n#{content}"
+            else               ".IP \\n\n#{content}"
+            end
+          end
+        }.compact.join("\n")
+      end
+
+      #
+      # Converts a `kd:abbreviation` element.
+      #
+      # @param [Kramdown::Element] abbr
+      #   A `kd:abbreviation` element.
+      #
+      # @return [String]
+      #   The roff output.
+      #
+      def convert_abbreviation(abbr)
+        escape(abbr.value)
+      end
+
+      #
+      # Converts a `kd:blockquote` element.
+      #
+      # @param [Kramdown::Element] blockquote
+      #   A `kd:blockquote` element.
+      #
+      # @return [String]
+      #   The roff output.
+      #
+      def convert_blockquote(blockquote)
+        content = blockquote.children.map { |child|
+          case child.type
+          when :p then convert_children(child.children)
+          else         convert_element(child)
+          end
+        }.join("\n")
+
+        return ".PP\n.RS\n#{content}\n.RE"
+      end
+
+      #
+      # Converts a `kd:codeblock` element.
+      #
+      # @param [Kramdown::Element] codeblock
+      #   A `kd:codeblock` element.
+      #
+      # @return [String]
+      #   The roff output.
+      #
+      def convert_codeblock(codeblock)
+        ".nf\n#{escape(codeblock.value).rstrip}\n.fi"
+      end
+
+      #
+      # Converts a `kd:comment` element.
+      #
+      # @param [Kramdown::Element] comment
+      #   A `kd:comment` element.
+      #
+      # @return [String]
+      #   The roff output.
+      #
+      def convert_comment(comment)
+        comment.value.lines.map { |line|
+          ".\\\" #{line}"
+        }.join("\n")
+      end
+
+      #
+      # Converts a `kd:p` element.
+      #
+      # @param [Kramdown::Element] p
+      #   A `kd:p` element.
+      #
+      # @return [String]
+      #   The roff output.
+      #
+      def convert_p(p)
+        children = p.children
+
+        if ((children.length >= 2) && (children.first.type == :codespan ||
+                                       children.first.type == :em       ||
+                                       children.first.type == :strong))
+          newline = children.find_index { |el|
+            el.type == :text && el.value.start_with?("\n")
+          }
+
+          if newline
+            first_line = convert_children(children[0...newline])
+            rest       = convert_children(children[newline..-1]).strip
+
+            ".TP\n#{first_line}\n#{rest}"
+          else
+            ".HP\n#{convert_children(children)}"
+          end
+        else
+          ".PP\n#{convert_children(children)}"
+        end
+      end
+
+      #
+      # Converts a `kd:em` element.
+      #
+      # @param [Kramdown::Element] em
+      #   A `kd:em` element.
+      #
+      # @return [String]
+      #   The roff output.
+      #
+      def convert_em(em)
+        "\\fI#{convert_children(em.children)}\\fP"
+      end
+
+      #
+      # Converts a `kd:strong` element.
+      #
+      # @param [Kramdown::Element] strong
+      #   A `kd:strong` element.
+      #
+      # @return [String]
+      #   The roff output.
+      #
+      def convert_strong(strong)
+        "\\fB#{convert_children(strong.children)}\\fP"
+      end
+
+      #
+      # Converts a `kd:codespan` element.
+      #
+      # @param [Kramdown::Element] codespan
+      #   A `kd:codespan` element.
+      #
+      # @return [String]
+      #   The roff output.
+      #
+      def convert_codespan(codespan)
+        "\\fB#{codespan.value}\\fR"
+      end
+
+      #
+      # Converts a `kd:a` element.
+      #
+      # @param [Kramdown::Element] a
+      #   A `kd:a` element.
+      #
+      # @return [String]
+      #   The roff output.
+      #
+      def convert_a(a)
+        href = escape(a.attr['href'])
+        text = convert_children(a.children)
+
+        case href
+        when /^mailto:/
+          email = href[7..-1]
+
+          unless text == email then "#{text}\n.MT #{email}\n.ME"
+          else                      "\n.MT #{email}\n.ME"
+          end
+        when /^man:/
+          match = href.match(/man:([A-Za-z0-9_-]+)(?:\((\d[a-z]?)\))?/)
+
+          if match[2] then "\n.BR #{match[1]} (#{match[2]})"
+          else             "\n.BR #{match[1]}"
+          end
+        else
+          "#{text}\n.UR #{href}\n.UE"
+        end
+      end
+
+      #
+      # Converts the children of an element.
+      #
+      # @param [Array<Kramdown::Element>] children
+      #   The children of an element.
+      #
+      # @return [String]
+      #   The roff output.
+      #
+      def convert_children(children)
+        children.map { |child| convert_element(child) }.join.strip
+      end
+
+      #
+      # Escapes text for roff.
+      #
+      # @param [String] text
+      #   The unescaped text.
+      #
+      # @return [String]
+      #   The escaped text.
+      #
+      def escape(text)
+        text.gsub(GLYPH_REGEXP) { |char| GLYPHS[char] }
+      end
+
+    end
+  end
+end