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.

Sign up for GitHub

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

Jump to bottom

-h/--help flag for all programs #1608

Closed
Rangi42 opened this issue Jan 14, 2025 · 0 comments · Fixed by #1620
Closed

-h/--help flag for all programs #1608

Rangi42 opened this issue Jan 14, 2025 · 0 comments · Fixed by #1620
Labels
enhancement Typically new features; lesser priority than bugs rgbasm This affects RGBASM rgbfix This affects RGBFIX rgbgfx This affects RGBGFX rgblink This affects RGBLINK
Milestone
0.9.1

Comments

@Rangi42
Copy link
Contributor

Rangi42 commented Jan 14, 2025

rgbasm, rgblink, rgbfix, and rgbgfx all support -V/--version to print the RGBDS version. But they do not have a way to print the basic help info, besides passing unrecognized flags ("--foobar"). Many programs support -h/--help, including GNU ones, Python ones that use argparse, and Rust ones that use clap. We could augment the usage info by suggesting to read the man page (at the gbdev URL, since the user's platform may not have man).
@Rangi42 Rangi42 added enhancement Typically new features; lesser priority than bugs rgbasm This affects RGBASM rgblink This affects RGBLINK rgbfix This affects RGBFIX rgbgfx This affects RGBGFX labels Jan 14, 2025
@Rangi42 Rangi42 added this to the 0.9.1 milestone Jan 14, 2025
@Rangi42 Rangi42 assigned Rangi42 and unassigned Rangi42 Jan 18, 2025
@Rangi42 Rangi42 mentioned this issue Jan 18, 2025
Merged
@Rangi42 Rangi42 changed the title -h/--help flag for all programs? -h/--help flag for all programs Jan 18, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement Typically new features; lesser priority than bugs rgbasm This affects RGBASM rgbfix This affects RGBFIX rgbgfx This affects RGBGFX rgblink This affects RGBLINK
Projects
None yet
Milestone
0.9.1
Development

Successfully merging a pull request may close this issue.

Support -h/--help for all programs Rangi42/rgbds
1 participant
@Rangi42