Repository: sharkdp/fd (language: rust)

Issue:
Man page doesn't explain search patterns
The man page doesn't say what form search patterns should take. The README here on GitHub says they are regular expressions, but not what kind of REs (I guess they are not PCREs, because there's an issue for adding that).

Suggestion: document in man page that the pattern argument is a regular expression, and say what kind of regular expression ops are supported.


Discussion / hints:
Thank you for the feedback. We should add that to the documentation (man page and maybe README) - yes.



> I guess they are not PCREs, because there's an issue for adding that

You are right. `fd` uses the regular expressions specified by the `regex` crate (Rust library). Its syntax is documented here: https://docs.rs/regex/1.1.0/regex/#syntax
FD lacks a basic description as well. And it’s important to have one if this app is used infrequently. Compare:
```
ripgrep 0.10.0
Andrew Gallant <jamslam@gmail.com>

ripgrep (rg) recursively searches your current directory for a regex pattern.
By default, ripgrep will respect your .gitignore and automatically skip hidden
files/directories and binary files.
```
Hey @sharkdp
I would like to get my feet wet with this, as my first contribution.
- [ ]  Add syntax patterns for RE.
- [ ]  Add examples with RE syntax.
@rootbid Sounds great!

Fix patch:
diff --git a/doc/fd.1 b/doc/fd.1
index 843d79516..7ab896965 100644
--- a/doc/fd.1
+++ b/doc/fd.1
@@ -233,6 +233,16 @@ path without file extension
 .IP {/.}
 basename without file extension
 .RE
+.SH PATTERN SYNTAX
+The regular expression syntax used by fd is documented here:
+
+.UR https://docs.rs/regex/1.0.0/regex/#syntax
+.UE
+
+The glob syntax is documented here:
+
+.UR https://docs.rs/globset/#syntax
+.UE
 .SH ENVIRONMENT
 .TP
 .B LS_COLORS


Test patch: