manbook 0.0.1

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,15 @@
+source "http://rubygems.org"
+
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+gem 'activesupport'
+gem 'open4'
+gem 'nokogiri'
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rake", "0.8.7" # http://stackoverflow.com/questions/6085610
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.4"
+end

data/Gemfile.lock

@@ -0,0 +1,25 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (3.1.1)
+      multi_json (~> 1.0)
+    git (1.2.5)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    multi_json (1.0.3)
+    nokogiri (1.4.3.1)
+    open4 (1.3.0)
+    rake (0.8.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport
+  bundler (~> 1.0.0)
+  jeweler (~> 1.6.4)
+  nokogiri
+  open4
+  rake (= 0.8.7)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Nicholas E. Rabenau
+
+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,105 @@
+manbook --  produces an eBook from man pages
+============================================
+
+## SYNOPSIS
+
+    manbook <MANPAGE>
+    manbook <MANPAGE1> [<MANPAGE2> ...]
+    manbook <MANPAGE> --output <DIRECTORY>
+    manbook <MANPAGE1> [<MANPAGE2> ...] --output <DIRECTORY>
+    manbook --all --output <DIRECTORY>
+
+    mktoc <DIRECTORY>
+
+## DESCRIPTION
+
+The `manbook` command can be used to produce an eBook from one or more
+man pages. 
+
+`mktoc` produces table-of-content files, suitable for MOBI files (Kindle,
+etc) from the HTML files in a directory.
+
+## QUICKSTART
+
+    gem install manbook
+    manbook --help
+    mktoc --help
+
+## MANPAGE
+
+`manbook` expects to be passed the name of one or more man pages. It will
+use the MANPATH environment variable to find the man page and convert it to
+HTML.
+
+If more than one man page was passed, an additional index page will be 
+created. If the man pages are from different sections, `manbook` will create 
+separate indexes by section together with an index file for each section.
+
+## OPTIONS
+
+You can specify an individual man page or a list of man pages using a few 
+options.
+
+  * `-o`, `--output`:
+    Specifies the output file (when operating on a single man page) or
+    the output directory (when operating on multiple man pages) where
+    the HTML files will be written to.
+
+  * `-a`, `--all`:
+    Produce a book with all man pages found.
+
+See `manbook --help` to view the options at any time.
+
+## INSTALL
+
+    gem install manbook
+
+## EXAMPLES
+
+    manbook ls
+    manbook ls grep bash --output ./my-favorite-pages/
+    manbook -a -o ./manpages/
+
+    mktoc ./my-favorite-pages/
+    mktoc --title "Kindle and the Fourty Amazons" ./my-favorite-pages/
+
+# HISTORY #
+After I bought a Kindle, the idea was born to put the man pages of my Mac onto my Kindle. My requirements are:
+
+1. Input should be exactly the man pages on /my/ system, not someone else's FreeBSD or whathever
+1. Should respect my MANPATH (not just look in /usr/share/man)
+1. Pages should be as plain-text as possible (no PDF).
+1. eBook should provide an index with a list of all man pages by section and by name
+
+When I looked around for an existing solution, all I found was:
+
+* http://askubuntu.com/questions/21903/man-pages-offline-for-e-reader
+* http://www.macgeekery.com/tips/cli/pretty-print_manual_pages_as_ps_pdf_or_html
+
+and a few other, not-quite-complete scripts. None of them satisfied my requirements, so I decided to write my own tool. Thus, `manbook` was born.
+
+## BUGS
+
+Requires the `groff` script to be in your path and executable. 
+
+Requires Ruby and RubyGems.
+
+Please report other bugs at <http://github.com/nerab/manbook/issues>
+
+## CONTRIBUTING
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## COPYRIGHT
+
+manbook is Copyright (C) 2011 Nicolas E. Rabenau. See LICENSE.txt for further details.
+
+## SEE ALSO
+
+groff(1), <http://en.wikipedia.org/wiki/Man_page>, [mail2kindle](https://gist.github.com/1410840)

data/Rakefile

@@ -0,0 +1,46 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "manbook"
+  gem.homepage = "http://github.com/nerab/manbook"
+  gem.license = "MIT"
+  gem.summary = %Q{Produces an eBook from man pages}
+  gem.description = %Q{The manbook command can be used to produce an eBook from one or more man pages.}
+  gem.email = "nerab@gmx.net"
+  gem.authors = ["Nicholas E. Rabenau"]
+  gem.executables << 'manbook'
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "manbook #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/TODO

@@ -0,0 +1,2 @@
+* Do not overwrite existing files unless --force was given
+* Potentially list authors

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/bin/manbook

@@ -0,0 +1,89 @@
+#!/usr/bin/env ruby
+
+$:.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
+
+require 'rubygems'
+
+help = <<HELP
+The manbook command can be used to produce an eBook from one or more man pages.
+
+Author: Nicolas E. Rabenau nerab@gmx.at
+Homepage: http://rubydoc.info/gems/manbook/file/README.md
+
+Basic Usage:
+
+    manbook <MANPAGE>
+    manbook <MANPAGE1> [<MANPAGE2> ...]
+    manbook <MANPAGE> --output <DIRECTORY>
+    manbook <MANPAGE1> [<MANPAGE2> ...] --output <DIRECTORY>
+    manbook --all --output <DIRECTORY>
+
+Options:
+HELP
+
+def usage
+  "Run '#{File.basename(__FILE__)} --help' for further help."
+end
+
+require 'optparse'
+require 'manbook'
+
+output_dir = '.'
+
+opts = OptionParser.new do |opts|
+  opts.banner = help
+
+  opts.on("--verbose", "Verbose mode - displays additional diagnostic information") do |file|
+    ManBook.logger = Logger.new(STDERR)
+    ManBook.logger.formatter = ManBook::LogFormatter.new
+    ManBook.logger.level = Logger::INFO
+  end
+
+  opts.on("--trace", "Trace (debug) mode - displays debug information and stack traces") do |file|
+    ManBook.logger = Logger.new(STDERR)
+    ManBook.logger.formatter = ManBook::LogFormatter.new
+    ManBook.logger.level = Logger::DEBUG
+  end
+
+  opts.on("--version", "Display current version") do
+    puts "#{File.basename(__FILE__)} " + ManBook::VERSION
+    exit 0
+  end
+
+  opts.on("--all", "Create a book with all man pages") do |dir|
+    ManBook.logger.info "Creating a book with all man pages"
+    raise "Not yet implemented"
+  end
+
+  opts.on("--output DIR", "Use DIR as output directory") do |dir|
+    ManBook.logger.info "Using '#{dir}' as output directory"
+    output_dir = dir
+    unless File.exist?(output_dir)
+      ManBook.logger.info "Creating output directory as it does not exist yet: #{output_dir}"
+      Dir.mkdir(output_dir)
+    end
+  end
+end
+
+begin
+  opts.parse!
+
+  raise "Which man page do you want to convert?" if ARGV.empty?
+
+  ARGV.each{|man_page|
+    html_file = File.join(output_dir, "#{File.basename(man_page)}.html")
+    ManBook.logger.debug("Output page is #{html_file}")
+
+    begin
+      ManBook::HtmlFormatter.new(man_page).convert(html_file)
+    rescue ManBook::ManPageNotFoundError => e
+      ManBook.logger.error e.message
+      ManBook.logger.debug "Backtrace:\n#{e.backtrace.join("\n")}"
+    end
+  }
+rescue
+  ManBook.logger.error $!.message
+  ManBook.logger.debug "Backtrace:\n#{$!.backtrace.join("\n")}"
+  ManBook.logger.info usage
+  exit(1)
+end

data/bin/mktoc

@@ -0,0 +1,157 @@
+#!/usr/bin/env ruby
+
+$:.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
+
+require 'rubygems'
+
+help = <<HELP
+Creates table of contents (TOC) files for all HTML files in a directory. This
+tool was built to prepare HTML pages for the Kindle.
+
+Author: Nicolas E. Rabenau nerab@gmx.at
+Homepage: http://rubydoc.info/gems/manbook/file/README.md
+
+Basic Usage:
+
+    mktoc <DIRECTORY>
+
+Options:
+HELP
+
+def usage
+  "Run '#{File.basename(__FILE__)} --help' for further help."
+end
+
+require 'optparse'
+require 'manbook'
+require 'erb'
+
+INDEX_HTML  = 'index.html'
+ABOUT_HTML  = 'about.html'
+INDEX_OPF   = 'index.opf'
+INDEX_NCX   = 'index.ncx'
+OUTPUT_FILE = 'manbook.mobi'
+GENERATOR = "#{File.basename(__FILE__)} v#{ManBook::VERSION}"
+
+# defaults
+@book_title  = ManBook::TITLE_DEFAULT
+@cover_image = ManBook::COVER_IMAGE_DEFAULT
+
+opts = OptionParser.new do |opts|
+  opts.banner = help
+
+  opts.on("--verbose", "Verbose mode - displays additional diagnostic information") do |file|
+    ManBook.logger = Logger.new(STDERR)
+    ManBook.logger.formatter = ManBook::LogFormatter.new
+    ManBook.logger.level = Logger::INFO
+  end
+
+  opts.on("--trace", "Trace (debug) mode - displays debug information and stack traces") do |file|
+    ManBook.logger = Logger.new(STDERR)
+    ManBook.logger.formatter = ManBook::LogFormatter.new
+    ManBook.logger.level = Logger::DEBUG
+  end
+
+  opts.on("--version", "Display current version") do
+    puts "#{File.basename(__FILE__)} " + ManBook::VERSION
+    exit 0
+  end
+
+  opts.on("--title STRING", "Use TITLE as book title") do |title|
+    ManBook.logger.info "Setting book title to '#{title}'"
+    @book_title = title
+  end
+
+  opts.on("--cover-image FILE", "Reference a cover image") do |cover_image|
+    ManBook.logger.info "Cover image set to #{cover_image}"
+    @cover_image = cover_image
+  end
+
+  opts.on("--no-cover-image", "Do not reference a cover image") do
+    @cover_image = nil
+  end
+end
+
+def render(template, my_binding = binding)
+  ERB.new(File.new(File.join(File.dirname(__FILE__), '..', 'templates', template)), 0, "%<>").result(my_binding)
+end
+
+begin
+  opts.parse!
+
+  raise "Directory argument missing" if ARGV.empty?
+  src_dir = ARGV.first
+  ManBook.logger.debug("Operating in directory #{src_dir}")
+
+  if @cover_image.nil?
+    ManBook.logger.debug("No cover image will be used")
+  else
+    ManBook.logger.debug("Using cover image #{@cover_image}")
+    raise "Could not find cover image" unless File.exist?(@cover_image)
+    FileUtils.cp(@cover_image, src_dir)
+
+    # continue working with the copy
+    @cover_image = File.basename(@cover_image)
+  end
+
+  # We generate about.html first so it is going to be picked up by the file finder
+  File.open(File.join(src_dir, ABOUT_HTML), 'w') {|f|
+    # Override page title. Would love to use a local here, but calling render with binding at this stage fails.
+    @title = "About this book"
+
+    f.write(render('application.html.erb'){
+      render('about.html.erb')
+    })
+
+    # undefine title
+    remove_instance_variable(:@title)
+  }
+
+  # find pages
+  @pages = Dir.glob(File.join(src_dir, "*.html")).reject{|f| INDEX_HTML == File.basename(f)}.collect{|html_file|
+    ManBook::Parser.parse(html_file)
+  }.sort{|l,r| l[:title] <=> r[:title]}
+
+  # index.html
+  File.open(File.join(src_dir, INDEX_HTML), 'w') {|f|
+    @title = "Table Of Contents"
+    f.write(render('application.html.erb'){
+      render('index.html.erb'){
+        @pages.collect{|page|
+          begin
+            render('_page.html.erb', binding)
+          rescue
+            ManBook.logger.error $!.message
+            ManBook.logger.debug "Backtrace:\n#{$!.backtrace.join("\n")}"
+          end
+        }.join
+      }
+    })
+    remove_instance_variable(:@title)
+  }
+
+  # opf file
+  # TODO add index.html so that the pseudo toc shows index.html, but index.html does not link to itself
+  File.open(File.join(src_dir, INDEX_OPF), 'w') {|f|
+    f.write(render('manbook.opf.erb'))
+  }
+
+  # ncx file
+  File.open(File.join(src_dir, INDEX_NCX), 'w') {|f|
+    f.write(render('manbook.ncx.erb'))
+  }
+
+  # print message how to call kindlegen
+  ManBook.logger.info "Successfully finished building the book in #{src_dir}"
+  ManBook.logger.info 'Call the following command in order to convert your book into the Kindle format:'
+  ManBook.logger.info
+  ManBook.logger.info "  kindlegen #{File.join(src_dir, INDEX_OPF)} -o #{OUTPUT_FILE}"
+  ManBook.logger.info
+  ManBook.logger.info "After that, the book will appear as #{File.join(src_dir, OUTPUT_FILE)}. You can"
+  ManBook.logger.info "then open it with the Kindle app or mail it to your kindle."
+rescue
+  ManBook.logger.error $!.message
+  ManBook.logger.debug "Backtrace:\n#{$!.backtrace.join("\n")}"
+  ManBook.logger.info usage
+  exit(1)
+end