Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse man pages in style with your personal manservant.
Perl Ruby CSS Shell
Branch: master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
bin
lib Stripped away too much from bootstrap.min.css... Ooops :P
libexec
.gitignore
CONTRIBUTORS.md
Gemfile
LICENSE
README.md
config.ru

README.md

Manservant

Browse man pages in style with your personal manservant.

Fed up with browsing manual pages in a console using less or Googling for the man page only to realize that your local install differs from the man page you found? Me too, so last night I hacked together manservant to serve up local man pages over HTTP with some pretty UI sprinkled over it.

Here's tmux's man page served to you by manservant:

preview

Requirements

Installation

Manservant is a simple Sinatra application, and is run just like any other Rack application.

Pow

The simplest way to run manservant is through Pow. Ensure you have Pow installed and working, and run the following to install manservant:

git clone https://github.com/jimeh/manservant.git ~/.pow/man
cd ~/.pow/man
bundle install

Then visit http://man.dev/ in your browser.

Other

There's many ways to run a Rack application, and I'm not gonna cover that here. But if you merely want to get manservant up and running to have a look, just clone the repo and run rackup inside the project directory:

git clone https://github.com/jimeh/manservant.git ~/Projects/manservant
cd ~/Projects/manservant
rackup

Then visit http://localhost:9292/ in your browser.

Credits

  • Man page to HTML conversion is done by man2html, which is bundled into manservant.
  • The HTML UI style is shamelessly ripped from the ronn gem's HTML output format.

Todo

  • Less shitty code.
  • Caching of rendered man pages.
  • Write some tests.
  • Search.

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Added some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

License

Copyright (c) 2012 Jim Myhrberg

MIT License

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.

Something went wrong with that request. Please try again.