summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMatan Kushner <hello@matchai.dev>2021-09-21 09:36:29 -0400
committerGitHub <noreply@github.com>2021-09-21 09:36:29 -0400
commite29b2ddc91b24d8bb672b2ed3b91085bf9407354 (patch)
tree0e7c99c0a2076a699bd04586b4aecbcdfc92428a
parent43feb6e4ecd756445b0bde391da41265e79a9e8c (diff)
docs(i18n): new Crowdin updates (#3012)
-rw-r--r--docs/ar-SA/advanced-config/README.md27
-rw-r--r--docs/ar-SA/config/README.md140
-rw-r--r--docs/ar-SA/guide/README.md58
-rw-r--r--docs/ar-SA/presets/README.md9
-rw-r--r--docs/ckb-IR/advanced-config/README.md27
-rw-r--r--docs/ckb-IR/config/README.md140
-rw-r--r--docs/ckb-IR/guide/README.md58
-rw-r--r--docs/ckb-IR/presets/README.md9
-rw-r--r--docs/de-DE/advanced-config/README.md37
-rw-r--r--docs/de-DE/config/README.md520
-rw-r--r--docs/de-DE/guide/README.md58
-rw-r--r--docs/de-DE/presets/README.md9
-rw-r--r--docs/es-ES/README.md6
-rw-r--r--docs/es-ES/advanced-config/README.md39
-rw-r--r--docs/es-ES/config/README.md1347
-rw-r--r--docs/es-ES/guide/README.md62
-rw-r--r--docs/es-ES/presets/README.md15
-rw-r--r--docs/fr-FR/advanced-config/README.md37
-rw-r--r--docs/fr-FR/config/README.md1371
-rw-r--r--docs/fr-FR/guide/README.md58
-rw-r--r--docs/fr-FR/presets/README.md9
-rw-r--r--docs/id-ID/README.md22
-rw-r--r--docs/id-ID/advanced-config/README.md39
-rw-r--r--docs/id-ID/config/README.md442
-rw-r--r--docs/id-ID/guide/README.md60
-rw-r--r--docs/id-ID/migrating-to-0.45.0/README.md150
-rw-r--r--docs/id-ID/presets/README.md51
-rw-r--r--docs/it-IT/README.md6
-rw-r--r--docs/it-IT/advanced-config/README.md39
-rw-r--r--docs/it-IT/config/README.md432
-rw-r--r--docs/it-IT/guide/README.md62
-rw-r--r--docs/it-IT/installing/README.md32
-rw-r--r--docs/it-IT/presets/README.md9
-rw-r--r--docs/ja-JP/advanced-config/README.md37
-rw-r--r--docs/ja-JP/config/README.md996
-rw-r--r--docs/ja-JP/guide/README.md62
-rw-r--r--docs/ja-JP/presets/README.md9
-rw-r--r--docs/ko-KR/advanced-config/README.md27
-rw-r--r--docs/ko-KR/config/README.md140
-rw-r--r--docs/ko-KR/guide/README.md58
-rw-r--r--docs/ko-KR/presets/README.md9
-rw-r--r--docs/nl-NL/advanced-config/README.md27
-rw-r--r--docs/nl-NL/config/README.md140
-rw-r--r--docs/nl-NL/guide/README.md62
-rw-r--r--docs/nl-NL/presets/README.md9
-rw-r--r--docs/pl-PL/README.md36
-rw-r--r--docs/pl-PL/advanced-config/README.md33
-rw-r--r--docs/pl-PL/config/README.md188
-rw-r--r--docs/pl-PL/faq/README.md40
-rw-r--r--docs/pl-PL/guide/README.md170
-rw-r--r--docs/pl-PL/installing/README.md18
-rw-r--r--docs/pl-PL/migrating-to-0.45.0/README.md2
-rw-r--r--docs/pl-PL/presets/README.md39
-rw-r--r--docs/pt-BR/advanced-config/README.md37
-rw-r--r--docs/pt-BR/config/README.md784
-rw-r--r--docs/pt-BR/guide/README.md58
-rw-r--r--docs/pt-BR/presets/README.md9
-rw-r--r--docs/pt-PT/advanced-config/README.md27
-rw-r--r--docs/pt-PT/config/README.md140
-rw-r--r--docs/pt-PT/guide/README.md58
-rw-r--r--docs/pt-PT/presets/README.md9
-rw-r--r--docs/ru-RU/advanced-config/README.md37
-rw-r--r--docs/ru-RU/config/README.md684
-rw-r--r--docs/ru-RU/guide/README.md58
-rw-r--r--docs/ru-RU/presets/README.md9
-rw-r--r--docs/tr-TR/advanced-config/README.md27
-rw-r--r--docs/tr-TR/config/README.md140
-rw-r--r--docs/tr-TR/guide/README.md58
-rw-r--r--docs/tr-TR/presets/README.md9
-rw-r--r--docs/vi-VN/advanced-config/README.md37
-rw-r--r--docs/vi-VN/config/README.md862
-rw-r--r--docs/vi-VN/guide/README.md58
-rw-r--r--docs/vi-VN/presets/README.md9
-rw-r--r--docs/zh-CN/advanced-config/README.md37
-rw-r--r--docs/zh-CN/config/README.md542
-rw-r--r--docs/zh-CN/guide/README.md58
-rw-r--r--docs/zh-CN/presets/README.md9
-rw-r--r--docs/zh-TW/advanced-config/README.md37
-rw-r--r--docs/zh-TW/config/README.md510
-rw-r--r--docs/zh-TW/guide/README.md58
-rw-r--r--docs/zh-TW/presets/README.md9
81 files changed, 6971 insertions, 4881 deletions
diff --git a/docs/ar-SA/advanced-config/README.md b/docs/ar-SA/advanced-config/README.md
index d423cdc5f..cabf9cdfc 100644
--- a/docs/ar-SA/advanced-config/README.md
+++ b/docs/ar-SA/advanced-config/README.md
@@ -68,6 +68,33 @@ function set_win_title(){
starship_precmd_user_func="set_win_title"
```
+## Enable Right Prompt
+
+Some shells support a right prompt which renders on the same line as the input. Starship can set the content of the right prompt using the `right_format` option. Any module that can be used in `format` is also supported in `right_format`. The `$all` variable will only contain modules not explicitly used in either `format` or `right_format`.
+
+Note: The right prompt is a single line following the input location. To right align modules above the input line in a multi-line prompt, see the [fill module](/config/#fill).
+
+`right_format` is currently supported for the following shells: elvish, fish, zsh.
+
+### Example
+
+```toml
+# ~/.config/starship.toml
+
+# A minimal left prompt
+format = """$character"""
+
+# move the rest of the prompt to the right
+right_format = """$all"""
+```
+
+Produces a prompt like the following:
+
+```
+▶ starship on  rprompt [!] is 📦 v0.57.0 via 🦀 v1.54.0 took 17s
+```
+
+
## Style Strings
Style strings are a list of words, separated by whitespace. The words are not case sensitive (i.e. `bold` and `BoLd` are considered the same string). Each word can be one of the following:
diff --git a/docs/ar-SA/config/README.md b/docs/ar-SA/config/README.md
index 61f8fcfd2..2fb31aa12 100644
--- a/docs/ar-SA/config/README.md
+++ b/docs/ar-SA/config/README.md
@@ -75,7 +75,7 @@ A text group is made up of two different parts.
The first part, which is enclosed in a `[]`, is a [format string](#format-strings). You can add texts, variables, or even nested text groups in it.
-In the second part, which is enclosed in a `()`, is a [style string](#style-strings). This can be used style the first part.
+In the second part, which is enclosed in a `()`, is a [style string](#style-strings). This can be used to style the first part.
For example:
@@ -142,12 +142,14 @@ This is the list of prompt-wide configuration options.
### Options
-| Option | Default | Description |
-| ----------------- | ------------------------------ | ------------------------------------------------------------ |
-| `format` | [link](#default-prompt-format) | Configure the format of the prompt. |
-| `scan_timeout` | `30` | Timeout for starship to scan files (in milliseconds). |
-| `command_timeout` | `500` | Timeout for commands executed by starship (in milliseconds). |
-| `add_newline` | `true` | Inserts blank line between shell prompts. |
+| Option | Default | Description |
+| ----------------- | ------------------------------ | ---------------------------------------------------------------- |
+| `format` | [link](#default-prompt-format) | Configure the format of the prompt. |
+| `right_format` | `""` | See [Enable Right Prompt](/advanced-config/#enable-right-prompt) |
+| `scan_timeout` | `30` | Timeout for starship to scan files (in milliseconds). |
+| `command_timeout` | `500` | Timeout for commands executed by starship (in milliseconds). |
+| `add_newline` | `true` | Inserts blank line between shell prompts. |
+
### Example
@@ -179,6 +181,7 @@ format = """
$username\
$hostname\
$shlvl\
+$singularity\
$kubernetes\
$directory\
$vcsh\
@@ -191,6 +194,7 @@ $hg_branch\
$docker_context\
$package\
$cmake\
+$cobol\
$dart\
$deno\
$dotnet\
@@ -202,6 +206,7 @@ $helm\
$java\
$julia\
$kotlin\
+$lua\
$nim\
$nodejs\
$ocaml\
@@ -209,6 +214,7 @@ $perl\
$php\
$purescript\
$python\
+$rlang\
$red\
$ruby\
$rust\
@@ -229,7 +235,6 @@ $crystal\
$custom\
$cmd_duration\
$line_break\
-$lua\
$jobs\
$battery\
$time\
@@ -238,6 +243,13 @@ $shell\
$character"""
```
+If you just want to extend the default format, you can use `$all`; modules you explicitly add to the format will not be duplicated. Eg.
+
+```toml
+# Move the directory to the second line
+format="$all$directory$character"
+```
+
## AWS
The `aws` module shows the current AWS region and profile. This is based on `AWS_REGION`, `AWS_DEFAULT_REGION`, and `AWS_PROFILE` env var with `~/.aws/config` file. This module also shows an expiration timer when using temporary credentials.
@@ -479,6 +491,36 @@ The `cmake` module shows the currently installed version of [CMake](https://cmak
\*: This variable can only be used as a part of a style string
+## COBOL / GNUCOBOL
+
+The `cobol` module shows the currently installed version of COBOL. By default, the module will be shown if any of the following conditions are met:
+
+- The current directory contains any files ending in `.cob` or `.COB`
+- The current directory contains any files ending in `.cbl` or `.CBL`
+
+### Options
+
+| Option | Default | Description |
+| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
+| `symbol` | `"⚙️ "` | The symbol used before displaying the version of COBOL. |
+| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
+| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
+| `style` | `"bold blue"` | The style for the module. |
+| `detect_extensions` | `["cbl", "cob", "CBL", "COB"]` | Which extensions should trigger this module. |
+| `detect_files` | `[]` | Which filenames should trigger this module. |
+| `detect_folders` | `[]` | Which folders should trigger this module. |
+| `disabled` | `false` | Disables the `cobol` module. |
+
+### Variables
+
+| Variable | Example | Description |
+| --------- | ---------- | ------------------------------------ |
+| version | `v3.1.2.0` | The version of `cobol` |
+| 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
+
## Command Duration
The `cmd_duration` module shows how long the last command took to execute. The module will be shown only if the command took longer than two seconds, or the `min_time` config value, if it exists.
@@ -530,7 +572,7 @@ format = "underwent [$duration](bold yellow)"
## Conda
-The `conda` module shows the current conda environment, if `$CONDA_DEFAULT_ENV` is set.
+The `conda` module shows the current [Conda](https://docs.conda.io/en/latest/) environment, if `$CONDA_DEFAULT_ENV` is set.
::: tip
@@ -1017,6 +1059,35 @@ The `erlang` module shows the currently installed version of [Erlang/OTP](https:
format = "via [e $version](bold red) "
```
+## Fill
+
+The `fill` module fills any extra space on the line with a symbol. If multiple `fill` modules are present in a line they will split the space evenly between them. This is useful for aligning other modules.
+
+### Options
+
+| Option | Default | Description |
+| -------- | -------------- | --------------------------------- |
+| `symbol` | `"."` | The symbol used to fill the line. |
+| `style` | `"bold black"` | The style for the module. |
+
+### Example
+
+```toml
+# ~/.config/starship.toml
+format="AA $fill BB $fill CC"
+
+[fill]
+symbol = "-"
+style = "bold green"
+```
+
+Produces a prompt that looks like:
+
+```
+AA -------------------------------------------- BB -------------------------------------------- CC
+
+```
+
## Google Cloud (`gcloud`)
The `gcloud` module shows the current configuration for [`gcloud`](https://cloud.google.com/sdk/gcloud) CLI. This is based on the `~/.config/gcloud/active_config` file and the `~/.config/gcloud/configurations/config_{CONFIG NAME}` file and the `CLOUDSDK_CONFIG` env var.
@@ -1205,12 +1276,13 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y
### Options
-| Option | Default | Description |
-| --------------- | -------------------------------------------------------- | ---------------------------------- |
-| `added_style` | `"bold green"` | The style for the added count. |
-| `deleted_style` | `"bold red"` | The style for the deleted count. |
-| `format` | `'[+$added]($added_style) [-$deleted]($deleted_style) '` | The format for the module. |
-| `disabled` | `true` | Disables the `git_metrics` module. |
+| Option | Default | Description |
+| -------------------- | ------------------------------------------------------------ | ------------------------------------- |
+| `added_style` | `"bold green"` | The style for the added count. |
+| `deleted_style` | `"bold red"` | The style for the deleted count. |
+| `only_nonzero_diffs` | `true` | Render status only for changed items. |
+| `format` | `'([+$added]($added_style) )([-$deleted]($deleted_style) )'` | The format for the module. |
+| `disabled` | `true` | Disables the `git_metrics` module. |
### Variables
@@ -1318,9 +1390,9 @@ diverged = "⇕⇡${ahead_count}⇣${behind_count}"
behind = "⇣${count}"
```
-## Golang
+## Go
-The `golang` module shows the currently installed version of [Golang](https://golang.org/). By default the module will be shown if any of the following conditions are met:
+The `golang` module shows the currently installed version of [Go](https://golang.org/). By default the module will be shown if any of the following conditions are met:
- The current directory contains a `go.mod` file
- The current directory contains a `go.sum` file
@@ -2041,18 +2113,18 @@ symbol = "☁️ "
The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `composer`, `gradle`, `julia`, `mix` and `helm` packages.
- [**npm**](https://docs.npmjs.com/cli/commands/npm) – The `npm` package version is extracted from the `package.json` present in the current directory
-- [**cargo**](https://doc.rust-lang.org/cargo/) – The `cargo` package version is extracted from the `Cargo.toml` present in the current directory
-- [**nimble**](https://github.com/nim-lang/nimble) - The `nimble` package version is extracted from the `*.nimble` file present in the current directory with the `nimble dump` command
-- [**poetry**](https://python-poetry.org/) – The `poetry` package version is extracted from the `pyproject.toml` present in the current directory
-- [**python**](https://www.python.org) - The `python` package version is extracted from the `setup.cfg` present in the current directory
-- [**composer**](https://getcomposer.org/) – The `composer` package version is extracted from the `composer.json` present in the current directory
-- [**gradle**](https://gradle.org/) – The `gradle` package version is extracted from the `build.gradle` present
-- [**julia**](https://docs.julialang.org/en/v1/stdlib/Pkg/) - The package version is extracted from the `Project.toml` present
-- [**mix**](https://hexdocs.pm/mix/) - The `mix` package version is extracted from the `mix.exs` present
-- [**helm**](https://helm.sh/docs/helm/helm_package/) - The `helm` chart version is extracted from the `Chart.yaml` present
-- [**maven**](https://maven.apache.org/) - The `maven` package version is extracted from the `pom.xml` present
-- [**meson**](https://mesonbuild.com/) - The `meson` package version is extracted from the `meson.build` present
-- [**vlang**](https://vlang.io) - The `vlang` package version is extracted from the `v.mod` present
+- [**Cargo**](https://doc.rust-lang.org/cargo/) – The `cargo` package version is extracted from the `Cargo.toml` present in the current directory
+- [**Nimble**](https://github.com/nim-lang/nimble) - The `nimble` package version is extracted from the `*.nimble` file present in the current directory with the `nimble dump` command
+- [**Poetry**](https://python-poetry.org/) – The `poetry` package version is extracted from the `pyproject.toml` present in the current directory
+- [**Python**](https://www.python.org) - The `python` package version is extracted from the `setup.cfg` present in the current directory
+- [**Composer**](https://getcomposer.org/) – The `composer` package version is extracted from the `composer.json` present in the current directory
+- [**Gradle**](https://gradle.org/) – The `gradle` package version is extracted from the `build.gradle` present
+- [**Julia**](https://docs.julialang.org/en/v1/stdlib/Pkg/) - The package version is extracted from the `Project.toml` present
+- [**Mix**](https://hexdocs.pm/mix/) - The `mix` package version is extracted from the `mix.exs` present
+- [**Helm**](https://helm.sh/docs/helm/helm_package/) - The `helm` chart version is extracted from the `Chart.yaml` present
+- [**Maven**](https://maven.apache.org/) - The `maven` package version is extracted from the `pom.xml` present
+- [**Meson**](https://mesonbuild.com/) - The `meson` package version is extracted from the `meson.build` present
+- [**V**](https://vlang.io) - The `vlang` package version is extracted from the `v.mod` present
> ⚠️ The version being shown is that of the package whose source code is in your current directory, not your package manager.
@@ -2296,7 +2368,7 @@ python_binary = ["./venv/bin/python", "python", "python3", "python2"]
## R
-The `rlang` module shows the currently installed version of R. The module will be shown if any of the following conditions are met:
+The `rlang` module shows the currently installed version of [R](https://www.r-project.org/). The module will be shown if any of the following conditions are met:
- The current directory contains a file with the `.R` extension.
- The current directory contains a file with the `.Rd` extension.
@@ -2539,7 +2611,7 @@ disabled = false
## SHLVL
-The `shlvl` module shows the current `SHLVL` ("shell level") environment variable, if it is set to a number and meets or exceeds the specified threshold.
+The `shlvl` module shows the current [`SHLVL`](https://tldp.org/LDP/abs/html/internalvariables.html#SHLVLREF) ("shell level") environment variable, if it is set to a number and meets or exceeds the specified threshold.
### Options
@@ -2894,9 +2966,9 @@ The `vagrant` module shows the currently installed version of [Vagrant](https://
format = "via [⍱ $version](bold white) "
```
-## VLang
+## V
-The `vlang` module shows you your currently installed version of V. By default the module will be shown if any of the following conditions are met:
+The `vlang` module shows you your currently installed version of [V](https://vlang.io/). By default the module will be shown if any of the following conditions are met:
- The current directory contains a file with `.v` extension
- The current directory contains a `v.mod`, `vpkg.json` or `.vpkg-lock.json` file
@@ -2925,7 +2997,7 @@ The `vlang` module shows you your currently installed version of V. By default t
```toml
# ~/.config/starship.toml
-[v]
+[vlang]
format = "via [V $version](blue bold) "
```
diff --git a/docs/ar-SA/guide