docs: context for SHLVL in pwsh

resolves #5069
This commit is contained in:
Jan De Dobbeleer 2024-06-22 16:07:38 +02:00
parent 170e5ac9e5
commit cbf8a31e72
No known key found for this signature in database
GPG key ID: D9FE64756B9A61E6

View file

@ -17,22 +17,22 @@ These properties can be used anywhere, in any segment. If a segment contains a p
the segment property value will be used instead. In case you want to use the global property, you can prefix the segment property value will be used instead. In case you want to use the global property, you can prefix
it with `.$` to reference it directly. it with `.$` to reference it directly.
| Name | Type | Description | | Name | Type | Description |
| --------------- | --------- | ----------------------------------------------------------------- | | --------------- | --------- | ------------------------------------------------------------------- |
| `.Root` | `boolean` | is the current user root/admin or not | | `.Root` | `boolean` | is the current user root/admin or not |
| `.PWD` | `string` | the current working directory (`~` for `$HOME`) | | `.PWD` | `string` | the current working directory (`~` for `$HOME`) |
| `.AbsolutePWD` | `string` | the current working directory (unaltered) | | `.AbsolutePWD` | `string` | the current working directory (unaltered) |
| `.Folder` | `string` | the current working folder | | `.Folder` | `string` | the current working folder |
| `.Shell` | `string` | the current shell name | | `.Shell` | `string` | the current shell name |
| `.ShellVersion` | `string` | the current shell version | | `.ShellVersion` | `string` | the current shell version |
| `.SHLVL` | `int` | the current shell level | | `.SHLVL` | `int` | the current shell level (not supported in [powershell][pwsh-shlvl]) |
| `.UserName` | `string` | the current user name | | `.UserName` | `string` | the current user name |
| `.HostName` | `string` | the host name | | `.HostName` | `string` | the host name |
| `.Code` | `int` | the last exit code | | `.Code` | `int` | the last exit code |
| `.OS` | `string` | the operating system | | `.OS` | `string` | the operating system |
| `.WSL` | `boolean` | in WSL yes/no | | `.WSL` | `boolean` | in WSL yes/no |
| `.Templates` | `string` | the [templates][templates] result | | `.Templates` | `string` | the [templates][templates] result |
| `.PromptCount` | `int` | the prompt counter, increments with 1 for every prompt invocation | | `.PromptCount` | `int` | the prompt counter, increments with 1 for every prompt invocation |
## Environment variables ## Environment variables
@ -271,3 +271,4 @@ This can be used in templates and icons/text inside your config.
[templates]: /docs/configuration/segment [templates]: /docs/configuration/segment
[regexpms]: https://pkg.go.dev/regexp#Regexp.MatchString [regexpms]: https://pkg.go.dev/regexp#Regexp.MatchString
[regexpra]: https://pkg.go.dev/regexp#Regexp.ReplaceAllString [regexpra]: https://pkg.go.dev/regexp#Regexp.ReplaceAllString
[pwsh-shlvl]: https://github.com/JanDeDobbeleer/oh-my-posh/issues/5069