Join GitHub today
GitHub is home to over 50 million developers working together to host and review code, manage projects, and build software together.
Sign upGitHub is where the world builds software
Millions of developers and companies build, ship, and maintain their software on GitHub — the largest and most advanced development platform in the world.
README.md: Please change to use readable --long option formats in documentation #21440
Labels
Comments
jaalto
changed the title
jaalto
changed the title
jaalto
changed the title
jaalto
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Checklist
Description
Please update README.md and manual pages to refer lo --long options for readability. E.g mentioning "-citw" is cryptic without consulting the manual page for each and every option separately.
To list SHORT options in the generic listing places like this is sufficient:
-f, ---format
The is also benefit to search manual pages more easily: (1) "-f ," would place cursor directly to option defiition, and using "--LONG-NAME" would unambiguously carousel all occurrances.
Please let me know if a patch would be accepted for this change.