diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 31 |
1 files changed, 13 insertions, 18 deletions
@@ -33,14 +33,9 @@ Table of Contents * [Check git statuses](#check-git-statuses) * [Further Reading](#further-reading) -## Installation -Full installation documentation can be found [here](https://dystroy.org/broot/documentation/installation/). - -## Feature Showcase - ### Get an overview of a directory, even a big one - + Notice the *unlisted*? @@ -50,7 +45,7 @@ That's what makes it usable where the old `tree` command would produce pages of ### Find a directory then `cd` to it - + This way, you can navigate to a directory with the minimum amount of keystrokes, even if you don't exactly remember where it is. @@ -66,7 +61,7 @@ Most useful keys for this: ### Never lose track of file hierarchy while you search - + broot tries to select the most relevant file. You can still go from one match to another one using <kbd>tab</kbd> or arrow keys. @@ -76,7 +71,7 @@ And you have other types of searches, for example searching on file content (sta  -You may also apply logical operators or combine patterns, for example searching `test` in all files except txt ones could be `!/txt$/&c/test` and searching `carg` both in file names and file contents would be `carg|c/carg`. +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`. Once the file you want is selected you can @@ -86,7 +81,7 @@ Once the file you want is selected you can ### Manipulate your files - + Most often you move your files in the blind. You do a few `ls` before, then your manipulation, and maybe you check after. @@ -110,31 +105,31 @@ If you like you may do it Norton Commander style by binding `:copy_to_panel` to ### Apply a standard or personal shortcut to a file - + Just find the file you want to edit with a few keystrokes, type `:e`, then <kbd>enter</kbd>. -You can add verbs or configure the existing ones; see [documentation](documentation/usage.md#verbs). +You can add verbs or configure the existing ones; see [documentation](../conf_file/#verbs-shortcuts-and-keys). And you can add shorcuts, for example a <kbd>ctrl</kbd> sequence or a function key ### Replace `ls` (and its clones): -If you want to display *dates* and *permissions*, do `br -dp` which gets you this: +If you want to display *sizes*, *dates* and *permissions*, do `br -sdp` which gets you this: - + You may also toggle options with a few keystrokes while inside broot. For example hitting a space, a `d` then enter shows you the dates. Or a space, then `h` then enter and you see hidden files. ### Sort, see what takes space: -You can toggle sorts from inside broot, or start broot with `--sort-by-size` or `--sort-by-date`. +You may sort by launching broot with `--sort-by-size` or `--sort-by-date`. Or you may, inside broot, just type a space, then `sd`, and <kbd>enter</kbd> and you toggled the `:sort_by_date` mode. When sorting, the whole content of directories is taken into account. So if you want to find on monday morning the most recently modified files, just launch `br --sort-by-date ~`. If you start broot with the `--whale-spotting` option (or its shorcut `-w`), you get a mode tailored to "whale spotting" navigation, making it easy to determine what files or folders take space. - + And you keep all broot tools, like filtering or the ability to delete or open files and directories. @@ -142,11 +137,11 @@ Sizes, dates, files counts, are computed in the background, you don't have to wa ### check git statuses: - + Use `:gf` to display the statuses of files (what are the new ones, the modified ones, etc.), the current branch name and the change statistics. -And if you want to see *only* the files which would be displayed by the `git status` command, do `:gs`. +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. ## Further Reading See **[Broot's web site](https://dystroy.org/broot)** for instructions regarding installation and usage. |