Adding a Manpage #45
Adding a Manpage #45
Conversation
Added manpage using groff markdown using the man macro. Using `groff -Tascii -man shotgun.man` to transpile.
This page can be viewed using the `man` command, thus giving you the program's manual.
There's most likely a better place/way to do this, but it's a start.
|
I never seen this from other rust repositories, where did you take this idea from? |
|
This is just something I made up. It appears that therefore: would seem to be logical, however, it isn't a default or standard by any means tho. The end user would have to add |
|
As far as I know, cargo doesn't really support building/installing any resources alongside the executable. This means that ~/.cargo/man isn't a very good idea (especially if no one else is creating subdirs there). I think I would rather leave this up to packagers. To be completely honest, I don't even recommend installing shotgun using cargo anyway, the preferred method is to package it for your distro. |
In #44 a manpage was added, this PR now installed the manpage to relative to the location that the program was installed in.
Ex:
program:
~/.cargo/bin/shotgunmanpage:
~/.cargo/man/man1/shotugn.1This path isn't, by default, on the manpath thus it would require more configuration from the user's end. It could also be installed onto one of the existing manpath(s) but this would break convention. LMK your thoughts.