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

Improve help/usage text #101

Closed
tukusejssirs opened this issue Oct 19, 2019 · 1 comment
Closed

Improve help/usage text #101

tukusejssirs opened this issue Oct 19, 2019 · 1 comment
Assignees
Labels

Comments

@tukusejssirs
Copy link

tukusejssirs commented Oct 19, 2019

I really miss the -h/--help option. You have already implemented -h for different purpose, so at least --help should be implemented.

Also, I think that usage output should be a separate function (e.g. usage()). For now, it could accept one parameter, either short (short usage help text when the program dies) or full (full help text when issued with --help (then it should return 0 as it is a success).

The full help text should include all options with there definitions (just like it is currently in the README.md.

The full help text should also include examples.

@nigelhorne
Copy link
Owner

Use '-?' to get help. This is a convention going back many years as far back as the days of UNIX.

@nigelhorne nigelhorne self-assigned this Aug 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants