Cornelicorn/oh-my-zsh
1
0
Fork 0
mirror of https://github.com/robbyrussell/oh-my-zsh.git synced 2025-12-06 07:20:40 +01:00
Code Issues Releases Wiki Activity

Move COMPLETION_WAITING_DOTS setting and document non-default sequence setting

Marc Cornellà
2021-09-22 11:37:17 +02:00
parent 0726b70d30
commit 7b490e3385
1 changed files with 21 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

35
Settings.md

@@ -17,6 +17,7 @@
- [Completion settings](#completion-settings) - [Completion settings](#completion-settings)
- [`ZSH_COMPDUMP`](#zsh_compdump) - [`ZSH_COMPDUMP`](#zsh_compdump)
- [`ZSH_DISABLE_COMPFIX`](#zsh_disable_compfix) - [`ZSH_DISABLE_COMPFIX`](#zsh_disable_compfix)
- [`COMPLETION_WAITING_DOTS`](#completion_waiting_dots)
- [Automatic title](#automatic-title) - [Automatic title](#automatic-title)
- [`DISABLE_AUTO_TITLE`](#disable_auto_title) - [`DISABLE_AUTO_TITLE`](#disable_auto_title)
- [`ZSH_THEME_TERM_TITLE_IDLE`](#zsh_theme_term_title_idle) - [`ZSH_THEME_TERM_TITLE_IDLE`](#zsh_theme_term_title_idle)
@@ -27,7 +28,6 @@
- [`DISABLE_MAGIC_FUNCTIONS`](#disable_magic_functions) - [`DISABLE_MAGIC_FUNCTIONS`](#disable_magic_functions)
- [`DISABLE_LS_COLORS`](#disable_ls_colors) - [`DISABLE_LS_COLORS`](#disable_ls_colors)
- [`ENABLE_CORRECTION`](#enable_correction) - [`ENABLE_CORRECTION`](#enable_correction)
- [`COMPLETION_WAITING_DOTS`](#completion_waiting_dots)
- [`DISABLE_UNTRACKED_FILES_DIRTY`](#disable_untracked_files_dirty) - [`DISABLE_UNTRACKED_FILES_DIRTY`](#disable_untracked_files_dirty)
- [`HIST_STAMPS`](#hist_stamps) - [`HIST_STAMPS`](#hist_stamps)
- [Random theme](#random-theme) - [Random theme](#random-theme)
@@ -165,6 +165,26 @@ you can safely ignore it as long as you control the `john` user, which has write
ZSH_DISABLE_COMPFIX=true ZSH_DISABLE_COMPFIX=true
``` ```
### `COMPLETION_WAITING_DOTS`
If you enable this setting, Oh My Zsh will print a red ellipsis to indicate that
Zsh is still processing a completion request, and will disappear when the
completion finishes. This is useful for example when completing a command that
requires a lot of processing before offering completion entries.
```zsh
COMPLETION_WAITING_DOTS=true
```
You can also set it to a string other than `false` so that it is shown instead of
the default red ellipsis. For example:
```zsh
COMPLETION_WAITING_DOTS="%F{yellow}waiting...%f"
```
**NOTE: this setting has been found to cause issues with [multiline prompt themes](https://github.com/ohmyzsh/ohmyzsh/issues/5765) ([zsh 5.7.1 and newer seem to work](https://github.com/ohmyzsh/ohmyzsh/issues/5765#issuecomment-569432346)).**
## Automatic title ## Automatic title
### `DISABLE_AUTO_TITLE` ### `DISABLE_AUTO_TITLE`
@@ -264,19 +284,6 @@ commands will be prevented to have filename correction: `cp`, `ebuild`, `gist`,
ENABLE_CORRECTION=true ENABLE_CORRECTION=true
``` ```
### `COMPLETION_WAITING_DOTS`
If you enable this setting, Oh My Zsh will print a red ellipsis to indicate that
Zsh is still processing a completion request, and will disappear when the
completion finishes. This is useful for example when completing a command that
requires a lot of processing before offering completion entries.
```zsh
COMPLETION_WAITING_DOTS=true
```
NOTE: this setting has been found to cause issues with [multiline prompt themes](https://github.com/ohmyzsh/ohmyzsh/issues/5765) ([zsh 5.7.1 and newer seem to work](https://github.com/ohmyzsh/ohmyzsh/issues/5765#issuecomment-569432346)).
### `DISABLE_UNTRACKED_FILES_DIRTY` ### `DISABLE_UNTRACKED_FILES_DIRTY`
Use this setting if you want to disable marking untracked files under VCS as dirty. Use this setting if you want to disable marking untracked files under VCS as dirty.