Contact Info

Crumbtrail

ActiveXperts.com » Administration » Powershell » Powershell 2.0 » Get-Help

Get-Help - Powershell 2.0 CmdLet

Microsoft Windows PowerShell is a command-line shell and scripting tool based on the Microsoft .NET Framework. It is designed for system administrators, engineers and developers to control and automate the administration of Windows and applications.

More than hundred command-line tools (so called "cmdlets") can be used to perform system administration tasks and Windows Management Instrumentation (WMI). These cmdlets are easy to use, with standard naming conventions and common parameters, and standard tools for piping, sorting, filtering, and formatting data and objects.

Get-Help


Short description
Displays information about Windows PowerShell commands and concepts.

Syntax
Get-Help [-Full] [[-Name] <string>] [-Category <string[]>] [-Component <string[]>] [-Functionality <string[]>] [-On
    line] [-Path <string>] [-Role <string[]>] [<CommonParameters>]
    
    Get-Help [-Detailed] [[-Name] <string>] [-Category <string[]>] [-Component <string[]>] [-Functionality <string[]>] 
    [-Online] [-Path <string>] [-Role <string[]>] [<CommonParameters>]
    
    Get-Help [-Examples] [[-Name] <string>] [-Category <string[]>] [-Component <string[]>] [-Functionality <string[]>] 
    [-Online] [-Path <string>] [-Role <string[]>] [<CommonParameters>]
    
    Get-Help [-Parameter <string>] [[-Name] <string>] [-Category <string[]>] [-Component <string[]>] [-Functionality <s
    tring[]>] [-Online] [-Path <string>] [-Role <string[]>] [<CommonParameters>]

Description
The Get-Help cmdlet displays information about Windows PowerShell concepts and commands, including cmdlets, provide
    rs, functions and scripts. To get a list of all cmdlet help topic titles, type "get-help *". 
    
    If you type "Get-Help" followed by the exact name of a help topic, or by a word unique to a help topic, Get-Help di
    splays the topic contents. If you enter a word or word pattern that appears in several help topic titles, Get-Help 
    displays a list of the matching titles. If you enter a word that does not appear in any help topic titles, Get-Help
     displays a list of topics that include that word in their contents.
    
    In addition to "get-help", you can also type "help" or "man", which displays one screen of text at a time, or "<cmd
    let-name> -?", which is identical to Get-Help but works only for cmdlets. 
    
    You can display the entire help file or selected parts of the file, such as the syntax, parameters, or examples. Yo
    u can also use the Online parameter to display an online version of a help file in your Internet browser. These par
    ameters have no effect on conceptual help topics.
    
    Conceptual help topics in Windows PowerShell begin with "about_", such as "about_Comparison_Operators". To see all 
    "about_" topics, type "get-help about_*". To see a particular topic, type "get-help about_<topic-name>", such as "g
    et-help about_Comparison_Operators".