grumpycoders / grumpycoders/pcsx-redux

[Feature Request] Add standard `--help`/`-h` command line interface arguments

Open
#1,967 0 comments 4 reactions 0 assignees View on GitHub
Dominant language
C++
Stars
994
Forks
151
Avg merge
1d 15h
Merged PRs (30d)
18

Description

Hi. Please considering adding the standard/GNU-style `--help`/`-h` command line arguments to pcsx-redux.

I'm sure you're probably already familiar with these, but for the sake of completeness, [here's a description of what I mean](https://www.gnu.org/prep/standards/html_node/_002d_002dhelp.html) from GNU themselves. In practice, this would output information similar to that which is contained [here in your docs](https://pcsx-redux.consoledev.net/cli_flags/), but just in a command-line readable fashion.

I would not expect you all to be forced to follow each and every one of GNU's coding standards to the T ([I know they have some very vocal detractors out there](https://www.kernel.org/doc/html/v4.10/process/coding-style.html) lol). In this specific case however, I think the usage of `--help`/`-h` is standard enough across the industry/FOSS-community that it's a convenient thing to have nonetheless.

Yes, we could just read the docs linked above, but it'd be nice to have that included with the program itself and easily accessible via a terminal (where we'd already be when trying to figure out command line arguments).

Thanks for considering this suggestion. All the best, -IP

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.