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

man: create xdg-ninja.1 man page #258

Merged
merged 1 commit into from
May 11, 2023
Merged

Conversation

Ballasi
Copy link
Contributor

@Ballasi Ballasi commented May 10, 2023

Because man pages are cool.

You can preview it by using $ man man/xdg-ninja.1

I can also edit the man page if you think it might require some changes before pushing. I was wondering about adding a paragraph for the optional dependencies (glow and alternatives) but figured it would be a better fit to have that in the README.md as a one-time installation information.

@b3nj5m1n
Copy link
Owner

Very cool, thank you!

It seems there's a small typo, the options are named as strip-ok, strip-unsupported, etc., when they're actually named skip-ok, skip-unsupported.

I was wondering about adding a paragraph for the optional dependencies

I think there should at least be a paragraph about the recommended dependencies, so jq and glow, although I'm not really familiar with the best practices for man pages.

Apart from that it looks good!

@Ballasi
Copy link
Contributor Author

Ballasi commented May 11, 2023

It seems there's a small typo, the options are named as strip-ok, strip-unsupported, etc., when they're actually named skip-ok, skip-unsupported.

You are right! I actually misread strip, that's my bad. Fixed.

I was wondering about adding a paragraph for the optional dependencies

I think there should at least be a paragraph about the recommended dependencies, so jq and glow, although I'm not really familiar with the best practices for man pages.

Since jq is a required (and not a recommended) dependency and the script fails when running without it, I would tend to not have that in the man page, because of the way I see man pages ; documentation on how to use a program and not how to install it.

I think it would make sense to add a note about optional dependencies as the user can have a different behavior depending on that during runtime.

For now I have just added a note about glow, if you prefer also adding a note about jq too I can squash that in.

@b3nj5m1n
Copy link
Owner

Looks good to me. Thanks again for all your help with this project!

@b3nj5m1n b3nj5m1n merged commit 569bd74 into b3nj5m1n:main May 11, 2023
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.

None yet

2 participants