search

osa1 / tiny

A terminal IRC client
MIT License
990 stars 57 forks source link

add man page #420

Open ralphptorres opened 8 months ago

ralphptorres commented 8 months ago

It would be nice to have a man page for tiny. I can make a pr if you are not averse to the idea.

osa1 commented 8 months ago

I'm not against it but I also don't want another documentation to maintain.

I'm curious what do you want to see in the man page for tiny? tiny's command line interface is very simple and --help documents it all, and README is supposed to show detailed usage. If README is missing anything let's update it first.

ralphptorres commented 8 months ago

Understandable. I think the README is actually good and would make a proper man page. That, the config.yml, and this repo's wiki on keys, external sasl can be combined into tiny(1), tiny(5) man pages with minimal editing. I suggest we use scdoc (also used in alacritty man pages) since the syntax is very similar to Markdown's. Once synced up, atomically updating the contents of README, etc. and man pages should be easy.

My only issue with README, etc. is that they are not always bundled with the binary by package managers. And if they are, they will be in different locations such as /usr/share/doc/tiny for README, /usr/share/tiny for config.yml, etc. They are not as convenient and accessible as man tiny for general commands, man 5 tiny for config and keys, etc.

But, I am okay with whatever you decide. :)