Update USAGE and man page

This commit is contained in:
sharkdp 2018-03-26 10:25:33 +02:00
parent 011e09840a
commit 388b90e624
3 changed files with 20 additions and 12 deletions

View File

@ -228,7 +228,7 @@ USAGE:
FLAGS: FLAGS:
-H, --hidden Search hidden files and directories -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 --no-ignore-vcs Do not respect .gitignore files
-s, --case-sensitive Case-sensitive search (default: smart case) -s, --case-sensitive Case-sensitive search (default: smart case)
-i, --ignore-case Case-insensitive search (default: smart case) -i, --ignore-case Case-insensitive search (default: smart case)
@ -241,13 +241,15 @@ FLAGS:
-V, --version Prints version information -V, --version Prints version information
OPTIONS: OPTIONS:
-d, --max-depth <depth> Set maximum search depth (default: none) -d, --max-depth <depth> Set maximum search depth (default: none)
-t, --type <filetype>... Filter by type: f(ile), d(irectory), (sym)l(ink) -t, --type <filetype>... Filter by type: file (f), directory (d), symlink (l),
-e, --extension <ext>... Filter by file extension executable (x)
-x, --exec <cmd> Execute a command for each search result -e, --extension <ext>... Filter by file extension
-E, --exclude <pattern>... Exclude entries that match the given glob pattern -x, --exec <cmd> Execute a command for each search result
-c, --color <when> When to use colors: never, *auto*, always -E, --exclude <pattern>... Exclude entries that match the given glob pattern
-j, --threads <num> Set number of threads to use for searching & executing --ignore-file <path>... Add a custom ignore-file in .gitignore format
-c, --color <when> When to use colors: never, *auto*, always
-j, --threads <num> Set number of threads to use for searching & executing
ARGS: ARGS:
<pattern> the search pattern, a regular expression (optional) <pattern> the search pattern, a regular expression (optional)

View File

@ -84,6 +84,8 @@ regular files
directories directories
.IP "l, symlink" .IP "l, symlink"
symbolic links symbolic links
.IP "x, executable"
executable (files)
.RE .RE
.RS .RS
@ -100,6 +102,10 @@ Exclude files/directories that match the given glob pattern.
This overrides any other ignore logic. This overrides any other ignore logic.
Multiple exclude patterns can be specified. Multiple exclude patterns can be specified.
.TP .TP
.BI "\-\-ignore-file " path
Add a custom ignore-file in '.gitignore' format.
These files have a low precedence.
.TP
.BI "\-c, \-\-color " when .BI "\-c, \-\-color " when
Declare Declare
.I when .I when

View File

@ -164,9 +164,9 @@ fn usage() -> HashMap<&'static str, Help> {
, "Include hidden directories and files in the search results (default: hidden files \ , "Include hidden directories and files in the search results (default: hidden files \
and directories are skipped)."); and directories are skipped).");
doc!(h, "no-ignore" 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 \ , "Show search results from files and directories that would otherwise be ignored by \
'.*ignore' files."); '.gitignore' or '.fdignore' files.");
doc!(h, "no-ignore-vcs" doc!(h, "no-ignore-vcs"
, "Do not respect .gitignore files" , "Do not respect .gitignore files"
, "Show search results from files and directories that would otherwise be ignored by \ , "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 \ , "Limit the directory traversal to a given depth. By default, there is no limit \
on the search depth."); on the search depth.");
doc!(h, "file-type" 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 \ , "Filter the search by type (multiple allowable filetypes can be specified):\n \
'f' or 'file': regular files\n \ 'f' or 'file': regular files\n \
'd' or 'directory': directories\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."); other ignore logic. Multiple exclude patterns can be specified.");
doc!(h, "ignore-file" doc!(h, "ignore-file"
, "Add a custom ignore-file in .gitignore format" , "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" doc!(h, "color"
, "When to use colors: never, *auto*, always" , "When to use colors: never, *auto*, always"
, "Declare when to use color for the pattern match output:\n \ , "Declare when to use color for the pattern match output:\n \