gem-man 0.1.3 → 0.2.0

data/README.md

@@ -5,6 +5,7 @@ gem-man(1) -- view a gem's man page
 
     gem man <GEM>
     gem man <SECTION> <GEM>
+    gem man --system <GEM>
     gem man --latest <GEM>
     gem man --exact <GEM>
     gem man --all
@@ -52,6 +53,12 @@ man` will ask which you'd prefer.
 
 You can specify gems or list available gems using a few options.
 
+  * `-s`, `--system`:
+    Fall back to searching for system manuals. That is, `gem man -s
+    mac` will first look for a gem named `mac` with a man page before
+    looking for any system man pages named `mac`. `gem man -s fork`
+    should find the fork(2) manual, for instance.
+
   * `-l`, `--latest`:
     If there are multiple versions of a gem, open the latest.
 
@@ -83,6 +90,19 @@ For information on authoring man pages, see [`ron(7)`][r7]:
     gem install ron
     gem man 7 ron
 
+## CHEATING
+
+If you want `man` to find RubyGems, it's this easy:
+
+    alias man="gem man -s"
+
+Now:
+
+    man say
+    man rails
+    man 1 ronn
+    man 2 fork
+
 ## BUGS
 
 Requires the `man(1)` script to be in your path, executable, and to

data/lib/rubygems/commands/man_command.rb

@@ -13,11 +13,21 @@ class Gem::Commands::ManCommand < Gem::Command
       :all     => false
 
     add_all_gems_option
+    add_system_fallback_option
     add_latest_version_option
     add_version_option
     add_exact_match_option
   end
 
+  def usage
+    "gem man [SECTION] GEMNAME"
+  end
+
+  def arguments
+    "SECTION       section of the manual to search\n" +
+    "GEMNAME       gem whose manual you wish to read"
+  end
+
   def add_all_gems_option
     add_option('-a', '--all',
       'List all installed gems that have manuals.') do |value, options|
@@ -25,8 +35,11 @@ class Gem::Commands::ManCommand < Gem::Command
     end
   end
 
-  def usage
-    "gem man [SECTION] GEMNAME"
+  def add_system_fallback_option
+    add_option('-s', '--system',
+      'Falls back to searching for system-wide man pages.') do |value, options|
+      options[:system] = true
+    end
   end
 
   def add_latest_version_option
@@ -42,11 +55,6 @@ class Gem::Commands::ManCommand < Gem::Command
     end
   end
 
-  def arguments
-    "SECTION       section of the manual to search\n" +
-    "GEMNAME       gem whose manual you wish to read"
-  end
-
   def execute
     if get_one_optional_argument =~ /^\d$/
       section = get_one_optional_argument
@@ -67,8 +75,13 @@ class Gem::Commands::ManCommand < Gem::Command
       end
 
       # Try to read manpages.
-      spec = get_spec(name) { |s| s.has_manpage?(section) }
-      read_manpage(spec, section)
+      if spec = get_spec(name) { |s| s.has_manpage?(section) }
+        read_manpage(spec, section)
+      elsif options[:system]
+        exec "man #{section} #{name}"
+      else
+        abort "No manual entry for #{name}"
+      end
     end
   end
 
@@ -115,7 +128,6 @@ class Gem::Commands::ManCommand < Gem::Command
         pattern = /#{Regexp.escape name}/
         get_spec(pattern, &block)
       else
-        say "Can't find any manpages for '#{name.inspect}"
         nil
       end
     elsif specs.length == 1 || options[:latest]

data/man/gem-man.1.ron

@@ -5,6 +5,7 @@ gem-man(1) -- view a gem's man page
 
     gem man <GEM>
     gem man <SECTION> <GEM>
+    gem man --system <GEM>
     gem man --latest <GEM>
     gem man --exact <GEM>
     gem man --all
@@ -52,6 +53,12 @@ man` will ask which you'd prefer.
 
 You can specify gems or list available gems using a few options.
 
+  * `-s`, `--system`:
+    Fall back to searching for system manuals. That is, `gem man -s
+    mac` will first look for a gem named `mac` with a man page before
+    looking for any system man pages named `mac`. `gem man -s fork`
+    should find the fork(2) manual, for instance.
+
   * `-l`, `--latest`:
     If there are multiple versions of a gem, open the latest.
 
@@ -83,6 +90,19 @@ For information on authoring man pages, see [`ron(7)`][r7]:
     gem install ron
     gem man 7 ron
 
+## CHEATING
+
+If you want `man` to find RubyGems, it's this easy:
+
+    alias man="gem man -s"
+
+Now:
+
+    man say
+    man rails
+    man 1 ronn
+    man 2 fork
+
 ## BUGS
 
 Requires the `man(1)` script to be in your path, executable, and to

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: gem-man
 version: !ruby/object:Gem::Version 
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors: 
 - Chris Wanstrath