diff options
-rw-r--r-- | .gitignore | 1 | ||||
-rw-r--r-- | CHANGELOG.md | 3 | ||||
-rw-r--r-- | Cargo.lock | 2 | ||||
-rw-r--r-- | Cargo.toml | 2 | ||||
-rw-r--r-- | README.md | 30 | ||||
-rw-r--r-- | website/docs/common-problems.md | 2 | ||||
-rw-r--r-- | website/docs/conf_file.md | 2 | ||||
-rw-r--r-- | website/docs/img/2020081609-preview-binary.png | bin | 0 -> 123123 bytes | |||
-rw-r--r-- | website/docs/img/2020081609-preview-image.png | bin | 0 -> 77114 bytes | |||
-rw-r--r-- | website/docs/index.md | 21 | ||||
-rw-r--r-- | website/docs/navigation.md | 6 | ||||
-rw-r--r-- | website/docs/panels.md | 8 |
12 files changed, 44 insertions, 33 deletions
@@ -11,3 +11,4 @@ screens /website/site build trav +press diff --git a/CHANGELOG.md b/CHANGELOG.md index 4417b7b..f3ee7fa 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,4 +1,5 @@ -### next +<a name="v0.20.0"></a> +### v0.20.0 - 2020-08-16 - it's now possible to launch a terminal as sub process from broot (and be back to broot on exit) - the selected directory is now the working dir for subprocess launched from broot - images are previewed as such @@ -121,7 +121,7 @@ dependencies = [ [[package]] name = "broot" -version = "0.20.0-dev" +version = "0.20.0" dependencies = [ "ansi_colours", "bet", @@ -1,6 +1,6 @@ [package] name = "broot" -version = "0.20.0-dev" +version = "0.20.0" authors = ["dystroy <denys.seguret@gmail.com>"] repository = "https://github.com/Canop/broot" documentation = "https://dystroy.org/broot" @@ -30,21 +30,13 @@ That's what makes it usable where the old `tree` command would produce pages of `.gitignore` files are properly dealt with to put unwanted files out of your way (you can ignore them though, see [documentation](../navigation/#toggles)). -# Preview files - -Hit <kbd>ctrl</kbd><kbd>→</kbd> when a file is selected and the preview panel appears. - -![preview](website/docs/img/20200716-preview.png) - -The preview panel stays synchronized with the selection in tree panels. - # Find a directory then `cd` to it type a few letters ![cd](website/docs/img/20191112-cd.png) -Hit <kbd>alt</kbd><kbd>enter</kbd> and you're done. +Hit <kbd>alt</kbd><kbd>enter</kbd> and you're back to the terminal in the desired location. This way, you can navigate to a directory with the minimum amount of keystrokes, even if you don't exactly remember where it is. @@ -53,7 +45,8 @@ broot is fast and doesn't block (any keystroke interrupts the current search to Most useful keys for this: * the letters of what you're looking for -* <kbd>enter</kbd> to select a directory (staying in broot) +* <kbd>enter</kbd> on the root line to go up to the parent (staying in broot) +* <kbd>enter</kbd> to focus a directory (staying in broot) * <kbd>esc</kbd> to get back to the previous state or clear your search * <kbd class=b>↓</kbd> and <kbd class=b>↑</kbd> may be used to move the selection * <kbd>alt</kbd><kbd>enter</kbd> to get back to the shell having `cd` to the selected directory @@ -77,8 +70,11 @@ Once the file you want is selected you can * hit <kbd>enter</kbd> (or double-click) to open it in your system's default program * hit <kbd>alt</kbd><kbd>enter</kbd> to open it in your system's default program and close broot +* hit <kbd>ctrl</kbd><kbd>→</kbd> to preview it (and then a second time to go inside the preview) * type a verb. For example `:e` opens the file in your preferred editor (which may be a terminal one) +[blog: a broot content search workflow](https://dystroy.org/blog/broot-c-search/) + # Manipulate your files ![mv](website/docs/img/20191112-mv.png) @@ -89,7 +85,7 @@ You can instead do it without losing the view of the file hierarchy. Move, copy, rm, mkdir, are built in and you can add your own shortcuts. -# Do it with panels +# Manage files with panels When a directory is selected, do <kbd>ctrl</kbd><kbd>→</kbd> and you open another panel (you may open other ones, or navigate between them, with <kbd>ctrl</kbd><kbd>←</kbd> and <kbd>ctrl</kbd><kbd>→</kbd>). @@ -103,6 +99,16 @@ Using two panels, you can for example copy or move elements between them: If you like you may do it Norton Commander style by binding `:copy_to_panel` to <kbd>F5</kbd> and `:move_to_panel` to <kbd>F6</kbd>. +# Preview files + +Hit <kbd>ctrl</kbd><kbd>→</kbd> when a file is selected and the preview panel appears. + +![preview](website/docs/img/20200716-preview.png) + +![preview](website/docs/img/2020081609-preview-image.png) + +The preview panel stays synchronized with the selection in tree panels. + # Apply a standard or personal shortcut to a file ![size](website/docs/img/20191112-edit.png) @@ -143,5 +149,7 @@ Use `:gf` to display the statuses of files (what are the new ones, the modified And if you want to see *only* the files which would be displayed by the `git status` command, do `:gs`. From there it's easy to edit, or diff, selected files. +[blog: use broot and meld to diff before commit](https://dystroy.org/blog/gg/) + ## Further Reading See **[Broot's web site](https://dystroy.org/broot)** for instructions regarding installation and usage. diff --git a/website/docs/common-problems.md b/website/docs/common-problems.md index 209a59a..6191b45 100644 --- a/website/docs/common-problems.md +++ b/website/docs/common-problems.md @@ -11,7 +11,7 @@ But you may want to have something more similar to your usual terminal colors, o * [set a transparent background](../skins/#transparent-background) * [set file extension dependent colors](../conf_file/#colors-by-file-extension) -# There are artifacts on tmux or screen +# There are artifacts on tmux Most problems with terminal multiplexers seem related to their bad proxying of some style related codes. diff --git a/website/docs/conf_file.md b/website/docs/conf_file.md index 37cbe50..a62dc61 100644 --- a/website/docs/conf_file.md +++ b/website/docs/conf_file.md @@ -115,7 +115,7 @@ toml = "ansi(105)" Broot uses [syntect](https://github.com/trishume/syntect) for syntax coloring of previewed files. -It's possible to choose any of the standard themes listed [here](https://docs.rs/syntect/4.2.0/syntect/highlighting/struct.ThemeSet.html#impl): +It's possible to choose any of the standard themes listed [here](https://docs.rs/syntect/latest/syntect/highlighting/struct.ThemeSet.html#impl): * base16-ocean.dark * base16-eighties.dark diff --git a/website/docs/img/2020081609-preview-binary.png b/website/docs/img/2020081609-preview-binary.png Binary files differnew file mode 100644 index 0000000..ff66309 --- /dev/null +++ b/website/docs/img/2020081609-preview-binary.png diff --git a/website/docs/img/2020081609-preview-image.png b/website/docs/img/2020081609-preview-image.png Binary files differnew file mode 100644 index 0000000..a227716 --- /dev/null +++ b/website/docs/img/2020081609-preview-image.png diff --git a/website/docs/index.md b/website/docs/index.md index 54b3099..983d2d3 100644 --- a/website/docs/index.md +++ b/website/docs/index.md @@ -18,14 +18,6 @@ That's what makes it usable where the old `tree` command would produce pages of `.gitignore` files are properly dealt with to put unwanted files out of your way (you can ignore them though, see [documentation](../navigation/#toggles)). -# Preview files - -Hit <kbd>ctrl</kbd><kbd>→</kbd> when a file is selected and the preview panel appears. - -![preview](img/20200716-preview.png) - -The preview panel stays synchronized with the selection in tree panels. - # Find a directory then `cd` to it type a few letters @@ -69,6 +61,8 @@ Once the file you want is selected you can * hit <kbd>ctrl</kbd><kbd>→</kbd> to preview it (and then a second time to go inside the preview) * type a verb. For example `:e` opens the file in your preferred editor (which may be a terminal one) +[blog: a broot content search workflow](https://dystroy.org/blog/broot-c-search/) + # Manipulate your files ![mv](img/20191112-mv.png) @@ -93,6 +87,16 @@ Using two panels, you can for example copy or move elements between them: If you like you may do it Norton Commander style by binding `:copy_to_panel` to <kbd>F5</kbd> and `:move_to_panel` to <kbd>F6</kbd>. +# Preview files + +Hit <kbd>ctrl</kbd><kbd>→</kbd> when a file is selected and the preview panel appears. + +![preview](img/20200716-preview.png) + +![preview](img/2020081609-preview-image.png) + +The preview panel stays synchronized with the selection in tree panels. + # Apply a standard or personal shortcut to a file ![size](img/20191112-edit.png) @@ -133,6 +137,7 @@ Use `:gf` to display the statuses of files (what are the new ones, the modified And if you want to see *only* the files which would be displayed by the `git status` command, do `:gs`. From there it's easy to edit, or diff, selected files. +[blog: use broot and meld to diff before commit](https://dystroy.org/blog/gg/) # More... diff --git a/website/docs/navigation.md b/website/docs/navigation.md index ac5d0d2..23ec9f1 100644 --- a/website/docs/navigation.md +++ b/website/docs/navigation.md @@ -24,7 +24,7 @@ There are also a few more shortcuts: * you can select a line with a mouse click * you can open a line with a mouse double-click -and you can define your own [shortcuts](../conf_file/#shortcuts-and-verb-search) or triggering [keyboard keys](../conf_file/#keyboard-key). +and you can define your own [shortcuts](../conf_verbs/#shortcuts-and-verb-search) or triggering [keyboard keys](../conf_verbs/#keyboard-key). # Fuzzy Patterns @@ -106,10 +106,6 @@ To apply one, type a space (or `:`), then the start of its shortcut, then hit <k For example typing `:s` then enter will show file and directory sizes. -You may notice a scrollbar on this screenshot. The first level of the tree is always uncut when you display sizes (you're in a special "whale spotting" mode). - -Not trimming the root is also possible in normal mode by using the `toggle_trim_root` toggle. - !!! Note The displayed size on Unix is the space the file takes on disk, that is the number of blocks multiplied by the size of a block. If a file is sparse, a little 's' is displayed next to the size. diff --git a/website/docs/panels.md b/website/docs/panels.md index fbee183..61e8ff5 100644 --- a/website/docs/panels.md +++ b/website/docs/panels.md @@ -15,7 +15,7 @@ Another way is to add a bang (`!`) to a verb. It tells broot to show the result For example, while `:focus ~` navigates to your home directory in the current panel, you can use `:!focus ~` or `:focus! ~` to open a new panel on your home. -The `:close_panel` closes the current panel and is bound to <kbd>ctrl</kbd><kbd>W</kbd> (remember: you can [change all bindings](../conf_file/#verbs-shortcuts-and-keys)). +The `:close_panel` closes the current panel and is bound to <kbd>ctrl</kbd><kbd>W</kbd> (remember: you can [change all bindings](../conf_verbs/#keyboard-key)). # The preview panel @@ -24,11 +24,11 @@ The `:close_panel` closes the current panel and is bound to <kbd>ctrl</kbd><kbd> It's not immediately focused on creation, because most often you'll want to preview a few files and it's convenient to stay in the tree to navigate. To focus it, for example to scroll it, do <kbd>ctrl</kbd><kbd>→</kbd> again. -Files that can't be interpreted as text are shown as binary: +Files that can't be interpreted as text or image are shown as binary: -![binary](img/20200716-binary.png) +![binary](img/2020081609-preview-binary.png) -You can search with fuzzy patterns or regular expressions inside a preview panel: +You can search with fuzzy patterns or regular expressions inside a text preview panel: ![search-preview](img/20200727-search-preview.png) |