{"id":13412004,"url":"https://github.com/bitboxer/manpages","last_synced_at":"2025-05-07T19:06:11.047Z","repository":{"id":52314827,"uuid":"69804240","full_name":"bitboxer/manpages","owner":"bitboxer","description":"Gem to add man pages support to ruby gems","archived":false,"fork":false,"pushed_at":"2021-04-30T20:28:33.000Z","size":56,"stargazers_count":40,"open_issues_count":1,"forks_count":2,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-05-06T05:45:12.441Z","etag":null,"topics":["man-page","ruby","rubygems"],"latest_commit_sha":null,"homepage":"","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/bitboxer.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-10-02T15:17:25.000Z","updated_at":"2025-03-15T08:24:48.000Z","dependencies_parsed_at":"2022-08-22T15:00:45.548Z","dependency_job_id":null,"html_url":"https://github.com/bitboxer/manpages","commit_stats":null,"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bitboxer%2Fmanpages","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bitboxer%2Fmanpages/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bitboxer%2Fmanpages/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bitboxer%2Fmanpages/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bitboxer","download_url":"https://codeload.github.com/bitboxer/manpages/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252940883,"owners_count":21828766,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["man-page","ruby","rubygems"],"created_at":"2024-07-30T20:01:20.026Z","updated_at":"2025-05-07T19:06:10.600Z","avatar_url":"https://github.com/bitboxer.png","language":"Ruby","readme":"# Manpages\n\n[![Build Status](https://travis-ci.com/bitboxer/manpages.svg?branch=master)](https://travis-ci.com/bitboxer/manpages)\n[![Gem](https://img.shields.io/gem/v/manpages.svg)](https://rubygems.org/gems/manpages)\n\nThis plugin will add man pages support to ruby gems. Instead \nof adding a new command like [gem-man](https://github.com/defunkt/gem-man)\nit will try to link the files to a place the `man` command automatically\ndiscovers.\n\nWith rvm and chruby it works out of the box, but sadly for rbenv we need to\n[add hooks that](#using-this-with-rbenv) modify the `man` symlink depending on\nthe ruby version currently used.\n\n# Installation\n\n`gem install manpages \u0026\u0026 gem manpages --update-all`\n\nThis plugin automatically hooks into the ruby gems system. Every gem\ninstalled afterwards is checked for manpages. If this gem finds them, it\nexposes them to the `man` command.\n\n# Using this with rbenv\n\nSadly rbenv uses shims to hide the actual executables. This makes it a bit\nharder to make this gem work in that environment.\n\nThis gem provides hooks to change the man path for the current used ruby version.\nTo install them execute the following line:\n\n```\ncurl -o- https://raw.githubusercontent.com/bitboxer/manpages/master/rbenv/rbenv_hook_install.sh | bash\n```\n\nAfter the hooks are installed, rbenv will always change the man symlink to the\ncurrently used ruby version. Sadly rbenv does not provide a hook that is fired\nwhen switching ruby versions. This means that the path can only be corrected\nwhen executing a command provided by a gem. If you want to have the correct\nman page for a gem, you need to execute the command of that gem, first.\n\n# How this works\n\nAfter a gem is installed, this plugin will check for a directory called `man` within the \ngem and link the manpages it finds to `BIN_DIR/../share/man`, where `BIN_DIR` is the\ndirectory where the executable of the gem is installed.\n\nMost man versions will automatically search this directory and no additional work\nis required. If you install a gem that includes a man page (e.g. [guard](https://github.com/guard/guard)), you can\nsimply use `man guard` and you will see the man page the gem provided.\n\n# Providing man pages with your gem\n\nThe most common way in the ruby world to create a man page is through a tool\ncalled [ronn](https://github.com/rtomayko/ronn#readme). Ronn uses a modified\nvariant of markdown as source file. More details about the format can be found\n[here](https://github.com/rtomayko/ronn/blob/master/man/ronn-format.7.ronn).\nIn the newest version [kramdown](http://kramdown.gettalong.org/converter/man.html) also\nis able to generate man pages.\n\nMake sure the resulting manpage is in a folder called `man` in the root of the\ngem. Files stored in that directory will automatically be exposed to the\n`man` command.\n\nExamples for gems with manpages are [guard](https://github.com/guard/guard/tree/master/man) or\n[gem-man](https://github.com/defunkt/gem-man/tree/master/man).\n","funding_links":[],"categories":["Ruby"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbitboxer%2Fmanpages","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbitboxer%2Fmanpages","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbitboxer%2Fmanpages/lists"}