From bab77275ece71df6ece197e5c96df451d49f9e33 Mon Sep 17 00:00:00 2001 From: David Peter Date: Tue, 1 Nov 2022 21:18:11 +0100 Subject: [PATCH] Update Usage in Readme --- README.md | 64 +++++++++++++++++++++++++++---------------------------- 1 file changed, 31 insertions(+), 33 deletions(-) diff --git a/README.md b/README.md index 793f8819c..d73f10b06 100644 --- a/README.md +++ b/README.md @@ -295,39 +295,37 @@ This is the output of `fd -h`. To see the full set of command-line options, use also includes a much more detailed help text. ``` -USAGE: - fd [FLAGS/OPTIONS] [] [...] - -FLAGS: - -H, --hidden Search hidden files and directories - -I, --no-ignore Do not respect .(git|fd)ignore files - -s, --case-sensitive Case-sensitive search (default: smart case) - -i, --ignore-case Case-insensitive search (default: smart case) - -g, --glob Glob-based search (default: regular expression) - -a, --absolute-path Show absolute instead of relative paths - -l, --list-details Use a long listing format with file metadata - -L, --follow Follow symbolic links - -p, --full-path Search full abs. path (default: filename only) - -h, --help Prints help information - -V, --version Prints version information - -OPTIONS: - -d, --max-depth Set maximum search depth (default: none) - -t, --type ... Filter by type: file (f), directory (d), symlink (l), - executable (x), empty (e), socket (s), pipe (p) - -e, --extension ... Filter by file extension - -x, --exec Execute a command for each search result - -X, --exec-batch Execute a command with all search results at once - -E, --exclude ... Exclude entries that match the given glob pattern - -c, --color When to use colors: never, *auto*, always - -S, --size ... Limit results based on the size of files - --changed-within Filter by file modification time (newer than) - --changed-before Filter by file modification time (older than) - -o, --owner Filter by owning user and/or group - -ARGS: - the search pattern (a regular expression, unless '--glob' is used; optional) - ... the root directory for the filesystem search (optional) +Usage: fd [OPTIONS] [pattern] [path]... + +Arguments: + [pattern] the search pattern (a regular expression, unless '--glob' is used; optional) + [path]... the root directories for the filesystem search (optional) + +Options: + -H, --hidden Search hidden files and directories + -I, --no-ignore Do not respect .(git|fd)ignore files + -s, --case-sensitive Case-sensitive search (default: smart case) + -i, --ignore-case Case-insensitive search (default: smart case) + -g, --glob Glob-based search (default: regular expression) + -a, --absolute-path Show absolute instead of relative paths + -l, --list-details Use a long listing format with file metadata + -L, --follow Follow symbolic links + -p, --full-path Search full abs. path (default: filename only) + -d, --max-depth Set maximum search depth (default: none) + -E, --exclude Exclude entries that match the given glob pattern + -t, --type Filter by type: file (f), directory (d), symlink (l), + executable (x), empty (e), socket (s), pipe (p) + -e, --extension Filter by file extension + -S, --size Limit results based on the size of files + --changed-within Filter by file modification time (newer than) + --changed-before Filter by file modification time (older than) + -o, --owner Filter by owning user and/or group + -x, --exec ... Execute a command for each search result + -X, --exec-batch ... Execute a command with all search results at once + -c, --color When to use colors [default: auto] [possible values: auto, + always, never] + -h, --help Print help information (use `--help` for more detail) + -V, --version Print version information ``` ## Benchmark