Skip to content

Commit 3cdd670

Browse files
committed
Fix descriptions of Out-Default and Out-Host
1 parent 602c333 commit 3cdd670

File tree

8 files changed

+112
-162
lines changed

8 files changed

+112
-162
lines changed

reference/5.1/Microsoft.PowerShell.Core/Out-Default.md

Lines changed: 7 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
external help file: System.Management.Automation.dll-Help.xml
33
Locale: en-US
44
Module Name: Microsoft.PowerShell.Core
5-
ms.date: 02/07/2023
5+
ms.date: 04/17/2025
66
online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.core/out-default?view=powershell-5.1&WT.mc_id=ps-gethelp
77
schema: 2.0.0
88
title: Out-Default
@@ -20,24 +20,9 @@ Out-Default [-Transcript] [-InputObject <PSObject>] [<CommonParameters>]
2020

2121
## DESCRIPTION
2222

23-
PowerShell automatically adds `Out-Default` to the end of every pipeline. `Out-Default` decides how
24-
to format and output the object stream. If the object stream is a stream of strings, `Out-Default`
25-
pipes these directly to `Out-Host` which calls the appropriate APIs provided by the host. If the
26-
object stream does not contain strings, `Out-Default` inspects the object to determine what to do.
27-
First it looks at the object type and determines whether there is a registered _view_ for this
28-
object type.
29-
30-
PowerShell defines an XML schema and a mechanism (the `Update-FormatData` cmdlet) where anyone can
31-
register views for an object type. You can specify **wide**, **list**, **table**, or **custom**
32-
views for any object type. The views specify which properties to display and how they should be
33-
displayed. If a view is registered, it defines which formatter to use. So if the registered view is
34-
a **table** view, `Out-Default` streams the objects to `Format-Table | Out-Host`. `Format-Table`
35-
transforms the objects into a stream of Formatting records (driven by the data in the view
36-
definition) and `Out-Host` transforms the formatting records into calls on the Host interface.
37-
38-
This cmdlet isn't intended to be used by the end user. Other cmdlets are recommended for controlling
39-
output like [Out-Host](Out-Host.md) or using `Format-*` cmdlets and the [Format.ps1xml](About/about_format.ps1xml.md)
40-
file to control formatting.
23+
PowerShell automatically adds `Out-Default` to the end of every top-level interactive pipeline.
24+
`Out-Default` passes the objects it receives to the PowerShell format system. Then, it writes the
25+
formatted output to the console. This cmdlet isn't intended to be used by the end user.
4126

4227
## EXAMPLES
4328

@@ -82,7 +67,7 @@ Accept wildcard characters: False
8267
8368
### -Transcript
8469
85-
Determines whether the output should be sent to PowerShell's transcription services.
70+
When you use this parameter, the output is only sent to the PowerShell transcript.
8671
8772
```yaml
8873
Type: System.Management.Automation.SwitchParameter
@@ -100,7 +85,8 @@ Accept wildcard characters: False
10085
10186
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
10287
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
103-
-WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
88+
-WarningAction, and -WarningVariable. For more information, see
89+
[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
10490
10591
## INPUTS
10692

reference/5.1/Microsoft.PowerShell.Core/Out-Host.md

Lines changed: 22 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
external help file: System.Management.Automation.dll-Help.xml
33
Locale: en-US
44
Module Name: Microsoft.PowerShell.Core
5-
ms.date: 12/31/2022
5+
ms.date: 04/17/2025
66
online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.core/out-host?view=powershell-5.1&WT.mc_id=ps-gethelp
77
schema: 2.0.0
88
title: Out-Host
@@ -27,10 +27,9 @@ The `Out-Host` cmdlet sends output to the PowerShell host for display. The host
2727
at the command line. Because `Out-Host` is the default, you don't have to specify it unless you want
2828
to use its parameters.
2929

30-
`Out-Host` is automatically appended to every command that is executed. It passes the output of the
31-
pipeline to the host executing the command. `Out-Host` ignores ANSI escape sequences. The escape
32-
sequences are handled by the host. `Out-Host` passes ANSI escape sequences to the host without
33-
trying to interpret or change them.
30+
`Out-Host` passes the output of the pipeline to the host executing the command. `Out-Host` ignores
31+
ANSI escape sequences. The escape sequences are handled by the host. `Out-Host` passes ANSI escape
32+
sequences to the host without trying to interpret or change them.
3433

3534
## EXAMPLES
3635

@@ -89,14 +88,14 @@ Accept wildcard characters: False
8988
9089
### -Paging
9190
92-
Indicates that `Out-Host` displays one page of output at a time, and waits for user input before the
93-
remaining pages are displayed. By default, all the output is displayed on a single page. The page
94-
size is determined by the characteristics of the host.
91+
Indicates that `Out-Host` displays one page of output at a time. The page size is determined by the
92+
characteristics of the host.
9593

96-
Press the <kbd>Space</kbd> bar to display the next page of output or the <kbd>Enter</kbd> key to
97-
view the next line of output. Press <kbd>Q</kbd> to quit.
94+
After outputting the first page, the command waits for user input before the remaining pages are
95+
displayed. Press the <kbd>Spacebar</kbd> to display the next page of output or the <kbd>Enter</kbd>
96+
key to view the next line of output. Press <kbd>Q</kbd> to quit.
9897

99-
**Paging** is similar to the **more** command.
98+
Using **Paging** is similar to using the **more** command.
10099

101100
> [!NOTE]
102101
> The **Paging** parameter isn't supported by the PowerShell ISE host.
@@ -117,7 +116,8 @@ Accept wildcard characters: False
117116

118117
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
119118
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
120-
-WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
119+
-WarningAction, and -WarningVariable. For more information, see
120+
[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
121121

122122
## INPUTS
123123

@@ -137,20 +137,22 @@ Windows PowerShell includes the following aliases for `Out-Host`:
137137

138138
- `oh`
139139

140-
The **Paging** parameter isn't supported by all PowerShell hosts. For example, if you use the
141-
**Paging** parameter in the PowerShell ISE, the following error is displayed:
142-
`out-lineoutput : The method or operation is not implemented.`
140+
Not all PowerShell hosts support the **Paging** parameter. For example, if you use the **Paging**
141+
parameter in the Windows PowerShell ISE, the following error is displayed:
142+
143+
> out-lineoutput : The method or operation is not implemented.
143144

144145
The cmdlets that contain the **Out** verb, `Out-`, don't format objects. They render objects and
145146
send them to the specified display destination. If you send an unformatted object to an `Out-`
146147
cmdlet, the cmdlet sends it to a formatting cmdlet before rendering it.
147148

148-
The `Out-` cmdlets don't have parameters for names or file paths. To send data to an `Out-` cmdlet,
149-
use the pipeline to send a PowerShell command's output to the cmdlet. Or, you can store data in a
150-
variable and use the **InputObject** parameter to pass the data to the cmdlet.
149+
The `Out-` cmdlets don't read input from files. To send data to an `Out-` cmdlet, use the pipeline
150+
to send data to the cmdlet. Or, you can store data in a variable and use the **InputObject**
151+
parameter to pass the data to the cmdlet.
151152

152-
`Out-Host` sends data, but it doesn't produce any output objects. If you pipeline the output of
153-
`Out-Host` to the `Get-Member` cmdlet, `Get-Member` reports that no objects have been specified.
153+
`Out-Host` sends data to the host only. Tt doesn't produce output objects to the pipeline. If you
154+
pipeline the output of `Out-Host` to the `Get-Member` cmdlet, `Get-Member` reports that no objects
155+
have been specified.
154156

155157
## RELATED LINKS
156158

reference/7.4/Microsoft.PowerShell.Core/Out-Default.md

Lines changed: 7 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
external help file: System.Management.Automation.dll-Help.xml
33
Locale: en-US
44
Module Name: Microsoft.PowerShell.Core
5-
ms.date: 02/07/2023
5+
ms.date: 04/17/2025
66
online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.core/out-default?view=powershell-7.4&WT.mc_id=ps-gethelp
77
schema: 2.0.0
88
title: Out-Default
@@ -20,24 +20,9 @@ Out-Default [-Transcript] [-InputObject <PSObject>] [<CommonParameters>]
2020

2121
## DESCRIPTION
2222

23-
PowerShell automatically adds `Out-Default` to the end of every pipeline. `Out-Default` decides how
24-
to format and output the object stream. If the object stream is a stream of strings, `Out-Default`
25-
pipes these directly to `Out-Host` which calls the appropriate APIs provided by the host. If the
26-
object stream does not contain strings, `Out-Default` inspects the object to determine what to do.
27-
First it looks at the object type and determines whether there is a registered _view_ for this
28-
object type.
29-
30-
PowerShell defines an XML schema and a mechanism (the `Update-FormatData` cmdlet) where anyone can
31-
register views for an object type. You can specify **wide**, **list**, **table**, or **custom**
32-
views for any object type. The views specify which properties to display and how they should be
33-
displayed. If a view is registered, it defines which formatter to use. So if the registered view is
34-
a **table** view, `Out-Default` streams the objects to `Format-Table | Out-Host`. `Format-Table`
35-
transforms the objects into a stream of Formatting records (driven by the data in the view
36-
definition) and `Out-Host` transforms the formatting records into calls on the Host interface.
37-
38-
This cmdlet isn't intended to be used by the end user. Other cmdlets are recommended for controlling
39-
output like [Out-Host](Out-Host.md) or using `Format-*` cmdlets and the [Format.ps1xml](About/about_format.ps1xml.md)
40-
file to control formatting.
23+
PowerShell automatically adds `Out-Default` to the end of every top-level interactive pipeline.
24+
`Out-Default` passes the objects it receives to the PowerShell format system. Then, it writes the
25+
formatted output to the console. This cmdlet isn't intended to be used by the end user.
4126

4227
## EXAMPLES
4328

@@ -82,7 +67,7 @@ Accept wildcard characters: False
8267
8368
### -Transcript
8469
85-
Determines whether the output should be sent to PowerShell's transcription services.
70+
When you use this parameter, the output is only sent to the PowerShell transcript.
8671
8772
```yaml
8873
Type: System.Management.Automation.SwitchParameter
@@ -100,7 +85,8 @@ Accept wildcard characters: False
10085
10186
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
10287
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
103-
-WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
88+
-WarningAction, and -WarningVariable. For more information, see
89+
[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
10490
10591
## INPUTS
10692

reference/7.4/Microsoft.PowerShell.Core/Out-Host.md

Lines changed: 22 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
external help file: System.Management.Automation.dll-Help.xml
33
Locale: en-US
44
Module Name: Microsoft.PowerShell.Core
5-
ms.date: 12/31/2022
5+
ms.date: 04/17/2025
66
online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.core/out-host?view=powershell-7.4&WT.mc_id=ps-gethelp
77
schema: 2.0.0
88
title: Out-Host
@@ -27,10 +27,9 @@ The `Out-Host` cmdlet sends output to the PowerShell host for display. The host
2727
at the command line. Because `Out-Host` is the default, you don't have to specify it unless you want
2828
to use its parameters.
2929

30-
`Out-Host` is automatically appended to every command that is executed. It passes the output of the
31-
pipeline to the host executing the command. `Out-Host` ignores ANSI escape sequences. The escape
32-
sequences are handled by the host. `Out-Host` passes ANSI escape sequences to the host without
33-
trying to interpret or change them.
30+
`Out-Host` passes the output of the pipeline to the host executing the command. `Out-Host` ignores
31+
ANSI escape sequences. The escape sequences are handled by the host. `Out-Host` passes ANSI escape
32+
sequences to the host without trying to interpret or change them.
3433

3534
## EXAMPLES
3635

@@ -89,14 +88,14 @@ Accept wildcard characters: False
8988
9089
### -Paging
9190
92-
Indicates that `Out-Host` displays one page of output at a time, and waits for user input before the
93-
remaining pages are displayed. By default, all the output is displayed on a single page. The page
94-
size is determined by the characteristics of the host.
91+
Indicates that `Out-Host` displays one page of output at a time. The page size is determined by the
92+
characteristics of the host.
9593

96-
Press the <kbd>Space</kbd> bar to display the next page of output or the <kbd>Enter</kbd> key to
97-
view the next line of output. Press <kbd>Q</kbd> to quit.
94+
After outputting the first page, the command waits for user input before the remaining pages are
95+
displayed. Press the <kbd>Spacebar</kbd> to display the next page of output or the <kbd>Enter</kbd>
96+
key to view the next line of output. Press <kbd>Q</kbd> to quit.
9897

99-
**Paging** is similar to the **more** command.
98+
Using **Paging** is similar to using the **more** command.
10099

101100
> [!NOTE]
102101
> The **Paging** parameter isn't supported by the PowerShell ISE host.
@@ -117,7 +116,8 @@ Accept wildcard characters: False
117116

118117
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
119118
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
120-
-WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
119+
-WarningAction, and -WarningVariable. For more information, see
120+
[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
121121

122122
## INPUTS
123123

@@ -138,20 +138,22 @@ PowerShell includes the following aliases for `Out-Host`:
138138
- All platforms:
139139
- `oh`
140140

141-
The **Paging** parameter isn't supported by all PowerShell hosts. For example, if you use the
142-
**Paging** parameter in the PowerShell ISE, the following error is displayed:
143-
`out-lineoutput : The method or operation is not implemented.`
141+
Not all PowerShell hosts support the **Paging** parameter. For example, if you use the **Paging**
142+
parameter in the Windows PowerShell ISE, the following error is displayed:
143+
144+
> out-lineoutput : The method or operation is not implemented.
144145

145146
The cmdlets that contain the **Out** verb, `Out-`, don't format objects. They render objects and
146147
send them to the specified display destination. If you send an unformatted object to an `Out-`
147148
cmdlet, the cmdlet sends it to a formatting cmdlet before rendering it.
148149

149-
The `Out-` cmdlets don't have parameters for names or file paths. To send data to an `Out-` cmdlet,
150-
use the pipeline to send a PowerShell command's output to the cmdlet. Or, you can store data in a
151-
variable and use the **InputObject** parameter to pass the data to the cmdlet.
150+
The `Out-` cmdlets don't read input from files. To send data to an `Out-` cmdlet, use the pipeline
151+
to send data to the cmdlet. Or, you can store data in a variable and use the **InputObject**
152+
parameter to pass the data to the cmdlet.
152153

153-
`Out-Host` sends data, but it doesn't produce any output objects. If you pipeline the output of
154-
`Out-Host` to the `Get-Member` cmdlet, `Get-Member` reports that no objects have been specified.
154+
`Out-Host` sends data to the host only. Tt doesn't produce output objects to the pipeline. If you
155+
pipeline the output of `Out-Host` to the `Get-Member` cmdlet, `Get-Member` reports that no objects
156+
have been specified.
155157

156158
## RELATED LINKS
157159

reference/7.5/Microsoft.PowerShell.Core/Out-Default.md

Lines changed: 5 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
external help file: System.Management.Automation.dll-Help.xml
33
Locale: en-US
44
Module Name: Microsoft.PowerShell.Core
5-
ms.date: 02/07/2023
5+
ms.date: 04/17/2025
66
online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.core/out-default?view=powershell-7.5&WT.mc_id=ps-gethelp
77
schema: 2.0.0
88
title: Out-Default
@@ -20,24 +20,9 @@ Out-Default [-Transcript] [-InputObject <PSObject>] [<CommonParameters>]
2020

2121
## DESCRIPTION
2222

23-
PowerShell automatically adds `Out-Default` to the end of every pipeline. `Out-Default` decides how
24-
to format and output the object stream. If the object stream is a stream of strings, `Out-Default`
25-
pipes these directly to `Out-Host` which calls the appropriate APIs provided by the host. If the
26-
object stream does not contain strings, `Out-Default` inspects the object to determine what to do.
27-
First it looks at the object type and determines whether there is a registered _view_ for this
28-
object type.
29-
30-
PowerShell defines an XML schema and a mechanism (the `Update-FormatData` cmdlet) where anyone can
31-
register views for an object type. You can specify **wide**, **list**, **table**, or **custom**
32-
views for any object type. The views specify which properties to display and how they should be
33-
displayed. If a view is registered, it defines which formatter to use. So if the registered view is
34-
a **table** view, `Out-Default` streams the objects to `Format-Table | Out-Host`. `Format-Table`
35-
transforms the objects into a stream of Formatting records (driven by the data in the view
36-
definition) and `Out-Host` transforms the formatting records into calls on the Host interface.
37-
38-
This cmdlet isn't intended to be used by the end user. Other cmdlets are recommended for controlling
39-
output like [Out-Host](Out-Host.md) or using `Format-*` cmdlets and the
40-
[Format.ps1xml](About/about_Format.ps1xml.md) file to control formatting.
23+
PowerShell automatically adds `Out-Default` to the end of every top-level interactive pipeline.
24+
`Out-Default` passes the objects it receives to the PowerShell format system. Then, it writes the
25+
formatted output to the console. This cmdlet isn't intended to be used by the end user.
4126

4227
## EXAMPLES
4328

@@ -82,7 +67,7 @@ Accept wildcard characters: False
8267
8368
### -Transcript
8469
85-
Determines whether the output should be sent to PowerShell's transcription services.
70+
When you use this parameter, the output is only sent to the PowerShell transcript.
8671
8772
```yaml
8873
Type: System.Management.Automation.SwitchParameter

0 commit comments

Comments
 (0)