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

Categorize options in --help and man page #1893

Closed
dfabulich opened this issue Jun 14, 2021 · 1 comment
Closed

Categorize options in --help and man page #1893

dfabulich opened this issue Jun 14, 2021 · 1 comment
Labels
duplicate An issue that is duplicative of another.

Comments

@dfabulich
Copy link
Contributor

When you run rg --help or man rg it presents a giant list of 100 options in alphabetical order. Related options like --heading and --no-heading do not appear together.

By comparison, man grep (for GNU grep) presents its options in categories: https://linux.die.net/man/1/grep

  • Generic Program Information (--help, --version)
  • Matcher Selection (--extended--regexp, --perl-regexp)
  • Matching Control (--ignore-case, --invert-match)
  • General Output Control (--files-with-matches, --count, --silent)
  • Output Line Prefix Control (--line-number, --no-filename)
  • Context Line Control (--after-context, --before-context)
  • File and Directory Selection (--exclude, --include)

Skimming through the options for ripgrep, I think a similar list of categories would work.
@BurntSushi BurntSushi added the duplicate An issue that is duplicative of another. label Jun 14, 2021
@BurntSushi
Copy link
Owner

Dupe of #1814

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
duplicate An issue that is duplicative of another.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@dfabulich @BurntSushi