Skip to content

[Fixes #6448] Updates Get-Help 7.1 #6543

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 24, 2020
Merged

[Fixes #6448] Updates Get-Help 7.1 #6543

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
69 changes: 49 additions & 20 deletions reference/7.1/Microsoft.PowerShell.Core/Get-Help.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ external help file: System.Management.Automation.dll-Help.xml
keywords: powershell,cmdlet
Locale: en-US
Module Name: Microsoft.PowerShell.Core
ms.date: 10/28/2019
ms.date: 08/24/2020
online version: https://docs.microsoft.com/powershell/module/microsoft.powershell.core/get-help?view=powershell-7.1&WT.mc_id=ps-gethelp
schema: 2.0.0
title: Get-Help
Expand All @@ -20,42 +20,42 @@ Displays information about PowerShell commands and concepts.

```
Get-Help [[-Name] <String>] [-Path <String>] [-Category <String[]>] [-Full] [-Component <String[]>]
[-Functionality <String[]>] [-Role <String[]>] [<CommonParameters>]
[-Functionality <String[]>] [-Paged] [-Role <String[]>] [<CommonParameters>]
```

### DetailedView

```
Get-Help [[-Name] <String>] [-Path <String>] [-Category <String[]>] -Detailed
[-Component <String[]>] [-Functionality <String[]>] [-Role <String[]>] [<CommonParameters>]
[-Component <String[]>] [-Functionality <String[]>] [-Paged] [-Role <String[]>] [<CommonParameters>]
```

### Examples

```
Get-Help [[-Name] <String>] [-Path <String>] [-Category <String[]>] -Examples
[-Component <String[]>] [-Functionality <String[]>] [-Role <String[]>] [<CommonParameters>]
[-Component <String[]>] [-Functionality <String[]>] [-Paged] [-Role <String[]>] [<CommonParameters>]
```

### Parameters

```
Get-Help [[-Name] <String>] [-Path <String>] [-Category <String[]>] -Parameter <String[]>
[-Component <String[]>] [-Functionality <String[]>] [-Role <String[]>] [<CommonParameters>]
[-Component <String[]>] [-Functionality <String[]>] [-Paged] [-Role <String[]>] [<CommonParameters>]
```

### Online

```
Get-Help [[-Name] <String>] [-Path <String>] [-Category <String[]>] [-Component <String[]>]
[-Functionality <String[]>] [-Role <String[]>] -Online [<CommonParameters>]
[-Functionality <String[]>] [-Paged] [-Role <String[]>] -Online [<CommonParameters>]
```

### ShowWindow

```
Get-Help [[-Name] <String>] [-Path <String>] [-Category <String[]>] [-Component <String[]>]
[-Functionality <String[]>] [-Role <String[]>] -ShowWindow [<CommonParameters>]
[-Functionality <String[]>] [-Paged] [-Role <String[]>] -ShowWindow [<CommonParameters>]
```

## DESCRIPTION
Expand Down Expand Up @@ -89,11 +89,11 @@ version of a help file, use the **Online** parameter, such as: `Get-Help Get-Pro
read all the PowerShell documentation, see the Microsoft Docs [PowerShell Documentation](/powershell).

If you type `Get-Help` followed by the exact name of a help article, or by a word unique to a help
article, `Get-Help` displays the article's content. If you specify the exact name of a command alias,
`Get-Help` displays the help for the original command. If you enter a word or word pattern that appears
in several help article titles, `Get-Help` displays a list of the matching titles. If you enter any text
that doesn't appear in any help article titles, `Get-Help` displays a list of articles that
include that text in their contents.
article, `Get-Help` displays the article's content. If you specify the exact name of a command
alias, `Get-Help` displays the help for the original command. If you enter a word or word pattern
that appears in several help article titles, `Get-Help` displays a list of the matching titles. If
you enter any text that doesn't appear in any help article titles, `Get-Help` displays a list of
articles that include that text in their contents.

`Get-Help` can get help articles for all supported languages and locales. `Get-Help` first looks for
help files in the locale set for Windows, then in the parent locale, such as **pt** for **pt-BR**,
Expand Down Expand Up @@ -185,7 +185,19 @@ is shown.

These parameters aren't effective for the conceptual (**about_**) help articles.

### Example 5: Display online version of help
### Example 5: Display help and use paging to navigate

This example displays help and allows you to navigate using the up and down arrows.

```powershell
Get-Help -Name Get-Command -Paged
```

The **Paged** parameter allows you to navigate the help with the up and down arrows. You can press
<kbd>Q</kbd> to exit the paging navigation. All other keyboard input will be ignored until
<kbd>Q</kbd> is pressed.

### Example 6: Display online version of help

This example displays the online version of the help article for the `Format-Table` cmdlet in your
default web browser.
Expand All @@ -194,23 +206,23 @@ default web browser.
Get-Help Format-Table -Online
```

### Example 6: Display help about the help system
### Example 7: Display help about the help system

The `Get-Help` cmdlet without parameters displays information about the PowerShell help system.

```powershell
Get-Help
```

### Example 7: Display available help articles
### Example 8: Display available help articles

This example displays a list of all help articles available on your computer.

```powershell
Get-Help *
```

### Example 8: Display a list of conceptual articles
### Example 9: Display a list of conceptual articles

This example displays a list of the conceptual articles included in PowerShell help. All these
articles begin with the characters **about_**. To display a particular help file, type
Expand All @@ -223,7 +235,7 @@ information about downloading and installing help files in PowerShell 3.0, see [
Get-Help about_*
```

### Example 9: Search for a word in cmdlet help
### Example 10: Search for a word in cmdlet help

This example shows how to search for a word in a cmdlet help article.

Expand All @@ -243,7 +255,7 @@ Import-Clixml
to convert the object into a string. `Select-String` uses the **Pattern** parameter to search the
string for **Clixml**.

### Example 10: Display a list of articles that include a word
### Example 11: Display a list of articles that include a word

This example displays a list of articles that include the word **remoting**.

Expand All @@ -262,7 +274,7 @@ Disable-PSRemoting Cmdlet Microsoft.PowerShell.Core Prevents r
Enable-PSRemoting Cmdlet Microsoft.PowerShell.Core Configures the computer...
```

### Example 11: Display provider-specific help
### Example 12: Display provider-specific help

This example shows two ways of getting the provider-specific help for `Get-Item`. These commands get
help that explains how to use the `Get-Item` cmdlet in the PowerShell SQL Server provider's
Expand Down Expand Up @@ -309,7 +321,7 @@ SYNOPSIS
...
```

### Example 12: Display help for a script
### Example 13: Display help for a script

This example gets help for the `MyScript.ps1 script`. For information about how to write help for
your functions and scripts, see [about_Comment_Based_Help](./About/about_Comment_Based_Help.md).
Expand Down Expand Up @@ -506,6 +518,23 @@ Accept pipeline input: False
Accept wildcard characters: False
```

### -Paged

Allows you to navigate help with the up and down arrows. You can press <kbd>Q</kbd> to exit the
paging navigation. All other keyboard input will be ignored until <kbd>Q</kbd> is pressed.

```yaml
Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```

### -Parameter

Displays only the detailed descriptions of the specified parameters. Wildcards are permitted. This
Expand Down