diff options
Diffstat (limited to 'docs')
53 files changed, 10051 insertions, 2948 deletions
diff --git a/docs/ar-SA/config/README.md b/docs/ar-SA/config/README.md index c9970753c..984ef22d4 100644 --- a/docs/ar-SA/config/README.md +++ b/docs/ar-SA/config/README.md @@ -29,7 +29,7 @@ export STARSHIP_CONFIG=~/.starship Equivalently in PowerShell (Windows) would be adding this line to your `$PROFILE`: -```ps1 +```powershell $ENV:STARSHIP_CONFIG = "$HOME\.starship" ``` @@ -43,7 +43,7 @@ export STARSHIP_CACHE=~/.starship/cache Equivalently in PowerShell (Windows) would be adding this line to your `$PROFILE`: -```ps1 +```powershell $ENV:STARSHIP_CACHE = "$HOME\AppData\Local\Temp" ``` @@ -427,12 +427,12 @@ The `cmake` module shows the currently installed version of CMake if any of the ### Options -| Option | Default | Description | -| ---------- | ---------------------------------- | -------------------------------------------- | -| `format` | `"via [$symbol$version]($style) "` | The format for the module. | -| `symbol` | `"喝 "` | The symbol used before the version of cmake. | -| `style` | `"bold blue"` | The style for the module. | -| `disabled` | `false` | Disables the `cmake` module. | +| Option | Default | Description | +| ---------- | ------------------------------------ | -------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `symbol` | `"喝 "` | The symbol used before the version of cmake. | +| `style` | `"bold blue"` | The style for the module. | +| `disabled` | `false` | Disables the `cmake` module. | ### Variables @@ -542,12 +542,12 @@ The `crystal` module shows the currently installed version of Crystal. The modul ### Options -| Option | Default | Description | -| ---------- | ---------------------------------- | --------------------------------------------------------- | -| `symbol` | `"🔮 "` | The symbol used before displaying the version of crystal. | -| `style` | `"bold red"` | The style for the module. | -| `format` | `"via [$symbol$version]($style) "` | The format for the module. | -| `disabled` | `false` | Disables the `crystal` module. | +| Option | Default | Description | +| ---------- | ------------------------------------ | --------------------------------------------------------- | +| `symbol` | `"🔮 "` | The symbol used before displaying the version of crystal. | +| `style` | `"bold red"` | The style for the module. | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `disabled` | `false` | Disables the `crystal` module. | ### Variables @@ -578,12 +578,12 @@ The `dart` module shows the currently installed version of Dart. The module will ### Options -| Option | Default | Description | -| ---------- | ---------------------------------- | ----------------------------------------------- | -| `format` | `"via [$symbol$version]($style) "` | The format for the module. | -| `symbol` | `"🎯 "` | A format string representing the symbol of Dart | -| `style` | `"bold blue"` | The style for the module. | -| `disabled` | `false` | Disables the `dart` module. | +| Option | Default | Description | +| ---------- | ------------------------------------ | ----------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `symbol` | `"🎯 "` | A format string representing the symbol of Dart | +| `style` | `"bold blue"` | The style for the module. | +| `disabled` | `false` | Disables the `dart` module. | ### Variables @@ -624,6 +624,7 @@ For example, given `~/Dev/Nix/nixpkgs/pkgs` where `nixpkgs` is the repo root, an | `read_only` | `"🔒"` | The symbol indicating current directory is read only. | | `read_only_style` | `"red"` | The style for the read only symbol. | | `truncation_symbol` | `""` | The symbol to prefix to truncated paths. eg: "…/" | +| `home_symbol` | `"~"` | The symbol indicating home directory. | <details> <summary>This module has a few advanced configuration options that control how the directory is displayed.</summary> @@ -671,13 +672,13 @@ The `docker_context` module shows the currently active [Docker context](https:// ### Options -| Option | Default | Description | -| ----------------- | ---------------------------------- | --------------------------------------------------------------------------------------- | -| `format` | `"via [$symbol$context]($style) "` | The format for the module. | -| `symbol` | `"🐳 "` | The symbol used before displaying the Docker context. | -| `style` | `"blue bold"` | The style for the module. | -| `only_with_files` | `false` | Only show when there's a `docker-compose.yml` or `Dockerfile` in the current directory. | -| `disabled` | `true` | Disables the `docker_context` module. | +| Option | Default | Description | +| ----------------- | ---------------------------------- | --------------------------------------------------------------------------------------------------------------- | +| `format` | `"via [$symbol$context]($style) "` | The format for the module. | +| `symbol` | `"🐳 "` | The symbol used before displaying the Docker context. | +| `style` | `"blue bold"` | The style for the module. | +| `only_with_files` | `true` | Only show when there's a `docker-compose.yml`, `docker-compose.yaml`, or `Dockerfile` in the current directory. | +| `disabled` | `false` | Disables the `docker_context` module. | ### Variables @@ -722,13 +723,13 @@ The module will also show the Target Framework Moniker (<https://docs.microsoft. ### Options -| Option | Default | Description | -| ----------- | --------------------------------------- | -------------------------------------------------------- | -| `format` | `"[$symbol$version( 🎯 $tfm)]($style) "` | The format for the module. | -| `symbol` | `"•NET "` | The symbol used before displaying the version of dotnet. | -| `heuristic` | `true` | Use faster version detection to keep starship snappy. | -| `style` | `"bold blue"` | The style for the module. | -| `disabled` | `false` | Disables the `dotnet` module. | +| Option | Default | Description | +| ----------- | ----------------------------------------- | -------------------------------------------------------- | +| `format` | `"[$symbol($version )(🎯 $tfm )]($style)"` | The format for the module. | +| `symbol` | `"•NET "` | The symbol used before displaying the version of dotnet. | +| `heuristic` | `true` | Use faster version detection to keep starship snappy. | +| `style` | `"bold blue"` | The style for the module. | +| `disabled` | `false` | Disables the `dotnet` module. | ### Variables @@ -760,12 +761,12 @@ The `elixir` module shows the currently installed version of Elixir and Erlang/O ### Options -| Option | Default | Description | -| ---------- | --------------------------------------------------------- | --------------------------------------------------------------- | -| `symbol` | `"💧 "` | The symbol used before displaying the version of Elixir/Erlang. | -| `style` | `"bold purple"` | The style for the module. | -| `format` | `'via [$symbol$version \(OTP $otp_version\)]($style) '` | The format for the module elixir. | -| `disabled` | `false` | Disables the `elixir` module. | +| Option | Default | Description | +| ---------- | ----------------------------------------------------------- | --------------------------------------------------------------- | +| `symbol` | `"💧 "` | The symbol used before displaying the version of Elixir/Erlang. | +| `style` | `"bold purple"` | The style for the module. | +| `format` | `'via [$symbol($version \(OTP $otp_version\) )]($style)'` | The format for the module elixir. | +| `disabled` | `false` | Disables the `elixir` module. | ### Variables @@ -799,12 +800,12 @@ The `elm` module shows the currently installed version of Elm. The module will b ### Options -| Option | Default | Description | -| ---------- | ---------------------------------- | ----------------------------------------------- | -| `format` | `"via [$symbol$version]($style) "` | The format for the module. | -| `symbol` | `"🌳 "` | A format string representing the symbol of Elm. | -| `style` | `"cyan bold"` | The style for the module. | -| `disabled` | `false` | Disables the `elm` module. | +| Option | Default | Description | +| ---------- | ------------------------------------ | ----------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `symbol` | `"🌳 "` | A format string representing the symbol of Elm. | +| `style` | `"cyan bold"` | The style for the module. | +| `disabled` | `false` | Disables the `elm` module. | ### Variables @@ -871,12 +872,12 @@ The `erlang` module shows the currently installed version of Erlang/OTP. The mod ### Options -| Option | Default | Description | -| ---------- | ---------------------------------- | -------------------------------------------------------- | -| `symbol` | `" "` | The symbol used before displaying the version of erlang. | -| `style` | `"bold red"` | The style for the module. | -| `format` | `"via [$symbol$version]($style) "` | The format for the module. | -| `disabled` | `false` | Disables the `erlang` module. | +| Option | Default | Description | +| ---------- | ------------------------------------ | -------------------------------------------------------- | +| `symbol` | `" "` | The symbol used before displaying the version of erlang. | +| `style` | `"bold red"` | The style for the module. | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `disabled` | `false` | Disables the `erlang` module. | ### Variables @@ -1170,12 +1171,12 @@ The `golang` module shows the currently installed version of Golang. The module ### Options -| Option | Default | Description | -| ---------- | ---------------------------------- | ---------------------------------------------- | -| `format` | `"via [$symbol$version]($style) "` | The format for the module. | -| `symbol` | `"🐹 "` | A format string representing the symbol of Go. | -| `style` | `"bold cyan"` | The style for the module. | -| `disabled` | `false` | Disables the `golang` module. | +| Option | Default | Description | +| ---------- | ------------------------------------ | ---------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `symbol` | `"🐹 "` | A format string representing the symbol of Go. | +| `style` | `"bold cyan"` | The style for the module. | +| `disabled` | `false` | Disables the `golang` module. | ### Variables @@ -1205,12 +1206,12 @@ The `helm` module shows the currently installed version of Helm. The module will ### Options -| Option | Default | Description | -| ---------- | ---------------------------------- | ------------------------------------------------ | -| `format` | `"via [$symbol$version]($style) "` | The format for the module. | -| `symbol` | `"⎈ "` | A format string representing the symbol of Helm. | -| `style` | `"bold white"` | The style for the module. | -| `disabled` | `false` | Disables the `helm` module. | +| Option | Default | Description | +| ---------- | ------------------------------------ | ------------------------------------------------ | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `symbol` | `"⎈ "` | A format string representing the symbol of Helm. | +| `style` | `"bold white"` | The style for the module. | +| `disabled` | `false` | Disables the `helm` module. | ### Variables @@ -1275,12 +1276,12 @@ The `java` module shows the currently installed version of Java. The module will ### Options -| Option | Default | Description | -| ---------- | -------------------------------------- | ----------------------------------------------- | -| `format` | `"via [${symbol}${version}]($style) "` | The format for the module. | -| `symbol` | `"☕ "` | A format string representing the symbol of Java | -| `style` | `"red dimmed"` | The style for the module. | -| `disabled` | `false` | Disables the `java` module. | +| Option | Default | Description | +| ---------- | ---------------------------------------- | ----------------------------------------------- | +| `format` | `"via [${symbol}(${version} )]($style)"` | The format for the module. | +| `symbol` | `"☕ "` | A format string representing the symbol of Java | +| `style` | `"red dimmed"` | The style for the module. | +| `disabled` | `false` | Disables the `java` module. | ### Variables @@ -1345,12 +1346,12 @@ The `julia` module shows the currently installed version of Julia. The module wi ### Options -| Option | Default | Description | -| ---------- | ---------------------------------- | ------------------------------------------------- | -| `format` | `"via [$symbol$version]($style) "` | The format for the module. | -| `symbol` | `"ஃ "` | A format string representing the symbol of Julia. | -| `style` | `"bold purple"` | The style for the module. | -| `disabled` | `false` | Disables the `julia` module. | +| Option | Default | Description | +| ---------- | ------------------------------------ | ------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `symbol` | `"ஃ "` | A format string representing the symbol of Julia. | +| `style` | `"bold purple"` | The style for the module. | +| `disabled` | `false` | Disables the `julia` module. | ### Variables @@ -1379,13 +1380,13 @@ The `kotlin` module shows the currently installed version of Kotlin. The module ### Options -| Option | Default | Description | -| --------------- | ---------------------------------- | ----------------------------------------------------------------------------- | -| `format` | `"via [$symbol$version]($style) "` | The format for the module. | -| `symbol` | `"🅺 "` | A format string representing the symbol of Kotlin. | -| `style` | `"bold blue"` | The style for the module. | -| `kotlin_binary` | `"kotlin"` | Configures the kotlin binary that Starship executes when getting the version. | -| `disabled` | `false` | Disables the `kotlin` module. | +| Option | Default | Description | +| --------------- | ------------------------------------ | ----------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `symbol` | `"🅺 "` | A format string representing the symbol of Kotlin. | +| `style` | `"bold blue"` | The style for the module. | +| `kotlin_binary` | `"kotlin"` | Configures the kotlin binary that Starship executes when getting the version. | +| `disabled` | `false` | Disables the `kotlin` module. | ### Variables @@ -1486,13 +1487,13 @@ The `lua` module shows the currently installed version of Lua. The module will b ### Options -| Option | Default | Description | -| ------------ | ---------------------------------- | -------------------------------------------------------------------------- | -| `format` | `"via [$symbol$version]($style) "` | The format for the module. | -| `symbol` | `"🌙 "` | A format string representing the symbol of Lua. | -| `style` | `"bold blue"` | The style for the module. | -| `lua_binary` | `"lua"` | Configures the lua binary that Starship executes when getting the version. | -| `disabled` | `false` | Disables the `lua` module. | +| Option | Default | Description | +| ------------ | ------------------------------------ | -------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `symbol` | `"🌙 "` | A format string representing the symbol of Lua. | +| `style` | `"bold blue"` | The style for the module. | +| `lua_binary` | `"lua"` | Configures the lua binary that Starship executes when getting the version. | +| `disabled` | `false` | Disables the `lua` module. | ### Variables @@ -1607,12 +1608,12 @@ The `nim` module shows the currently installed version of Nim. The module will b ### Options -| Option | Default | Description | -| ---------- | ---------------------------------- | ----------------------------------------------------- | -| `format` | `"via [$symbol$version]($style) "` | The format for the module | -| `symbol` | `"👑 "` | The symbol used before displaying the version of Nim. | -| `style` | `"bold yellow"` | The style for the module. | -| `disabled` | `false` | Disables the `nim` module. | +| Option | Default | Description | +| ---------- | ------------------------------------ | ----------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module | +| `symbol` | `"👑 "` | The symbol used before displaying the version of Nim. | +| `style` | `"bold yellow"` | The style for the module. | +| `disabled` | `false` | Disables the `nim` module. | ### Variables @@ -1684,13 +1685,13 @@ The `nodejs` module shows the currently installed version of NodeJS. The module ### Options -| Option | Default | Description | -| ------------------- | ---------------------------------- | ----------------------------------------------------------------------------------------------------- | -| `format` | `"via [$symbol$version]($style) "` | The format for the module. | -| `sy |