Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update settings docs #4951

Merged
merged 2 commits into from
Nov 8, 2024
Merged

Update settings docs #4951

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0c1c93a
Update settings
JohnMcPMS Nov 8, 2024
f809dbd
Use MSDN link to accent color since github blocks custom protocol lin…
JohnMcPMS Nov 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 9 additions & 5 deletions doc/Settings.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ The `source` settings involve configuration to the WinGet source.
A positive integer represents the update interval in minutes. The check for updates only happens when a source is used. A zero will disable the check for updates to a source. Any other values are invalid.

- Disable: 0
- Default: 5
- Default: 15

To manually update the source use `winget source update`

Expand All @@ -33,11 +33,15 @@ The `visual` settings involve visual elements that are displayed by WinGet

### progressBar

Color of the progress bar that WinGet displays when not specified by arguments.
Style of the progress spinner and bar that WinGet displays when not specified by arguments. In addition, all options except `disabled` send [Virtual Terminal progress](https://conemu.github.io/en/AnsiEscapeCodes.html#ConEmu_specific_OSC) updates that any supporting terminal may display visually.

- accent (default)
- retro
- rainbow
|Value|Description|Release|
|---|---|---|
|`accent` (default)|Use the [Windows Accent color](https://support.microsoft.com/en-us/windows/change-colors-in-windows-d26ef4d6-819a-581c-1581-493cfcc005fe)|1.0|
|`retro`|Use the current foreground terminal color|1.0|
|`rainbow`|Progress through a rainbow of colors|1.0|
|`sixel`|Use sixel images; requires a terminal that supports displaying sixels, such as [Windows Terminal](https://github.com/microsoft/terminal/releases) 1.22.2362 or later|1.9|
|`disabled`|No progress will be displayed|1.9|

```json
"visual": {
Expand Down
Loading