diff options
| author | John Letey <30328854+johnletey@users.noreply.github.com> | 2019-08-12 18:42:33 +0100 |
|---|---|---|
| committer | Matan Kushner <hello@matchai.me> | 2019-08-12 13:42:33 -0400 |
| commit | 82cf484cedd0e989b39af760d6cc83b500454610 (patch) | |
| tree | 7b76247043084608c947933ea0e7f1704a1a6b7d /docs | |
| parent | 3f6fe50adb98ded2c7f90a581d2b8e1e88cde7e2 (diff) | |
feat: Implement the prompt module for jobs (#85)
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/config/README.md | 23 |
1 files changed, 23 insertions, 0 deletions
diff --git a/docs/config/README.md b/docs/config/README.md index 004fe9521..8177cec59 100644 --- a/docs/config/README.md +++ b/docs/config/README.md @@ -250,6 +250,29 @@ The module will be shown if any of the following conditions are met: symbol = "🏎💨 " ``` +## Jobs + +The `jobs` module shows the current number of jobs running. +The module will be shown only if there are background jobs running. +The module will show the number of jobs running if there is more than 1 job, or +more than the `threshold` config value, if it exists. + +### Options + +| Variable | Default | Description | +| ----------- | ------- | -------------------------------- | +| `threshold` | `1` | Show number of jobs if execeded. | +| `disabled` | `false` | Disables the `jobs` module. | + +### Example + +```toml +# ~/.config/starship.toml + +[jobs] +threshold = 4 +``` + ## Line Break The `line_break` module separates the prompt into two lines. |