summaryrefslogtreecommitdiffstats
path: root/website
diff options
context:
space:
mode:
authorCanop <cano.petrole@gmail.com>2021-12-22 09:42:07 +0100
committerCanop <cano.petrole@gmail.com>2021-12-22 09:42:07 +0100
commitf7520dc392fa3a38bac94e491c6fd1321266f971 (patch)
tree2bf47ecad1d9c453fad07afb642cc419fcd9f712 /website
parent5bf8703c14062d5a2134f57634248e49f4aff63f (diff)
alt-i and alt-h now toggle showing gitignored and hidden files
Diffstat (limited to 'website')
-rw-r--r--website/docs/index.md8
-rw-r--r--website/docs/navigation.md24
2 files changed, 19 insertions, 13 deletions
diff --git a/website/docs/index.md b/website/docs/index.md
index 54680a3..3a66ca0 100644
--- a/website/docs/index.md
+++ b/website/docs/index.md
@@ -15,7 +15,11 @@ Notice the *unlisted*?
That's what makes it usable where the old `tree` command would produce pages of output.
-`.gitignore` files are properly dealt with to put unwanted files out of your way (you can ignore them though, see [documentation](../navigation/#toggles)).
+`.gitignore` files are properly dealt with to put unwanted files out of your way.
+
+As you sometimes want to see gitignored files, or hidden ones, you'll soon get used to the <kbd>alt</kbd><kbd>i</kbd> and <kbd>alt</kbd><kbd>h</kbd> shortcuts to toggle those visibilities.
+
+(you can ignore them though, see [documentation](../navigation/#toggles)).
# Find a directory then `cd` to it
@@ -37,6 +41,8 @@ Most useful keys for this:
* <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
+* <kbd>alt</kbd><kbd>h</kbd> to toggle showing hidden files (the ones whose name starts with a dot)
+* <kbd>alt</kbd><kbd>i</kbd> to toggle showing gitignored files
* `:q` if you just want to quit (you can use <kbd>ctrl</kbd><kbd>q</kbd> if you prefer)
# Never lose track of file hierarchy while you search
diff --git a/website/docs/navigation.md b/website/docs/navigation.md
index c4150e9..3f15002 100644
--- a/website/docs/navigation.md
+++ b/website/docs/navigation.md
@@ -90,17 +90,17 @@ Initially, broot doesn't show files whose name starts with a dot, or files decla
This behavior is tuned with several toggles.
- | name | shortcut | description
- |----------------------|----------|----------------------------------------------------
- | toggle_counts | counts | toggle showing deep counts of files in directories
- | toggle_dates | dates | toggle showing last modified dates (deep computed)
- | toggle_files | files | toggle showing files (or just folders)
- | 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_sizes | sizes | toggle showing sizes
- | toggle_trim_root | t | toggle removing nodes at first level too (default)
+ | name | shortcut | key |description
+ |----------------------|----------|-------|----------------------------------------------
+ | toggle_counts | counts | | toggle showing deep counts of files in directories
+ | toggle_dates | dates | | toggle showing last modified dates (deep computed)
+ | toggle_files | files | | toggle showing files (or just folders)
+ | toggle_git_file_info | gf | | toggle display of git file information
+ | toggle_git_ignore | gi | <kbd>alt</kbd><kbd>i</kbd> | toggle use of .gitignore
+ | toggle_hidden | h | <kbd>alt</kbd><kbd>h</kbd> | toggle showing hidden files
+ | 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
To apply one, type a space (or `:`), then the start of its shortcut, then hit <kbd class=b>⏎</kbd>.
@@ -109,7 +109,7 @@ For example typing `:s` then enter will show file and directory sizes.
!!! 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.
-Those toggles may also be defined with [launch options](../launch) and the [default_flags preference](../conf_file/#default-flags).
+Those toggles may also be defined with [launch options](../launch) and the [default_flags preference](../conf_file/#default-flags). And you can see them in the application with <kbd>?</kbd>.
# Quitting broot