README.md

This commit is contained in:
Amber 2024-04-08 10:20:44 +02:00
parent 82aebaf869
commit 98f55a65f0
1 changed files with 25 additions and 6 deletions

View File

@ -16,24 +16,37 @@ In my opinion the better solution is:<br />
## How to use
**vfind** has 2 mandatory arguments, the *path* of subtree from which to begin the search and the *search* pattern (a regexp)
**vfind** has 2 mandatory arguments, the *path* of subtree from which to begin the search and the *search* pattern.
The **search** pattern can be:
- an expression whith wild card supporting the shell expansion, the default
- a regular expression, using the flag -re
The only thing that needs to be remembered is to wrap in double quote the regular expression in conjunction with the **-re** flag
when you choose to use it, for example:
```
vfind ~/nerd_tree/ "(.*)rem(.*)"
vfind ~/nerd_tree/ -re "(.*)rem(.*)"
```
all items matching the pattern are show in the result tree: in this specific case any name containing **rem** substring<br />
The same results above can be achieved using the command version with the shell expansion:
```
vfind ~/nerd_tree/ *rem*
```
You can use as pattern any valid regular expression, for example pattern as this
```
vfind ~/nerd_tree/ "(.*)rem|tree(.*)"
vfind ~/nerd_tree/ -re "(.*)rem|tree(.*)"
```
The folder matching the pattern are show collapsed with information about the total number of files and the size of the subtree.
If you want to show the subtree expanded you can use the flag **-s**
```
vfind ~/nerd_tree/ "(.*)rem(.*)" -s
vfind ~/nerd_tree/ -re "(.*)rem(.*)" -s
```
## Include/Exclude path
@ -42,17 +55,23 @@ You can include a set of results selecting specific branch (or paths) with the o
For example:
```
vfind ~/nerd_tree/ "(.*)py" -i src
vfind ~/nerd_tree/ -re "(.*)py" -i src
```
include the results that along the path have the name **src**.<br />
**NOTE** the command above is equivalent to
```
vfind ~/nerd_tree/ *py -i src
```
You can include the -i more than once, for example:
```
vfind ~/nerd_tree/ "([0-9][0-9])|(^tree_(.*))" -i src -i .git
```
the above command will search for files or folders beginning with **two digits** or with the name beginning with **tree_**
the above command will search for files or folders with a **two digits** name or with the name beginning with **tree_**
only in the path ***src*** or ***.git***