diff --git a/doc/fd.1 b/doc/fd.1 index 51d0c03..f60a7dd 100644 --- a/doc/fd.1 +++ b/doc/fd.1 @@ -158,18 +158,40 @@ regular files directories .IP "l, symlink" symbolic links -.IP "x, executable" -executable (files) -.IP "e, empty" -empty files or directories .IP "s, socket" sockets .IP "p, pipe" named pipes (FIFOs) +.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. +This option can be specified more than once to include multiple file types. +Searching for '--type file --type symlink' will show both regular files as well as +symlinks. Note that the 'executable' and 'empty' filters work differently: '--type +executable' implies '--type file' by default. And '--type empty' searches for +empty files and directories, unless either '--type file' or '--type directory' is +specified in addition. + +Examples: + - Only search for files: + fd --type file … + fd -tf … + - Find both files and symlinks + fd --type file --type symlink … + fd -tf -tl … + - Find executable files: + fd --type executable + fd -tx + - Find empty files: + fd --type empty --type file + fd -te -tf + - Find empty directories: + fd --type empty --type directory + fd -te -td .RE .TP .BI "\-e, \-\-extension " ext diff --git a/src/app.rs b/src/app.rs index a548365..ee514b4 100644 --- a/src/app.rs +++ b/src/app.rs @@ -333,14 +333,36 @@ pub fn build_app() -> App<'static, 'static> { empty (e), socket (s), pipe (p)", ) .long_help( - "Filter the search by type (multiple allowable filetypes can be specified):\n \ + "Filter the search by type:\n \ 'f' or 'file': regular files\n \ 'd' or 'directory': directories\n \ 'l' or 'symlink': symbolic links\n \ - 'x' or 'executable': executables\n \ - 'e' or 'empty': empty files or directories\n \ 's' or 'socket': socket\n \ - 'p' or 'pipe': named pipe (FIFO)", + 'p' or 'pipe': named pipe (FIFO)\n\n \ + 'x' or 'executable': executables\n \ + 'e' or 'empty': empty files or directories\n\n\ + This option can be specified more than once to include multiple file types. \ + Searching for '--type file --type symlink' will show both regular files as \ + well as symlinks. Note that the 'executable' and 'empty' filters work differently: \ + '--type executable' implies '--type file' by default. And '--type empty' searches \ + for empty files and directories, unless either '--type file' or '--type directory' \ + is specified in addition.\n\n\ + Examples:\n \ + - Only search for files:\n \ + fd --type file …\n \ + fd -tf …\n \ + - Find both files and symlinks\n \ + fd --type file --type symlink …\n \ + fd -tf -tl …\n \ + - Find executable files:\n \ + fd --type executable\n \ + fd -tx\n \ + - Find empty files:\n \ + fd --type empty --type file\n \ + fd -te -tf\n \ + - Find empty directories:\n \ + fd --type empty --type directory\n \ + fd -te -td" ), ) .arg(