diff options
Diffstat (limited to 'website')
-rw-r--r-- | website/docs/img/20200620-complex-composite.png | bin | 0 -> 46874 bytes | |||
-rw-r--r-- | website/docs/img/20200620-composite-notrs.png | bin | 0 -> 34001 bytes | |||
-rw-r--r-- | website/docs/img/20200620-content-memm.png | bin | 0 -> 35627 bytes | |||
-rw-r--r-- | website/docs/img/20200620-content-search.png | bin | 0 -> 36140 bytes | |||
-rw-r--r-- | website/docs/index.md | 2 | ||||
-rw-r--r-- | website/docs/input.md | 41 | ||||
-rw-r--r-- | website/docs/navigation.md | 22 |
7 files changed, 56 insertions, 9 deletions
diff --git a/website/docs/img/20200620-complex-composite.png b/website/docs/img/20200620-complex-composite.png Binary files differnew file mode 100644 index 0000000..6c87a5d --- /dev/null +++ b/website/docs/img/20200620-complex-composite.png diff --git a/website/docs/img/20200620-composite-notrs.png b/website/docs/img/20200620-composite-notrs.png Binary files differnew file mode 100644 index 0000000..e28db1f --- /dev/null +++ b/website/docs/img/20200620-composite-notrs.png diff --git a/website/docs/img/20200620-content-memm.png b/website/docs/img/20200620-content-memm.png Binary files differnew file mode 100644 index 0000000..12723bb --- /dev/null +++ b/website/docs/img/20200620-content-memm.png diff --git a/website/docs/img/20200620-content-search.png b/website/docs/img/20200620-content-search.png Binary files differnew file mode 100644 index 0000000..45e5e79 --- /dev/null +++ b/website/docs/img/20200620-content-search.png diff --git a/website/docs/index.md b/website/docs/index.md index b76ce83..b61db43 100644 --- a/website/docs/index.md +++ b/website/docs/index.md @@ -42,7 +42,7 @@ You may also search with a regular expression. To do this, add a `/` before the And you have other types of searches, for example searching on file content (start with `c/`): -![content search](img/20200608-content-search.png) +![content search](img/20200620-content-memm.png) You may also apply logical operators or combine patterns, for example searching `test` in all files except json ones could be `!/json$/&c/test` and searching `carg` both in file names and file contents would be `carg|c/carg`. diff --git a/website/docs/input.md b/website/docs/input.md index 2cc7047..e0990fc 100644 --- a/website/docs/input.md +++ b/website/docs/input.md @@ -13,7 +13,9 @@ Both parts are optional. ## The filtering pattern -The search syntax is globally +A search pattern is made of 1 to 3 parts separated by the `/` character but you rarely need the two `/`. + +The syntax is globally <mode><pattern>[/<flags>] @@ -21,18 +23,36 @@ The mode is either nothing (fuzzy name), just a slash (regex name) or some lette mode | example query | example match | explanation -|-|-|- -fuzzy name | `abc` | `abac.txt` | search for "abc" in a fuzzy way in filenames -regex name | `/abc` | `abc.txt` | search for the regular expression `abc` in filenames ("exact search") -regex name | `/[yz]{3}` | `fuzzy.rs` | search for the regular expression `[yz]{3}` in filenames +fuzzy name | `abc` or `nf/abc` | `abac.txt` | search for "abc" in a fuzzy way in filenames +regex name | `/abc` or `/abc/` | `abc.txt` | search for the regular expression `abc` in filenames ("exact search") +regex name | `/[yz]{3}` or `/[yz]{3}/` | `fuzzy.rs` | search for the regular expression `[yz]{3}` in filenames +regex name | `/(json|xml)$/i` | `thing.XML` | find files whose name ends in `json` or `xml`, case insensitive regex name | `/abc/i` | `aBc.txt` | search for the regular expression `abc` with flag `i` in filenames -fuzzy path | `p/abc` | `a/bac.txt` | search for "abc" in a fuzzy way in sub-paths from current tree root +fuzzy path | `p/abc` or `p/abc/` | `a/bac.txt` | search for "abc" in a fuzzy way in sub-paths from current tree root regex path | `rp/abc` | `e/abac.txt` | search for the "abc" regex in sub-paths from current tree root -content | `c/mask` | `umask = "1.0"` | search for the "mask" string in file contents +content | `c/mask` or `c/mask/` | `umask = "1.0"` | search for the "mask" string in file contents It's also possible to [redefine those mode mappings](../conf_file/#search-modes). To escape characters (for example the space, colon or slash) in the pattern, use a `\` (an antislash is `\\`). +## Combining filtering patterns + +Patterns can be combined with the `!` (not), `&` (and) and `|` (or) operators, and parentheses if necessary. + +You can for example display non `json` files containing either `isize` or `i32` with + + !/json$/&(c/isize/|c/i32/) + +### Subtleties + +The caracters you use as operators and the parenthesis can be useful in patterns too, either because you want to search for them in fuzzy patterns or in file contents, or because you write non trivial regular expressions. + +Most often you'll just type what feels natural and broot will select the interpretation which makes sense but you might be interested in a few rules: + +* parenthesis and operators in the second pattern part (parts being separated by `/`) are part of the patternC, which explains why `/(json|xml)` is interpreted as a regular expression. If you want to do a fuzzy search for a `|` in the name of your files, you'll need to have an explicit pattern mode : `nf/a|b` because `a|b` would search for files whose name contains either `a` or `b`. And to ensure an operator or closing parenthesis isn't interpreted as part of your pattern, just close it with a `/`. +* broot interprets the left operand before the right one and don't interpret the second one if it looks useless. So if you want to search your whole disk for json files containing `abcd`, it will be faster to use `/json$/&c/abcd` rather than `c/abcd/&/json$/` which would look at the file name only after having scanned the content. + ## The verb invocation The verb invocation is @@ -89,3 +109,12 @@ In this case with an escaped space: ![content search](img/20200608-content-search.png) +### A complex composite search + +Here we search for `"carg"` both in file names and file contents, and we exclude `"lock"` files: + +`!lock&(carg|c/carg/)` + +![complex composite](img/20200620-complex-composite.png) + +note: the `/` at the end of `c/carg/` is necessary to tell broot that the following parenthesis isn't part of the pattern. diff --git a/website/docs/navigation.md b/website/docs/navigation.md index e7b7940..17b3caa 100644 --- a/website/docs/navigation.md +++ b/website/docs/navigation.md @@ -48,9 +48,27 @@ For example `/pat+ern` would match `"patern.zip"` or `"some_patttern.rar"` but n If you want the regex to be case insensitive, add the `i` flag: `/pat+ern/i`. -# Other kinds of searches +# File content searches -Other types of searches are possible, see [reference](../input/#the-filtering-pattern). +To display only files containing `"memmap"`, type `c/memmap`: + +![content](../img/20200620-content-search.png) + +(as the search is displayed in real time you'll usually stop as soon as you have the right matches) + +# Composite patterns + +Simple patterns can be composed with the `!`, `&` and `|` operators. + +For example, if you don't want to see files whose name ends in `"rs"`, you may type `!/rs$` (it's the negation of the `/rs$` regular expression). + +And if you want to see all files containing `"pattern"` but not the rust ones, you'll type `!rs&c/pattern`: + +![composite](../img/20200620-composite-notrs.png) + +# More about searches + +If you want to know more about the exact pattern syntax, see [reference](../input/#the-filtering-pattern). # Total Search |