diff options
author | Rory Bradford <roryrjb@gmail.com> | 2019-11-15 17:12:07 +0000 |
---|---|---|
committer | Rory Bradford <roryrjb@gmail.com> | 2019-11-15 17:12:07 +0000 |
commit | 0de5b3a641bc4fb405d3919f018b4869bd0612c5 (patch) | |
tree | 1b5450fb79e8a96c706bb97609555a7df5c8b967 /rf.1 | |
download | rf-0de5b3a641bc4fb405d3919f018b4869bd0612c5.tar.gz |
Initial implementation
Signed-off-by: Rory Bradford <roryrjb@gmail.com>
Diffstat (limited to 'rf.1')
-rw-r--r-- | rf.1 | 55 |
1 files changed, 55 insertions, 0 deletions
diff --git a/rf.1 b/rf.1 new file mode 100644 index 0000000..1e8e08d --- /dev/null +++ b/rf.1 @@ -0,0 +1,55 @@ +.TH rf 1 + +.SH NAME +rf \- A tiny and simple file finder + +.SH SYNOPSIS +.B rf +[OPTIONS] PATTERNS... + +.SH DESCRIPTION +.B rf +will find files based on simple substring patterns. + +.SH OPTIONS +.TP +.B "\-h, \-\-help" +.br +Show help message. + +.TP +.B "\-v, \-\-version" +.br +Show version. + +.TP +.B "\-b, \-\-basename" +.br +Only show the basename of results. + +.SH PATTERNS +Files and directories can be found using very simple patterns. + +.TP +.B "Substrings" +.br +A simple string is basically a substring match. So if you supply a +pattern of 'js', rf will match any file that contains the string 'js' +anywhere in the filename. If the pattern is '.js' it will match any +\'.js' or even '.json' files for example, as well as the filename +\'script.js.backup', in other words the character '.' is just that, it +doesn't have any special significance such as in regular expressions. +It also doesn't have any kind of implicit positional information, it +will just match at any point in the filename. + +.TP +.B "Beginning and end" +.br + +.SH SEE ALSO +.BR find (1), +.BR rg (1) + + +.SH COPYRIGHT +Copyright \(co 2019 Rory Bradford <roryrjb@gmail.com>. |