summaryrefslogtreecommitdiffstats
path: root/docs/config/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/config/README.md')
-rw-r--r--docs/config/README.md4
1 files changed, 3 insertions, 1 deletions
diff --git a/docs/config/README.md b/docs/config/README.md
index 8832230c8..67a685018 100644
--- a/docs/config/README.md
+++ b/docs/config/README.md
@@ -3024,6 +3024,7 @@ These modules will be shown if any of the following conditions are met:
- The current directory contains a directory whose name is in `directories`
- The current directory contains a file whose extension is in `extensions`
- The `when` command returns 0
+- The current Operating System (std::env::consts::OS) matchs with `os` field if defined.
::: tip
@@ -3060,7 +3061,8 @@ If you have an interesting example not covered there, feel free to share it ther
| `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. |
+| `disabled` | `false` | Disables this `custom` module. |
+| `os` | | Operating System name on which the module will be shown (unix, linux, macos, windows, ... ) [See possible values](https://doc.rust-lang.org/std/env/consts/constant.OS.html). |
### Variables