PowerShell Get-Help

PowerShell includes its own extensive, console-based help (similar to man pages in Unix /Linux shells) accessible via the Get-Help cmdlet.

The Get-Help cmdlet displays information about PowerShell concepts and commands, including cmdlets, functions, CIM commands, workflows, providers, aliases and scripts.

To get help for a PowerShell provider, type Get-Help followed by the provider name. For example, to get help for the Certificate provider, type Get-Help Certificate.

To get help for a cmdlet, type:

PS C:\> Get-Help 

To get online help, type:

PS C:\> Get-Help   -Online

For more information about the Get-Help cmdlet, type:

PS C:\> Get-Help Get-Help -Online

The help is a function that runs Get-Help cmdlet internally and displays the result one page at a time.

The man is an alias for the help function.

Display basic information about a command

PS C:\> Get-Help Format-Table
PS C:\> Get-Help -Name Format-Table

Display basic information one page at a time

PS C:\> Get-Help Format-Table | Out-Host   -Paging
 or
PS C:\> help  Format-Table 
 or 
PS C:\> man  Format-Table 

Display more information for a cmdlet

PS C:\> Get-Help Format-Table -Detailed
PS C:\> Get-Help Format-Table -Full

Display selected parts of a cmdlet by using parameters

PS C:\> Get-Help Format-Table -Examples
PS C:\> Get-Help Format-Table -Parameter GroupBy
PS C:\> Get-Help Format-Table -Parameter *

Display available help topics

PS C:\> Get-Help *

Display a list of conceptual topics

PS C:\> Get-Help about_*
Advertisements

Learn Technology

%d bloggers like this: