Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add man page #420

Open
ralphptorres opened this issue Nov 10, 2023 · 2 comments
Open

add man page #420

ralphptorres opened this issue Nov 10, 2023 · 2 comments

Comments

@ralphptorres
Copy link
Contributor

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
Copy link
Owner

osa1 commented Nov 11, 2023

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
Copy link
Contributor Author

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. :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants