diff --git a/doc/fd.1 b/doc/fd.1 index d23909d..0692a3c 100644 --- a/doc/fd.1 +++ b/doc/fd.1 @@ -1,11 +1,10 @@ -.TH FD 1 fd-4.0.0 +.TH FD 1 .SH NAME -fd \- find files -.BR find (1) +fd \- find entries in the filesystem .SH SYNOPSIS .B fd -.RB [ \-HIsaLp0hV ] -.RB [ \- d +.RB [ \-HIsiaLp0hV ] +.RB [ \-d .IR depth ] .RB [ \-t .IR filetype ] @@ -36,6 +35,9 @@ files. .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 \-a, \-\-absolute\-path Show absolute instead of relative paths. .TP @@ -45,8 +47,7 @@ Dereference all symbolic links encountered. .B \-p, \-\-full\-path Match .I pattern -against full -.IR path . +against the full path .TP .B \-0, \-\-print0 Print results followed by null character instead of newlines. @@ -62,7 +63,7 @@ Limit directory traversal to at most .I levels of depth. .TP -.BI "\-t, \-\-type " c +.BI "\-t, \-\-type " filetype Filter search by type: .RS .IP "f, file" @@ -83,7 +84,7 @@ Declare to colorize search results: .RS .IP auto -Colorize output when standard output is connected to terminal. (default) +Colorize output when standard output is connected to terminal (default). .IP never Do not colorize output. .IP always @@ -91,8 +92,7 @@ Always colorize output. .RE .TP .BI "\-j, \-\-threads " num -Number of threads to use for searching. (default: number of processing units -available) +Number of threads to use for searching (default: number of available CPUs). .TP .BI "\-x, \-\-exec " command Execute @@ -117,10 +117,13 @@ Determines how to colorize search results, see .BR dircolors (1) . .SH EXAMPLES .TP -.RI "Find the specific log files in " /var/log . +.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 -Find all Python files that ends with \(dq.py\(dq in the current directory. +.RI "Find all Python files (all files with the extention " .py ") in the current directory:" $ fd -e py .SH SEE ALSO .BR find (1)