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

Follow GNU convention regarding usage output #151

Open
ggrossetie opened this issue May 20, 2021 · 0 comments
Open

Follow GNU convention regarding usage output #151

ggrossetie opened this issue May 20, 2021 · 0 comments

Comments

@ggrossetie
Copy link
Member

The standard --help option should output brief documentation for how to invoke the program, on standard output, then exit successfully. Other options and arguments should be ignored once this is seen, and the program should not perform its normal function.

https://www.gnu.org/prep/standards/html_node/_002d_002dhelp.html#g_t_002d_002dhelp

The following command should exit(0) and print usage to stdout:

$ asciidoctor --help

The following invalid commands should exit(1) and print usage to stderr:

$ asciidoctor file.adoc --hello

Reason: --hello is an invalid option

$ asciidoctor

Reason: The command requires at least one file

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

No branches or pull requests

1 participant