glejeune / Ruby-Graphviz

[MIRROR] Ruby interface to the GraphViz graphing tool
https://gitlab.com/glejeune/ruby-graphviz
Other
609 stars 116 forks source link

man pages for the commandline programs #57

Closed pravi closed 11 years ago

pravi commented 12 years ago

Debian policy requires every program in /usr/bin to have a man page, so I wrote man pages for these executables. You can see them at http://anonscm.debian.org/gitweb/?p=pkg-ruby-extras/ruby-graphviz.git;a=tree;f=debian;h=131d5d236f5eab223cd98bf07e906aa8d071f318;hb=HEAD

You can convert these to man page by running pod2man. pod2man options I used can be seen at http://anonscm.debian.org/gitweb/?p=pkg-ruby-extras/ruby-graphviz.git;a=blob;f=debian/rules;h=36d91ce6dda36509991107690b03964b3098f64d;hb=HEAD

If you like it, feel free to include it in your gem so that everyone using the gem benefits.

glejeune commented 11 years ago

@pravi do i have to place the man pages files in a specific place or is it ok like that's ?

pravi commented 11 years ago

I'm not sure if gem knows how to handle man pages. For debian package we can take it from that location, I hope other distribution packagers can also take it from here. May be Cedric (copied here) can suggest a better idea for installing it with rubygems. Normally man pages are kept in /usr/share/man by the distribution package managers (like dpkg in debian based systems and rpm on redhat based systems).

2013/4/24 Gregoire Lejeune notifications@github.com

@pravi https://github.com/pravi do i have to place the man pages files in a specific place or is it ok like that's ?

— Reply to this email directly or view it on GitHubhttps://github.com/glejeune/Ruby-Graphviz/issues/57#issuecomment-16922215 .

glejeune commented 11 years ago

I know that's it's OK for gems, at least for gem-man - but let's wait to see what Cedric says and if he has a better idea. My question was mainly about the Debian package. If I well understand your answer, it's good. OK ?

boutil commented 11 years ago

Hi! Thanks for adding the man pages in the gem. I think it is perfectly acceptable that way. Most of gems packages for Debian that include man pages have them in a man/ directory.

Cheers,

Cédric

glejeune commented 11 years ago

Cool. Thanks for your help.