diff options
Diffstat (limited to 'docs')
102 files changed, 6690 insertions, 5017 deletions
diff --git a/docs/ar-SA/README.md b/docs/ar-SA/README.md index 9091f2c9c..332f46bc4 100644 --- a/docs/ar-SA/README.md +++ b/docs/ar-SA/README.md @@ -120,7 +120,7 @@ description: Starship is the minimal, blazing fast, and extremely customizable p #### Elvish - ::: warning يدعم فقط elvish v0.17 أو أعلى. ::: + ::: warning يدعم فقط elvish v0.18 أو أعلى. ::: أضف ما يلي إلى نهاية `~/.elvish/rc.elv`: diff --git a/docs/ar-SA/advanced-config/README.md b/docs/ar-SA/advanced-config/README.md index 9ba38747b..c4c9f7fd6 100644 --- a/docs/ar-SA/advanced-config/README.md +++ b/docs/ar-SA/advanced-config/README.md @@ -131,7 +131,7 @@ Invoke-Expression (&starship init powershell) 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). +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, xonsh, cmd. diff --git a/docs/ar-SA/config/README.md b/docs/ar-SA/config/README.md index 4204ae376..8bcf47c84 100644 --- a/docs/ar-SA/config/README.md +++ b/docs/ar-SA/config/README.md @@ -9,6 +9,9 @@ mkdir -p ~/.config && touch ~/.config/starship.toml All configuration for starship is done in this [TOML](https://github.com/toml-lang/toml) file: ```toml +# Get editor completions based on the config schema +"$schema" = 'https://starship.rs/config-schema.json' + # Inserts a blank line between shell prompts add_newline = true @@ -199,6 +202,7 @@ $hg_branch\ $docker_context\ $package\ $buf\ +$c\ $cmake\ $cobol\ $container\ @@ -235,6 +239,7 @@ $vagrant\ $zig\ $nix_shell\ $conda\ +$spack\ $memory_usage\ $aws\ $gcloud\ @@ -263,9 +268,9 @@ format = "$all$directory$character" ## AWS -The `aws` module shows the current AWS region and profile when credentials, a `credential_process` or a `sso_start_url` have been setup. 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. +The `aws` module shows the current AWS region and profile when credentials, a `credential_process` or a `sso_start_url` have been setup. Alternatively, you can force this module to show the region and profile even when the credentials have not been setup with the `force_display` option. 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. -The module will display a profile only if its credentials are present in `~/.aws/credentials` or a `credential_process` is defined in `~/.aws/config`. Alternatively, having any of the `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, or `AWS_SESSION_TOKEN` env vars defined will also suffice. +The module will display a profile only if its credentials are present in `~/.aws/credentials` or a `credential_process` is defined in `~/.aws/config`. Alternatively, having any of the `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, or `AWS_SESSION_TOKEN` env vars defined will also suffice. If the option `force_display` is set to `true`, all available information will be displayed even if the conditions above are not respected. When using [aws-vault](https://github.com/99designs/aws-vault) the profile is read from the `AWS_VAULT` env var and the credentials expiration date is read from the `AWS_SESSION_EXPIRATION` env var. @@ -275,15 +280,16 @@ When using [AWSume](https://awsu.me) the profile is read from the `AWSUME_PROFIL ### Options -| Option | الافتراضي | الوصف | -| ------------------- | -------------------------------------------------------------------- | ----------------------------------------------------------------- | -| `format` | `'on [$symbol($profile )(\($region\) )(\[$duration\])]($style)'` | The format for the module. | -| `symbol` | `"☁️ "` | The symbol used before displaying the current AWS profile. | -| `region_aliases` | | Table of region aliases to display in addition to the AWS name. | -| `profile_aliases` | | Table of profile aliases to display in addition to the AWS name. | -| `style` | `"bold yellow"` | The style for the module. | -| `expiration_symbol` | `X` | The symbol displayed when the temporary credentials have expired. | -| `disabled` | `false` | Disables the `AWS` module. | +| Option | الافتراضي | الوصف | +| ------------------- | -------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | +| `format` | `'on [$symbol($profile )(\($region\) )(\[$duration\])]($style)'` | The format for the module. | +| `symbol` | `"☁️ "` | The symbol used before displaying the current AWS profile. | +| `region_aliases` | | Table of region aliases to display in addition to the AWS name. | +| `profile_aliases` | | Table of profile aliases to display in addition to the AWS name. | +| `style` | `"bold yellow"` | The style for the module. | +| `expiration_symbol` | `X` | The symbol displayed when the temporary credentials have expired. | +| `disabled` | `false` | Disables the `AWS` module. | +| `force_display` | `false` | If `true` displays info even if `credentials`, `credential_process` or `sso_start_url` have not been setup. | ### Variables @@ -472,6 +478,52 @@ The `buf` module shows the currently installed version of [Buf](https://buf.buil symbol = "🦬 " ``` +## C + +The `c` module shows some information about your C compiler. By default the module will be shown if the current directory contains a `.c` or `.h` file. + +### Options + +| Option | الافتراضي | الوصف | +| ------------------- | --------------------------------------------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version(-$name) )]($style)"` | The format string for the module. | +| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"C "` | The symbol used before displaying the compiler details | +| `detect_extensions` | `["c", "h"]` | Which extensions should trigger this module. | +| `detect_files` | `[]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `commands` | [ [ "cc", "--version" ], [ "gcc", "--version" ], [ "clang", "--version" ] ] | How to detect what the compiler is | +| `style` | `"bold 149"` | The style for the module. | +| `disabled` | `false` | Disables the `c` module. | + +### Variables + +| Variable | مثال | الوصف | +| -------- | ------ | ------------------------------------ | +| name | clang | The name of the compiler | +| version | 13.0.0 | The version of the compiler | +| symbol | | Mirrors the value of option `symbol` | +| style | | Mirrors the value of option `style` | + +NB that `version` is not in the default format. + +### Commands + +The `commands` option accepts a list of commands to determine the compiler version and name. + +Each command is represented as a list of the executable name, followed by its arguments, usually something like `["mycc", "--version"]`. Starship will try executing each command until it gets a result on STDOUT. + +If a C compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/). + +### مثال + +```toml +# ~/.config/starship.toml + +[c] +format = "via [$name $version]($style)" +``` + ## Character The `character` module shows a character (usually an arrow) beside where the text is entered in your terminal. @@ -962,7 +1014,7 @@ You'll also need the .NET Core SDK installed in order to use it correctly. Internally, this module uses its own mechanism for version detection. Typically it is twice as fast as running `dotnet --version`, but it may show an incorrect version if your .NET project has an unusual directory layout. If accuracy is more important than speed, you can disable the mechanism by setting `heuristic = false` in the module options. -The module will also show the Target Framework Moniker (<https://docs.microsoft.com/en-us/dotnet/standard/frameworks#supported-target-framework-versions>) when there is a csproj file in the current directory. +The module will also show the Target Framework Moniker (<https://docs.microsoft.com/en-us/dotnet/standard/frameworks#supported-target-frameworks>) when there is a `.csproj` file in the current directory. ### Options @@ -1103,13 +1155,13 @@ default = "unknown user" ### Options -| Option | الافتراضي | الوصف | -| ---------- | ------------------------------ | ---------------------------------------------------------------------------- | -| `symbol` | `""` | The symbol used before displaying the variable value. | -| `variable` | | The environment variable to be displayed. | -| `default` | | The default value to be displayed when the selected variable is not defined. | -| `format` | `"with [$env_value]($style) "` | The format for the module. | -| `disabled` | `false` | Disables the `en |