From 794e4a4a047af77da3e005aecc5b7245d02746cc Mon Sep 17 00:00:00 2001 From: Muhammad Danish <88161975+mdanish-kh@users.noreply.github.com> Date: Sat, 31 Aug 2024 17:33:09 +0500 Subject: [PATCH] markdown lint fixes --- .../Add-WinGetSource.md | 3 ++- .../Assert-WinGetPackageManager.md | 5 ++-- .../Disable-WinGetSetting.md | 3 ++- .../Enable-WinGetSetting.md | 2 +- .../Export-WinGetPackage.md | 5 ++-- .../Find-WinGetPackage.md | 4 +++- .../Get-WinGetPackage.md | 3 ++- .../Get-WinGetSettings.md | 4 +++- .../Get-WinGetSource.md | 3 ++- .../Get-WinGetUserSettings.md | 3 ++- .../Get-WinGetVersion.md | 3 ++- .../Install-WinGetPackage.md | 17 ++++++++----- .../Microsoft.WinGet.Client.md | 24 ++++++++++++++++++- .../Remove-WinGetSource.md | 3 ++- .../Repair-WinGetPackageManager.md | 9 +++---- .../Reset-WinGetSource.md | 5 ++-- .../Set-WinGetUserSettings.md | 3 ++- .../Test-WinGetUserSettings.md | 5 ++-- .../Uninstall-WinGetPackage.md | 15 ++++++------ .../Update-WinGetPackage.md | 16 ++++++------- 20 files changed, 90 insertions(+), 45 deletions(-) diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Add-WinGetSource.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Add-WinGetSource.md index ca1c4c9c714..d2c84633adb 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Add-WinGetSource.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Add-WinGetSource.md @@ -10,11 +10,12 @@ title: Add-WinGetSource # Add-WinGetSource ## SYNOPSIS + Adds a new source. ## SYNTAX -``` +```powershell Add-WinGetSource -Name -Argument [-Type ] [] ``` diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Assert-WinGetPackageManager.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Assert-WinGetPackageManager.md index 176426fe284..bc6b6380f6d 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Assert-WinGetPackageManager.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Assert-WinGetPackageManager.md @@ -10,19 +10,20 @@ title: Assert-WinGetPackageManager # Assert-WinGetPackageManager ## SYNOPSIS + Verifies that WinGet is installed properly. ## SYNTAX ### IntegrityVersionSet (Default) -``` +```powershell Assert-WinGetPackageManager [-Version ] [] ``` ### IntegrityLatestSet -``` +```powershell Assert-WinGetPackageManager [-Latest] [-IncludePrerelease] [] ``` diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Disable-WinGetSetting.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Disable-WinGetSetting.md index 4c78a1d9a38..07717d18488 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Disable-WinGetSetting.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Disable-WinGetSetting.md @@ -10,11 +10,12 @@ title: Disable-WinGetSetting # Disable-WinGetSetting ## SYNOPSIS + Disables an administrative setting. ## SYNTAX -``` +```powershell Disable-WinGetSetting [-Name] [] ``` diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Enable-WinGetSetting.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Enable-WinGetSetting.md index d4b03f2b9ec..5c73cd90bd9 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Enable-WinGetSetting.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Enable-WinGetSetting.md @@ -15,7 +15,7 @@ Enables WinGet administrative settings. ## SYNTAX -``` +```powershell Enable-WinGetSetting [-Name] [] ``` diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Export-WinGetPackage.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Export-WinGetPackage.md index e6e81882b73..ec6dc639115 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Export-WinGetPackage.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Export-WinGetPackage.md @@ -10,13 +10,14 @@ title: Export-WinGetPackage # Export-WinGetPackage ## SYNOPSIS + Downloads a WinGet package and its dependencies. ## SYNTAX ### FoundSet (Default) -``` +```powershell Export-WinGetPackage [-DownloadDirectory ] [-AllowHashMismatch] [-Architecture ] [-InstallerType ] [-Locale ] [-Scope ] [-SkipDependencies] [-Version ] [-Id ] [-Name ] @@ -26,7 +27,7 @@ Export-WinGetPackage [-DownloadDirectory ] [-AllowHashMismatch] ### GivenSet -``` +```powershell Export-WinGetPackage [-DownloadDirectory ] [-AllowHashMismatch] [-Architecture ] [-InstallerType ] [-Locale ] [-Scope ] [-SkipDependencies] [[-PSCatalogPackage] ] diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Find-WinGetPackage.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Find-WinGetPackage.md index 30e3ed283ec..ac7423fa004 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Find-WinGetPackage.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Find-WinGetPackage.md @@ -10,11 +10,12 @@ title: Find-WinGetPackage # Find-WinGetPackage ## SYNOPSIS + Searches for packages from configured sources. ## SYNTAX -``` +```powershell Find-WinGetPackage [-Tag ] [-Command ] [-Count ] [-Id ] [-Name ] [-Moniker ] [-Source ] [[-Query] ] [-MatchOption ] [] @@ -171,6 +172,7 @@ Accept wildcard characters: False Specify one or more strings to search for. By default, the command searches all configured sources. The command compares the value provided to the following package manifest properties: + - `PackageIdentifier` - `PackageName` - `Moniker` diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetPackage.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetPackage.md index 4ca6d316da5..8dea4de10d2 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetPackage.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetPackage.md @@ -10,11 +10,12 @@ title: Get-WinGetPackage # Get-WinGetPackage ## SYNOPSIS + Lists installed packages. ## SYNTAX -``` +```powershell Get-WinGetPackage [-Tag ] [-Command ] [-Count ] [-Id ] [-Name ] [-Moniker ] [-Source ] [[-Query] ] [-MatchOption ] [] diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetSettings.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetSettings.md index 6c828f7b28a..2036f3a19d8 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetSettings.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetSettings.md @@ -10,17 +10,19 @@ title: Get-WinGetSettings # Get-WinGetSettings ## SYNOPSIS + Gets WinGet configuration settings. ## SYNTAX -``` +```powershell Get-WinGetSettings [-AsPlainText] [] ``` ## DESCRIPTION This command gets the WinGet configuration settings. The settings include: + - the schema - administrative settings - the location of the user settings file diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetSource.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetSource.md index d0cb84a4593..05c34606938 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetSource.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetSource.md @@ -10,11 +10,12 @@ title: Get-WinGetSource # Get-WinGetSource ## SYNOPSIS + Lists configured WinGet sources. ## SYNTAX -``` +```powershell Get-WinGetSource [[-Name] ] [] ``` diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetUserSettings.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetUserSettings.md index 9c6ef88b231..52c9a0ae7a2 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetUserSettings.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetUserSettings.md @@ -10,11 +10,12 @@ title: Get-WinGetUserSettings # Get-WinGetUserSettings ## SYNOPSIS + Gets user settings for WinGet. ## SYNTAX -``` +```powershell Get-WinGetUserSettings [] ``` diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetVersion.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetVersion.md index dd216df1987..d694b5d235f 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetVersion.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetVersion.md @@ -10,11 +10,12 @@ title: Get-WinGetVersion # Get-WinGetVersion ## SYNOPSIS + Gets the installed version of WinGet. ## SYNTAX -``` +```powershell Get-WinGetVersion [] ``` diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Install-WinGetPackage.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Install-WinGetPackage.md index 037d872cd4f..be4b06d5575 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Install-WinGetPackage.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Install-WinGetPackage.md @@ -10,13 +10,14 @@ title: Install-WinGetPackage # Install-WinGetPackage ## SYNOPSIS + Installs a WinGet Package. ## SYNTAX ### FoundSet (Default) -``` +```powershell Install-WinGetPackage [-Mode ] [-Override ] [-Custom ] [-Location ] [-Log ] [-Force] [-Header ] [-AllowHashMismatch] [-Architecture ] [-InstallerType ] [-Locale ] @@ -27,7 +28,7 @@ Install-WinGetPackage [-Mode ] [-Override ] [-Cust ### GivenSet -``` +```powershell Install-WinGetPackage [-Mode ] [-Override ] [-Custom ] [-Location ] [-Log ] [-Force] [-Header ] [-AllowHashMismatch] [-Architecture ] [-InstallerType ] [-Locale ] @@ -188,6 +189,7 @@ Accept wildcard characters: False A package may contain multiple installer types. Use this parameter to select the installer you want to use. The parameter accepts the following values: + - `Default` - `Inno` - `Wix` @@ -267,6 +269,7 @@ Accept wildcard characters: False ### -MatchOption Specify the match option for a WinGet package query. This parameter accepts the following values: + - `Equals` - `EqualsCaseInsensitive` - `StartsWithCaseInsensitive` @@ -288,6 +291,7 @@ Accept wildcard characters: False ### -Mode Specify the output mode for the installer. The parameter accepts the following values: + - `Default` - `Silent` - `Interactive` @@ -375,10 +379,11 @@ Accept wildcard characters: False Specify one or more strings to search for. By default, the command searches all configured sources. The command compares the value provided to the following package manifest properties: - - `PackageIdentifier` - - `PackageName` - - `Moniker` - - `Tags` + +- `PackageIdentifier` +- `PackageName` +- `Moniker` +- `Tags` The command does a case-insensitive substring comparison of these properties. diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Microsoft.WinGet.Client.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Microsoft.WinGet.Client.md index 44689febb52..f2a9bc00528 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Microsoft.WinGet.Client.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Microsoft.WinGet.Client.md @@ -2,70 +2,92 @@ Module Name: Microsoft.WinGet.Client ms.date: 08/01/2024 Module Guid: e11157e2-cd24-4250-83b8-c6654ea4926a -Download Help Link: +Download Help Link: Help Version: 1.8.0 Locale: en-US title: Microsoft.WinGet.Client Module --- # Microsoft.WinGet.Client Module + ## Description + Microsoft WinGet Client Module for the Windows Package Manager ## Microsoft.WinGet.Client Cmdlets + ### [Add-WinGetSource](Add-WinGetSource.md) + Adds a new WinGet source. ### [Assert-WinGetPackageManager](Assert-WinGetPackageManager.md) + Verifies WinGet is installed properly. ### [Disable-WinGetSetting](Disable-WinGetSetting.md) + Disables an administrative setting. ### [Enable-WinGetSetting](Enable-WinGetSetting.md) + Enables WinGet administrative settings. ### [Export-WinGetPackage](Export-WinGetPackage.md) + Downloads a package. ### [Find-WinGetPackage](Find-WinGetPackage.md) + Searches configured sources for packages. ### [Get-WinGetPackage](Get-WinGetPackage.md) + Gets installed packages. ### [Get-WinGetSettings](Get-WinGetSettings.md) + Gets WinGet settings. ### [Get-WinGetSource](Get-WinGetSource.md) + Gets configured WinGet sources. ### [Get-WinGetUserSettings](Get-WinGetUserSettings.md) + Gets user settings for WinGet. ### [Get-WinGetVersion](Get-WinGetVersion.md) + Gets the installed version of WinGet. ### [Install-WinGetPackage](Install-WinGetPackage.md) + Install a WinGet Package. ### [Remove-WinGetSource](Remove-WinGetSource.md) + Removes a configured source. ### [Repair-WinGetPackageManager](Repair-WinGetPackageManager.md) + Repairs the WinGet client. ### [Reset-WinGetSource](Reset-WinGetSource.md) + Resets default WinGet sources. ### [Set-WinGetUserSettings](Set-WinGetUserSettings.md) + Sets WinGet settings. ### [Test-WinGetUserSettings](Test-WinGetUserSettings.md) + Tests WinGet settings. ### [Uninstall-WinGetPackage](Uninstall-WinGetPackage.md) + Uninstalls a WinGet Package. ### [Update-WinGetPackage](Update-WinGetPackage.md) + Updates a WinGet Package. diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Remove-WinGetSource.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Remove-WinGetSource.md index 99c85f981c5..cf16c2fbbfd 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Remove-WinGetSource.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Remove-WinGetSource.md @@ -10,11 +10,12 @@ title: Remove-WinGetSource # Remove-WinGetSource ## SYNOPSIS + Removes a configured source. ## SYNTAX -``` +```powershell Remove-WinGetSource -Name [] ``` diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Repair-WinGetPackageManager.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Repair-WinGetPackageManager.md index b0f6e28a696..dfb448310ec 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Repair-WinGetPackageManager.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Repair-WinGetPackageManager.md @@ -10,19 +10,20 @@ title: Repair-WinGetPackageManager # Repair-WinGetPackageManager ## SYNOPSIS + Repairs the installation of the WinGet client on your computer. ## SYNTAX ### IntegrityVersionSet (Default) -``` +```powershell Repair-WinGetPackageManager [-AllUsers] [-Force] [-Version ] [] ``` ### IntegrityLatestSet -``` +```powershell Repair-WinGetPackageManager [-AllUsers] [-Force] [-Latest] [-IncludePreRelease] [] ``` @@ -30,8 +31,8 @@ Repair-WinGetPackageManager [-AllUsers] [-Force] [-Latest] [-IncludePreRelease] ## DESCRIPTION This command repairs the installation of the WinGet client on your computer by installing the -specified version or the latest version of the client. This command can also install the WinGet -client if it is not already installed on your machine. It ensures that the client is installed +specified version or the latest version of the client. This command can also install the WinGet +client if it is not already installed on your machine. It ensures that the client is installed in a working state. ## EXAMPLES diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Reset-WinGetSource.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Reset-WinGetSource.md index 7d4630ac6f4..86579815603 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Reset-WinGetSource.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Reset-WinGetSource.md @@ -10,19 +10,20 @@ title: Reset-WinGetSource # Reset-WinGetSource ## SYNOPSIS + Resets WinGet sources. ## SYNTAX ### DefaultSet (Default) -``` +```powershell Reset-WinGetSource -Name [] ``` ### OptionalSet -``` +```powershell Reset-WinGetSource -All [] ``` diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Set-WinGetUserSettings.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Set-WinGetUserSettings.md index b76a7c4f4a7..5f7e64c421a 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Set-WinGetUserSettings.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Set-WinGetUserSettings.md @@ -10,11 +10,12 @@ title: Set-WinGetUserSettings # Set-WinGetUserSettings ## SYNOPSIS + Sets configuration settings of the WinGet client for the current user. ## SYNTAX -``` +```powershell Set-WinGetUserSettings -UserSettings [-Merge] [] ``` diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Test-WinGetUserSettings.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Test-WinGetUserSettings.md index fbc0100c95f..cdeca4a034f 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Test-WinGetUserSettings.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Test-WinGetUserSettings.md @@ -10,11 +10,12 @@ title: Test-WinGetUserSettings # Test-WinGetUserSettings ## SYNOPSIS + Tests the current state of WinGet user settings. ## SYNTAX -``` +```powershell Test-WinGetUserSettings -UserSettings [-IgnoreNotSet] [] ``` @@ -37,7 +38,7 @@ Test-WinGetUserSettings -UserSettings @{ ``` This example shows how to confirm that your current user settings match specific values. The -command returns `$false` if it is not an exact match. +command returns `$false` if it is not an exact match. ### Example 2: Test only progress bar setting diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Uninstall-WinGetPackage.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Uninstall-WinGetPackage.md index 91d92f7078f..99168b7b77e 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Uninstall-WinGetPackage.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Uninstall-WinGetPackage.md @@ -10,13 +10,14 @@ title: Uninstall-WinGetPackage # Uninstall-WinGetPackage ## SYNOPSIS + Uninstalls a WinGet Package. ## SYNTAX ### FoundSet (Default) -``` +```powershell Uninstall-WinGetPackage [-Mode ] [-Force] [-Log ] [-Version ] [-Id ] [-Name ] [-Moniker ] [-Source ] [[-Query] ] [-MatchOption ] [-WhatIf] [-Confirm] [] @@ -24,7 +25,7 @@ Uninstall-WinGetPackage [-Mode ] [-Force] [-Log ### GivenSet -``` +```powershell Uninstall-WinGetPackage [-Mode ] [-Force] [-Log ] [[-PSCatalogPackage] ] [-Version ] [-WhatIf] [-Confirm] [] @@ -155,7 +156,7 @@ Accept wildcard characters: False ### -Mode Specify the output mode for the installer. The parameter accepts the following values: - + - `Default` - `Silent` - `Interactive` @@ -233,10 +234,10 @@ Specify one or more strings to search for. By default, the command searches all Wildcards are not supported. The command compares the value provided to the following package manifest properties: - - `PackageIdentifier` - - `PackageName` - - `Moniker` - - `Tags` +- `PackageIdentifier` +- `PackageName` +- `Moniker` +- `Tags` The command does a case-insensitive substring comparison of these properties. diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Update-WinGetPackage.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Update-WinGetPackage.md index 66b9cb45c80..9e5391bec46 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Update-WinGetPackage.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Update-WinGetPackage.md @@ -10,13 +10,14 @@ title: Update-WinGetPackage # Update-WinGetPackage ## SYNOPSIS + Installs a newer version of a previously installed WinGet package. ## SYNTAX ### FoundSet (Default) -``` +```powershell Update-WinGetPackage [-IncludeUnknown] [-Mode ] [-Override ] [-Custom ] [-Location ] [-Log ] [-Force] [-Header ] [-AllowHashMismatch] [-Architecture ] [-InstallerType ] [-Locale ] @@ -27,7 +28,7 @@ Update-WinGetPackage [-IncludeUnknown] [-Mode ] [-Override ### GivenSet -``` +```powershell Update-WinGetPackage [-IncludeUnknown] [-Mode ] [-Override ] [-Custom ] [-Location ] [-Log ] [-Force] [-Header ] [-AllowHashMismatch] [-Architecture ] [-InstallerType ] [-Locale ] @@ -59,7 +60,6 @@ Update-WinGetPackage -Id Microsoft.PowerShell ``` This example shows how to update a package by the specifying the package identifier. - If the package identifier is available from more than one source, you must provide additional search criteria to select a specific instance of the package. @@ -218,7 +218,7 @@ Accept wildcard characters: False A package may contain multiple installer types. Use this parameter to select the installer you want to use. The parameter accepts the following values: - + - `Default` - `Inno` - `Wix` @@ -414,10 +414,10 @@ Specify one or more strings to search for. By default, the command searches all Wildcards are not supported. The command compares the value provided to the following package manifest properties: - - `PackageIdentifier` - - `PackageName` - - `Moniker` - - `Tags` +- `PackageIdentifier` +- `PackageName` +- `Moniker` +- `Tags` The command does a case-insensitive substring comparison of these properties.