From 388b90e62449f302892a50b7742804ebf10f0bab Mon Sep 17 00:00:00 2001 From: sharkdp Date: Mon, 26 Mar 2018 10:25:33 +0200 Subject: Update USAGE and man page --- README.md | 18 ++++++++++-------- doc/fd.1 | 6 ++++++ src/app.rs | 8 ++++---- 3 files changed, 20 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 3d59f43..22fc2d5 100644 --- a/README.md +++ b/README.md @@ -228,7 +228,7 @@ USAGE: FLAGS: -H, --hidden Search hidden files and directories - -I, --no-ignore Do not respect .(git)ignore files + -I, --no-ignore Do not respect .(git|fd)ignore files --no-ignore-vcs Do not respect .gitignore files -s, --case-sensitive Case-sensitive search (default: smart case) -i, --ignore-case Case-insensitive search (default: smart case) @@ -241,13 +241,15 @@ FLAGS: -V, --version Prints version information OPTIONS: - -d, --max-depth Set maximum search depth (default: none) - -t, --type ... Filter by type: f(ile), d(irectory), (sym)l(ink) - -e, --extension ... Filter by file extension - -x, --exec Execute a command for each search result - -E, --exclude ... Exclude entries that match the given glob pattern - -c, --color When to use colors: never, *auto*, always - -j, --threads Set number of threads to use for searching & executing + -d, --max-depth Set maximum search depth (default: none) + -t, --type ... Filter by type: file (f), directory (d), symlink (l), + executable (x) + -e, --extension ... Filter by file extension + -x, --exec Execute a command for each search result + -E, --exclude ... Exclude entries that match the given glob pattern + --ignore-file ... Add a custom ignore-file in .gitignore format + -c, --color When to use colors: never, *auto*, always + -j, --threads Set number of threads to use for searching & executing ARGS: the search pattern, a regular expression (optional) diff --git a/doc/fd.1 b/doc/fd.1 index 26e36a0..450bdad 100644 --- a/doc/fd.1 +++ b/doc/fd.1 @@ -84,6 +84,8 @@ regular files directories .IP "l, symlink" symbolic links +.IP "x, executable" +executable (files) .RE .RS @@ -100,6 +102,10 @@ Exclude files/directories that match the given glob pattern. This overrides any other ignore logic. Multiple exclude patterns can be specified. .TP +.BI "\-\-ignore-file " path +Add a custom ignore-file in '.gitignore' format. +These files have a low precedence. +.TP .BI "\-c, \-\-color " when Declare .I when diff --git a/src/app.rs b/src/app.rs index 14291a3..d7fa9e9 100644 --- a/src/app.rs +++ b/src/app.rs @@ -164,9 +164,9 @@ fn usage() -> HashMap<&'static str, Help> { , "Include hidden directories and files in the search results (default: hidden files \ and directories are skipped)."); doc!(h, "no-ignore" - , "Do not respect .(git)ignore files" + , "Do not respect .(git|fd)ignore files" , "Show search results from files and directories that would otherwise be ignored by \ - '.*ignore' files."); + '.gitignore' or '.fdignore' files."); doc!(h, "no-ignore-vcs" , "Do not respect .gitignore files" , "Show search results from files and directories that would otherwise be ignored by \ @@ -202,7 +202,7 @@ fn usage() -> HashMap<&'static str, Help> { , "Limit the directory traversal to a given depth. By default, there is no limit \ on the search depth."); doc!(h, "file-type" - , "Filter by type: f(ile), d(irectory), (sym)l(ink)" + , "Filter by type: file (f), directory (d), symlink (l),\nexecutable (x)" , "Filter the search by type (multiple allowable filetypes can be specified):\n \ 'f' or 'file': regular files\n \ 'd' or 'directory': directories\n \ @@ -230,7 +230,7 @@ fn usage() -> HashMap<&'static str, Help> { other ignore logic. Multiple exclude patterns can be specified."); doc!(h, "ignore-file" , "Add a custom ignore-file in .gitignore format" - , "Add a custom ignore-file in .gitignore format. These files have a low precedence."); + , "Add a custom ignore-file in '.gitignore' format. These files have a low precedence."); doc!(h, "color" , "When to use colors: never, *auto*, always" , "Declare when to use color for the pattern match output:\n \ -- cgit v1.2.3