mirror of https://github.com/sharkdp/fd.git
160 lines
3.4 KiB
Groff
160 lines
3.4 KiB
Groff
.TH FD 1
|
|
.SH NAME
|
|
fd \- find entries in the filesystem
|
|
.SH SYNOPSIS
|
|
.B fd
|
|
.RB [ \-HIEsiaLp0hV ]
|
|
.RB [ \-d
|
|
.IR depth ]
|
|
.RB [ \-t
|
|
.IR filetype ]
|
|
.RB [ \-e
|
|
.IR ext ]
|
|
.RB [ \-E
|
|
.IR exclude ]
|
|
.RB [ \-c
|
|
.IR when ]
|
|
.RB [ \-j
|
|
.IR num ]
|
|
.RB [ \-x
|
|
.IR cmd ]
|
|
.RI [ pattern ]
|
|
.RI [ path... ]
|
|
.SH DESCRIPTION
|
|
.B fd
|
|
is a simple, fast and user-friendly alternative to
|
|
.BR find (1).
|
|
.SH OPTIONS
|
|
.TP
|
|
.B \-H, \-\-hidden
|
|
Include hidden files and directories in the search results.
|
|
.TP
|
|
.B \-I, \-\-no\-ignore
|
|
Do not respect files like
|
|
.I .gitignore
|
|
and
|
|
.I .fdignore
|
|
and include ignored files in the search results.
|
|
.TP
|
|
.B \-\-no\-ignore\-vcs
|
|
Do not respect version control ignore files like
|
|
.I ".gitignore"
|
|
and include the respective entries in the search results.
|
|
.TP
|
|
.B \-s, \-\-case\-sensitive
|
|
Perform a case-sensitive search (default: smart case).
|
|
.TP
|
|
.B \-i, \-\-ignore\-case
|
|
Perform a case-insensitive search (default: smart case).
|
|
.TP
|
|
.B \-F, \-\-fixed\-strings
|
|
Treat the pattern as a literal string instead of a regular expression.
|
|
.TP
|
|
.B \-a, \-\-absolute\-path
|
|
Show absolute instead of relative paths.
|
|
.TP
|
|
.B \-L, \-\-follow
|
|
Dereference all symbolic links encountered.
|
|
.TP
|
|
.B \-p, \-\-full\-path
|
|
Match the
|
|
.I pattern
|
|
against the full path instead of just the file or directory name.
|
|
.TP
|
|
.B \-0, \-\-print0
|
|
Separate search results by null characters instead of newlines.
|
|
.TP
|
|
.B \-h, \-\-help
|
|
Print help information.
|
|
.TP
|
|
.B \-V, \-\-version
|
|
Print version information.
|
|
.TP
|
|
.BI "\-d, \-\-max\-depth " d
|
|
Limit directory traversal to at most
|
|
.I d
|
|
levels of depth. By default, there is no limit on the search depth.
|
|
.TP
|
|
.BI "\-t, \-\-type " filetype
|
|
Filter search by type:
|
|
.RS
|
|
.IP "f, file"
|
|
regular files
|
|
.IP "d, directories"
|
|
directories
|
|
.IP "l, symlink"
|
|
symbolic links
|
|
.IP "x, executable"
|
|
executable (files)
|
|
.IP "e, empty"
|
|
empty files or directories
|
|
.RE
|
|
|
|
.RS
|
|
This option can be used repeatedly to allow for multiple file types.
|
|
.RE
|
|
.TP
|
|
.BI "\-e, \-\-extension " ext
|
|
Filter search results by file extension
|
|
.IR ext .
|
|
This option can be used repeatedly to allow for multiple possible file extensions.
|
|
.TP
|
|
.BI "\-E, \-\-exclude " pattern
|
|
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
|
|
to colorize search results:
|
|
.RS
|
|
.IP auto
|
|
Colorize output when standard output is connected to terminal (default).
|
|
.IP never
|
|
Do not colorize output.
|
|
.IP always
|
|
Always colorize output.
|
|
.RE
|
|
.TP
|
|
.BI "\-j, \-\-threads " num
|
|
Number of threads to use for searching (default: number of available CPUs).
|
|
.TP
|
|
.BI "\-x, \-\-exec " command "\fR [args...] ;"
|
|
Execute
|
|
.I command
|
|
for each search result. The following placeholders are substituted by a path derived from the current search result:
|
|
.RS
|
|
.IP {}
|
|
path
|
|
.IP {/}
|
|
basename
|
|
.IP {//}
|
|
parent directory
|
|
.IP {.}
|
|
path without file extension
|
|
.IP {/.}
|
|
basename without file extension
|
|
.RE
|
|
.SH ENVIRONMENT
|
|
.TP
|
|
.B LS_COLORS
|
|
Determines how to colorize search results, see
|
|
.BR dircolors (1) .
|
|
.SH EXAMPLES
|
|
.TP
|
|
.RI "Find files and directories that match the pattern '" needle "':"
|
|
$ fd needle
|
|
.TP
|
|
.RI "Start a search in a given directory (" /var/log "):"
|
|
$ fd nginx /var/log
|
|
.TP
|
|
.RI "Find all Python files (all files with the extention " .py ") in the current directory:"
|
|
$ fd -e py
|
|
.SH SEE ALSO
|
|
.BR find (1)
|