Update manpage to match --help output

Three command line options were added in late 2021
that never made their way into the manpage:

* f8ae334 introduced --no-ignore-parent;
* bf9e6fd introduced --strip-prefix
  (later renamed strip-cwd-prefix); and
* 17dd2a6 introduced --batch-size.

This commit updates the manpage content to reflect
the auto-generated output of `fd --help`.
This commit is contained in:
Ryan Lue 2021-12-23 13:28:34 -08:00 committed by David Peter
parent dade9736ac
commit 30add71233
1 changed files with 13 additions and 1 deletions

14
doc/fd.1 vendored
View File

@ -66,6 +66,10 @@ git setting, which defaults to
.IR $HOME/.config/git/ignore ). .IR $HOME/.config/git/ignore ).
The flag can be overridden with '--ignore-vcs'. The flag can be overridden with '--ignore-vcs'.
.TP .TP
.B \-\-no\-ignore\-parent
Show search results from files and directories that would otherwise be ignored by gitignore files in
parent directories.
.TP
.B \-s, \-\-case\-sensitive .B \-s, \-\-case\-sensitive
Perform a case-sensitive search. By default, fd uses case-insensitive searches, unless the Perform a case-sensitive search. By default, fd uses case-insensitive searches, unless the
pattern contains an uppercase character (smart case). pattern contains an uppercase character (smart case).
@ -126,6 +130,10 @@ can be used as an alias.
Enable the display of filesystem errors for situations such as insufficient Enable the display of filesystem errors for situations such as insufficient
permissions or dead symlinks. permissions or dead symlinks.
.TP .TP
.B \-\-strip-cwd-prefix
By default, relative paths are prefixed with './' when the output goes to a non interactive terminal
(TTY). Use this flag to disable this behaviour.
.TP
.B \-\-one\-file\-system, \-\-mount, \-\-xdev .B \-\-one\-file\-system, \-\-mount, \-\-xdev
By default, fd will traverse the file system tree as far as other options dictate. With this flag, fd ensures that it does not descend into a different file system than the one it started in. Comparable to the -mount or -xdev filters of find(1). By default, fd will traverse the file system tree as far as other options dictate. With this flag, fd ensures that it does not descend into a different file system than the one it started in. Comparable to the -mount or -xdev filters of find(1).
.TP .TP
@ -393,7 +401,11 @@ Examples:
fd -e rs -X wc -l fd -e rs -X wc -l
.RE .RE
.TP
.BI "\-\-batch-size " size
Maximum number of arguments to pass to the command given with -X. If the number of results is
greater than the given size, the command given with -X is run again with remaining arguments. A
batch size of zero means there is no limit.
.SH PATTERN SYNTAX .SH PATTERN SYNTAX
The regular expression syntax used by fd is documented here: The regular expression syntax used by fd is documented here: