diff --git a/reference/5.1/Microsoft.PowerShell.Core/About/about_CommonParameters.md b/reference/5.1/Microsoft.PowerShell.Core/About/about_CommonParameters.md index 6351bd9161c..2189f71105d 100644 --- a/reference/5.1/Microsoft.PowerShell.Core/About/about_CommonParameters.md +++ b/reference/5.1/Microsoft.PowerShell.Core/About/about_CommonParameters.md @@ -1,7 +1,7 @@ --- description: Describes the parameters that can be used with any cmdlet. Locale: en-US -ms.date: 04/24/2025 +ms.date: 09/02/2025 no-loc: [Debug, Verbose, Confirm] online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_commonparameters?view=powershell-5.1&WT.mc_id=ps-gethelp schema: 2.0.0 @@ -21,7 +21,7 @@ they're automatically available to any cmdlet. You can use the common parameters with any cmdlet, but they might not have an effect on all cmdlets. For example, if a cmdlet doesn't generate any verbose -output, using the **Verbose** common parameter has no effect. +output, using the `Verbose` common parameter has no effect. The common parameters are also available on advanced functions that use the `CmdletBinding` attribute or the `Parameter` attribute. When you use these @@ -37,21 +37,21 @@ For more information, see [about_Preference_Variables][03]. The following list displays the common parameters. Their aliases are listed in parentheses. -- **Debug** (db) -- **ErrorAction** (ea) -- **ErrorVariable** (ev) -- **InformationAction** (infa) -- **InformationVariable** (iv) -- **OutVariable** (ov) -- **OutBuffer** (ob) -- **PipelineVariable** (pv) -- **ProgressAction** (proga) -- **Verbose** (vb) -- **WarningAction** (wa) -- **WarningVariable** (wv) - -The **Action** parameters are **ActionPreference** type values. -**ActionPreference** is an enumeration with the following values: +- `Debug` (db) +- `ErrorAction` (ea) +- `ErrorVariable` (ev) +- `InformationAction` (infa) +- `InformationVariable` (iv) +- `OutVariable` (ov) +- `OutBuffer` (ob) +- `PipelineVariable` (pv) +- `ProgressAction` (proga) +- `Verbose` (vb) +- `WarningAction` (wa) +- `WarningVariable` (wv) + +The **Action** parameters are `ActionPreference` type values. +`ActionPreference` is an enumeration with the following values: | Name | Value | | ------------------ | ----- | @@ -70,8 +70,8 @@ offer these parameters. The risk mitigation parameters are: -- **WhatIf** (wi) -- **Confirm** (cf) +- `WhatIf` (wi) +- `Confirm` (cf) ## Common parameter descriptions @@ -92,19 +92,19 @@ Accept wildcard characters: False ``` By default, debugging messages aren't displayed because the value of the -`$DebugPreference` variable is **SilentlyContinue**. +`$DebugPreference` variable is `SilentlyContinue`. -In interactive mode, the **Debug** parameter overrides the value of the +In interactive mode, the `Debug` parameter overrides the value of the `$DebugPreference` variable for the current command, setting the value of -`$DebugPreference` to **Inquire**. +`$DebugPreference` to `Inquire`. -In non-interactive mode, the **Debug** parameter overrides the value of the +In non-interactive mode, the `Debug` parameter overrides the value of the `$DebugPreference` variable for the current command, setting the value of -`$DebugPreference` to **Continue**. +`$DebugPreference` to `Continue`. -`-Debug:$true` has the same effect as `-Debug`. Use `-Debug:$false` to -suppress the display of debugging messages when `$DebugPreference` isn't -**SilentlyContinue**, which is the default. +`-Debug:$true` has the same effect as `-Debug`. Use `-Debug:$false` to suppress +the display of debugging messages when `$DebugPreference` isn't +`SilentlyContinue`, which is the default. ### -ErrorAction @@ -124,13 +124,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -The **ErrorAction** parameter overrides the value of the -`$ErrorActionPreference` variable for the current command. Because the default -value of the `$ErrorActionPreference` variable is **Continue**, error messages -are displayed and execution continues unless you use the **ErrorAction** -parameter. +The `ErrorAction` parameter overrides the value of the `$ErrorActionPreference` +variable for the current command. Because the default value of the +`$ErrorActionPreference` variable is `Continue`, error messages are displayed +and execution continues unless you use the `ErrorAction` parameter. -The **ErrorAction** parameter has no effect on terminating errors (such as +The `ErrorAction` parameter has no effect on terminating errors (such as missing data, parameters that aren't valid, or insufficient permissions) that prevent a command from completing successfully. @@ -139,8 +138,8 @@ prevent a command from completing successfully. - `-ErrorAction:Continue` displays the error message and continues executing the command. `Continue` is the default. - `-ErrorAction:Ignore` suppresses the error message and continues executing - the command. Unlike **SilentlyContinue**, **Ignore** doesn't add the error - message to the `$Error` automatic variable. The **Ignore** value is + the command. Unlike `SilentlyContinue`, `Ignore` doesn't add the error + message to the `$Error` automatic variable. The `Ignore` value is introduced in PowerShell 3.0. - `-ErrorAction:Inquire` displays the error message and prompts you for confirmation before continuing execution. This value is rarely used. @@ -152,7 +151,7 @@ prevent a command from completing successfully. in PowerShell 6 and beyond. > [!NOTE] -> The **ErrorAction** parameter overrides, but doesn't replace the value of the +> The `ErrorAction` parameter overrides, but doesn't replace the value of the > `$ErrorActionPreference` variable when the parameter is used in a command to > run a script or function. @@ -161,9 +160,9 @@ prevent a command from completing successfully. Error records are automatically store in the `$Error` automatic variable. For more information, see [about_Automatic_Variables][02]. -When you use the **ErrorVariable** parameter on a command, PowerShell also -stores the error records emitted by the command in the variable specified by -the parameter. +When you use the `ErrorVariable` parameter on a command, PowerShell also stores +the error records emitted by the command in the variable specified by the +parameter. ```yaml Type: String @@ -179,8 +178,8 @@ By default, new error messages overwrite error messages that are already stored in the variable. To append the error message to the variable content, put a plus sign (`+`) before the variable name. -For example, the following command creates the `$a` variable and then stores any -errors in it: +For example, the following command creates the `$a` variable and then stores +any errors in it: ```powershell Get-Process -Id 6 -ErrorVariable a @@ -211,11 +210,11 @@ from all the commands in the session. You can use array notation, such as ### -InformationAction Introduced in PowerShell 5.0. Within the command or script in which it's used, -the **InformationAction** common parameter overrides the value of the +the `InformationAction` common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to -**SilentlyContinue**. When you use `Write-Information` in a script with -**InformationAction**, `Write-Information` values are shown depending on the -value of the **InformationAction** parameter. For more information about +`SilentlyContinue`. When you use `Write-Information` in a script with +`InformationAction`, `Write-Information` values are shown depending on the +value of the `InformationAction` parameter. For more information about `$InformationPreference`, see [about_Preference_Variables][03]. ```yaml @@ -235,7 +234,7 @@ Accept wildcard characters: False - `-InformationAction:Stop` stops a command or script at an occurrence of the `Write-Information` command. - `-InformationAction:Ignore` suppresses the informational message and - continues running the command. Unlike **SilentlyContinue**, **Ignore** + continues running the command. Unlike `SilentlyContinue`, `Ignore` completely forgets the informational message; it doesn't add the informational message to the information stream. - `-InformationAction:Inquire` displays the informational message that you @@ -249,22 +248,22 @@ Accept wildcard characters: False aren't (Default) displayed, and the script continues without interruption. > [!NOTE] -> The **InformationAction** parameter overrides, but doesn't replace the +> The `InformationAction` parameter overrides, but doesn't replace the > value of the `$InformationAction` preference variable when the parameter > is used in a command to run a script or function. ### -InformationVariable -Introduced in PowerShell 5.0. When you use the **InformationVariable** common +Introduced in PowerShell 5.0. When you use the `InformationVariable` common parameter, information records are stored in the variable specified by the parameter. And PowerShell cmdlet can write information records to the -**Information** stream. You can also use the `Write-Information` cmdlet to -write information records. +`Information` stream. You can also use the `Write-Information` cmdlet to write +information records. Information records are displayed as messages in the console by default. You -can control the display of information record by using the -**InformationAction** common parameter. You can also change the behavior using -the `$InformationPreference` preference variable. For more information about +can control the display of information record by using the `InformationAction` +common parameter. You can also change the behavior using the +`$InformationPreference` preference variable. For more information about `$InformationPreference`, see [about_Preference_Variables][03]. > [!NOTE] @@ -366,19 +365,19 @@ $out ``` > [!NOTE] -> The variable created by the **OutVariable** parameter is a +> The variable created by the `OutVariable` parameter is a > `[System.Collections.ArrayList]`. ### -PipelineVariable -**PipelineVariable** allows access to the most recent value passed into the -next pipeline segment by the command that uses this parameter. Any command in -the pipeline can access the value using the named **PipelineVariable**. The -value is assigned to the variable when it's passed into the next pipeline -segment. This makes the **PipelineVariable** easier to use than a specific -temporary variable, which might need to be assigned in multiple locations. +`PipelineVariable` allows access to the most recent value passed into the next +pipeline segment by the command that uses this parameter. Any command in the +pipeline can access the value using the named `PipelineVariable`. The value is +assigned to the variable when it's passed into the next pipeline segment. This +makes the `PipelineVariable` easier to use than a specific temporary variable, +which might need to be assigned in multiple locations. -Unlike `$_` or `$PSItem`, using a **PipelineVariable** allows any pipeline +Unlike `$_` or `$PSItem`, using a `PipelineVariable` allows any pipeline command to access pipeline values passed (and saved) by commands other than the immediately preceding command. Pipeline commands can access the last value piped from while processing the next item passing through the pipeline. This @@ -386,7 +385,7 @@ allows a command to _feed back_ its output to a previous command (or itself). >[!NOTE] > Advanced functions can have up to three script blocks: `begin`, `process`, -> and `end`. When using the **PipelineVariable** parameter with advanced +> and `end`. When using the `PipelineVariable` parameter with advanced > functions, only values from the first defined script block are assigned to > the variable as the function runs. For more information, see > [Advanced functions][05]. PowerShell 7.2 corrects this behavior. @@ -404,22 +403,22 @@ Accept wildcard characters: False Valid values are strings, the same as for any variable names. > [!CAUTION] -> The **PipelineVariable** is scoped to the pipeline in which it's invoked. +> The `PipelineVariable` is scoped to the pipeline in which it's invoked. > Variables outside the pipeline, which use same name, are cleared before the -> pipeline is executed. The **PipelineVariable** goes out of scope when the +> pipeline is executed. The `PipelineVariable` goes out of scope when the > pipeline terminates. If multiple commands within the pipeline specify the -> same **PipelineVariable** then there is only one shared variable. That -> variable is updated with the most recent piped output from the command that -> specifies the variable. +> same `PipelineVariable` then there is only one shared variable. That variable +> is updated with the most recent piped output from the command that specifies +> the variable. > > Some _blocking_ commands collect all the pipeline items before producing any > output, for example `Sort-Object` or `Select-Object -Last`. Any -> **PipelineVariable** assigned in a command before such a blocking command +> `PipelineVariable` assigned in a command before such a blocking command > always contains the final piped item from the preceding command when used in > a command after the blocking command. -The following is an example of how **PipelineVariable** works. In this example, -the **PipelineVariable** parameter is added to a `ForEach-Object` command to +The following is an example of how `PipelineVariable` works. In this example, +the `PipelineVariable` parameter is added to a `ForEach-Object` command to store the results of the command in variables. A range of numbers, 1 to 5, are piped into the first `ForEach-Object` command, the results of which are stored in a variable named `$temp`. @@ -534,10 +533,10 @@ At line:1 char:1 Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the [Write-Progress][06] cmdlet. The `Write-Progress` cmdlet creates progress bars -that show a command's status. The **ProgressAction** parameter was added in +that show a command's status. The `ProgressAction` parameter was added in PowerShell 7.4. -The **ProgressAction** parameter takes one of the [`ActionPreference`][07] +The `ProgressAction` parameter takes one of the [`ActionPreference`][07] enumeration values: `SilentlyContinue`, `Stop`, `Continue`, `Inquire`, `Ignore`, `Suspend`, or `Break`. @@ -580,20 +579,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -The **Verbose** parameter overrides the value of the `$VerbosePreference` +The `Verbose` parameter overrides the value of the `$VerbosePreference` variable for the current command. Because the default value of the -`$VerbosePreference` variable is **SilentlyContinue**, verbose messages aren't +`$VerbosePreference` variable is `SilentlyContinue`, verbose messages aren't displayed by default. - `-Verbose:$true` has the same effect as `-Verbose` - `-Verbose:$false` suppresses the display of verbose messages. Use this - parameter when the value of `$VerbosePreference` isn't **SilentlyContinue** + parameter when the value of `$VerbosePreference` isn't `SilentlyContinue` (the default). ### -WarningAction -Determines how the cmdlet responds to a warning from the command. **Continue** -is the default value. This parameter works only when the command generates a +Determines how the cmdlet responds to a warning from the command. `Continue` is +the default value. This parameter works only when the command generates a warning message. For example, this parameter works when a command contains the `Write-Warning` cmdlet. @@ -609,10 +608,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -The **WarningAction** parameter overrides the value of the `$WarningPreference` +The `WarningAction` parameter overrides the value of the `$WarningPreference` variable for the current command. Because the default value of the -`$WarningPreference` variable is **Continue**, warnings are displayed and -execution continues unless you use the **WarningAction** parameter. +`$WarningPreference` variable is `Continue`, warnings are displayed and +execution continues unless you use the `WarningAction` parameter. - `-WarningAction:Break` enters the debugger when a warning occurs. - `-WarningAction:Continue` displays the warning messages and continues @@ -625,9 +624,9 @@ execution continues unless you use the **WarningAction** parameter. command. > [!NOTE] -> The **WarningAction** parameter overrides, but doesn't replace the value of -> the `$WarningAction` preference variable when the parameter is used in a -> command to run a script or function. +> The `WarningAction` parameter overrides, but doesn't replace the value of the +> `$WarningAction` preference variable when the parameter is used in a command +> to run a script or function. ### -WarningVariable @@ -694,11 +693,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -The **WhatIf** parameter overrides the value of the `$WhatIfPreference` -variable for the current command. Because the default value of the -`$WhatIfPreference` variable is 0 (disabled), **WhatIf** behavior isn't done -without the **WhatIf** parameter. For more information, see -[about_Preference_Variables][03]. +The `WhatIf` parameter overrides the value of the `$WhatIfPreference` variable +for the current command. Because the default value of the `$WhatIfPreference` +variable is 0 (disabled), `WhatIf` behavior isn't done without the `WhatIf` +parameter. For more information, see [about_Preference_Variables][03]. - `-WhatIf:$true` has the same effect as `-WhatIf`. - `-WhatIf:$false` suppresses the automatic WhatIf behavior that results when @@ -733,7 +731,7 @@ Accept pipeline input: False Accept wildcard characters: False ``` -The **Confirm** parameter overrides the value of the `$ConfirmPreference` +The `Confirm` parameter overrides the value of the `$ConfirmPreference` variable for the current command. The default value is true. For more information, see [about_Preference_Variables][03]. @@ -742,7 +740,7 @@ information, see [about_Preference_Variables][03]. value of `$ConfirmPreference` is less than or equal to the estimated risk of the cmdlet. -For example, the following command uses the **Confirm** parameter with a +For example, the following command uses the `Confirm` parameter with a `Remove-Item` command. Before removing the item, PowerShell lists the operations it would do and the items that would be affected, and asks for approval. @@ -770,14 +768,14 @@ The Confirm response options are as follows: | `Suspend` (`S`): | Pause the command and create a temporary session. | | `Help` (`?`) | Display help for these options. | -The **Suspend** option places the command on hold and creates a temporary -nested session in which you can work until you're ready to choose a **Confirm** -option. The command prompt for the nested session has two extra carets (>>) to -indicate that it's a child operation of the original parent command. You can -run commands and scripts in the nested session. To end the nested session and +The `Suspend` option places the command on hold and creates a temporary nested +session in which you can work until you're ready to choose a `Confirm` option. +The command prompt for the nested session has two extra carets (>>) to indicate +that it's a child operation of the original parent command. You can run +commands and scripts in the nested session. To end the nested session and return to the Confirm options for the original command, type "exit". -In the following example, the **Suspend** option (S) is used to halt a command +In the following example, the `Suspend` option (S) is used to halt a command temporarily while the user checks the help for a command parameter. After obtaining the needed information, the user types "exit" to end the nested prompt and then selects the Yes (y) response to the Confirm query. diff --git a/reference/5.1/PSReadLine/About/about_PSReadLine_Release_Notes.md b/reference/5.1/PSReadLine/About/about_PSReadLine_Release_Notes.md index 64f98d46c28..ac1782a7fe2 100644 --- a/reference/5.1/PSReadLine/About/about_PSReadLine_Release_Notes.md +++ b/reference/5.1/PSReadLine/About/about_PSReadLine_Release_Notes.md @@ -1,7 +1,7 @@ --- description: This article contains the list of changes for each released version of PSReadLine. Locale: en-US -ms.date: 08/18/2025 +ms.date: 09/02/2025 online version: https://learn.microsoft.com/powershell/module/psreadline/about/about_psreadline_release_notes?view=powershell-5.1&WT.mc_id=ps-gethelp schema: 2.0.0 title: about_PSReadLine_Release_Notes @@ -11,7 +11,7 @@ title: about_PSReadLine_Release_Notes This is a summary of changes to the **PSReadLine** module. For a full list of changes, see the **PSReadLine** [ChangeLog][01]. -- Current preview: v2.4.0-beta1 +- Current preview: v2.4.4-beta4 - Current stable release: v2.3.6 ## PSReadLine release history @@ -29,6 +29,12 @@ Windows PowerShell 5.1. ## Release Notes +### 2.4.4-beta4 - 2025-08-28 + +- Added screen reader support to PSReadLine - The new render implementation + redrawing the terminal buffer to avoid unnecessary and confusing output for + screen readers. + ### v2.4.3-beta3 - 2025-07-23 You can get the v2.4.3-beta3 version of the PSReadLine module from PowerShell diff --git a/reference/7.4/Microsoft.PowerShell.Core/About/about_CommonParameters.md b/reference/7.4/Microsoft.PowerShell.Core/About/about_CommonParameters.md index 806155e57eb..373c971cb5d 100644 --- a/reference/7.4/Microsoft.PowerShell.Core/About/about_CommonParameters.md +++ b/reference/7.4/Microsoft.PowerShell.Core/About/about_CommonParameters.md @@ -1,7 +1,7 @@ --- description: Describes the parameters that can be used with any cmdlet. Locale: en-US -ms.date: 04/24/2025 +ms.date: 09/02/2025 no-loc: [Debug, Verbose, Confirm] online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_commonparameters?view=powershell-7.4&WT.mc_id=ps-gethelp schema: 2.0.0 @@ -21,7 +21,7 @@ they're automatically available to any cmdlet. You can use the common parameters with any cmdlet, but they might not have an effect on all cmdlets. For example, if a cmdlet doesn't generate any verbose -output, using the **Verbose** common parameter has no effect. +output, using the `Verbose` common parameter has no effect. The common parameters are also available on advanced functions that use the `CmdletBinding` attribute or the `Parameter` attribute. When you use these @@ -37,21 +37,21 @@ For more information, see [about_Preference_Variables][03]. The following list displays the common parameters. Their aliases are listed in parentheses. -- **Debug** (db) -- **ErrorAction** (ea) -- **ErrorVariable** (ev) -- **InformationAction** (infa) -- **InformationVariable** (iv) -- **OutVariable** (ov) -- **OutBuffer** (ob) -- **PipelineVariable** (pv) -- **ProgressAction** (proga) -- **Verbose** (vb) -- **WarningAction** (wa) -- **WarningVariable** (wv) - -The **Action** parameters are **ActionPreference** type values. -**ActionPreference** is an enumeration with the following values: +- `Debug` (db) +- `ErrorAction` (ea) +- `ErrorVariable` (ev) +- `InformationAction` (infa) +- `InformationVariable` (iv) +- `OutVariable` (ov) +- `OutBuffer` (ob) +- `PipelineVariable` (pv) +- `ProgressAction` (proga) +- `Verbose` (vb) +- `WarningAction` (wa) +- `WarningVariable` (wv) + +The **Action** parameters are `ActionPreference` type values. +`ActionPreference` is an enumeration with the following values: | Name | Value | | ------------------ | ----- | @@ -71,8 +71,8 @@ offer these parameters. The risk mitigation parameters are: -- **WhatIf** (wi) -- **Confirm** (cf) +- `WhatIf` (wi) +- `Confirm` (cf) ## Common parameter descriptions @@ -93,15 +93,14 @@ Accept wildcard characters: False ``` By default, debugging messages aren't displayed because the value of the -`$DebugPreference` variable is **SilentlyContinue**. +`$DebugPreference` variable is `SilentlyContinue`. -The **Debug** parameter overrides the value of the `$DebugPreference` variable -for the current command, setting the value of `$DebugPreference` to -**Continue**. +The `Debug` parameter overrides the value of the `$DebugPreference` variable +for the current command, setting the value of `$DebugPreference` to `Continue`. -`-Debug:$true` has the same effect as `-Debug`. Use `-Debug:$false` to -suppress the display of debugging messages when `$DebugPreference` isn't -**SilentlyContinue**, which is the default. +`-Debug:$true` has the same effect as `-Debug`. Use `-Debug:$false` to suppress +the display of debugging messages when `$DebugPreference` isn't +`SilentlyContinue`, which is the default. ### -ErrorAction @@ -120,13 +119,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -The **ErrorAction** parameter overrides the value of the -`$ErrorActionPreference` variable for the current command. Because the default -value of the `$ErrorActionPreference` variable is **Continue**, error messages -are displayed and execution continues unless you use the **ErrorAction** -parameter. +The `ErrorAction` parameter overrides the value of the `$ErrorActionPreference` +variable for the current command. Because the default value of the +`$ErrorActionPreference` variable is `Continue`, error messages are displayed +and execution continues unless you use the `ErrorAction` parameter. -The **ErrorAction** parameter has no effect on terminating errors (such as +The `ErrorAction` parameter has no effect on terminating errors (such as missing data, parameters that aren't valid, or insufficient permissions) that prevent a command from completing successfully. @@ -134,8 +132,8 @@ prevent a command from completing successfully. - `Continue` displays the error message and continues executing the command. `Continue` is the default. - `Ignore` suppresses the error message and continues executing the command. - Unlike **SilentlyContinue**, **Ignore** doesn't add the error message to the - `$Error` automatic variable. The **Ignore** value is introduced in PowerShell + Unlike `SilentlyContinue`, `Ignore` doesn't add the error message to the + `$Error` automatic variable. The `Ignore` value is introduced in PowerShell 3.0. - `Inquire` displays the error message and prompts you for confirmation before continuing execution. This value is rarely used. @@ -146,7 +144,7 @@ prevent a command from completing successfully. PowerShell 6 and beyond. > [!NOTE] -> The **ErrorAction** parameter overrides, but doesn't replace the value of the +> The `ErrorAction` parameter overrides, but doesn't replace the value of the > `$ErrorActionPreference` variable when the parameter is used in a command to > run a script or function. @@ -155,9 +153,9 @@ prevent a command from completing successfully. Error records are automatically store in the `$Error` automatic variable. For more information, see [about_Automatic_Variables][02]. -When you use the **ErrorVariable** parameter on a command, PowerShell also -stores the error records emitted by the command in the variable specified by -the parameter. +When you use the `ErrorVariable` parameter on a command, PowerShell also stores +the error records emitted by the command in the variable specified by the +parameter. ```yaml Type: String @@ -205,11 +203,11 @@ from all the commands in the session. You can use array notation, such as ### -InformationAction Introduced in PowerShell 5.0. Within the command or script in which it's used, -the **InformationAction** common parameter overrides the value of the +the `InformationAction` common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to -**SilentlyContinue**. When you use `Write-Information` in a script with -**InformationAction**, `Write-Information` values are shown depending on the -value of the **InformationAction** parameter. For more information about +`SilentlyContinue`. When you use `Write-Information` in a script with +`InformationAction`, `Write-Information` values are shown depending on the +value of the `InformationAction` parameter. For more information about `$InformationPreference`, see [about_Preference_Variables][03]. ```yaml @@ -228,7 +226,7 @@ Accept wildcard characters: False - `Stop` stops a command or script at an occurrence of the `Write-Information` command. - `Ignore` suppresses the informational message and continues running the - command. Unlike **SilentlyContinue**, **Ignore** completely forgets the + command. Unlike `SilentlyContinue`, `Ignore` completely forgets the informational message; it doesn't add the informational message to the information stream. - `Inquire` displays the informational message that you specify in a @@ -240,22 +238,22 @@ Accept wildcard characters: False displayed, and the script continues without interruption. > [!NOTE] -> The **InformationAction** parameter overrides, but doesn't replace the +> The `InformationAction` parameter overrides, but doesn't replace the > value of the `$InformationAction` preference variable when the parameter > is used in a command to run a script or function. ### -InformationVariable -Introduced in PowerShell 5.0. When you use the **InformationVariable** common +Introduced in PowerShell 5.0. When you use the `InformationVariable` common parameter, information records are stored in the variable specified by the parameter. And PowerShell cmdlet can write information records to the -**Information** stream. You can also use the `Write-Information` cmdlet to -write information records. +`Information` stream. You can also use the `Write-Information` cmdlet to write +information records. Information records are displayed as messages in the console by default. You -can control the display of information record by using the -**InformationAction** common parameter. You can also change the behavior using -the `$InformationPreference` preference variable. For more information about +can control the display of information record by using the `InformationAction` +common parameter. You can also change the behavior using the +`$InformationPreference` preference variable. For more information about `$InformationPreference`, see [about_Preference_Variables][03]. > [!NOTE] @@ -357,19 +355,19 @@ $out ``` > [!NOTE] -> The variable created by the **OutVariable** parameter is a +> The variable created by the `OutVariable` parameter is a > `[System.Collections.ArrayList]`. ### -PipelineVariable -**PipelineVariable** allows access to the most recent value passed into the -next pipeline segment by the command that uses this parameter. Any command in -the pipeline can access the value using the named **PipelineVariable**. The -value is assigned to the variable when it's passed into the next pipeline -segment. This makes the **PipelineVariable** easier to use than a specific -temporary variable, which might need to be assigned in multiple locations. +`PipelineVariable` allows access to the most recent value passed into the next +pipeline segment by the command that uses this parameter. Any command in the +pipeline can access the value using the named `PipelineVariable`. The value is +assigned to the variable when it's passed into the next pipeline segment. This +makes the `PipelineVariable` easier to use than a specific temporary variable, +which might need to be assigned in multiple locations. -Unlike `$_` or `$PSItem`, using a **PipelineVariable** allows any pipeline +Unlike `$_` or `$PSItem`, using a `PipelineVariable` allows any pipeline command to access pipeline values passed (and saved) by commands other than the immediately preceding command. Pipeline commands can access the last value piped from while processing the next item passing through the pipeline. This @@ -377,7 +375,7 @@ allows a command to _feed back_ its output to a previous command (or itself). >[!NOTE] > Advanced functions can have up to three script blocks: `begin`, `process`, -> and `end`. When using the **PipelineVariable** parameter with advanced +> and `end`. When using the `PipelineVariable` parameter with advanced > functions, only values from the first defined script block are assigned to > the variable as the function runs. For more information, see > [Advanced functions][05]. PowerShell 7.2 corrects this behavior. @@ -395,22 +393,22 @@ Accept wildcard characters: False Valid values are strings, the same as for any variable names. > [!CAUTION] -> The **PipelineVariable** is scoped to the pipeline in which it's invoked. +> The `PipelineVariable` is scoped to the pipeline in which it's invoked. > Variables outside the pipeline, which use same name, are cleared before the -> pipeline is executed. The **PipelineVariable** goes out of scope when the +> pipeline is executed. The `PipelineVariable` goes out of scope when the > pipeline terminates. If multiple commands within the pipeline specify the -> same **PipelineVariable** then there is only one shared variable. That -> variable is updated with the most recent piped output from the command that -> specifies the variable. +> same `PipelineVariable` then there is only one shared variable. That variable +> is updated with the most recent piped output from the command that specifies +> the variable. > > Some _blocking_ commands collect all the pipeline items before producing any > output, for example `Sort-Object` or `Select-Object -Last`. Any -> **PipelineVariable** assigned in a command before such a blocking command +> `PipelineVariable` assigned in a command before such a blocking command > always contains the final piped item from the preceding command when used in > a command after the blocking command. -The following is an example of how **PipelineVariable** works. In this example, -the **PipelineVariable** parameter is added to a `ForEach-Object` command to +The following is an example of how `PipelineVariable` works. In this example, +the `PipelineVariable` parameter is added to a `ForEach-Object` command to store the results of the command in variables. A range of numbers, 1 to 5, are piped into the first `ForEach-Object` command, the results of which are stored in a variable named `$temp`. @@ -460,13 +458,13 @@ temp ``` > [!CAUTION] -> There are two known issues with using the **PipelineVariable** parameter in a +> There are two known issues with using the `PipelineVariable` parameter in a > pipeline that includes CimCmdlets or CDXML cmdlets. In the following > examples, `Get-Partition` is a CDXML function and `Get-CimInstance` is a > CimCmdlet. 1. When the first command is a CDXML function and downstream contains either a - CimCmdlet cmdlet or CDXML function, **PipelineVariable** is reset to + CimCmdlet cmdlet or CDXML function, `PipelineVariable` is reset to `$null`. ```powershell @@ -500,7 +498,7 @@ temp ``` 1. When the preceding command is _not_ a CDXML command and the downstream - contains either command type, the **PipelineVariable** remains as the last + contains either command type, the `PipelineVariable` remains as the last accumulated object. ```powershell @@ -535,10 +533,10 @@ temp Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the [Write-Progress][06] cmdlet. The `Write-Progress` cmdlet creates progress bars -that show a command's status. The **ProgressAction** parameter was added in +that show a command's status. The `ProgressAction` parameter was added in PowerShell 7.4. -The **ProgressAction** parameter takes one of the [`ActionPreference`][07] +The `ProgressAction` parameter takes one of the [`ActionPreference`][07] enumeration values: `SilentlyContinue`, `Stop`, `Continue`, `Inquire`, `Ignore`, `Suspend`, or `Break`. @@ -581,20 +579,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -The **Verbose** parameter overrides the value of the `$VerbosePreference` +The `Verbose` parameter overrides the value of the `$VerbosePreference` variable for the current command. Because the default value of the -`$VerbosePreference` variable is **SilentlyContinue**, verbose messages aren't +`$VerbosePreference` variable is `SilentlyContinue`, verbose messages aren't displayed by default. - `-Verbose:$true` has the same effect as `-Verbose` - `-Verbose:$false` suppresses the display of verbose messages. Use this - parameter when the value of `$VerbosePreference` isn't **SilentlyContinue** + parameter when the value of `$VerbosePreference` isn't `SilentlyContinue` (the default). ### -WarningAction -Determines how the cmdlet responds to a warning from the command. **Continue** -is the default value. This parameter works only when the command generates a +Determines how the cmdlet responds to a warning from the command. `Continue` is +the default value. This parameter works only when the command generates a warning message. For example, this parameter works when a command contains the `Write-Warning` cmdlet. @@ -609,10 +607,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -The **WarningAction** parameter overrides the value of the `$WarningPreference` +The `WarningAction` parameter overrides the value of the `$WarningPreference` variable for the current command. Because the default value of the -`$WarningPreference` variable is **Continue**, warnings are displayed and -execution continues unless you use the **WarningAction** parameter. +`$WarningPreference` variable is `Continue`, warnings are displayed and +execution continues unless you use the `WarningAction` parameter. - `Break` enters the debugger when a warning occurs. - `Continue` displays the warning messages and continues executing the command. @@ -624,9 +622,9 @@ execution continues unless you use the **WarningAction** parameter. - `Stop` displays the warning message and stops executing the command. > [!NOTE] -> The **WarningAction** parameter overrides, but doesn't replace the value of -> the `$WarningAction` preference variable when the parameter is used in a -> command to run a script or function. +> The `WarningAction` parameter overrides, but doesn't replace the value of the +> `$WarningAction` preference variable when the parameter is used in a command +> to run a script or function. ### -WarningVariable @@ -693,11 +691,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -The **WhatIf** parameter overrides the value of the `$WhatIfPreference` -variable for the current command. Because the default value of the -`$WhatIfPreference` variable is 0 (disabled), **WhatIf** behavior isn't done -without the **WhatIf** parameter. For more information, see -[about_Preference_Variables][03]. +The `WhatIf` parameter overrides the value of the `$WhatIfPreference` variable +for the current command. Because the default value of the `$WhatIfPreference` +variable is 0 (disabled), `WhatIf` behavior isn't done without the `WhatIf` +parameter. For more information, see [about_Preference_Variables][03]. - `$true` has the same effect as `-WhatIf`. - `$false` suppresses the automatic WhatIf behavior that results when the value @@ -732,7 +729,7 @@ Accept pipeline input: False Accept wildcard characters: False ``` -The **Confirm** parameter overrides the value of the `$ConfirmPreference` +The `Confirm` parameter overrides the value of the `$ConfirmPreference` variable for the current command. The default value is true. For more information, see [about_Preference_Variables][03]. @@ -741,7 +738,7 @@ information, see [about_Preference_Variables][03]. `$ConfirmPreference` is less than or equal to the estimated risk of the cmdlet. -For example, the following command uses the **Confirm** parameter with a +For example, the following command uses the `Confirm` parameter with a `Remove-Item` command. Before removing the item, PowerShell lists the operations it would do and the items that would be affected, and asks for approval. @@ -769,14 +766,14 @@ The Confirm response options are as follows: | `Suspend` (`S`): | Pause the command and create a temporary session. | | `Help` (`?`) | Display help for these options. | -The **Suspend** option places the command on hold and creates a temporary -nested session in which you can work until you're ready to choose a **Confirm** -option. The command prompt for the nested session has two extra carets (>>) to -indicate that it's a child operation of the original parent command. You can -run commands and scripts in the nested session. To end the nested session and +The `Suspend` option places the command on hold and creates a temporary nested +session in which you can work until you're ready to choose a `Confirm` option. +The command prompt for the nested session has two extra carets (>>) to indicate +that it's a child operation of the original parent command. You can run +commands and scripts in the nested session. To end the nested session and return to the Confirm options for the original command, type "exit". -In the following example, the **Suspend** option (S) is used to halt a command +In the following example, the `Suspend` option (S) is used to halt a command temporarily while the user checks the help for a command parameter. After obtaining the needed information, the user types "exit" to end the nested prompt and then selects the Yes (y) response to the Confirm query. diff --git a/reference/7.4/PSReadLine/About/about_PSReadLine_Release_Notes.md b/reference/7.4/PSReadLine/About/about_PSReadLine_Release_Notes.md index 85713b4f0cb..37eb944e2bc 100644 --- a/reference/7.4/PSReadLine/About/about_PSReadLine_Release_Notes.md +++ b/reference/7.4/PSReadLine/About/about_PSReadLine_Release_Notes.md @@ -1,7 +1,7 @@ --- description: This article contains the list of changes for each released version of PSReadLine. Locale: en-US -ms.date: 08/18/2025 +ms.date: 09/02/2025 online version: https://learn.microsoft.com/powershell/module/psreadline/about/about_psreadline_release_notes?view=powershell-7.4&WT.mc_id=ps-gethelp schema: 2.0.0 title: about_PSReadLine_Release_Notes @@ -11,7 +11,7 @@ title: about_PSReadLine_Release_Notes This is a summary of changes to the **PSReadLine** module. For a full list of changes, see the **PSReadLine** [ChangeLog][01]. -- Current preview: v2.4.0-beta1 +- Current preview: v2.4.4-beta4 - Current stable release: v2.3.6 ## PSReadLine release history @@ -29,6 +29,12 @@ Windows PowerShell 5.1. ## Release Notes +### 2.4.4-beta4 - 2025-08-28 + +- Added screen reader support to PSReadLine - The new render implementation + redrawing the terminal buffer to avoid unnecessary and confusing output for + screen readers. + ### v2.4.3-beta3 - 2025-07-23 You can get the v2.4.3-beta3 version of the PSReadLine module from PowerShell diff --git a/reference/7.5/Microsoft.PowerShell.Core/About/about_CommonParameters.md b/reference/7.5/Microsoft.PowerShell.Core/About/about_CommonParameters.md index 4ed3b86ce47..9bf5370d45a 100644 --- a/reference/7.5/Microsoft.PowerShell.Core/About/about_CommonParameters.md +++ b/reference/7.5/Microsoft.PowerShell.Core/About/about_CommonParameters.md @@ -1,7 +1,7 @@ --- description: Describes the parameters that can be used with any cmdlet. Locale: en-US -ms.date: 04/24/2025 +ms.date: 09/02/2025 no-loc: [Debug, Verbose, Confirm] online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_commonparameters?view=powershell-7.5&WT.mc_id=ps-gethelp schema: 2.0.0 @@ -21,7 +21,7 @@ they're automatically available to any cmdlet. You can use the common parameters with any cmdlet, but they might not have an effect on all cmdlets. For example, if a cmdlet doesn't generate any verbose -output, using the **Verbose** common parameter has no effect. +output, using the `Verbose` common parameter has no effect. The common parameters are also available on advanced functions that use the `CmdletBinding` attribute or the `Parameter` attribute. When you use these @@ -37,21 +37,21 @@ For more information, see [about_Preference_Variables][03]. The following list displays the common parameters. Their aliases are listed in parentheses. -- **Debug** (db) -- **ErrorAction** (ea) -- **ErrorVariable** (ev) -- **InformationAction** (infa) -- **InformationVariable** (iv) -- **OutVariable** (ov) -- **OutBuffer** (ob) -- **PipelineVariable** (pv) -- **ProgressAction** (proga) -- **Verbose** (vb) -- **WarningAction** (wa) -- **WarningVariable** (wv) - -The **Action** parameters are **ActionPreference** type values. -**ActionPreference** is an enumeration with the following values: +- `Debug` (db) +- `ErrorAction` (ea) +- `ErrorVariable` (ev) +- `InformationAction` (infa) +- `InformationVariable` (iv) +- `OutVariable` (ov) +- `OutBuffer` (ob) +- `PipelineVariable` (pv) +- `ProgressAction` (proga) +- `Verbose` (vb) +- `WarningAction` (wa) +- `WarningVariable` (wv) + +The **Action** parameters are `ActionPreference` type values. +`ActionPreference` is an enumeration with the following values: | Name | Value | | ------------------ | ----- | @@ -71,8 +71,8 @@ offer these parameters. The risk mitigation parameters are: -- **WhatIf** (wi) -- **Confirm** (cf) +- `WhatIf` (wi) +- `Confirm` (cf) ## Common parameter descriptions @@ -93,15 +93,14 @@ Accept wildcard characters: False ``` By default, debugging messages aren't displayed because the value of the -`$DebugPreference` variable is **SilentlyContinue**. +`$DebugPreference` variable is `SilentlyContinue`. -The **Debug** parameter overrides the value of the `$DebugPreference` variable -for the current command, setting the value of `$DebugPreference` to -**Continue**. +The `Debug` parameter overrides the value of the `$DebugPreference` variable +for the current command, setting the value of `$DebugPreference` to `Continue`. -`-Debug:$true` has the same effect as `-Debug`. Use `-Debug:$false` to -suppress the display of debugging messages when `$DebugPreference` isn't -**SilentlyContinue**, which is the default. +`-Debug:$true` has the same effect as `-Debug`. Use `-Debug:$false` to suppress +the display of debugging messages when `$DebugPreference` isn't +`SilentlyContinue`, which is the default. ### -ErrorAction @@ -120,13 +119,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -The **ErrorAction** parameter overrides the value of the -`$ErrorActionPreference` variable for the current command. Because the default -value of the `$ErrorActionPreference` variable is **Continue**, error messages -are displayed and execution continues unless you use the **ErrorAction** -parameter. +The `ErrorAction` parameter overrides the value of the `$ErrorActionPreference` +variable for the current command. Because the default value of the +`$ErrorActionPreference` variable is `Continue`, error messages are displayed +and execution continues unless you use the `ErrorAction` parameter. -The **ErrorAction** parameter has no effect on terminating errors (such as +The `ErrorAction` parameter has no effect on terminating errors (such as missing data, parameters that aren't valid, or insufficient permissions) that prevent a command from completing successfully. @@ -134,8 +132,8 @@ prevent a command from completing successfully. - `Continue` displays the error message and continues executing the command. `Continue` is the default. - `Ignore` suppresses the error message and continues executing the command. - Unlike **SilentlyContinue**, **Ignore** doesn't add the error message to the - `$Error` automatic variable. The **Ignore** value is introduced in PowerShell + Unlike `SilentlyContinue`, `Ignore` doesn't add the error message to the + `$Error` automatic variable. The `Ignore` value is introduced in PowerShell 3.0. - `Inquire` displays the error message and prompts you for confirmation before continuing execution. This value is rarely used. @@ -146,7 +144,7 @@ prevent a command from completing successfully. PowerShell 6 and beyond. > [!NOTE] -> The **ErrorAction** parameter overrides, but doesn't replace the value of the +> The `ErrorAction` parameter overrides, but doesn't replace the value of the > `$ErrorActionPreference` variable when the parameter is used in a command to > run a script or function. @@ -155,9 +153,9 @@ prevent a command from completing successfully. Error records are automatically store in the `$Error` automatic variable. For more information, see [about_Automatic_Variables][02]. -When you use the **ErrorVariable** parameter on a command, PowerShell also -stores the error records emitted by the command in the variable specified by -the parameter. +When you use the `ErrorVariable` parameter on a command, PowerShell also stores +the error records emitted by the command in the variable specified by the +parameter. ```yaml Type: String @@ -205,11 +203,11 @@ from all the commands in the session. You can use array notation, such as ### -InformationAction Introduced in PowerShell 5.0. Within the command or script in which it's used, -the **InformationAction** common parameter overrides the value of the +the `InformationAction` common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to -**SilentlyContinue**. When you use `Write-Information` in a script with -**InformationAction**, `Write-Information` values are shown depending on the -value of the **InformationAction** parameter. For more information about +`SilentlyContinue`. When you use `Write-Information` in a script with +`InformationAction`, `Write-Information` values are shown depending on the +value of the `InformationAction` parameter. For more information about `$InformationPreference`, see [about_Preference_Variables][03]. ```yaml @@ -228,7 +226,7 @@ Accept wildcard characters: False - `Stop` stops a command or script at an occurrence of the `Write-Information` command. - `Ignore` suppresses the informational message and continues running the - command. Unlike **SilentlyContinue**, **Ignore** completely forgets the + command. Unlike `SilentlyContinue`, `Ignore` completely forgets the informational message; it doesn't add the informational message to the information stream. - `Inquire` displays the informational message that you specify in a @@ -240,22 +238,22 @@ Accept wildcard characters: False displayed, and the script continues without interruption. > [!NOTE] -> The **InformationAction** parameter overrides, but doesn't replace the +> The `InformationAction` parameter overrides, but doesn't replace the > value of the `$InformationAction` preference variable when the parameter > is used in a command to run a script or function. ### -InformationVariable -Introduced in PowerShell 5.0. When you use the **InformationVariable** common +Introduced in PowerShell 5.0. When you use the `InformationVariable` common parameter, information records are stored in the variable specified by the parameter. And PowerShell cmdlet can write information records to the -**Information** stream. You can also use the `Write-Information` cmdlet to -write information records. +`Information` stream. You can also use the `Write-Information` cmdlet to write +information records. Information records are displayed as messages in the console by default. You -can control the display of information record by using the -**InformationAction** common parameter. You can also change the behavior using -the `$InformationPreference` preference variable. For more information about +can control the display of information record by using the `InformationAction` +common parameter. You can also change the behavior using the +`$InformationPreference` preference variable. For more information about `$InformationPreference`, see [about_Preference_Variables][03]. > [!NOTE] @@ -357,19 +355,19 @@ $out ``` > [!NOTE] -> The variable created by the **OutVariable** parameter is a +> The variable created by the `OutVariable` parameter is a > `[System.Collections.ArrayList]`. ### -PipelineVariable -**PipelineVariable** allows access to the most recent value passed into the -next pipeline segment by the command that uses this parameter. Any command in -the pipeline can access the value using the named **PipelineVariable**. The -value is assigned to the variable when it's passed into the next pipeline -segment. This makes the **PipelineVariable** easier to use than a specific -temporary variable, which might need to be assigned in multiple locations. +`PipelineVariable` allows access to the most recent value passed into the next +pipeline segment by the command that uses this parameter. Any command in the +pipeline can access the value using the named `PipelineVariable`. The value is +assigned to the variable when it's passed into the next pipeline segment. This +makes the `PipelineVariable` easier to use than a specific temporary variable, +which might need to be assigned in multiple locations. -Unlike `$_` or `$PSItem`, using a **PipelineVariable** allows any pipeline +Unlike `$_` or `$PSItem`, using a `PipelineVariable` allows any pipeline command to access pipeline values passed (and saved) by commands other than the immediately preceding command. Pipeline commands can access the last value piped from while processing the next item passing through the pipeline. This @@ -377,7 +375,7 @@ allows a command to _feed back_ its output to a previous command (or itself). >[!NOTE] > Advanced functions can have up to three script blocks: `begin`, `process`, -> and `end`. When using the **PipelineVariable** parameter with advanced +> and `end`. When using the `PipelineVariable` parameter with advanced > functions, only values from the first defined script block are assigned to > the variable as the function runs. For more information, see > [Advanced functions][05]. PowerShell 7.2 corrects this behavior. @@ -395,22 +393,22 @@ Accept wildcard characters: False Valid values are strings, the same as for any variable names. > [!CAUTION] -> The **PipelineVariable** is scoped to the pipeline in which it's invoked. +> The `PipelineVariable` is scoped to the pipeline in which it's invoked. > Variables outside the pipeline, which use same name, are cleared before the -> pipeline is executed. The **PipelineVariable** goes out of scope when the +> pipeline is executed. The `PipelineVariable` goes out of scope when the > pipeline terminates. If multiple commands within the pipeline specify the -> same **PipelineVariable** then there is only one shared variable. That -> variable is updated with the most recent piped output from the command that -> specifies the variable. +> same `PipelineVariable` then there is only one shared variable. That variable +> is updated with the most recent piped output from the command that specifies +> the variable. > > Some _blocking_ commands collect all the pipeline items before producing any > output, for example `Sort-Object` or `Select-Object -Last`. Any -> **PipelineVariable** assigned in a command before such a blocking command +> `PipelineVariable` assigned in a command before such a blocking command > always contains the final piped item from the preceding command when used in > a command after the blocking command. -The following is an example of how **PipelineVariable** works. In this example, -the **PipelineVariable** parameter is added to a `ForEach-Object` command to +The following is an example of how `PipelineVariable` works. In this example, +the `PipelineVariable` parameter is added to a `ForEach-Object` command to store the results of the command in variables. A range of numbers, 1 to 5, are piped into the first `ForEach-Object` command, the results of which are stored in a variable named `$temp`. @@ -460,13 +458,13 @@ temp ``` > [!CAUTION] -> There are two known issues with using the **PipelineVariable** parameter in a +> There are two known issues with using the `PipelineVariable` parameter in a > pipeline that includes CimCmdlets or CDXML cmdlets. In the following > examples, `Get-Partition` is a CDXML function and `Get-CimInstance` is a > CimCmdlet. 1. When the first command is a CDXML function and downstream contains either a - CimCmdlet cmdlet or CDXML function, **PipelineVariable** is reset to + CimCmdlet cmdlet or CDXML function, `PipelineVariable` is reset to `$null`. ```powershell @@ -500,7 +498,7 @@ temp ``` 1. When the preceding command is _not_ a CDXML command and the downstream - contains either command type, the **PipelineVariable** remains as the last + contains either command type, the `PipelineVariable` remains as the last accumulated object. ```powershell @@ -535,10 +533,10 @@ temp Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the [Write-Progress][06] cmdlet. The `Write-Progress` cmdlet creates progress bars -that show a command's status. The **ProgressAction** parameter was added in +that show a command's status. The `ProgressAction` parameter was added in PowerShell 7.4. -The **ProgressAction** parameter takes one of the [`ActionPreference`][07] +The `ProgressAction` parameter takes one of the [`ActionPreference`][07] enumeration values: `SilentlyContinue`, `Stop`, `Continue`, `Inquire`, `Ignore`, `Suspend`, or `Break`. @@ -581,20 +579,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -The **Verbose** parameter overrides the value of the `$VerbosePreference` +The `Verbose` parameter overrides the value of the `$VerbosePreference` variable for the current command. Because the default value of the -`$VerbosePreference` variable is **SilentlyContinue**, verbose messages aren't +`$VerbosePreference` variable is `SilentlyContinue`, verbose messages aren't displayed by default. - `-Verbose:$true` has the same effect as `-Verbose` - `-Verbose:$false` suppresses the display of verbose messages. Use this - parameter when the value of `$VerbosePreference` isn't **SilentlyContinue** + parameter when the value of `$VerbosePreference` isn't `SilentlyContinue` (the default). ### -WarningAction -Determines how the cmdlet responds to a warning from the command. **Continue** -is the default value. This parameter works only when the command generates a +Determines how the cmdlet responds to a warning from the command. `Continue` is +the default value. This parameter works only when the command generates a warning message. For example, this parameter works when a command contains the `Write-Warning` cmdlet. @@ -609,10 +607,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -The **WarningAction** parameter overrides the value of the `$WarningPreference` +The `WarningAction` parameter overrides the value of the `$WarningPreference` variable for the current command. Because the default value of the -`$WarningPreference` variable is **Continue**, warnings are displayed and -execution continues unless you use the **WarningAction** parameter. +`$WarningPreference` variable is `Continue`, warnings are displayed and +execution continues unless you use the `WarningAction` parameter. - `Break` enters the debugger when a warning occurs. - `Continue` displays the warning messages and continues executing the command. @@ -624,9 +622,9 @@ execution continues unless you use the **WarningAction** parameter. - `Stop` displays the warning message and stops executing the command. > [!NOTE] -> The **WarningAction** parameter overrides, but doesn't replace the value of -> the `$WarningAction` preference variable when the parameter is used in a -> command to run a script or function. +> The `WarningAction` parameter overrides, but doesn't replace the value of the +> `$WarningAction` preference variable when the parameter is used in a command +> to run a script or function. ### -WarningVariable @@ -693,11 +691,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -The **WhatIf** parameter overrides the value of the `$WhatIfPreference` -variable for the current command. Because the default value of the -`$WhatIfPreference` variable is 0 (disabled), **WhatIf** behavior isn't done -without the **WhatIf** parameter. For more information, see -[about_Preference_Variables][03]. +The `WhatIf` parameter overrides the value of the `$WhatIfPreference` variable +for the current command. Because the default value of the `$WhatIfPreference` +variable is 0 (disabled), `WhatIf` behavior isn't done without the `WhatIf` +parameter. For more information, see [about_Preference_Variables][03]. - `$true` has the same effect as `-WhatIf`. - `$false` suppresses the automatic WhatIf behavior that results when the value @@ -732,7 +729,7 @@ Accept pipeline input: False Accept wildcard characters: False ``` -The **Confirm** parameter overrides the value of the `$ConfirmPreference` +The `Confirm` parameter overrides the value of the `$ConfirmPreference` variable for the current command. The default value is true. For more information, see [about_Preference_Variables][03]. @@ -741,7 +738,7 @@ information, see [about_Preference_Variables][03]. `$ConfirmPreference` is less than or equal to the estimated risk of the cmdlet. -For example, the following command uses the **Confirm** parameter with a +For example, the following command uses the `Confirm` parameter with a `Remove-Item` command. Before removing the item, PowerShell lists the operations it would do and the items that would be affected, and asks for approval. @@ -769,14 +766,14 @@ The Confirm response options are as follows: | `Suspend` (`S`): | Pause the command and create a temporary session. | | `Help` (`?`) | Display help for these options. | -The **Suspend** option places the command on hold and creates a temporary -nested session in which you can work until you're ready to choose a **Confirm** -option. The command prompt for the nested session has two extra carets (>>) to -indicate that it's a child operation of the original parent command. You can -run commands and scripts in the nested session. To end the nested session and +The `Suspend` option places the command on hold and creates a temporary nested +session in which you can work until you're ready to choose a `Confirm` option. +The command prompt for the nested session has two extra carets (>>) to indicate +that it's a child operation of the original parent command. You can run +commands and scripts in the nested session. To end the nested session and return to the Confirm options for the original command, type "exit". -In the following example, the **Suspend** option (S) is used to halt a command +In the following example, the `Suspend` option (S) is used to halt a command temporarily while the user checks the help for a command parameter. After obtaining the needed information, the user types "exit" to end the nested prompt and then selects the Yes (y) response to the Confirm query. diff --git a/reference/7.5/PSReadLine/About/about_PSReadLine_Release_Notes.md b/reference/7.5/PSReadLine/About/about_PSReadLine_Release_Notes.md index 3be2a0964f8..5dcc04e9edd 100644 --- a/reference/7.5/PSReadLine/About/about_PSReadLine_Release_Notes.md +++ b/reference/7.5/PSReadLine/About/about_PSReadLine_Release_Notes.md @@ -1,7 +1,7 @@ --- description: This article contains the list of changes for each released version of PSReadLine. Locale: en-US -ms.date: 08/18/2025 +ms.date: 09/02/2025 online version: https://learn.microsoft.com/powershell/module/psreadline/about/about_psreadline_release_notes?view=powershell-7.5&WT.mc_id=ps-gethelp schema: 2.0.0 title: about_PSReadLine_Release_Notes @@ -11,7 +11,7 @@ title: about_PSReadLine_Release_Notes This is a summary of changes to the **PSReadLine** module. For a full list of changes, see the **PSReadLine** [ChangeLog][01]. -- Current preview: v2.4.0-beta1 +- Current preview: v2.4.4-beta4 - Current stable release: v2.3.6 ## PSReadLine release history @@ -29,6 +29,12 @@ Windows PowerShell 5.1. ## Release Notes +### 2.4.4-beta4 - 2025-08-28 + +- Added screen reader support to PSReadLine - The new render implementation + redrawing the terminal buffer to avoid unnecessary and confusing output for + screen readers. + ### v2.4.3-beta3 - 2025-07-23 You can get the v2.4.3-beta3 version of the PSReadLine module from PowerShell diff --git a/reference/7.6/Microsoft.PowerShell.Core/About/about_CommonParameters.md b/reference/7.6/Microsoft.PowerShell.Core/About/about_CommonParameters.md index 60fd5c1eb27..52094a4771a 100644 --- a/reference/7.6/Microsoft.PowerShell.Core/About/about_CommonParameters.md +++ b/reference/7.6/Microsoft.PowerShell.Core/About/about_CommonParameters.md @@ -1,7 +1,7 @@ --- description: Describes the parameters that can be used with any cmdlet. Locale: en-US -ms.date: 04/24/2025 +ms.date: 09/02/2025 no-loc: [Debug, Verbose, Confirm] online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_commonparameters?view=powershell-7.6&WT.mc_id=ps-gethelp schema: 2.0.0 @@ -21,7 +21,7 @@ they're automatically available to any cmdlet. You can use the common parameters with any cmdlet, but they might not have an effect on all cmdlets. For example, if a cmdlet doesn't generate any verbose -output, using the **Verbose** common parameter has no effect. +output, using the `Verbose` common parameter has no effect. The common parameters are also available on advanced functions that use the `CmdletBinding` attribute or the `Parameter` attribute. When you use these @@ -37,21 +37,21 @@ For more information, see [about_Preference_Variables][03]. The following list displays the common parameters. Their aliases are listed in parentheses. -- **Debug** (db) -- **ErrorAction** (ea) -- **ErrorVariable** (ev) -- **InformationAction** (infa) -- **InformationVariable** (iv) -- **OutVariable** (ov) -- **OutBuffer** (ob) -- **PipelineVariable** (pv) -- **ProgressAction** (proga) -- **Verbose** (vb) -- **WarningAction** (wa) -- **WarningVariable** (wv) - -The **Action** parameters are **ActionPreference** type values. -**ActionPreference** is an enumeration with the following values: +- `Debug` (db) +- `ErrorAction` (ea) +- `ErrorVariable` (ev) +- `InformationAction` (infa) +- `InformationVariable` (iv) +- `OutVariable` (ov) +- `OutBuffer` (ob) +- `PipelineVariable` (pv) +- `ProgressAction` (proga) +- `Verbose` (vb) +- `WarningAction` (wa) +- `WarningVariable` (wv) + +The **Action** parameters are `ActionPreference` type values. +`ActionPreference` is an enumeration with the following values: | Name | Value | | ------------------ | ----- | @@ -71,8 +71,8 @@ offer these parameters. The risk mitigation parameters are: -- **WhatIf** (wi) -- **Confirm** (cf) +- `WhatIf` (wi) +- `Confirm` (cf) ## Common parameter descriptions @@ -93,15 +93,14 @@ Accept wildcard characters: False ``` By default, debugging messages aren't displayed because the value of the -`$DebugPreference` variable is **SilentlyContinue**. +`$DebugPreference` variable is `SilentlyContinue`. -The **Debug** parameter overrides the value of the `$DebugPreference` variable -for the current command, setting the value of `$DebugPreference` to -**Continue**. +The `Debug` parameter overrides the value of the `$DebugPreference` variable +for the current command, setting the value of `$DebugPreference` to `Continue`. -`-Debug:$true` has the same effect as `-Debug`. Use `-Debug:$false` to -suppress the display of debugging messages when `$DebugPreference` isn't -**SilentlyContinue**, which is the default. +`-Debug:$true` has the same effect as `-Debug`. Use `-Debug:$false` to suppress +the display of debugging messages when `$DebugPreference` isn't +`SilentlyContinue`, which is the default. ### -ErrorAction @@ -120,13 +119,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -The **ErrorAction** parameter overrides the value of the -`$ErrorActionPreference` variable for the current command. Because the default -value of the `$ErrorActionPreference` variable is **Continue**, error messages -are displayed and execution continues unless you use the **ErrorAction** -parameter. +The `ErrorAction` parameter overrides the value of the `$ErrorActionPreference` +variable for the current command. Because the default value of the +`$ErrorActionPreference` variable is `Continue`, error messages are displayed +and execution continues unless you use the `ErrorAction` parameter. -The **ErrorAction** parameter has no effect on terminating errors (such as +The `ErrorAction` parameter has no effect on terminating errors (such as missing data, parameters that aren't valid, or insufficient permissions) that prevent a command from completing successfully. @@ -134,8 +132,8 @@ prevent a command from completing successfully. - `Continue` displays the error message and continues executing the command. `Continue` is the default. - `Ignore` suppresses the error message and continues executing the command. - Unlike **SilentlyContinue**, **Ignore** doesn't add the error message to the - `$Error` automatic variable. The **Ignore** value is introduced in PowerShell + Unlike `SilentlyContinue`, `Ignore` doesn't add the error message to the + `$Error` automatic variable. The `Ignore` value is introduced in PowerShell 3.0. - `Inquire` displays the error message and prompts you for confirmation before continuing execution. This value is rarely used. @@ -146,7 +144,7 @@ prevent a command from completing successfully. PowerShell 6 and beyond. > [!NOTE] -> The **ErrorAction** parameter overrides, but doesn't replace the value of the +> The `ErrorAction` parameter overrides, but doesn't replace the value of the > `$ErrorActionPreference` variable when the parameter is used in a command to > run a script or function. @@ -155,9 +153,9 @@ prevent a command from completing successfully. Error records are automatically store in the `$Error` automatic variable. For more information, see [about_Automatic_Variables][02]. -When you use the **ErrorVariable** parameter on a command, PowerShell also -stores the error records emitted by the command in the variable specified by -the parameter. +When you use the `ErrorVariable` parameter on a command, PowerShell also stores +the error records emitted by the command in the variable specified by the +parameter. ```yaml Type: String @@ -205,11 +203,11 @@ from all the commands in the session. You can use array notation, such as ### -InformationAction Introduced in PowerShell 5.0. Within the command or script in which it's used, -the **InformationAction** common parameter overrides the value of the +the `InformationAction` common parameter overrides the value of the `$InformationPreference` preference variable, which by default is set to -**SilentlyContinue**. When you use `Write-Information` in a script with -**InformationAction**, `Write-Information` values are shown depending on the -value of the **InformationAction** parameter. For more information about +`SilentlyContinue`. When you use `Write-Information` in a script with +`InformationAction`, `Write-Information` values are shown depending on the +value of the `InformationAction` parameter. For more information about `$InformationPreference`, see [about_Preference_Variables][03]. ```yaml @@ -228,7 +226,7 @@ Accept wildcard characters: False - `Stop` stops a command or script at an occurrence of the `Write-Information` command. - `Ignore` suppresses the informational message and continues running the - command. Unlike **SilentlyContinue**, **Ignore** completely forgets the + command. Unlike `SilentlyContinue`, `Ignore` completely forgets the informational message; it doesn't add the informational message to the information stream. - `Inquire` displays the informational message that you specify in a @@ -240,22 +238,22 @@ Accept wildcard characters: False displayed, and the script continues without interruption. > [!NOTE] -> The **InformationAction** parameter overrides, but doesn't replace the +> The `InformationAction` parameter overrides, but doesn't replace the > value of the `$InformationAction` preference variable when the parameter > is used in a command to run a script or function. ### -InformationVariable -Introduced in PowerShell 5.0. When you use the **InformationVariable** common +Introduced in PowerShell 5.0. When you use the `InformationVariable` common parameter, information records are stored in the variable specified by the parameter. And PowerShell cmdlet can write information records to the -**Information** stream. You can also use the `Write-Information` cmdlet to -write information records. +`Information` stream. You can also use the `Write-Information` cmdlet to write +information records. Information records are displayed as messages in the console by default. You -can control the display of information record by using the -**InformationAction** common parameter. You can also change the behavior using -the `$InformationPreference` preference variable. For more information about +can control the display of information record by using the `InformationAction` +common parameter. You can also change the behavior using the +`$InformationPreference` preference variable. For more information about `$InformationPreference`, see [about_Preference_Variables][03]. > [!NOTE] @@ -357,19 +355,19 @@ $out ``` > [!NOTE] -> The variable created by the **OutVariable** parameter is a +> The variable created by the `OutVariable` parameter is a > `[System.Collections.ArrayList]`. ### -PipelineVariable -**PipelineVariable** allows access to the most recent value passed into the -next pipeline segment by the command that uses this parameter. Any command in -the pipeline can access the value using the named **PipelineVariable**. The -value is assigned to the variable when it's passed into the next pipeline -segment. This makes the **PipelineVariable** easier to use than a specific -temporary variable, which might need to be assigned in multiple locations. +`PipelineVariable` allows access to the most recent value passed into the next +pipeline segment by the command that uses this parameter. Any command in the +pipeline can access the value using the named `PipelineVariable`. The value is +assigned to the variable when it's passed into the next pipeline segment. This +makes the `PipelineVariable` easier to use than a specific temporary variable, +which might need to be assigned in multiple locations. -Unlike `$_` or `$PSItem`, using a **PipelineVariable** allows any pipeline +Unlike `$_` or `$PSItem`, using a `PipelineVariable` allows any pipeline command to access pipeline values passed (and saved) by commands other than the immediately preceding command. Pipeline commands can access the last value piped from while processing the next item passing through the pipeline. This @@ -377,7 +375,7 @@ allows a command to _feed back_ its output to a previous command (or itself). >[!NOTE] > Advanced functions can have up to three script blocks: `begin`, `process`, -> and `end`. When using the **PipelineVariable** parameter with advanced +> and `end`. When using the `PipelineVariable` parameter with advanced > functions, only values from the first defined script block are assigned to > the variable as the function runs. For more information, see > [Advanced functions][05]. PowerShell 7.2 corrects this behavior. @@ -395,22 +393,22 @@ Accept wildcard characters: False Valid values are strings, the same as for any variable names. > [!CAUTION] -> The **PipelineVariable** is scoped to the pipeline in which it's invoked. +> The `PipelineVariable` is scoped to the pipeline in which it's invoked. > Variables outside the pipeline, which use same name, are cleared before the -> pipeline is executed. The **PipelineVariable** goes out of scope when the +> pipeline is executed. The `PipelineVariable` goes out of scope when the > pipeline terminates. If multiple commands within the pipeline specify the -> same **PipelineVariable** then there is only one shared variable. That -> variable is updated with the most recent piped output from the command that -> specifies the variable. +> same `PipelineVariable` then there is only one shared variable. That variable +> is updated with the most recent piped output from the command that specifies +> the variable. > > Some _blocking_ commands collect all the pipeline items before producing any > output, for example `Sort-Object` or `Select-Object -Last`. Any -> **PipelineVariable** assigned in a command before such a blocking command +> `PipelineVariable` assigned in a command before such a blocking command > always contains the final piped item from the preceding command when used in > a command after the blocking command. -The following is an example of how **PipelineVariable** works. In this example, -the **PipelineVariable** parameter is added to a `ForEach-Object` command to +The following is an example of how `PipelineVariable` works. In this example, +the `PipelineVariable` parameter is added to a `ForEach-Object` command to store the results of the command in variables. A range of numbers, 1 to 5, are piped into the first `ForEach-Object` command, the results of which are stored in a variable named `$temp`. @@ -460,13 +458,13 @@ temp ``` > [!CAUTION] -> There are two known issues with using the **PipelineVariable** parameter in a +> There are two known issues with using the `PipelineVariable` parameter in a > pipeline that includes CimCmdlets or CDXML cmdlets. In the following > examples, `Get-Partition` is a CDXML function and `Get-CimInstance` is a > CimCmdlet. 1. When the first command is a CDXML function and downstream contains either a - CimCmdlet cmdlet or CDXML function, **PipelineVariable** is reset to + CimCmdlet cmdlet or CDXML function, `PipelineVariable` is reset to `$null`. ```powershell @@ -500,7 +498,7 @@ temp ``` 1. When the preceding command is _not_ a CDXML command and the downstream - contains either command type, the **PipelineVariable** remains as the last + contains either command type, the `PipelineVariable` remains as the last accumulated object. ```powershell @@ -535,10 +533,10 @@ temp Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the [Write-Progress][06] cmdlet. The `Write-Progress` cmdlet creates progress bars -that show a command's status. The **ProgressAction** parameter was added in +that show a command's status. The `ProgressAction` parameter was added in PowerShell 7.4. -The **ProgressAction** parameter takes one of the [`ActionPreference`][07] +The `ProgressAction` parameter takes one of the [`ActionPreference`][07] enumeration values: `SilentlyContinue`, `Stop`, `Continue`, `Inquire`, `Ignore`, `Suspend`, or `Break`. @@ -581,20 +579,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -The **Verbose** parameter overrides the value of the `$VerbosePreference` +The `Verbose` parameter overrides the value of the `$VerbosePreference` variable for the current command. Because the default value of the -`$VerbosePreference` variable is **SilentlyContinue**, verbose messages aren't +`$VerbosePreference` variable is `SilentlyContinue`, verbose messages aren't displayed by default. - `-Verbose:$true` has the same effect as `-Verbose` - `-Verbose:$false` suppresses the display of verbose messages. Use this - parameter when the value of `$VerbosePreference` isn't **SilentlyContinue** + parameter when the value of `$VerbosePreference` isn't `SilentlyContinue` (the default). ### -WarningAction -Determines how the cmdlet responds to a warning from the command. **Continue** -is the default value. This parameter works only when the command generates a +Determines how the cmdlet responds to a warning from the command. `Continue` is +the default value. This parameter works only when the command generates a warning message. For example, this parameter works when a command contains the `Write-Warning` cmdlet. @@ -609,10 +607,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -The **WarningAction** parameter overrides the value of the `$WarningPreference` +The `WarningAction` parameter overrides the value of the `$WarningPreference` variable for the current command. Because the default value of the -`$WarningPreference` variable is **Continue**, warnings are displayed and -execution continues unless you use the **WarningAction** parameter. +`$WarningPreference` variable is `Continue`, warnings are displayed and +execution continues unless you use the `WarningAction` parameter. - `Break` enters the debugger when a warning occurs. - `Continue` displays the warning messages and continues executing the command. @@ -624,9 +622,9 @@ execution continues unless you use the **WarningAction** parameter. - `Stop` displays the warning message and stops executing the command. > [!NOTE] -> The **WarningAction** parameter overrides, but doesn't replace the value of -> the `$WarningAction` preference variable when the parameter is used in a -> command to run a script or function. +> The `WarningAction` parameter overrides, but doesn't replace the value of the +> `$WarningAction` preference variable when the parameter is used in a command +> to run a script or function. ### -WarningVariable @@ -693,11 +691,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -The **WhatIf** parameter overrides the value of the `$WhatIfPreference` -variable for the current command. Because the default value of the -`$WhatIfPreference` variable is 0 (disabled), **WhatIf** behavior isn't done -without the **WhatIf** parameter. For more information, see -[about_Preference_Variables][03]. +The `WhatIf` parameter overrides the value of the `$WhatIfPreference` variable +for the current command. Because the default value of the `$WhatIfPreference` +variable is 0 (disabled), `WhatIf` behavior isn't done without the `WhatIf` +parameter. For more information, see [about_Preference_Variables][03]. - `$true` has the same effect as `-WhatIf`. - `$false` suppresses the automatic WhatIf behavior that results when the value @@ -732,7 +729,7 @@ Accept pipeline input: False Accept wildcard characters: False ``` -The **Confirm** parameter overrides the value of the `$ConfirmPreference` +The `Confirm` parameter overrides the value of the `$ConfirmPreference` variable for the current command. The default value is true. For more information, see [about_Preference_Variables][03]. @@ -741,7 +738,7 @@ information, see [about_Preference_Variables][03]. `$ConfirmPreference` is less than or equal to the estimated risk of the cmdlet. -For example, the following command uses the **Confirm** parameter with a +For example, the following command uses the `Confirm` parameter with a `Remove-Item` command. Before removing the item, PowerShell lists the operations it would do and the items that would be affected, and asks for approval. @@ -769,14 +766,14 @@ The Confirm response options are as follows: | `Suspend` (`S`): | Pause the command and create a temporary session. | | `Help` (`?`) | Display help for these options. | -The **Suspend** option places the command on hold and creates a temporary -nested session in which you can work until you're ready to choose a **Confirm** -option. The command prompt for the nested session has two extra carets (>>) to -indicate that it's a child operation of the original parent command. You can -run commands and scripts in the nested session. To end the nested session and +The `Suspend` option places the command on hold and creates a temporary nested +session in which you can work until you're ready to choose a `Confirm` option. +The command prompt for the nested session has two extra carets (>>) to indicate +that it's a child operation of the original parent command. You can run +commands and scripts in the nested session. To end the nested session and return to the Confirm options for the original command, type "exit". -In the following example, the **Suspend** option (S) is used to halt a command +In the following example, the `Suspend` option (S) is used to halt a command temporarily while the user checks the help for a command parameter. After obtaining the needed information, the user types "exit" to end the nested prompt and then selects the Yes (y) response to the Confirm query. diff --git a/reference/7.6/PSReadLine/About/about_PSReadLine_Release_Notes.md b/reference/7.6/PSReadLine/About/about_PSReadLine_Release_Notes.md index 3ac3f1b2bdc..6b36dc94383 100644 --- a/reference/7.6/PSReadLine/About/about_PSReadLine_Release_Notes.md +++ b/reference/7.6/PSReadLine/About/about_PSReadLine_Release_Notes.md @@ -1,7 +1,7 @@ --- description: This article contains the list of changes for each released version of PSReadLine. Locale: en-US -ms.date: 08/18/2025 +ms.date: 09/02/2025 online version: https://learn.microsoft.com/powershell/module/psreadline/about/about_psreadline_release_notes?view=powershell-7.6&WT.mc_id=ps-gethelp schema: 2.0.0 title: about_PSReadLine_Release_Notes @@ -11,7 +11,7 @@ title: about_PSReadLine_Release_Notes This is a summary of changes to the **PSReadLine** module. For a full list of changes, see the **PSReadLine** [ChangeLog][01]. -- Current preview: v2.4.0-beta1 +- Current preview: v2.4.4-beta4 - Current stable release: v2.3.6 ## PSReadLine release history @@ -29,6 +29,12 @@ Windows PowerShell 5.1. ## Release Notes +### 2.4.4-beta4 - 2025-08-28 + +- Added screen reader support to PSReadLine - The new render implementation + redrawing the terminal buffer to avoid unnecessary and confusing output for + screen readers. + ### v2.4.3-beta3 - 2025-07-23 You can get the v2.4.3-beta3 version of the PSReadLine module from PowerShell diff --git a/reference/docs-conceptual/community/2025-updates.md b/reference/docs-conceptual/community/2025-updates.md index b8d7d402f89..dbd3cc4d60a 100644 --- a/reference/docs-conceptual/community/2025-updates.md +++ b/reference/docs-conceptual/community/2025-updates.md @@ -1,6 +1,6 @@ --- description: List of changes to the PowerShell documentation for 2025 -ms.date: 08/04/2025 +ms.date: 09/02/2025 title: What's New in PowerShell-Docs for 2025 --- # What's new in PowerShell Docs for 2025 @@ -14,6 +14,33 @@ get started. [01]: contributing/overview.md +## 2025-August + +Content updates + +- AI Shell updates for preview 6 release +- [MCP support](/powershell/utility-modules/aishell/how-to/mcp-support) +- DSC updates for v3.1.1 release + +GitHub stats + +- 16 PRs merged (3 from Community) +- 34 issues opened (31 from Community) +- 36 issues closed (32 Community issues closed) + +Top Community Contributors + +The following people contributed to PowerShell docs this month by submitting pull requests or +filing issues. Thank you! + +| GitHub Id | PRs merged | Issues opened | +| ----------- | :--------: | :-----------: | +| changeworld | 3 | | +| sethvs | 2 | | +| yashanshh | 2 | | +| Gijsreyn | 2 | | +| TNGBBK | | 2 | + ## 2025-July New content diff --git a/reference/docs-conceptual/community/hall-of-fame.md b/reference/docs-conceptual/community/hall-of-fame.md index a90ee7885f2..b51d2a12f1c 100644 --- a/reference/docs-conceptual/community/hall-of-fame.md +++ b/reference/docs-conceptual/community/hall-of-fame.md @@ -1,6 +1,6 @@ --- description: List of the GitHub users that have the most contributions to the PowerShell-Doc project. -ms.date: 08/04/2025 +ms.date: 09/02/2025 title: Community contributor Hall of Fame --- # Community Contributor Hall of Fame @@ -17,7 +17,7 @@ Pull Requests help us fix those issues and make the documentation better for eve | PRs Merged | 2015 | 2016 | 2017 | 2018 | 2019 | 2020 | 2021 | 2022 | 2023 | 2024 | 2025 | Grand Total | | ------------------ | ---: | ---: | ---: | ---: | ---: | ---: | ---: | ---: | ---: | ---: | ---: | ----------: | -| Community | 3 | 194 | 446 | 467 | 321 | 160 | 99 | 121 | 108 | 81 | 128 | 2128 | +| Community | 3 | 194 | 446 | 467 | 321 | 160 | 99 | 121 | 108 | 81 | 132 | 2132 | | matt9ucci | | | 157 | 80 | 30 | 1 | 6 | | | | | 274 | | nschonni | | | | 14 | 138 | 10 | | | | | | 162 | | kiazhi | | 25 | 79 | 12 | | | | | | | | 116 | @@ -28,7 +28,7 @@ Pull Requests help us fix those issues and make the documentation better for eve | ehmiiz | | | | | | | | 22 | 14 | | | 36 | | ArieHein | | | | | 1 | | | | | 7 | 25 | 33 | | yecril71pl | | | | | | 21 | 3 | 3 | | | | 27 | -| changeworld | | | | | | | | 3 | | | 20 | 23 | +| changeworld | | | | | | | | 3 | | | 22 | 25 | | skycommand | | | 1 | 3 | 3 | 6 | | 1 | 4 | 1 | 2 | 21 | | Dan1el42 | | 20 | | | | | | | | | | 20 | | NReilingh | | 2 | | 13 | 3 | | | | | | | 18 | @@ -48,15 +48,15 @@ GitHub issues help us identify errors and gaps in our documentation. | Issues Opened | 2015 | 2016 | 2017 | 2018 | 2019 | 2020 | 2021 | 2022 | 2023 | 2024 | 2025 | Grand Total | | ------------------ | ---: | ---: | ---: | ---: | ---: | ---: | ---: | ---: | ---: | ---: | ---: | ----------: | -| Community | 3 | 54 | 95 | 211 | 562 | 557 | 363 | 225 | 270 | 220 | 105 | 2665 | +| Community | 3 | 54 | 95 | 210 | 562 | 557 | 363 | 225 | 270 | 220 | 114 | 2673 | | mklement0 | | | 19 | 60 | 56 | 61 | 28 | 8 | 20 | 24 | 2 | 278 | | ehmiiz | | | | | | | | 20 | 14 | | | 34 | | iSazonov | | | 1 | 4 | 10 | 8 | 4 | 3 | | 1 | | 31 | +| iRon7 | | | | | | 2 | 2 | 2 | 10 | 8 | 3 | 27 | | jszabo98 | | | | 2 | 15 | 6 | 1 | | 1 | 2 | | 27 | -| iRon7 | | | | | | 2 | 2 | 2 | 10 | 8 | 2 | 26 | | juvtib | | | | | | 15 | 7 | | | | | 22 | +| surfingoldelephant | | | | | | | | | | 6 | 15 | 21 | | doctordns | | | 5 | 3 | 5 | 7 | 1 | | | | | 21 | -| surfingoldelephant | | | | | | | | | | 6 | 14 | 20 | | peetrike | | | | 1 | | 4 | 2 | 6 | 4 | 3 | | 20 | | JustinGrote | | | | 1 | 3 | 6 | 1 | 1 | 2 | 2 | 2 | 18 | | vexx32 | | | | 3 | 11 | | | 3 | | | | 17 | diff --git a/reference/docs-conceptual/discover-powershell.md b/reference/docs-conceptual/discover-powershell.md index f33c170728b..d1d84a4811e 100644 --- a/reference/docs-conceptual/discover-powershell.md +++ b/reference/docs-conceptual/discover-powershell.md @@ -1,6 +1,6 @@ --- description: Learn what PowerShell is and some essential commands used to discover more about PowerShell. -ms.date: 01/31/2023 +ms.date: 09/02/2025 ms.topic: overview title: Discover PowerShell --- @@ -11,28 +11,25 @@ PowerShell is a command-line shell and a scripting language in one. PowerShell s Windows to help automate administrative tasks. Now, it runs cross platform and can be used for various tasks. -The thing that makes PowerShell unique is that it accepts and returns .NET objects, rather than -text. This feature makes it easier to connect different commands in a _pipeline_. +What makes PowerShell unique is that it accepts and returns .NET objects, rather than text. This +feature makes it easier to connect different commands in a _pipeline_. ## What can PowerShell be used for? -Usage of PowerShell has grown since the days when it was Windows-only. It's still used for Windows -task automation, but today, you can use it for tasks like: +Initially, PowerShell was Windows-only. Now, it's cross-platform and can be used for various tasks +like: - **Cloud management**. PowerShell can be used to manage cloud resources. For example, you can - retrieve information about cloud resources, as well as update or deploy new resources. + retrieve information, update, or deploy new resources. - **CI/CD**. It can also be used as part of a Continuous Integration/Continuous Deployment pipeline. - **Automate tasks for Active Directory and Exchange**. You can use it to automate almost any task on Windows like creating users in Active Directory and mailboxes in Exchange. -There are many more areas of usage but the preceding list gives you a hint that PowerShell has come -a long way. - ## Who uses PowerShell? PowerShell is a powerful tool that can help people working in a multitude of roles. Traditionally, -PowerShell has been used by the System Administrator role but is now being used by people calling -themselves DevOps, Cloud Ops, and even Developers. +PowerShell was used by the System Administrators. Now it's being used by people calling themselves +DevOps, Cloud Ops, and even Developers. ## PowerShell cmdlets @@ -53,8 +50,8 @@ discover what commands are available, what they do, and what types they operate - `Get-Verb`. Running this command returns a list of verbs that most commands adhere to. The response includes a description of what these verbs do. Since most commands follow this naming - convention, it sets expectations on what a command does. This helps you select the appropriate - command and what to name a command, should you be creating one. + convention, it sets expectations on what a command does. This command helps you select the + appropriate verb and what to name a command when you create your own commands. - `Get-Command`. This command retrieves a list of all commands installed on your machine. - `Get-Member`. It operates on object based output and is able to discover what object, properties and methods are available for a command. @@ -92,8 +89,8 @@ Exit ex Common Sets the current environment or context to the m ## Find commands with Get-Command The `Get-Command` cmdlet returns a list of all available commands installed on your system. The list -you get back is quite large. You can limit the amount of information that comes back by filtering -the response using parameters or helper cmdlets. +can be large. You can limit the amount of information that comes back by filtering the response +using parameters or helper cmdlets. ### Filter on name @@ -205,9 +202,9 @@ You can also use other cmdlets to filter results. ## Explore objects with Get-Member -Once you've been able to locate the cmdlet you want, you want to know more about what output it -produces. The `Get-Member` cmdlet displays the type, properties, and methods of an object. Pipe the -output you want to inspect to `Get-Member`. +Once you locate the cmdlet you want, you want to know more about what output it produces. The +`Get-Member` cmdlet displays the type, properties, and methods of an object. Pipe the output you +want to inspect to `Get-Member`. ```powershell Get-Process | Get-Member @@ -233,8 +230,8 @@ Get-Process | Get-Member -MemberType Method ``` By default PowerShell only displays a few properties. The previous example displayed the `Name`, -`MemberType` and `Definition` members. You can use `Select-Object` to specify properties you want to -see. For example, you want to display only the `Name` and `Definition` properties: +`MemberType`, and `Definition` members. You can use `Select-Object` to specify properties you want +to see. For example, you want to display only the `Name` and `Definition` properties: ```powershell Get-Process | Get-Member | Select-Object Name, Definition diff --git a/reference/module/index.md b/reference/module/index.md index 071f28ce23d..2124e30545e 100644 --- a/reference/module/index.md +++ b/reference/module/index.md @@ -12,7 +12,7 @@ ms.manager: sewhee ms.product: powershell ms.topic: landing-page quickFilterColumn1: powershell-7.4,windowsserver2025-ps -quickFilterColumn2: azps-14.3.0,sqlserver-ps +quickFilterColumn2: azps-14.4.0,sqlserver-ps quickFilterColumn3: graph-powershell-1.0,systemcenter-ps-2022 title: PowerShell Module Browser ---