]> src.twobees.de Git - dotfiles.git/blob - stow/oh-my-zsh/.oh-my-zsh/plugins/zbell/README.md
eb87699c4d98f617b09096009c318215e4ca056b
[dotfiles.git] / stow / oh-my-zsh / .oh-my-zsh / plugins / zbell / README.md
1 # zbell plugin
2
3 This plugin prints a bell character when a command finishes if it has been
4 running for longer than a specified duration.
5
6 To use it, add `zbell` to the plugins array in your zshrc file:
7
8 ```zsh
9 plugins=(... zbell)
10 ```
11
12 ## Settings
13
14 These settings need to be set in your zshrc file, before Oh My Zsh is sourced.
15
16 - `zbell_duration`: duration in seconds after which to consider notifying
17   the end of a command. Default: 15 seconds.
18
19 - `zbell_ignore`: if there are programs that you know run long that you
20   don't want to bell after, then add them to the `zbell_ignore` array.
21   By default, `$EDITOR` and `$PAGER` are ignored:
22
23   ```zsh
24   zbell_ignore=($EDITOR $PAGER)
25   ```
26
27 - `zbell_use_notify_send`: If set to `true`, `notify-send` tool is used -- if
28   available -- to display a popup on the screen. Default: `true` (enabled).
29
30 ## Author
31
32 Adapted from an original version by [Jean-Philippe Ouellet](https://github.com/jpouellet).
33 Made available under the ISC license.