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 #152

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add man page #152

wants to merge 1 commit into from

Conversation

markcaudill
Copy link

@markcaudill markcaudill commented Jan 20, 2024

I saw mention of wanting a man page so I took the one from rsync and replaced everything with some of the contents of the readme. I'm not sure what next steps would be. Feel free to disregard this.

You can preview the file by running man runitor.1 from the project root.

@bdd
Copy link
Owner

bdd commented Jan 20, 2024

Thanks for taking the initiative.

I don't think having the man page in roff is anywhere sustainable. I've done my own share of doing this for OpenBSD man pages, dunno 20 years ago but today these should be written in Markdown or something equally reasonable so it can be converted to whatever presentation format is desired, be it roff for man pages, HTML for online browsing, or PDF for people who like printing things.

If you're up for doing something like this, where we can also CLI help text in the source code and the docs in sync, and rely on a doc converter (Pandoc comes to mind), I'd be happy to collaborate on a PR like that.

I this current form, as a sole developer, I cannot possibly maintain a roff file.

@markcaudill
Copy link
Author

Yeah I completely agree about maintaining roff. My first instinct was to see if I could hook into any current document generation but I didn't see where I could do that.

I'm happy if you close this and as time allows I'll try to see about maybe leveraging go doc or something if you think that's the right direction (I'm not as familiar with the Go ecosystem and idioms).

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

Successfully merging this pull request may close these issues.

2 participants