diff options
| author | Matan Kushner <hello@matchai.dev> | 2022-02-07 15:53:55 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-02-07 15:53:55 +0100 |
| commit | 1d965a9d24509d500954669b4e5fb08e54733411 (patch) | |
| tree | d2d0714bad4ba9ac79a8a8385a690ad0e454c2a3 /docs/nl-NL/config/README.md | |
| parent | db86a93824ae0ce985db463ea34807990b3b879b (diff) | |
docs(i18n): new Crowdin updates (#3460)
Diffstat (limited to 'docs/nl-NL/config/README.md')
| -rw-r--r-- | docs/nl-NL/config/README.md | 269 |
1 files changed, 164 insertions, 105 deletions
diff --git a/docs/nl-NL/config/README.md b/docs/nl-NL/config/README.md index 2565504e2..9c4407f49 100644 --- a/docs/nl-NL/config/README.md +++ b/docs/nl-NL/config/README.md @@ -13,8 +13,8 @@ All configuration for starship is done in this [TOML](https://github.com/toml-la add_newline = true # Replace the "❯" symbol in the prompt with "➜" -[character] # The name of the module we are configuring is "character" -success_symbol = "[➜](bold green)" # The "success_symbol" segment is being set to "➜" with the color "bold green" +[character] # The name of the module we are configuring is "character" +success_symbol = "[➜](bold green)" # The "success_symbol" segment is being set to "➜" with the color "bold green" # Disable the package module, hiding it from the prompt completely [package] @@ -155,7 +155,6 @@ This is the list of prompt-wide configuration options. | `command_timeout` | `500` | Timeout for commands executed by starship (in milliseconds). | | `add_newline` | `true` | Inserts blank line between shell prompts. | - ### Example ```toml @@ -185,6 +184,7 @@ format = "$all" format = """ $username\ $hostname\ +$localip\ $shlvl\ $singularity\ $kubernetes\ @@ -200,6 +200,7 @@ $docker_context\ $package\ $cmake\ $cobol\ +$container\ $dart\ $deno\ $dotnet\ @@ -255,7 +256,7 @@ If you just want to extend the default format, you can use `$all`; modules you e ```toml # Move the directory to the second line -format="$all$directory$character" +format = "$all$directory$character" ``` ## AWS @@ -289,7 +290,7 @@ When using [AWSume](https://awsu.me) the profile is read from the `AWSUME_PROFIL | symbol | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | -\*: This variable can only be used as a part of a style string +*: This variable can only be used as a part of a style string ### Examples @@ -411,17 +412,16 @@ The `display` option is an array of the following table. #### Example ```toml -[[battery.display]] # "bold red" style and discharging_symbol when capacity is between 0% and 10% +[[battery.display]] # "bold red" style and discharging_symbol when capacity is between 0% and 10% threshold = 10 style = "bold red" -[[battery.display]] # "bold yellow" style and 💦 symbol when capacity is between 10% and 30% +[[battery.display]] # "bold yellow" style and 💦 symbol when capacity is between 10% and 30% threshold = 30 style = "bold yellow" discharging_symbol = "💦" # when capacity is over 30%, the battery indicator will not be displayed - ``` ## Character @@ -522,7 +522,7 @@ The `cmake` module shows the currently installed version of [CMake](https://cmak | symbol | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | -\*: This variable can only be used as a part of a style string +*: This variable can only be used as a part of a style string ## COBOL / GNUCOBOL @@ -552,7 +552,7 @@ The `cobol` module shows the currently installed version of COBOL. By default, t | symbol | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | -\*: This variable can only be used as a part of a style string +*: This variable can only be used as a part of a style string ## Command Duration @@ -568,21 +568,16 @@ Bash users who need preexec-like functionality can use [rcaloras's bash_preexec ### Options -| Option | Default | Description | -| -------------------- | ----------------------------- | ---------------------------------------------------------- | -| `min_time` | `2_000` | Shortest duration to show time for (in milliseconds). | -| `show_milliseconds` | `false` | Show milliseconds in addition to seconds for the duration. | -| `format` | `"took [$duration]($style) "` | The format for the module. | -| `style` | `"bold yellow"` | The style for the module. | -| `disabled` | `false` | Disables the `cmd_duration` module. | -| `show_notifications` | `false` | Show desktop notifications when command completes. | -| `min_time_to_notify` | `45_000` | Shortest duration for notification (in milliseconds). | - -::: tip - -Showing desktop notifications requires starship to be built with `notify-rust` support. You check if your starship supports notifications by running `STARSHIP_LOG=debug starship module cmd_duration -d 60000` when `show_notifications` is set to `true`. - -::: +| Option | Default | Description | +| ---------------------- | ----------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `min_time` | `2_000` | Shortest duration to show time for (in milliseconds). | +| `show_milliseconds` | `false` | Show milliseconds in addition to seconds for the duration. | +| `format` | `"took [$duration]($style) "` | The format for the module. | +| `style` | `"bold yellow"` | The style for the module. | +| `disabled` | `false` | Disables the `cmd_duration` module. | +| `show_notifications` | `false` | Show desktop notifications when command completes. | +| `min_time_to_notify` | `45_000` | Shortest duration for notification (in milliseconds). | +| `notification_timeout` | | Duration to show notification for (in milliseconds). If unset, notification timeout will be determined by daemon. Not all notification daemons honor this option. | ### Variables @@ -591,7 +586,7 @@ Showing desktop notifications requires starship to be built with `notify-rust` s | duration | `16m40s` | The time it took to execute the command | | style\* | | Mirrors the value of option `style` | -\*: This variable can only be used as a part of a style string +*: This variable can only be used as a part of a style string ### Example @@ -632,7 +627,7 @@ This does not suppress conda's own prompt modifier, you may want to run `conda c | symbol | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | -\*: This variable can only be used as a part of a style string +*: This variable can only be used as a part of a style string ### Example @@ -643,6 +638,38 @@ This does not suppress conda's own prompt modifier, you may want to run `conda c format = "[$symbol$environment](dimmed green) " ``` +## Container + +The `container` module displays a symbol and container name, if inside a container. + +### Options + +| Option | Default | Description | +| ---------- | ------------------------------------ | ----------------------------------------- | +| `symbol` | `"⬢"` | The symbol shown, when inside a container | +| `style` | `"bold red dimmed"` | The style for the module. | +| `format` | "[$symbol \\[$name\\]]($style) " | The format for the module. | +| `disabled` | `false` | Disables the `container` module. | + +### Variables + +| Variable | Example | Description | +| --------- | ------------------- | ------------------------------------ | +| name | `fedora-toolbox:35` | The name of the container | +| symbol | | Mirrors the value of option `symbol` | +| 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 + +[container] +format = "[$symbol \\[$name\\]]($style) " +``` + ## Crystal The `crystal` module shows the currently installed version of [Crystal](https://crystal-lang.org/). By default the module will be shown if any of the following conditions are met: @@ -671,7 +698,7 @@ The `crystal` module shows the currently installed version of [Crystal](https:// | symbol | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | -\*: This variable can only be used as a part of a style string +*: This variable can only be used as a part of a style string ### Example @@ -711,7 +738,7 @@ The `dart` module shows the currently installed version of [Dart](https://dart.d | symbol | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | -\*: This variable can only be used as a part of a style string +*: This variable can only be used as a part of a style string ### Example @@ -725,6 +752,7 @@ format = "via [🔰 $version](bold red) " ## Deno The `deno` module shows you your currently installed version of [Deno](https://deno.land/). By default the module will be shown if any of the following conditions are met: + - The current directory contains a `deno.json`, `deno.jsonc`, `mod.ts`, `mod.js`, `deps.ts` or `deps.js` file ### Options @@ -809,7 +837,7 @@ For example, given `~/Dev/Nix/nixpkgs/pkgs` where `nixpkgs` is the repo root, an | path | `"D:/Projects"` | The current directory path | | style\* | `"black bold dimmed"` | Mirrors the value of option `style` | -\*: This variable can only be used as a part of a style string +*: This variable can only be used as a part of a style string ### Example @@ -846,7 +874,7 @@ The `docker_context` module shows the currently active [Docker context](https:// | symbol | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | -\*: This variable can only be used as a part of a style string +*: This variable can only be used as a part of a style string ### Example @@ -901,7 +929,7 @@ The module will also show the Target Framework Moniker (<https://docs.microsoft. | symbol | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | -\*: This variable can only be used as a part of a style string +*: This variable can only be used as a part of a style string ### Example @@ -942,7 +970,7 @@ The `elixir` module shows the currently installed version of [Elixir](https://el | symbol | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | -\*: This variable can only be used as a part of a style string +*: This variable can only be used as a part of a style string ### Example @@ -984,7 +1012,7 @@ The `elm` module shows the currently installed version of [Elm](https://elm-lang | symbol | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | -\*: This variable can only be used as a part of a style string +*: This variable can only be used as a part of a style string ### Example @@ -1002,16 +1030,17 @@ The `env_var` module displays the current value of a selected environment variab - The `variable` configuration option matches an existing environment variable - The `variable` configuration option is not defined, but the `default` configuration option is - ::: tip Multiple environmental variables can be displayed by using a `.`. (see example) If the `variable` configuration option is not set, the module will display value of variable under the name of text after the `.` character. Example: following configuration will display value of USER environment variable + ```toml # ~/.config/starship.toml [env_var.USER] default = "unknown user" ``` + ::: ### Options @@ -1032,7 +1061,7 @@ default = "unknown user" | symbol | | Mirrors the value of option `symbol` | | style\* | `black bold dimmed` | Mirrors the value of option `style` | -\*: This variable can only be used as a part of a style string +*: This variable can only be used as a part of a style string ### Example @@ -1045,6 +1074,7 @@ default = "unknown shell" ``` Displaying multiple environmental variables: + ```toml # ~/.config/starship.toml @@ -1083,7 +1113,7 @@ The `erlang` module shows the currently installed version of [Erlang/OTP](https: | symbol | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | -\*: This variable can only be used as a part of a style string +*: This variable can only be used as a part of a style string ### Example @@ -1110,7 +1140,7 @@ The `fill` module fills any extra space on the line with a symbol. If multiple ` ```toml # ~/.config/starship.toml -format="AA $fill BB $fill CC" +format = "AA $fill BB $fill CC" [fill] symbol = "-" @@ -1121,7 +1151,6 @@ Produces a prompt that looks like: ``` AA -------------------------------------------- BB -------------------------------------------- CC - ``` ## Google Cloud (`gcloud`) @@ -1150,7 +1179,7 @@ The `gcloud` module shows the current configuration for [`gcloud`](https://cloud | symbol | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | -\*: This variable can only be used as a part of a style string +*: This variable can only be used as a part of a style string ### Examples @@ -1212,7 +1241,7 @@ The `git_branch` module shows the active branch of the repo in your current dire | symbol | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | -\*: This variable can only be used as a part of a style string +*: This variable can only be used as a part of a style string ### Example @@ -1248,7 +1277,7 @@ The `git_commit` module shows the current commit hash and also the tag (if any) | hash | `b703eb3` | The current git commit hash | | style\* | | Mirrors the value of option `style` | -\*: This variable can only be used as a part of a style string +*: This variable can only be used as a part of a style string ### Example @@ -1288,7 +1317,7 @@ The `git_state` module will show in directories which are part of a git reposito | progress_total | `2` | The total operation progress | | style\* | | Mirrors the value of option `style` | -\*: This variable can only be used as a part of a style string +*: This variable can only be used as a part of a style string ### Example @@ -1329,7 +1358,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y | added_style\* | | Mirrors the value of option `added_style` | | deleted_style\* | | Mirrors the value of option `deleted_style` | -\*: This variable can only be used as a part of a style string +*: This variable can only be used as a part of a style string ### Example @@ -1382,7 +1411,7 @@ The following variables can be used in `format`: | `deleted` | Displays `deleted` when a file's deletion has been added to the staging area. | | style\* | Mirrors the value of option `style` | -\*: This variable can only be used as a part of a style string +*: This variable can only be used as a part of a style string The following variables can be used in `diverged`: @@ -1408,7 +1437,7 @@ ahead = "🏎💨" behind = "😰" diverged = "😵" up_to_date = "✓" -untracked = "🤷" +untracked = "🤷" stashed = "📦" modified = "📝" staged = '[++\($count\)](green)' @@ -1461,7 +1490,7 @@ The `golang` module shows the currently installed version of [Go](https://golang | symbol | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | -\*: This variable can only be used as a part of a style string +*: This variable can only be used as a part of a style string ### Example @@ -1500,7 +1529,7 @@ The `helm` module shows the currently installed version of [Helm](https://helm.s | symbol | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | -\*: This variable can only be used as a part of a style string +*: This variable can only be used as a part of a style string ### Example @@ -1532,7 +1561,7 @@ The `hostname` module shows the system hostname. | hostname | `computer` | The hostname of the computer | | style\* | | Mirrors the value of option `style` | -\*: This variable can only be used as a part of a style string +*: This variable can only be used as a part of a style string ### Example @@ -1541,7 +1570,7 @@ The `hostname` module shows the system hostname. [hostname] ssh_only = false -format = "on [$hostname](bold red) " +format = "on [$hostname](bold red) " trim_at = ".companyname.com" disabled = false ``` @@ -1574,7 +1603,7 @@ The `java` module shows the currently installed version of [Java](https://www.or | symbol | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | -\*: This variable can only be used as a part of a style string +*: This variable can only be used as a part of a style string ### Example @@ -1587,7 +1616,7 @@ symbol = "🌟 " ## Jobs -The `jobs` module shows the current number of jobs running. The module will be shown only if there are background jobs running. The module will show the number of jobs running if there are at least 2 jobs, or more than the `number_threshold` config value, if it exists. The module will show a symbol if there is at least 1 job, or more than the `symbol_threshold` config value, if it exists. You can set both values to 0 in order to *always* show the symbol and number of jobs, even if there are 0 jobs running. +The `jobs` module shows the current number of jobs running. The module will be shown only if there are background jobs running. The module will show the number of jobs running if there are at least 2 jobs, or more than the `number_threshold` config value, if it exists. The module will show a symbol if there is at least 1 job, or more than the `symbol_threshold` config value, if it exists. You can set both values to 0 in order to _always_ show the symbol and number of jobs, even if there are 0 jobs running. The default functionality is: @@ -1611,16 +1640,15 @@ The `threshold` option is deprecated, but if you want to use it, the module will | Option | Default | Description | | ------------------ | ----------------------------- | ------------------------------------------------------------------------ | -| `threshold`\* | `1` | Show number of jobs if exceeded. | +| `threshold`* | `1` | Show number of jobs if exceeded. | | `symbol_threshold` | `1` | Show `symbol` if the job count is at least `symbol_threshold`. | | `number_threshold` | `2` | Show the number of jobs if the job count is at least `number_threshold`. | | `format` | `"[$symbol$number]($style) "` | The format for the module. | | `symbol` | `"✦"` | The string used to represent the `symbol` variable. | | `style` | `"bold blue"` | The style for the module. | | `disabled` | `false` | Disables the `jobs` module. | - \*: This option is deprecated, please use the -`number_threshold` and `symbol_threshold` options instead. +*: This option is deprecated, please use the `number_threshold` and `symbol_threshold` options instead. ### Variables @@ -1630,7 +1658,7 @@ The `threshold` option is deprecated, but if you want to use it, the module will | symbol | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | -\*: This variable can only be used as a part of a style string +*: This variable can only be used as a part of a style string ### Example @@ -1672,7 +1700,7 @@ The `julia` module shows the currently installed version of [Julia](https://juli | symbol | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | -\*: This variable can only be used as a part of a style string +*: This variable can only be used as a part of a style string ### Example @@ -1683,6 +1711,39 @@ The `julia` module shows the currently installed version of [Julia](https://juli symbol = "∴ " ``` +## localip + +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/). By default the module will be shown if any of the following conditions are met: @@ -1711,7 +1772,7 @@ The `kotlin` module shows the currently installed version of [Kotlin](https://ko | symbol | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | -\*: This variable can only be used as a part of a style string +*: This variable can only be used as a part of a style string ### Example @@ -1759,7 +1820,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y | symbol | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | -\*: This variable can only be used as a part of a style string +*: This variable can only be used as a part of a style string ### Example @@ -1845,7 +1906,7 @@ The `lua` module shows the currently installed version of [Lua](http://www.lua.o | symbol | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | -\*: This variable can only be used as a part of a style string +*: This variable can only be used as a part of a style string ### Example @@ -1889,7 +1950,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y | symbol | `🐏` | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | -\*: This variable can only be used as a part of a style string \*\*: The SWAP file information is only displayed if detected on the current system +*: This variable can only be used as a part of a style string *\*: The SWAP file information is only displayed if detected on the current system ### Example @@ -1926,7 +1987,7 @@ The `hg_branch` module shows the active branch of the repo in your current direc | symbol | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | -\*: This variable can only be used as a part of a style string +*: This variable can only be used as a part of a style string ### Example @@ -1969,7 +2030,7 @@ The `nim` module shows the currently installed version of [Nim](https://nim-lang | symbol | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | -\*: This variable can only be used as a part of a style string +*: This variable can only be used as a part of a style string ### Example @@ -2005,7 +2066,7 @@ The `nix_shell` module shows the [nix-shell](https://nixos.org/guides/nix-pills/ | symbol | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | -\*: This variable can only be used as a part of a style string +*: This variable can only be used as a part of a style string ### Example @@ -2036,7 +2097,7 @@ The `nodejs` module shows the currently installed version of [Node.js](https://n | ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------------------------- | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | -| `symbol` | `" "` | A format string representing the symbol of Node.js. | +| `symbol` | `" "` | A format string representing the symbol of Node.js. | | `detect_extensions` | `["js", "mjs", "cjs", "ts"]` | Which extensions should trigger this module. | | `detect_files` | `["package.json", ".node-version"]` | Which filenames should trigger this module. | | `detect_folders` | `["node_modules"]` | Which folders should trigger this module. | @@ -2052,7 +2113,7 @@ The `nodejs` module shows the currently installed version of [Node.js](https://n | symbol | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | -\*: This variable can only be used as a part of a style string +*: This variable can only be used as a part of a style string ### Example @@ -2099,7 +2160,7 @@ The `ocaml` module shows the currently installed version of [OCaml](https://ocam | symbol | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | -\*: This variable can only be used as a part of a style string +*: This variable can only be used as a part of a style string ### Example @@ -2132,7 +2193,7 @@ The `openstack` module shows the current OpenStack cloud and project. The module | symbol | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | -\*: This variable can only be used as a part of a style string +*: This variable can only be used as a part of a style string ### Example @@ -2187,7 +2248,7 @@ The `package` module is shown when the current directory is the repository for a | symbol | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | -\*: This variable can only be used as a part of a style string +*: This variable can only be used as a part of a style string ### Example @@ -2267,7 +2328,7 @@ The `php` module shows the currently installed version of [PHP](https://www.php. | symbol | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | -\*: This variable can only be used as a part of a style string +*: This variable can only be used as a part of a style string ### Example @@ -2280,7 +2341,7 @@ format = "via [🔹 $version](147 bold) " ## Pulumi -The `pulumi` module shows the currently selected [Pulumi Stack](https://www.pulumi.com/docs/intro/concepts/stack/) and version. +The `pulumi` module shows the current username, selected [Pulumi Stack](https://www.pulumi.com/docs/intro/concepts/stack/), and version. ::: tip @@ -2295,13 +2356,13 @@ By default the module will be shown if any of the following conditions are met: ### Options -| Option | Default | Description | -| ---------------- | -------------------------------- | ------------------------------------------------------------------------- | -| `format` | `"via [$symbol$stack]($style) "` | The format string for the module. | -| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | -| `symbol` | `" "` | A format string shown before the Pulumi stack. | -| `style` | `"bold 5"` | The style for the module. | -| `disabled` | `false` | Disables the `pulumi` module. | +| Option | Default | Description | +| ---------------- | -------------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($username@)$stack]($style) "` | The format string for the module. | +| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `" "` | A format string shown before the Pulumi stack. | +| `style` | `"bold 5"` | The style for the module. | +| `disabled` | `false` | Disables the `pulumi` module. | ### Variables @@ -2309,10 +2370,11 @@ By default the module will be shown if any of the following conditions are met: | --------- | ---------- | ------------------------------------ | | version | `v0.12.24` | The version of `pulumi` | | stack | `dev` | The current Pulumi stack | +| username | `alice` | The current Pulumi username | | symbol | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | -\*: This variable can only be used as a part of a style string +*: This variable can only be used as a part of a style string ### Example @@ -2332,7 +2394,6 @@ format = "[🛥 ($version )$stack]($style) " [pulumi] symbol = "🛥 " format = "[$symbol$stack]($style) " - ``` ## PureScript @@ -2363,7 +2424,7 @@ The `purescript` module shows the currently installed version of [PureScript](ht | symbol | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | -\*: This variable can only be used as a part of a style string +*: This variable can only be used as a part of a style string ### Example @@ -2532,7 +2593,7 @@ By default the `red` module shows the currently installed version of [Red](https | symbol | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | -\*: This variable can only be used as a part of a style string +*: This variable can only be used as a part of a style string ### Example @@ -2576,7 +2637,7 @@ Starship gets the current Ruby version by running `ruby -v`. | symbol | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | -\*: This variable can only be used as a part of a style string +*: This variable can only be used as a part of a style string ### Example @@ -2615,7 +2676,7 @@ By default the `rust` module shows the currently installed version of [Rust](htt | symbol | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | -\*: This variable can only be used as a part of a style string +*: This variable can only be used as a part of a style string ### Example @@ -2655,7 +2716,7 @@ The `scala` module shows the currently installed version of [Scala](https://www. | symbol | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | -\*: This variable can only be used as a part of a style string +*: This variable can only be used as a part of a style string ### Example @@ -2702,7 +2763,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y | indicator | | Mirrors the value of `indicator` for currently used shell. | | style\* | | Mirrors the value of option `style`. | -\*: This variable can only be used as a part of a style string +*: This variable can only be used as a part of a style string ### Examples @@ -2740,7 +2801,7 @@ The `shlvl` module shows the current [`SHLVL`](https://tldp.org/LDP/abs/html/int | symbol | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | -\*: This variable can only be used as a part of a style string +*: This variable can only be used as a part of a style string ### Example @@ -2774,7 +2835,7 @@ The `singularity` module shows the current [Singularity](https://sylabs.io/singu | symbol | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | -\*: This variable can only be used as a part of a style string +*: This variable can only be used as a part of a style string ### Example @@ -2787,7 +2848,7 @@ format = '[📦 \[$env\]]($style) ' ## Status -The `status` module displays the exit code of the previous command. The module will be shown only if the exit code is not `0`. +The `status` module displays the exit code of the previous command. The module will be shown only if the exit code is not `0`. The status code will cast to a signed 32-bit integer. ::: tip @@ -2812,7 +2873,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y | `recognize_signal_code` | `true` | Enable signal mapping from exit code | | `map_symbol` | `false` | Enable symbols mapping from exit code | | `pipestatus` | `false` | Enable pipestatus reporting | -| `pipestatus_separator` | `|` | The symbol that separate in pipe program exit codes | +| `pipestatus_separator` | `|` | | | `pipestatus_format` | `\\[$pipestatus\\] => [$symbol$common_meaning$signal_name$maybe_int]($style)` | The format of the module when the command is a pipeline | | `disabled` | `true` | Disables the `status` module. | @@ -2831,12 +2892,11 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y | symbol | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | -\*: This variable can only be used as a part of a style string +*: This variable can only be used as a part of a style string ### Example ```toml - # ~/.config/starship.toml [status] @@ -2845,7 +2905,6 @@ symbol = "🔴" format = '[\[$symbol $common_meaning$signal_name$maybe_int\]]($style) ' map_symbol = true disabled = false - ``` ## Sudo @@ -2875,12 +2934,11 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y | symbol | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | -\*: This variable can only be used as a part of a style string +*: This variable can only be used as a part of a style string ### Example ```toml - # ~/.config/starship.toml [sudo] @@ -2926,7 +2984,7 @@ By default the `swift` module shows the currently installed version of [Swift](h |