diff options
-rw-r--r-- | README.md | 6 | ||||
-rw-r--r-- | client-server.md | 4 | ||||
-rw-r--r-- | documentation.md | 2 | ||||
-rw-r--r-- | website/docs/common-problems.md | 6 | ||||
-rw-r--r-- | website/docs/community.md | 6 | ||||
-rw-r--r-- | website/docs/conf_file.md | 6 | ||||
-rw-r--r-- | website/docs/conf_verbs.md | 12 | ||||
-rw-r--r-- | website/docs/index.md | 6 | ||||
-rw-r--r-- | website/docs/input.md | 4 | ||||
-rw-r--r-- | website/docs/install.md | 2 | ||||
-rw-r--r-- | website/docs/launch.md | 8 | ||||
-rw-r--r-- | website/docs/navigation.md | 8 | ||||
-rw-r--r-- | website/docs/panels.md | 4 | ||||
-rw-r--r-- | website/docs/skins.md | 4 | ||||
-rw-r--r-- | website/docs/tricks.md | 2 | ||||
-rw-r--r-- | website/docs/verbs.md | 4 |
16 files changed, 42 insertions, 42 deletions
@@ -126,7 +126,7 @@ Just find the file you want to edit with a few keystrokes, type `:e`, then <kbd> 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 +And you can add shortcuts, for example a <kbd>ctrl</kbd> sequence or a function key # Replace `ls` (and its clones): @@ -140,9 +140,9 @@ You may also toggle options with a few keystrokes while inside broot. For exampl You may sort by launching broot with `--sort-by-size` or `--sort-by-date`. Or you may, inside broot, 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, launch `br --sort-by-date ~`. +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, 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. +If you start broot with the `--whale-spotting` option (or its shortcut `-w`), you get a mode tailored to "whale spotting" navigation, making it easy to determine what files or folders take space. ![size](website/docs/img/20200704-whale-spotting.png) diff --git a/client-server.md b/client-server.md index 55048ca..28798e5 100644 --- a/client-server.md +++ b/client-server.md @@ -44,7 +44,7 @@ If you don't pass the `--cmd` (shortened in `-c`) argument, then the server is t This feature started here: https://github.com/Canop/broot/issues/225 -and is being discussed and developped between @Canop (@dystroy on Miaou) and @SRGOM (@fiAtcBr on Miaou) and you're welcome to contribute on [Miaou](https://miaou.dystroy.org/3490). +and is being discussed and developed between @Canop (@dystroy on Miaou) and @SRGOM (@fiAtcBr on Miaou) and you're welcome to contribute on [Miaou](https://miaou.dystroy.org/3490). # Possible use cases (for users to utilize this). @@ -58,6 +58,6 @@ You can start an instance of broot with `broot --listen global_file_viewer` and - [ ] implement a command "GetRoot" to - [ ] have convincing use cases implemented - [ ] make available with TCP localhost sockets on windows ? -- [ ] stop hiding behing a compilation flag +- [ ] stop hiding behind a compilation flag diff --git a/documentation.md b/documentation.md index a673074..4257737 100644 --- a/documentation.md +++ b/documentation.md @@ -1,3 +1,3 @@ -Broot Docmumentation was too big to fit here and moved to [https://dystroy.org/broot](https://dystroy.org/broot). +Broot Documentation was too big to fit here and moved to [https://dystroy.org/broot](https://dystroy.org/broot). diff --git a/website/docs/common-problems.md b/website/docs/common-problems.md index c1bc800..209a59a 100644 --- a/website/docs/common-problems.md +++ b/website/docs/common-problems.md @@ -4,7 +4,7 @@ Please come to [miaou](https://miaou.dystroy.org/3490?broot) if something isn't # Those aren't my colors -Broot's initial colors ensure that everything is readable whathever your settings. +Broot's initial colors ensure that everything is readable whatever your settings. But you may want to have something more similar to your usual terminal colors, or maybe to define the whole skin. * [changing the skin](../skins/) @@ -21,9 +21,9 @@ A workaround is to create a skin (for example by uncommenting the one in `conf.t # alt-enter (or other shortcut) isn't available -Most terminals intercept a few keybaord shorctut for their own features. +Most terminals intercept a few keyboard shortcut for their own features. -If a shorcut isn't available for broot and you can't or don't want to remap the one of your terminal, the solution is to change the shortcut in broot. +If a shortcut isn't available for broot and you can't or don't want to remap the one of your terminal, the solution is to change the shortcut in broot. * [specific solution for alt-enter](https://github.com/Canop/broot/issues/86#issuecomment-635974557) * [general shortcut configuration](../conf_verbs/#keyboard-key) diff --git a/website/docs/community.md b/website/docs/community.md index 3fc1a94..f47e227 100644 --- a/website/docs/community.md +++ b/website/docs/community.md @@ -1,5 +1,5 @@ -**broot** is developped by [Denys Séguret](https://twitter.com/DenysSeguret), also known as [Canop](https://github.com/Canop) or [dystroy](https://dystroy.org). +**broot** is developed by [Denys Séguret](https://twitter.com/DenysSeguret), also known as [Canop](https://github.com/Canop) or [dystroy](https://dystroy.org). ## Discuss Broot in a chat room @@ -32,7 +32,7 @@ When something looks like a bug, especially keyboard problems, we need both to k To get a precise idea of the time taken by operations in real broot use, it's often a good idea to run them with `--cmd`. -For example full text search performances can be mesured (and compared to other tools) with +For example full text search performances can be measured (and compared to other tools) with ``` time broot -c "c/memmap;:pt" ~/code @@ -42,7 +42,7 @@ time broot -c "c/memmap;:pt" ~/code **Broot** is written in [Rust](https://www.rust-lang.org/). The current focus is linux+mac but we try to support windows too (use PowerShell instead of the old cmd). -Before starting working on a Pull Request, please join the Miaou room to coordinate the developement. There are frequently several feature branchs waiting to be merged and adding some wild ones may make the process painful. +Before starting working on a Pull Request, please join the Miaou room to coordinate the development. There are frequently several feature branches waiting to be merged and adding some wild ones may make the process painful. A PR must be also be *focused*. Don't touch other code and don't refactor or reformat without discussion. diff --git a/website/docs/conf_file.md b/website/docs/conf_file.md index 010a768..37cbe50 100644 --- a/website/docs/conf_file.md +++ b/website/docs/conf_file.md @@ -5,7 +5,7 @@ The configuration file is called `conf.toml` and is in [TOML](https://github.com This file's location follows the XDG convention, which depends on your system settings. This location in your case can be found on the help screen (use <kbd>?</kbd>). -From this screen you can directly open the configuration file in your system's editor by typing `:os` (shorcut for `:open_stay`). +From this screen you can directly open the configuration file in your system's editor by typing `:os` (shortcut for `:open_stay`). Currently, you can configure @@ -28,7 +28,7 @@ If you almost always want those flags, you may define them as default in the `co default_flags = "gh" -Those flags can still be overriden at launch with the negating ones. For example if you don't want to see hidden files at a specific launch, do +Those flags can still be overridden at launch with the negating ones. For example if you don't want to see hidden files at a specific launch, do br -H @@ -90,7 +90,7 @@ The default value is ```toml cols_order = "gscpdbn" ``` -If you prefer to have the branchs left of the tree (as was the default in broot prior 0.18.1) you can use +If you prefer to have the branches left of the tree (as was the default in broot prior 0.18.1) you can use ```toml cols_order = "gbpdscn" diff --git a/website/docs/conf_verbs.md b/website/docs/conf_verbs.md index 1b4fbc8..a4b94e9 100644 --- a/website/docs/conf_verbs.md +++ b/website/docs/conf_verbs.md @@ -21,10 +21,10 @@ name | mandatory | role -|-|- invocation | no | how the verb is called by the user, with placeholders for arguments execution | yes | how the verb is executed -key | no | a keyboard key triggerring execution -shorcut | no | an alternate way to call the verb (without the arguments part) +key | no | a keyboard key triggering execution +shortcut | no | an alternate way to call the verb (without the arguments part) leave_broot | no | whether to quit broot on execution (default: `true`) -from_shell | no | whether the verb must be executed from the parent shell (needs `br`, default: `false`). As this is executed after broot closed, this isn't compatiple with `leave_broot = false` +from_shell | no | whether the verb must be executed from the parent shell (needs `br`, default: `false`). As this is executed after broot closed, this isn't compatible with `leave_broot = false` apply_to | no | the type of selection this verb applies to, may be `"file"`, `"directory"` or `"any"`. You may declare two verbs with the same key if the first one applies to only files or only directories !!! Note @@ -34,7 +34,7 @@ apply_to | no | the type of selection this verb applies to, may be `"file"`, `"d **broot** looks for the first token following a space or `:` and tries to find the verb you want. -* If what you typed is exactly the shorcut or name of a verb, then this verb is selected: broot explains you what it would do if you were to type `enter` +* If what you typed is exactly the shortcut or name of a verb, then this verb is selected: broot explains you what it would do if you were to type `enter` * If there's exactly one verb whose name or shortcut starts with the characters you typed, then it's selected * if there are several verbs whose name or shortcut start with the characters you typed, then broot waits for more * if no verb has a name or shortcut starting with those characters, broot tells you there's a problem @@ -224,7 +224,7 @@ invocation | default key | default shortcut | behavior / details :toggle_counts | - | - | toggle display of total counts of files per directory :toggle_dates | - | - | toggle display of last modified dates (looking for the most recently changed file, even deep) :toggle_files | - | - | toggle showing files (or just folders) -:toggle_git_ignore | - | - | toggle git hignore handling (auto, no or yes) +:toggle_git_ignore | - | - | toggle git ignore handling (auto, no or yes) :toggle_git_file_info | - | - | toggle display of git file information :toggle_git_status | - | - | toggle showing only the file which would show up on `git status` :toggle_hidden | - | - | toggle display of hidden files (the ones whose name starts with a dot on linux) @@ -241,7 +241,7 @@ Note that ## Input related verbs -Some internal actions can be bound to a key shortcut but can't be called explicitely because they directly act on the input field: +Some internal actions can be bound to a key shortcut but can't be called explicitly because they directly act on the input field: name | default binding | behavior -|-|- diff --git a/website/docs/index.md b/website/docs/index.md index 5667369..d0c39af 100644 --- a/website/docs/index.md +++ b/website/docs/index.md @@ -100,7 +100,7 @@ Just find the file you want to edit with a few keystrokes, type `:e`, then <kbd> 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 +And you can add shortcuts, for example a <kbd>ctrl</kbd> sequence or a function key # Replace `ls` (and its clones): @@ -114,9 +114,9 @@ You may also toggle options with a few keystrokes while inside broot. For exampl You may sort by launching broot with `--sort-by-size` or `--sort-by-date`. Or you may, inside broot, 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, launch `br --sort-by-date ~`. +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, 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. +If you start broot with the `--whale-spotting` option (or its shortcut `-w`), you get a mode tailored to "whale spotting" navigation, making it easy to determine what files or folders take space. ![size](img/20200704-whale-spotting.png) diff --git a/website/docs/input.md b/website/docs/input.md index ec97ab6..ca67b3c 100644 --- a/website/docs/input.md +++ b/website/docs/input.md @@ -46,7 +46,7 @@ You can for example display non `json` files containing either `isize` or `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. +The characters 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: @@ -65,7 +65,7 @@ or where arguments can be empty, depending on the verb's behaviour and invocation pattern. -Verbs are detailled in the [Verbs & Commands](verbs.md) chapter. +Verbs are detailed in the [Verbs & Commands](verbs.md) chapter. ## Examples diff --git a/website/docs/install.md b/website/docs/install.md index 5a7bc93..8226496 100644 --- a/website/docs/install.md +++ b/website/docs/install.md @@ -4,7 +4,7 @@ The current version of broot works on linux, mac and windows (win 10+). !!! Note **Windows users:** broot may need additional rights at first use in order to write its configuration file. Some users on Windows also report problems with the colon. Remember that a space can be used instead of a colon. - You should also use the new Powershell terminal and not the old cmd.exe which isn't supported. + You should also use the new PowerShell terminal and not the old cmd.exe which isn't supported. !!! Note If you use cargo and there's a compilation error, it usually means you have an old version of the compiler, and you should update it (for example with `rustup update`). diff --git a/website/docs/launch.md b/website/docs/launch.md index 363392d..fbc8efd 100644 --- a/website/docs/launch.md +++ b/website/docs/launch.md @@ -15,11 +15,11 @@ You can pass as argument the path you want to see, for example br ~ -Broot renders on `stderr` and can be ran in a subshell, which means you can also (on unix) do things like +Broot renders on `stderr` and can be ran in a subshell, which means you can also (on Unix) do things like my_unix_command "$(broot some_dir)" -and quit broot with `:pp` on the selected path. But most often you'll more conveniently simply add your command (and maybe a shorcut) to the [config file](../conf_file/#verbs-shortcuts-and-keys). +and quit broot with `:pp` on the selected path. But most often you'll more conveniently simply add your command (and maybe a shortcut) to the [config file](../conf_file/#verbs-shortcuts-and-keys). # Launch Arguments @@ -42,7 +42,7 @@ The trick to enable broot to `cd` your shell when you do `alt-enter` is the foll * **br** is a shell function. It creates a temp file whose path it gives as argument to **broot** using `--outcmd` * when you do `alt-enter`, **broot** writes `cd your-selected-path` in this file, then quits -* **br** reads the file, deletes it, then evals the command +* **br** reads the file, deletes it, then evaluates the command Most users have no reason to use `--outcmd` on their own, but it can still be used to write an alternative to **br** or to port it to shells which aren't currently supported. @@ -50,7 +50,7 @@ Most users have no reason to use `--outcmd` on their own, but it can still be us If you provide a path to broot with `--out`, then a few commands won't execute anything directly but will instead write the relevant path as a line in the given file. -This may be used by shell functions or other programs calling broot, in a similar way to `--outcmd`, for example in conjonction with ̀ --cmd`. +This may be used by shell functions or other programs calling broot, in a similar way to `--outcmd`, for example in conjunction with ̀ --cmd`. <a name=cmd></a> ## the `--cmd` launch argument diff --git a/website/docs/navigation.md b/website/docs/navigation.md index a71a844..ac5d0d2 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 [shorcuts](../conf_file/#shortcuts-and-verb-search) or triggering [keyboard keys](../conf_file/#keyboard-key). +and you can define your own [shortcuts](../conf_file/#shortcuts-and-verb-search) or triggering [keyboard keys](../conf_file/#keyboard-key). # Fuzzy Patterns @@ -42,7 +42,7 @@ Hitting <kbd>esc</kbd> clears the current pattern. # Regular Expressions -If there's a `/` before or after the patten, it's interpreted as a regular expression. +If there's a `/` before or after the pattern, it's interpreted as a regular expression. For example `/pat+ern` would match `"patern.zip"` or `"some_patttern.rar"` but not `"pATTern"`. @@ -98,7 +98,7 @@ This behavior is tuned with several toggles. | toggle_git_file_info | gf | toggle display of git file information | toggle_git_ignore | gi | toggle use of .gitignore | toggle_hidden | h | toggle showing hidden files - | toggle_perm | perm | toggle showing file permissions (unix only) + | toggle_perm | perm | toggle showing file permissions (Unix only) | toggle_sizes | sizes | toggle showing sizes | toggle_trim_root | t | toggle removing nodes at first level too (default) @@ -111,7 +111,7 @@ You may notice a scrollbar on this screenshot. The first level of the tree is al 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. + 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. Those toggles may also be defined with [launch options](../launch) and the [default_flags preference](../conf_file/#default-flags). diff --git a/website/docs/panels.md b/website/docs/panels.md index 9a84a70..6b174e4 100644 --- a/website/docs/panels.md +++ b/website/docs/panels.md @@ -9,7 +9,7 @@ When there's no panel in that direction, a new one is created: * if the current selection is a regular file and you've hit <kbd>ctrl</kbd><kbd>→</kbd>, you get the preview panel * in other cases you get a new tree whose root is the selected line. -This makes those shorcuts the easiest way to create a panel. +This makes those shortcuts the easiest way to create a panel. Another way is to add a bang (`!`) to a verb. It tells broot to show the result in a new panel. @@ -21,7 +21,7 @@ The `:close_panel` closes the current panel and is bound to <kbd>ctrl</kbd><kbd> ![preview](img/20200716-preview.png) -It's not immediately focused on creation, because most often you'll want to preview a few files and it's conveninient to stay in the tree to navigate. +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: diff --git a/website/docs/skins.md b/website/docs/skins.md index a50e8cb..9a2f7a3 100644 --- a/website/docs/skins.md +++ b/website/docs/skins.md @@ -94,7 +94,7 @@ Each skin entry value is made of * a background color (or `none`) * zero, one, or more *attributes* -This tree parts can be repeatedi, after a `/`, to define the style to use in non focused panels (when more than one panel is used). +This tree parts can be repeated, after a `/`, to define the style to use in non focused panels (when more than one panel is used). Example: @@ -120,7 +120,7 @@ Currently supported attributes are: * reverse * underlined -Note that some of them may be ignored by your terminal especially if you're not on a unix system. +Note that some of them may be ignored by your terminal especially if you're not on a Unix system. The mapping between keys and screen parts may not always be obvious. Don't hesitate to come ask for help on [Miaou](https://miaou.dystroy.org/3490?broot). diff --git a/website/docs/tricks.md b/website/docs/tricks.md index 2dcf798..cc61263 100644 --- a/website/docs/tricks.md +++ b/website/docs/tricks.md @@ -71,7 +71,7 @@ Then just hitting the `esc` key will show you the normal unfiltered broot view. (note: this isn't equivalent to `git status`. Most notably, removed files aren't displayed) -From there you may use the `:gd` verb (`:git_diff`) to open the selection into your favourite dif viewer. +From there you may use the `:gd` verb (`:git_diff`) to open the selection into your favourite diff viewer. If you want more: [Use broot and meld to diff before commit](https://dystroy.org/blog/gg/). diff --git a/website/docs/verbs.md b/website/docs/verbs.md index 559787e..35cf63a 100644 --- a/website/docs/verbs.md +++ b/website/docs/verbs.md @@ -1,5 +1,5 @@ -When you used a toggle, you executed a command in it simplest form: without argument and independant from the current selection. +When you used a toggle, you executed a command in it simplest form: without argument and independent from the current selection. The simplest verbs are just executed by typing a space (or `:`), then its first letters, then enter. @@ -86,7 +86,7 @@ Note: there's another solution to gain time when typing a path, especially when There are two types of verbs, differing by their *execution* pattern (which will be covered in more details in the [configuration page](../conf_file/#verb-definition-attributes)): -* buitin features, whose execution starts with `:`, apply internal functions, for example `:toggle_perm` to trigger computation and display of unix file permissions +* builtin features, whose execution starts with `:`, apply internal functions, for example `:toggle_perm` to trigger computation and display of Unix file permissions * external commands, whose execution implies calling an external program, for example `rm -rf {file}` A command may leave broot (for example to start a program), or not (the tree will be refreshed). |