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

Include regex syntax in man page #2742

Open
tournemire opened this issue Feb 22, 2024 · 1 comment
Open

Include regex syntax in man page #2742

tournemire opened this issue Feb 22, 2024 · 1 comment
Labels
question An issue that is lacking clarity on one or more points.

Comments

@tournemire
Copy link

Ripgrep's manpage does not document its default regex syntax, instead redirecting to the regex crate's documentation. This makes offline use with non-trivial regexes impractical, as end-users do not necessarily have a local copy of the crate's doc.

@BurntSushi
Copy link
Owner

I think this has been requested before, but duplicating the regex syntax doc is quarrelsome for a couple reasons:

  1. It is extremely long. It would be too long to include it in man rg IMO. Which means we'd probably need to ship a man rg-regex-syntax or something.
  2. This would create two separate copies of the syntax documentation, which in turn means it'd be easy for them to get out-of-sync with one another.
  3. The regex syntax doc is "plain" HTML/CSS/some-javascript. It is not hard to download it if you need an offline copy.

@BurntSushi BurntSushi added the question An issue that is lacking clarity on one or more points. label Feb 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
question An issue that is lacking clarity on one or more points.
Projects
None yet
Development

No branches or pull requests

2 participants