Skip to content

Commit f30dd6b

Browse files
(MicrosoftDocsGH-11332) Fix pager info for built-in help function (MicrosoftDocs#11335)
Prior to this change, the documentation for the built-in `help` function in `about_Built-in_Functions` incorrectly stated that PowerShell always uses `more` for the pager on Windows and the `PAGER` environment variable on non-Windows systems. This change: - Clarifies that PowerShell uses a default pager for both Windows (`more`) and non-Windows (`less`) systems. - Clarifies that when the `PAGER` environment variable is defined, PowerShell uses that command instead of the default pager on both Windows and non-Windows systems. - Fixes AB#297346 - Resolves MicrosoftDocs#11332
1 parent d70a397 commit f30dd6b

File tree

4 files changed

+23
-14
lines changed

4 files changed

+23
-14
lines changed

reference/5.1/Microsoft.PowerShell.Core/About/about_Built-in_Functions.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
description: Describes the built-in functions in PowerShell.
33
Locale: en-US
4-
ms.date: 06/13/2024
4+
ms.date: 08/14/2024
55
online version: https://learn.microsoft.com/powershell/module/Microsoft.PowerShell.Core/about/about_built-in_functions?view=powershell-5.1&WT.mc_id=ps-gethelp
66
schema: 2.0.0
77
title: about Built-in Functions
@@ -46,7 +46,7 @@ more information, see [Get-Verb](xref:Microsoft.PowerShell.Core.Get-Verb)
4646
## `help`
4747

4848
This function invokes `Get-Help` with your parameters and passes the output to
49-
the systems pager command, `more.com`.
49+
the system's pager command, `more.com`.
5050

5151
## `ImportSystemModules`
5252

reference/7.2/Microsoft.PowerShell.Core/About/about_Built-in_Functions.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
description: Describes the built-in functions in PowerShell.
33
Locale: en-US
4-
ms.date: 06/13/2024
4+
ms.date: 08/14/2024
55
online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_built-in_functions?view=powershell-7.2&WT.mc_id=ps-gethelp
66
schema: 2.0.0
77
title: about Built-in Functions
@@ -41,9 +41,12 @@ The script pauses execution and prompts the user to hit a key to continue.
4141
## `help`
4242

4343
This function invokes `Get-Help` with your parameters and passes the output to
44-
the systems pager command. On Windows systems, the pager is `more.com`. On
45-
non-Windows systems, `help` uses the pager defined by the `$env:PAGER`
46-
environment variable.
44+
the system's pager command. PowerShell uses a different default pager for
45+
Windows and non-Windows systems. On Windows systems, the default pager is
46+
`more.com`. On non-Windows systems, the default pager is `less`.
47+
48+
If the `$env:PAGER` environment variable is defined, PowerShell uses the
49+
specified program instead of the system default.
4750

4851
## `prompt`
4952

reference/7.4/Microsoft.PowerShell.Core/About/about_Built-in_Functions.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
description: Describes the built-in functions in PowerShell.
33
Locale: en-US
4-
ms.date: 06/13/2024
4+
ms.date: 08/14/2024
55
online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_built-in_functions?view=powershell-7.4&WT.mc_id=ps-gethelp
66
schema: 2.0.0
77
title: about Built-in Functions
@@ -49,9 +49,12 @@ The script pauses execution and prompts the user to hit a key to continue.
4949
## `help`
5050

5151
This function invokes `Get-Help` with your parameters and passes the output to
52-
the systems pager command. On Windows systems, the pager is `more.com`. On
53-
non-Windows systems, `help` uses the pager defined by the `$env:PAGER`
54-
environment variable.
52+
the system's pager command. PowerShell uses a different default pager for
53+
Windows and non-Windows systems. On Windows systems, the default pager is
54+
`more.com`. On non-Windows systems, the default pager is `less`.
55+
56+
If the `$env:PAGER` environment variable is defined, PowerShell uses the
57+
specified program instead of the system default.
5558

5659
## `prompt`
5760

reference/7.5/Microsoft.PowerShell.Core/About/about_Built-in_Functions.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
description: Describes the built-in functions in PowerShell.
33
Locale: en-US
4-
ms.date: 06/13/2024
4+
ms.date: 08/14/2024
55
online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_built-in_functions?view=powershell-7.5&WT.mc_id=ps-gethelp
66
schema: 2.0.0
77
title: about Built-in Functions
@@ -49,9 +49,12 @@ The script pauses execution and prompts the user to hit a key to continue.
4949
## `help`
5050

5151
This function invokes `Get-Help` with your parameters and passes the output to
52-
the systems pager command. On Windows systems, the pager is `more.com`. On
53-
non-Windows systems, `help` uses the pager defined by the `$env:PAGER`
54-
environment variable.
52+
the system's pager command. PowerShell uses a different default pager for
53+
Windows and non-Windows systems. On Windows systems, the default pager is
54+
`more.com`. On non-Windows systems, the default pager is `less`.
55+
56+
If the `$env:PAGER` environment variable is defined, PowerShell uses the
57+
specified program instead of the system default.
5558

5659
## `prompt`
5760

0 commit comments

Comments
 (0)