diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/config/README.md | 14 |
1 files changed, 9 insertions, 5 deletions
diff --git a/docs/config/README.md b/docs/config/README.md index 772fa6b41..d86ae3391 100644 --- a/docs/config/README.md +++ b/docs/config/README.md @@ -89,16 +89,18 @@ discharging_symbol = "💀" The `character` module shows a character (usually an arrow) beside where the text is entered in your terminal. -The character will be green if the status of your -last command had a successful status code (zero), and will be red if the last -command had an unsuccessful status code (non-zero). +The character will tell you whether the last command was successful or not. It +can do this in two ways: by changing color (red/green) or by changing its shape +(➜/✖). The latter will only be done if `use_symbol_for_status` is set to `true`. ### Options | Variable | Default | Description | | ---------- | ------- | ---------------------------------------------------- | -| `symbol` | `"➜"` | The symbol used before the text input in the prompt. | -| `disabled` | `false` | Disables the `character` module. | +| `symbol` | `"➜"` | The symbol used before the text input in the prompt. | +| `error_symbol` | `"✖"` | The symbol used before text input if the previous command failed. | +| `use_symbol_for_status` | `false` | Indicate error status by changing the symbol. | +| `disabled` | `false` | Disables the `character` module. | ### Example @@ -107,6 +109,8 @@ command had an unsuccessful status code (non-zero). [character] symbol = "❯" +error_symbol = "✗" +use_symbol_for_status = true ``` ## Command Duration |