From a2349848c02d1a71a1051f004f20deb734365c21 Mon Sep 17 00:00:00 2001 From: sharkdp Date: Sat, 9 Sep 2017 19:32:30 +0200 Subject: [PATCH] Add command-line options --- README.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/README.md b/README.md index 45db03f..e50ce3e 100644 --- a/README.md +++ b/README.md @@ -132,3 +132,29 @@ bash test.sh # Install cargo install ``` + +## Command-line options +``` +USAGE: + fd [FLAGS/OPTIONS] [] [] + +FLAGS: + -s, --case-sensitive Case-sensitive search (default: smart case) + -p, --full-path Search full path (default: file-/dirname only) + -H, --hidden Search hidden files and directories + -I, --no-ignore Do not respect .(git)ignore files + -L, --follow Follow symlinks + -0, --print0 Separate results by the null character + -a, --absolute-path Show absolute instead of relative paths + -n, --no-color Do not colorize output + -h, --help Prints help information + -V, --version Prints version information + +OPTIONS: + -d, --max-depth Set maximum search depth (default: none) + -j, --threads The number of threads used for searching + +ARGS: + the search pattern, a regular expression (optional) + the root directory for the filesystem search (optional) +```