mirror of
https://github.com/Llewellynvdm/starship.git
synced 2024-11-10 23:30:57 +00:00
docs: "Local IP" chapter in alphabetical order (#3613)
This commit is contained in:
parent
186f8ac881
commit
4011c05827
@ -1808,39 +1808,6 @@ By default the module will be shown if any of the following conditions are met:
|
||||
symbol = "∴ "
|
||||
```
|
||||
|
||||
## Local IP
|
||||
|
||||
The `localip` module shows the IPv4 address of the primary network interface.
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
| ---------- | ------------------------- | ------------------------------------------------------ |
|
||||
| `ssh_only` | `true` | Only show IP address when connected to an SSH session. |
|
||||
| `format` | `"[$localipv4]($style) "` | The format for the module. |
|
||||
| `style` | `"bold yellow"` | The style for the module. |
|
||||
| `disabled` | `true` | Disables the `localip` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
| Variable | Example | Description |
|
||||
| --------- | ------------ | ----------------------------------- |
|
||||
| localipv4 | 192.168.1.13 | Contains the primary IPv4 address |
|
||||
| style\* | | Mirrors the value of option `style` |
|
||||
|
||||
*: This variable can only be used as a part of a style string
|
||||
|
||||
### Example
|
||||
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
|
||||
[localip]
|
||||
ssh_only = false
|
||||
format = "@[$localipv4](bold red) "
|
||||
disabled = false
|
||||
```
|
||||
|
||||
## Kotlin
|
||||
|
||||
The `kotlin` module shows the currently installed version of [Kotlin](https://kotlinlang.org/).
|
||||
@ -1982,6 +1949,39 @@ The `line_break` module separates the prompt into two lines.
|
||||
disabled = true
|
||||
```
|
||||
|
||||
## Local IP
|
||||
|
||||
The `localip` module shows the IPv4 address of the primary network interface.
|
||||
|
||||
### Options
|
||||
|
||||
| Option | Default | Description |
|
||||
| ---------- | ------------------------- | ------------------------------------------------------ |
|
||||
| `ssh_only` | `true` | Only show IP address when connected to an SSH session. |
|
||||
| `format` | `"[$localipv4]($style) "` | The format for the module. |
|
||||
| `style` | `"bold yellow"` | The style for the module. |
|
||||
| `disabled` | `true` | Disables the `localip` module. |
|
||||
|
||||
### Variables
|
||||
|
||||
| Variable | Example | Description |
|
||||
| --------- | ------------ | ----------------------------------- |
|
||||
| localipv4 | 192.168.1.13 | Contains the primary IPv4 address |
|
||||
| style\* | | Mirrors the value of option `style` |
|
||||
|
||||
*: This variable can only be used as a part of a style string
|
||||
|
||||
### Example
|
||||
|
||||
```toml
|
||||
# ~/.config/starship.toml
|
||||
|
||||
[localip]
|
||||
ssh_only = false
|
||||
format = "@[$localipv4](bold red) "
|
||||
disabled = false
|
||||
```
|
||||
|
||||
## Lua
|
||||
|
||||
The `lua` module shows the currently installed version of [Lua](http://www.lua.org/).
|
||||
|
Loading…
Reference in New Issue
Block a user