diff options
| author | David Knaack <davidkna@users.noreply.github.com> | 2021-01-20 19:01:49 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-01-20 19:01:49 +0100 |
| commit | 8302a3ccb4f83ecea0cad834c05c9e6f003f128a (patch) | |
| tree | ce092e7e66199e6dd89547b89fd77c87f62f4ee9 /docs | |
| parent | bb160d92079fb8f2f9f301159a54db0741aec41d (diff) | |
perf(custom): evaluate command lazily (#2173)
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/config/README.md | 24 |
1 files changed, 12 insertions, 12 deletions
diff --git a/docs/config/README.md b/docs/config/README.md index 97c3095ae..7cd9dcf86 100644 --- a/docs/config/README.md +++ b/docs/config/README.md @@ -2559,18 +2559,18 @@ If you have an interesting example not covered there, feel free to share it ther ### Options | Option | Default | Description | -| ------------- | ----------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -| `command` | | The command whose output should be printed. The command will be passed on stdin to the shell. | -| `when` | | A shell command used as a condition to show the module. The module will be shown if the command returns a `0` status code. | -| `shell` | | [See below](#custom-command-shell) | -| `description` | `"<custom module>"` | The description of the module that is shown when running `starship explain`. | -| `files` | `[]` | The files that will be searched in the working directory for a match. | -| `directories` | `[]` | The directories that will be searched in the working directory for a match. | -| `extensions` | `[]` | The extensions that will be searched in the working directory for a match. | -| `symbol` | `""` | The symbol used before displaying the command output. | -| `style` | `"bold green"` | The style for the module. | -| `format` | `"[$symbol$output]($style) "` | The format for the module. | -| `disabled` | `false` | Disables this `custom` module. | +| ------------- | ------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | +| `command` | | The command whose output should be printed. The command will be passed on stdin to the shell. | +| `when` | | A shell command used as a condition to show the module. The module will be shown if the command returns a `0` status code. | +| `shell` | | [See below](#custom-command-shell) | +| `description` | `"<custom module>"` | The description of the module that is shown when running `starship explain`. | +| `files` | `[]` | The files that will be searched in the working directory for a match. | +| `directories` | `[]` | The directories that will be searched in the working directory for a match. | +| `extensions` | `[]` | The extensions that will be searched in the working directory for a match. | +| `symbol` | `""` | The symbol used before displaying the command output. | +| `style` | `"bold green"` | The style for the module. | +| `format` | `"[$symbol($output )]($style)"` | The format for the module. | +| `disabled` | `false` | Disables this `custom` module. | ### Variables |