diff options
author | Canop <cano.petrole@gmail.com> | 2019-01-28 20:50:54 +0100 |
---|---|---|
committer | Canop <cano.petrole@gmail.com> | 2019-01-28 20:50:54 +0100 |
commit | 89fe29ef75f9d4668337275866e1306fe6009e49 (patch) | |
tree | 51c970380eb7a858fb5ea43cb45d6702cac24999 /README.md | |
parent | 281d4940cf43819a298b898996aca3d870951c6d (diff) |
updated documentation
- mention regexes
- updated screenshots with flags
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 27 |
1 files changed, 17 insertions, 10 deletions
@@ -8,7 +8,7 @@ An interactive tree view, a fuzzy search, a balanced BFS descent and customizabl ### Get an overview of a directory, even a big one: -![overview](img/20181215-overview.png) +![overview](img/20190128-overview.png) Notice the "unlisted" ? That's what makes it usable where the old `tree` command would produce pages of output. @@ -16,13 +16,12 @@ Notice the "unlisted" ? That's what makes it usable where the old `tree` command ### Find a directory then `cd` to it: -![cd](img/20181218-cd.png) +![cd](img/20190128-cd.png) You can this way navigate to a directory with the minimum amount of keystrokes, even if you don't exactly remember where it is. broot is fast and never blocks, even when you make it search a big slow disk (any keystroke interrupts the current search to start the following one). - Most useful keys for this: * the letters of what you're looking for @@ -31,21 +30,29 @@ Most useful keys for this: * `:c` to get back to the shell having cd to the selected directory ([see below](#use-broot-for-navigation)) * `:q` if you just want to quit (`<esc>` works too) -### See what takes space: +### Never lose track of file hierarchy while you fuzzy search: -![size](img/20181215-only-folders-with-size.png) +![size](img/20190128-search.png) -To toggle size display, you usually hit `:s`. Sizes are computed in the background, you don't have to wait for them when you navigate. +broot tries to select the most relevant file. You can still go from one match to another one using `<tab>` or arrow keys. -### Never lose track of file hierarchy while you fuzzy search: +You may also search with a regular expression. To do this, add a `/` before or after the pattern. -![size](img/20181215-search.png) +Complex regular expression are possible, but you'll probably most often use a regex to do an "exact" search, or search an expression at the start or end of the filename. -broot tries to select the most relevant file. You can still go from one match to another one using `<tab>` or arrow keys. +For example, assuming you look for your one file whose name contains `"abc"` in a big directory, you may not see it immediately because of many fuzzy matches. In that case, just add a slash at the end to change you fuzzy search into an exact expression: `abc/`. + +And if you look for a filename *ending* in `"abc"` then you may anchor the regex: `abc$/`. + +### See what takes space: + +![size](img/20190128-only-folders-with-size.png) + +To toggle size display, you usually hit `:s`. Sizes are computed in the background, you don't have to wait for them when you navigate. ### Apply a personal shorcut to a file: -![size](img/20181215-edit.png) +![size](img/20190128-edit.png) Just find the file you want to edit with a few keystrokes, type `:e`, then `<enter>` (you should define your prefered editor, see [documentation](documentation.md#verbs)). |