diff options
Diffstat (limited to '')
-rw-r--r-- | bfind.1 (renamed from doc/man/bfind.1) | 102 |
1 files changed, 71 insertions, 31 deletions
diff --git a/doc/man/bfind.1 b/bfind.1 index d0a9b37..3aa03f8 100644 --- a/doc/man/bfind.1 +++ b/bfind.1 @@ -1,15 +1,15 @@ -.TH BFIND 1 BFIND +.TH BFIND 1 bfind .SH NAME -bfind - Minimalitic find using breadth-first crawling +bfind - minimalitic find using breadth-first crawling + .SH SYNOPSIS .BR bfind -.RI [ OPTION ]... -[--] -.RI [ DIRECTORY ] -.IR PASSPHRASE_LIST +[-0hsvx] +.RI [ directory ] + .SH DESCRIPTION .BR bfind -is a minimalitic alternative to +is a minimalistic alternative to .BR find (1) that is designed to be efficient that locating files. To accomplish this, @@ -27,23 +27,78 @@ will never include all features of because they are excessive and some other than makes not since to have in the program and can be outright dangerous. + .SH OPTIONS +The +.B bfind +utility conforms to the Base Definitions volume of POSIX.1-2017, +.IR "Section 12.2" , +.IR "Utility Syntax Guidelines" . +.PP +The following options are supported: .TP -.BR \-x ,\ \-\-xdev -Do not restrict crawling to one mount point. +.BR \-0 +Terminate lines with NUL rather than LF. .TP -.BR \-h ,\ \-\-hardlinks +.BR \-h Watch out for hardlinked directories. .TP -.BR \-s ,\ \-\-symlinks +.BR \-s Visit symbolically linked directories, but never visit the same directory twice. .TP -.BR \-v ,\ \-\-visible +.BR \-v No files starting with a dot will be listed. .TP -.BR \-0 ,\ \-\-print0 -Terminate lines with NUL rather than LF. +.BR \-x +Do not restrict crawling to one mount point. + +.SH OPERANDS +The following operand is supported: +.TP +.I directory +The directory to crawl. If not specified, the current +working directory is crawled. + +.SH STDIN +Not used. + +.SH INPUT FILES +.I directory +may be of any type. + +.SH ENVIRONMENT VARIABLES +No environment variables affects the execution of +.BR bfind . + +.SH ASYNCHRONOUS EVENTS +Default. + +.SH STDOUT +The +.B bfind +utility prints all visited files to the standard output. + +.SH STDERR +The standard error is only used for diagnostic messages. + +.SH OUTPUT FILES +None. + +.SH EXTENDED DESCRIPTION +None. + +.SH EXIT STATUS +The +.B bfind +utility exits with one of the following statuses: +.TP +0 +Successful. +.TP +1 +On error, including missing permissions to crawl a directory. + .SH RATIONALE While .BR bfind @@ -54,22 +109,7 @@ results faster if you are looking for a file (rather than listing files), because the file you are looking for is probably near the directory you are searching from. -.SH "SEE ALSO" + +.SH SEE ALSO .BR find (1), .BR grep (1) -.PP -Full documentation available locally via: info \(aq(bfind)\(aq -.SH AUTHORS -Principal author, Mattias Andrée. See the COPYING file for the full -list of authors. -.SH LICENSE -Copyright \(co 2013, 2015 Mattias Andrée -.br -License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>. -.br -This is free software: you are free to change and redistribute it. -.br -There is NO WARRANTY, to the extent permitted by law. -.SH BUGS -Please report bugs to https://github.com/maandree/bfind/issues or to -maandree@member.fsf.org |