diff --git a/reference/3.0/Microsoft.PowerShell.Core/Get-Help.md b/reference/3.0/Microsoft.PowerShell.Core/Get-Help.md index 8cc6b01cfac6..b5535fb43caf 100644 --- a/reference/3.0/Microsoft.PowerShell.Core/Get-Help.md +++ b/reference/3.0/Microsoft.PowerShell.Core/Get-Help.md @@ -9,52 +9,65 @@ title: Get-Help --- # Get-Help + ## SYNOPSIS + Displays information about Windows PowerShell commands and concepts. + ## SYNTAX ### AllUsersView (Default) + ``` Get-Help [[-Name] ] [-Path ] [-Category ] [-Component ] [-Functionality ] [-Role ] [-Full] [] ``` ### DetailedView + ``` Get-Help [[-Name] ] [-Path ] [-Category ] [-Component ] [-Functionality ] [-Role ] [-Detailed] [] ``` ### Examples + ``` Get-Help [[-Name] ] [-Path ] [-Category ] [-Component ] [-Functionality ] [-Role ] [-Examples] [] ``` ### Parameters + ``` Get-Help [[-Name] ] [-Path ] [-Category ] [-Component ] [-Functionality ] [-Role ] -Parameter [] ``` ### Online + ``` Get-Help [[-Name] ] [-Path ] [-Category ] [-Component ] [-Functionality ] [-Role ] [-Online] [] ``` ### ShowWindow + ``` Get-Help [[-Name] ] [-Path ] [-Category ] [-Component ] [-Functionality ] [-Role ] [-ShowWindow] [] ``` ## DESCRIPTION -The **Get-Help** cmdlet displays information about Windows PowerShell concepts and commands, including cmdlets, functions, CIM commands, workflows, providers, aliases and scripts. -To get help for a Windows PowerShell command, type "Get-Help" followed by the command name, such as: `Get-Help Get-Process`. +The **Get-Help** cmdlet displays information about Windows PowerShell concepts and commands, +including cmdlets, functions, CIM commands, workflows, providers, aliases and scripts. + +To get help for a Windows PowerShell command, type "Get-Help" followed by the command name, such +as: `Get-Help Get-Process`. To get a list of all help topics on your system, type: `Get-Help *`. -You can display the entire help topic or use the parameters of the **Get-Help** cmdlet to get selected parts of the topic, such as the syntax, parameters, or examples. +You can display the entire help topic or use the parameters of the **Get-Help** cmdlet to get +selected parts of the topic, such as the syntax, parameters, or examples. Conceptual help topics in Windows PowerShell begin with "about_", such as "about_Comparison_Operators". To see all "about_" topics, type: `Get-Help about_*`. @@ -63,48 +76,65 @@ To see a particular topic, type: `Get-Help about_\`, such as `Get-H To get help for a Windows PowerShell provider, type "Get-Help" followed by the provider name. For example, to get help for the Certificate provider, type: `Get-Help Certificate`. -In addition to "Get-Help", you can also type "help" or "man", which displays one screen of text at a time, or "\ -?", which is identical to **Get-Help** but works only for commands. +In addition to "Get-Help", you can also type "help" or "man", which displays one screen of text +at a time, or "\ -?", which is identical to **Get-Help** but works only for commands. **Get-Help** gets the help content that it displays from help files on your computer. Without the help files, **Get-Help** displays only basic information about commands. Some Windows PowerShell modules come with help files. -However, beginning in Windows PowerShell 3.0, the modules that come with Windows do not include help files. +However, beginning in Windows PowerShell 3.0, the modules that come with Windows do not include +help files. To download or update the help files for a module in Windows PowerShell 3.0, use the Update-Help cmdlet. You can also view the help topics for Windows PowerShell online in the TechNet Library. -To get the online version of a help topic, use the **Online** parameter, such as: `Get-Help Get-Process -Online`. +To get the online version of a help topic, use the **Online** parameter, such as: +`Get-Help Get-Process -Online`. You can read all of the help topics beginning at: http://go.microsoft.com/fwlink/?LinkID=107116http://go.microsoft.com/fwlink/?LinkID=107116. -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** displays 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. +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** displays 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. **Get-Help** can get help topics 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"), and then in a fallback locale. -Beginning in Windows PowerShell 3.0, if **Get-Help** does not find help in the fallback locale, it looks for help topics in English ("en-US") before returning an error message or displaying auto-generated help. +**Get-Help** first looks for help files in the locale set for Windows, then in the parent locale +(such as "pt" for "pt-BR"), and then in a fallback locale. +Beginning in Windows PowerShell 3.0, if **Get-Help** does not find help in the fallback locale, +it looks for help topics in English ("en-US") before returning an error message or displaying +auto-generated help. For information about the symbols that **Get-Help** displays in the command syntax diagram, see about_Command_Syntaxhttp://go.microsoft.com/fwlink/?LinkID=113215. For information about parameter attributes, such as **Required** and **Position**, see about_Parametershttp://go.microsoft.com/fwlink/?LinkID=113243. -**TROUBLESHOOTING NOTE**: In Windows PowerShell 3.0, **Get-Help** cannot find About topics in modules unless the module is imported into the current session. +**TROUBLESHOOTING NOTE**: In Windows PowerShell 3.0, **Get-Help** cannot find About topics in +modules unless the module is imported into the current session. This is a known issue. -To get About topics in a module, import the module, either by using the Import-Module cmdlet or by using a cmdlet in the module. +To get About topics in a module, import the module, either by using the Import-Module cmdlet or +by using a cmdlet in the module. + ## EXAMPLES ### Example 1 -``` + +```powershell PS C:\> Get-Help ``` This command displays help about the Windows PowerShell help system. + ### Example 2 -``` + +```powershell PS C:\> Get-Help * ``` This command displays a list of the available help topics. + ### Example 3 -``` + +```powershell PS C:\> Get-Help Get-Alias PS C:\> Help Get-Alias PS C:\> Get-Alias -? @@ -113,185 +143,243 @@ PS C:\> Get-Alias -? These commands display basic information about the Get-Alias cmdlet. The "Get-Help" and "-?" commands display the information on a single page. The "Help" command displays the information one page at a time. + ### Example 4 -``` + +```powershell PS C:\> Get-Help about_* ``` This command displays a list of the conceptual topics included in Windows PowerShell help. All of these topics begin with the characters "about_". -To display a particular help file, type "get-help \, for example, "Get-Help about_Signing". +To display a particular help file, type "Get-Help \, for example, "Get-Help about_Signing". -This command displays the conceptual topics only when the help files for those topics are installed on the computer. +This command displays the conceptual topics only when the help files for those topics are +installed on the computer. For information about downloading and installing help files in Windows PowerShell 3.0, see Update-Help. + ### Example 5 -``` -The first command uses the **Get-Help** cmdlet to get help for the Get-Command cmdlet. Without help files, **Get-Help** display the cmdlet name, syntax and alias of **Get-Command**, and prompts you to use the Update-Help cmdlet to get the newest help files. + +The first command uses the **Get-Help** cmdlet to get help for the Get-Command cmdlet. Without +help files, **Get-Help** display the cmdlet name, syntax and alias of **Get-Command**, and +prompts you to use the Update-Help cmdlet to get the newest help files. + +```powershell PS C:\> Get-Help Get-Command +``` + +```Output NAME Get-Command - SYNTAX - Get-Command [[-Name] ] [-CommandType {Alias | Function | Filter | Cmdlet | ExternalScript | Application | - Script | All}] [[-ArgumentList] ] [-Module ] [-Syntax] [-TotalCount ] [] - - Get-Command [-Noun ] [-Verb ] [[-ArgumentList] ] [-Module ] [-Syntax] - - [-TotalCount ] [] - - +Get-Command [-Noun ] [-Verb ] [[-ArgumentList] ] [-Module ] [-Syntax] [-TotalCount ] [] ALIASES - gcm - + gcm REMARKS Get-Help cannot find the help files for this cmdlet on this computer. It is displaying only partial help. To download and install help files for this cmdlet, use Update-Help. +``` + +The second command runs the Update-Help cmdlet without parameters. This command downloads help +files from the Internet for all of the modules in the current session and installs them on the +local computer.This command works only when the local computer is connected to the Internet. If +your computer is not connected to the Internet, you might be able to install help files from a +network share. For more information, see Save-Help. -The second command runs the Update-Help cmdlet without parameters. This command downloads help files from the Internet for all of the modules in the current session and installs them on the local computer.This command works only when the local computer is connected to the Internet. If your computer is not connected to the Internet, you might be able to install help files from a network share. For more information, see Save-Help. +```powershell PS C:\> Update-Help +``` + +Now that the help files are downloaded, we can repeat the first command in the sequence. This +command gets help for the **Get-Command** cmdlet. The cmdlet now gets more extensive help for +**Get-Command** and you can use the **Detailed**, **Full**, **Example**, and **Parameter** +parameters of **Get-Help** to customize the displays.You can use the **Get-Help** cmdlet as soon +as the Update-Help command completes. You do not need to restart Windows PowerShell. -Now that the help files are downloaded, we can repeat the first command in the sequence. This command gets help for the **Get-Command** cmdlet. The cmdlet now gets more extensive help for **Get-Command** and you can use the **Detailed**, **Full**, **Example**, and **Parameter** parameters of **Get-Help** to customize the displays.You can use the **Get-Help** cmdlet as soon as the Update-Help command completes. You do not need to restart Windows PowerShell. +```powershell PS C:\> Get-Help Get-Command ``` This example shows how to download and install new or updated help files for a module. It uses features that were introduced in Windows PowerShell 3.0. -The example compares the help that **Get-Help** displays for commands when you do not have help files installed on your computer and when you do have help files. -You can use the same command sequence to update the help files on your computer so that your local help content is never obsolete. +The example compares the help that **Get-Help** displays for commands when you do not have help +files installed on your computer and when you do have help files. +You can use the same command sequence to update the help files on your computer so that your +local help content is never obsolete. + +To download and install the help files for the commands that come with Windows PowerShell, and +for any modules in the $pshome\Modules directory, open Windows PowerShell with the "Run as +administrator" option. +If you are not a member of the Administrators group on the computer, you cannot download help for +these modules. +However, you can use the **Online** parameter to open the online version of help for a command, +and you can read the help for Windows PowerShell in the TechNet Library beginning at http://go.microsoft.com/fwlink/?LinkID=107116http://go.microsoft.com/fwlink/?LinkID=107116. -To download and install the help files for the commands that come with Windows PowerShell, and for any modules in the $pshome\Modules directory, open Windows PowerShell with the "Run as administrator" option. -If you are not a member of the Administrators group on the computer, you cannot download help for these modules. -However, you can use the **Online** parameter to open the online version of help for a command, and you can read the help for Windows PowerShell in the TechNet Library beginning at http://go.microsoft.com/fwlink/?LinkID=107116http://go.microsoft.com/fwlink/?LinkID=107116. ### Example 6 -``` + +```powershell PS C:\> Get-Help ls -Detailed ``` -This command displays detailed help for the Get-ChildItem cmdlet by specifying one of its aliases, "ls." The **Detailed** parameter of **Get-Help** gets the detailed view of the help topic, which includes parameter descriptions and examples. +This command displays detailed help for the Get-ChildItem cmdlet by specifying one of its aliases + "ls." The **Detailed** parameter of **Get-Help** gets the detailed view of the help topic, which + includes parameter descriptions and examples. To see the complete help topic for a cmdlet, use the **Full** parameter. -The **Full** and **Detailed** parameters are effective only when help files for the command are installed on the computer. +The **Full** and **Detailed** parameters are effective only when help files for the command are +installed on the computer. + ### Example 7 -``` + +```powershell PS C:\> Get-Help Format-Table -Full ``` -This command uses the **Full** parameter of **Get-Help** to display the full view help for the Format-Table cmdlet. -The full view of help includes parameter descriptions, examples, and a table of technical details about the parameters. +This command uses the **Full** parameter of **Get-Help** to display the full view help for the +Format-Table cmdlet. +The full view of help includes parameter descriptions, examples, and a table of technical details +about the parameters. The **Full** parameter is effective only when help files for the command are installed on the computer. + ### Example 8 -``` + +```powershell PS C:\> Get-Help Start-Service -Examples ``` This command displays examples of using the Start-Service cmdlet. -It uses the **Examples** parameter of **Get-Help** to display only the Examples section of the cmdlet help topics. +It uses the **Examples** parameter of **Get-Help** to display only the Examples section of the +cmdlet help topics. The **Examples** parameter is effective only when help files for the command are installed on the computer. + ### Example 9 -``` + +```powershell PS C:\> Get-Help Format-List -Parameter GroupBy ``` -This command uses the **Parameter** parameter of **Get-Help** to display a detailed description of the **GroupBy** parameter of the Format-List cmdlet. -For detailed descriptions of all parameters of the **Format-List** cmdlet, type "`Get-Help Format-List -Parameter *`". +This command uses the **Parameter** parameter of **Get-Help** to display a detailed description +of the **GroupBy** parameter of the Format-List cmdlet. +For detailed descriptions of all parameters of the **Format-List** cmdlet, type +"`Get-Help Format-List -Parameter *`". + ### Example 10 -``` + +```powershell PS C:\> Get-Help Add-Member -Full | Out-String -Stream | Select-String -Pattern Clixml ``` This example shows how to search for a word in particular cmdlet help topic. -This command searches for the word "Clixml" in the full version of the help topic for the Add-Member cmdlet. +This command searches for the word "Clixml" in the full version of the help topic for the +Add-Member cmdlet. + +Because the **Get-Help** cmdlet generates a **MamlCommandHelpInfo** object, not a string, you +need to use a cmdlet that transforms the help topic content into a string, such as Out-String or Out-File. -Because the **Get-Help** cmdlet generates a **MamlCommandHelpInfo** object, not a string, you need to use a cmdlet that transforms the help topic content into a string, such as Out-String or Out-File. ### Example 11 -``` + +```powershell PS C:\> Get-Help Get-Member -Online ``` This command displays the online version of the help topic for the Get-Member cmdlet. + ### Example 12 -``` + +```powershell PS C:\> Get-Help remoting ``` This command displays a list of topics that include the word "remoting." -When you enter a word that does not appear in any topic title, **Get-Help** displays a list of topics that include that word. +When you enter a word that does not appear in any topic title, **Get-Help** displays a list of +topics that include that word. + ### Example 13 -``` -The first command uses the **Path** parameter of **Get-Help** to specify the provider path. This command can be entered at any path location. + +The first command uses the **Path** parameter of **Get-Help** to specify the provider path. This +command can be entered at any path location. + +```powershell PS C:\> Get-Help Get-Item -Path SQLSERVER:\DataCollection +``` +```Output NAME - Get-Item - SYNOPSIS - Gets a collection of Server objects for the local computer and any computers - to which you have made a SQL Server PowerShell connection. - ... +``` -The second command uses the Set-Location cmdlet (alias = "cd") to navigate to the provider path. From that location, even without the **Path** parameter, the **Get-Help** command gets the provider-specific help for the **Get-Item** cmdlet. +The second command uses the Set-Location cmdlet (alias = "cd") to navigate to the provider path. +From that location, even without the **Path** parameter, the **Get-Help** command gets the +provider-specific help for the **Get-Item** cmdlet. + +```powershell PS C:\> cd SQLSERVER:\DataCollection SQLSERVER:\DataCollection> Get-Help Get-Item +``` +```Output NAME - Get-Item - SYNOPSIS - Gets a collection of Server objects for the local computer and any computers - to which you have made a SQL Server PowerShell connection. - ... +``` +The third command shows that a **Get-Help** command in a file system path, and without the +**Path** parameter, gets the standard help for the **Get-Item** cmdlet. -The third command shows that a **Get-Help** command in a file system path, and without the **Path** parameter, gets the standard help for the **Get-Item** cmdlet. +```powershell PS C:\> Get-Item +``` +```Output NAME - Get-Item - SYNOPSIS - Gets the item at the specified location. ... ``` -This example shows how to get help that explains how to use the Get-Item cmdlet in the **DataCollection** node of the Windows PowerShell SQL Server provider. +This example shows how to get help that explains how to use the Get-Item cmdlet in the +**DataCollection** node of the Windows PowerShell SQL Server provider. The example shows two ways of getting the provider-specific help for **Get-Item**. You can also get provider-specific help for cmdlets online in the section that describes the provider. -For example, for provider-specific online help for the New-Item cmdlet in each WSMan provider path, see http://go.microsoft.com/fwlink/?LinkID=158676http://go.microsoft.com/fwlink/?LinkID=158676. +For example, for provider-specific online help for the New-Item cmdlet in each WSMan provider +path, see http://go.microsoft.com/fwlink/?LinkID=158676http://go.microsoft.com/fwlink/?LinkID=158676. + ### Example 14 -``` + +```powershell PS C:\> Get-Help C:\PS-Test\MyScript.ps1 ``` This command gets help for the MyScript.ps1 script. For information about writing help for your functions and scripts, see about_Comment_Based_Helphttp://go.microsoft.com/fwlink/?LinkID=144309. + ## PARAMETERS ### -Category + Displays help only for items in the specified category and their aliases. Valid values are **Alias**, **Cmdlet**, **Function**, **Provider**, **Workflow**, and **HelpFile**. Conceptual topics are in the **HelpFile** category. @@ -299,7 +387,7 @@ Conceptual topics are in the **HelpFile** category. ```yaml Type: String[] Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -309,6 +397,7 @@ Accept wildcard characters: False ``` ### -Component + Displays commands with the specified component value, such as "Exchange." Enter a component name. Wildcards are permitted. @@ -317,7 +406,7 @@ This parameter has no effect on displays of conceptual ("About_") help. ```yaml Type: String[] Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -327,6 +416,7 @@ Accept wildcard characters: True ``` ### -Detailed + Adds parameter descriptions and examples to the basic help display. This parameter is effective only when help files are for the command are installed on the computer. @@ -335,7 +425,7 @@ It has no effect on displays of conceptual ("About_") help. ```yaml Type: SwitchParameter Parameter Sets: DetailedView -Aliases: +Aliases: Required: True Position: Named @@ -345,6 +435,7 @@ Accept wildcard characters: False ``` ### -Examples + Displays only the name, synopsis, and examples. To display only the examples, type "(Get-Help \).Examples". @@ -354,7 +445,7 @@ It has no effect on displays of conceptual ("About_") help. ```yaml Type: SwitchParameter Parameter Sets: Examples -Aliases: +Aliases: Required: True Position: Named @@ -364,15 +455,16 @@ Accept wildcard characters: False ``` ### -Full -Displays the entire help topic for a cmdlet, including parameter descriptions and attributes, examples, input and output object types, and additional notes. + +Displays the entire help topic for a cmdlet, including parameter descriptions and attributes, +examples, input and output object types, and additional notes. This parameter is effective only when help files are for the command are installed on the computer. It has no effect on displays of conceptual ("About_") help. ```yaml Type: SwitchParameter -Parameter Sets: AllUsersView -Aliases: +Aliases: Required: False Position: Named @@ -382,6 +474,7 @@ Accept wildcard characters: False ``` ### -Functionality + Displays help for items with the specified functionality. Enter the functionality. Wildcards are permitted. @@ -391,7 +484,7 @@ This parameter has no effect on displays of conceptual ("About_") help. ```yaml Type: String[] Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -401,22 +494,29 @@ Accept wildcard characters: True ``` ### -Name + Gets help about the specified command or concept. -Enter the name of a cmdlet, function, provider, script, or workflow, such as "Get-Member", a conceptual topic name, such as "about_Objects", or an alias, such as "ls". -Wildcards are permitted in cmdlet and provider names, but you cannot use wildcards to find the names of function help and script help topics. +Enter the name of a cmdlet, function, provider, script, or workflow, such as "Get-Member", a +conceptual topic name, such as "about_Objects", or an alias, such as "ls". +Wildcards are permitted in cmdlet and provider names, but you cannot use wildcards to find the +names of function help and script help topics. -To get help for a script that is not located in a path that is listed in the Path environment variable, type the path and file name of the script . +To get help for a script that is not located in a path that is listed in the Path environment +variable, type the path and file name of the script . If you enter the exact name of a help topic, **Get-Help** displays 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 match any help topic titles, **Get-Help** displays a list of topics that include that word in their 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 match any help topic titles, **Get-Help** displays a list of +topics that include that word in their contents. -The names of conceptual topics, such as "about_Objects", must be entered in English, even in non-English versions of Windows PowerShell. +The names of conceptual topics, such as "about_Objects", must be entered in English, even in +non-English versions of Windows PowerShell. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: 1 @@ -426,16 +526,19 @@ Accept wildcard characters: True ``` ### -Online + Displays the online version of a help topic in the default Internet browser. This parameter is valid only for cmdlet, function, workflow and script help topics. You cannot use the **Online** parameter in **Get-Help** commands in a remote session. -For information about supporting this feature in help topics that you write, see about_Comment_Based_Help (http://go.microsoft.com/fwlink/?LinkID=144309), and "Supporting Online Help" (http://go.microsoft.com/fwlink/?LinkID=242132), and [How to Write Cmdlet Help](https://go.microsoft.com/fwlink/?LinkID=123415) in the MSDN library. +For information about supporting this feature in help topics that you write, see +about_Comment_Based_Help (http://go.microsoft.com/fwlink/?LinkID=144309), and "Supporting Online +Help" (http://go.microsoft.com/fwlink/?LinkID=242132), and [How to Write Cmdlet Help](https://go.microsoft.com/fwlink/?LinkID=123415) in the MSDN library. ```yaml Type: SwitchParameter Parameter Sets: Online -Aliases: +Aliases: Required: True Position: Named @@ -445,6 +548,7 @@ Accept wildcard characters: False ``` ### -Parameter + Displays only the detailed descriptions of the specified parameters. Wildcards are permitted. @@ -453,7 +557,7 @@ This parameter has no effect on displays of conceptual ("About_") help. ```yaml Type: String Parameter Sets: Parameters -Aliases: +Aliases: Required: True Position: Named @@ -463,14 +567,19 @@ Accept wildcard characters: True ``` ### -Path + Gets help that explains how the cmdlet works in the specified provider path. Enter a Windows PowerShell provider path. -This parameter gets a customized version of a cmdlet help topic that explains how the cmdlet works in the specified Windows PowerShell provider path. -This parameter is effective only for help about a provider cmdlet and only when the provider includes a custom version of the provider cmdlet help topic in its help file. +This parameter gets a customized version of a cmdlet help topic that explains how the cmdlet +works in the specified Windows PowerShell provider path. +This parameter is effective only for help about a provider cmdlet and only when the provider +includes a custom version of the provider cmdlet help topic in its help file. To use this parameter, install the help file for the module that includes the provider. -To see the custom cmdlet help for a provider path, go to the provider path location and enter a **Get-Help** command or, from any path location, use the **Path** parameter of Get-Help to specify the provider path. +To see the custom cmdlet help for a provider path, go to the provider path location and enter a +**Get-Help** command or, from any path location, use the **Path** parameter of Get-Help to +specify the provider path. You can also find custom cmdlet help online in the provider help section of the help topics. For example, you can find help for the **New-Item** cmdlet in the Wsman:\*\ClientCertificate path (http://go.microsoft.com/fwlink/?LinkID=158676). @@ -479,7 +588,7 @@ For more information about Windows PowerShell providers, see [about_Providers](A ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -489,6 +598,7 @@ Accept wildcard characters: False ``` ### -Role + Displays help customized for the specified user role. Enter a role. Wildcards are permitted. @@ -500,7 +610,7 @@ This parameter has no effect on help for the core cmdlets. ```yaml Type: String[] Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -510,10 +620,13 @@ Accept wildcard characters: True ``` ### -ShowWindow + Displays the help topic in a window for easier reading. -The window includes a "Find" search feature and a "Settings" box that lets you set options for the display, including options to display only selected sections of a help topic. +The window includes a "Find" search feature and a "Settings" box that lets you set options for +the display, including options to display only selected sections of a help topic. -The **ShowWindow** parameter supports help topics for commands (cmdlets, functions, CIM commands, workflows, scripts) and conceptual "About" topics. +The **ShowWindow** parameter supports help topics for commands (cmdlets, functions, CIM commands, +workflows, scripts) and conceptual "About" topics. It does not support provider help. This parameter is introduced in Windows PowerShell 3.0. @@ -521,7 +634,7 @@ This parameter is introduced in Windows PowerShell 3.0. ```yaml Type: SwitchParameter Parameter Sets: ShowWindow -Aliases: +Aliases: Required: True Position: Named @@ -531,58 +644,72 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, +-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, +-WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + ## INPUTS ### None + You cannot pipe objects to this cmdlet. + ## OUTPUTS ### ExtendedCmdletHelpInfo -If you run **Get-Help** on a command that does not have a help file, **Get-Help** returns an ExtendedCmdletHelpInfo object that represents autogenerated help. -### System.String -If you get a conceptual help topic, **Get-Help** returns it as a string. -### MamlCommandHelpInfo -If you get a command that has a help file, **Get-Help** returns a **MamlCommandHelpInfo** object. -## NOTES -* Without parameters, "Get-Help" displays information about the Windows PowerShell help system. -* Windows PowerShell 3.0 does not come with help files. To download and install the help files that **Get-Help** reads, use the Update-Help cmdlet. You can use the **Update-Help** cmdlet to download and install help files for the core commands that come with Windows PowerShell and for any modules that you install. You can also use it to update the help files so that the help on your computer is never outdated. - You can also read the help topics about the commands that come with Windows PowerShell online beginning at http://go.microsoft.com/fwlink/?LinkID=107116. +If you run **Get-Help** on a command that does not have a help file, **Get-Help** returns an +ExtendedCmdletHelpInfo object that represents autogenerated help. -* **Get-Help** displays help in the locale set for Windows or in the fallback language for that locale. If you do not have help files for the primary or fallback locale, **Get-Help** behaves as though there are no help files on the computer. To get help for a different locale, use Region and Language in Control Panel to change the settings for Windows. -* The full view of help (-Full) includes a table of information about the parameters. The table includes the following fields: - - - Required: Indicates whether the parameter is required (true) or optional (false). +### System.String - - Position: Indicates whether the parameter is named or positional (numbered). -Positional parameters must appear in a specified place in the command. +If you get a conceptual help topic, **Get-Help** returns it as a string. - - "Named" indicates that the parameter name is required, but that the parameter can appear anywhere in the command. +### MamlCommandHelpInfo - - \ indicates that the parameter name is optional, but when the name is omitted, the parameter must be in the place specified by the number. -For example, "2" indicates that when the parameter name is omitted, the parameter must be the second (2) or only unnamed parameter in the command. -When the parameter name is used, the parameter can appear anywhere in the command. +If you get a command that has a help file, **Get-Help** returns a **MamlCommandHelpInfo** object. - - Default value: The parameter value that Windows PowerShell uses if you do not include the parameter in the command. +## NOTES - - Accepts pipeline input: Indicates whether you can (true) or cannot (false) send objects to the parameter through a pipeline. -"By Property Name" means that the pipelined object must have a property with the same name as the parameter name. +- **Update-Help** cmdlet + - Windows PowerShell 3.0 does not include help files. + - To download and install the help files that **Get-Help** reads, use the **Update-Help** cmdlet. + - Download and install help files for any Windows PowerShell Cmdlets and for any third-party modules. + - You can also use it to update the help files so that the help on your computer is never outdated. + - Online help topics about Windows PowerShell Cmdlets can be found online + - Starting with [Scripting with Windows PowerShell](http://go.microsoft.com/fwlink/?LinkID=107116). + +- Localization Support + - **Get-Help** displays help in the locale set for the Windows operating system. + - Fallback language support is avialable. + - **Get-Help** behaves as if there are no help files on the computer if: + - You do not have help files for the primary locale or, + - You do not have help files for the fallback locale + - To get help for a different locale, use Region and Language in Control Panel to change the settings. + +- Parameter Notes: + - No Parameters used + - **Get-Help** displays information about the Windows PowerShell help system. + - Required: Indicates whether the parameter is required (true) or optional (false). + - Position: Indicates whether the parameter is named or positional (numbered). + - Positional parameters must appear in a specified place in the command. + - Named: Indicates that the parameter name is required but does not have a required position. + - Number: Indicates that the parameter name is optional, but the parameter must be in that positon. + - For example, "2" indicates that when the parameter name is omitted: + - The parameter must be the second (2) or + - Only unnamed parameter in the command. + - When the parameter name is used, the parameter can appear anywhere in the command. + - Default value: + - The parameter value that Windows PowerShell uses if you do not include the parameter in the command. + - Accepts pipeline input: Indicates whether objects can be sent throught the pipeleine: + - you can (true) or, + - cannot (false) + - By Property Name: Indicates that the pipelined object must have a property with the same name. + - Accepts wildcard characters: Indicates whether wildcard characters can be used. - - Accepts wildcard characters: Indicates whether the value of a parameter can include wildcard characters, such as * and ?. ## RELATED LINKS [Updatable Help Status Table (http://go.microsoft.com/fwlink/?LinkID=270007)](http://go.microsoft.com/fwlink/?LinkID=270007) - [about_Command_Syntax](About/about_Command_Syntax.md) - [Get-Command](Get-Command.md) - -[Get-Member](../Microsoft.PowerShell.Utility/Get-Member.md) - -[Get-PSDrive](../microsoft.powershell.management/get-psdrive.md) - -[about_Comment_Based_Help](About/about_Comment_Based_Help.md) - -[about_Parameters](About/about_Parameters.md) - diff --git a/reference/4.0/Microsoft.PowerShell.Core/Get-Help.md b/reference/4.0/Microsoft.PowerShell.Core/Get-Help.md index 48e6773649a4..4ba665bab061 100644 --- a/reference/4.0/Microsoft.PowerShell.Core/Get-Help.md +++ b/reference/4.0/Microsoft.PowerShell.Core/Get-Help.md @@ -11,52 +11,63 @@ title: Get-Help # Get-Help ## SYNOPSIS + Displays information about Windows PowerShell commands and concepts. ## SYNTAX ### AllUsersView (Default) + ``` Get-Help [[-Name] ] [-Path ] [-Category ] [-Component ] [-Functionality ] [-Role ] [-Full] [] ``` ### DetailedView + ``` Get-Help [[-Name] ] [-Path ] [-Category ] [-Component ] [-Functionality ] [-Role ] [-Detailed] [] ``` ### Examples + ``` Get-Help [[-Name] ] [-Path ] [-Category ] [-Component ] [-Functionality ] [-Role ] [-Examples] [] ``` ### Parameters + ``` Get-Help [[-Name] ] [-Path ] [-Category ] [-Component ] [-Functionality ] [-Role ] -Parameter [] ``` ### Online + ``` Get-Help [[-Name] ] [-Path ] [-Category ] [-Component ] [-Functionality ] [-Role ] [-Online] [] ``` ### ShowWindow + ``` Get-Help [[-Name] ] [-Path ] [-Category ] [-Component ] [-Functionality ] [-Role ] [-ShowWindow] [] ``` ## DESCRIPTION -The **Get-Help** cmdlet displays information about Windows PowerShell concepts and commands, including cmdlets, functions, CIM commands, workflows, providers, aliases and scripts. -To get help for a Windows PowerShell command, type "Get-Help" followed by the command name, such as: `Get-Help Get-Process`. +The **Get-Help** cmdlet displays information about Windows PowerShell concepts and commands, +including cmdlets, functions, CIM commands, workflows, providers, aliases and scripts. + +To get help for a Windows PowerShell command, type "Get-Help" followed by the command name, such as: +`Get-Help Get-Process`. To get a list of all help topics on your system, type: `Get-Help *`. -You can display the entire help topic or use the parameters of the **Get-Help** cmdlet to get selected parts of the topic, such as the syntax, parameters, or examples. +You can display the entire help topic or use the parameters of the **Get-Help** cmdlet to get +selected parts of the topic, such as the syntax, parameters, or examples. Conceptual help topics in Windows PowerShell begin with "about_", such as "about_Comparison_Operators". To see all "about_" topics, type: `Get-Help about_*`. @@ -65,51 +76,65 @@ To see a particular topic, type: `Get-Help about_\`, such as `Get-H To get help for a Windows PowerShell provider, type "Get-Help" followed by the provider name. For example, to get help for the Certificate provider, type: `Get-Help Certificate`. -In addition to "Get-Help", you can also type "help" or "man", which displays one screen of text at a time, or "\ -?", which is identical to **Get-Help** but works only for commands. +In addition to "Get-Help", you can also type "help" or "man", which displays one screen of text +at a time, or "\ -?", which is identical to **Get-Help** but works only for commands. **Get-Help** gets the help content that it displays from help files on your computer. Without the help files, **Get-Help** displays only basic information about commands. Some Windows PowerShell modules come with help files. -However, beginning in Windows PowerShell 3.0, the modules that come with Windows do not include help files. +However, beginning in Windows PowerShell 3.0, the modules that come with Windows do not include +help files. To download or update the help files for a module in Windows PowerShell 3.0, use the Update-Help cmdlet. You can also view the help topics for Windows PowerShell online in the TechNet Library. -To get the online version of a help topic, use the **Online** parameter, such as: `Get-Help Get-Process -Online`. +To get the online version of a help topic, use the **Online** parameter, such as: +`Get-Help Get-Process -Online`. You can read all of the help topics beginning at: http://go.microsoft.com/fwlink/?LinkID=107116http://go.microsoft.com/fwlink/?LinkID=107116. -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** displays 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. +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** displays 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. **Get-Help** can get help topics 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"), and then in a fallback locale. -Beginning in Windows PowerShell 3.0, if **Get-Help** does not find help in the fallback locale, it looks for help topics in English ("en-US") before returning an error message or displaying auto-generated help. +**Get-Help** first looks for help files in the locale set for Windows, then in the parent locale +(such as "pt" for "pt-BR"), and then in a fallback locale. +Beginning in Windows PowerShell 3.0, if **Get-Help** does not find help in the fallback locale, it +looks for help topics in English ("en-US") before returning an error message or displaying +auto-generated help. -For information about the symbols that **Get-Help** displays in the command syntax diagram, see about_Command_Syntaxhttp://go.microsoft.com/fwlink/?LinkID=113215. -For information about parameter attributes, such as **Required** and **Position**, see about_Parametershttp://go.microsoft.com/fwlink/?LinkID=113243. +For information about the symbols that **Get-Help** displays in the command syntax diagram, see [about_Command_Syntax](http://go.microsoft.com/fwlink/?LinkID=113215). +For information about parameter attributes, such as **Required** and **Position**, see [about_Parameters](http://go.microsoft.com/fwlink/?LinkID=113243). -**TROUBLESHOOTING NOTE**: In Windows PowerShell 3.0 and 4.0, **Get-Help** cannot find About topics in modules unless the module is imported into the current session. +**TROUBLESHOOTING NOTE**: In Windows PowerShell 3.0 and 4.0, **Get-Help** cannot find About +topics in modules unless the module is imported into the current session. This is a known issue. -To get About topics in a module, import the module, either by using the Import-Module cmdlet or by running a cmdlet in the module. +To get About topics in a module, import the module, either by using the Import-Module cmdlet or +by running a cmdlet in the module. ## EXAMPLES ### Example 1 -``` + +```powershell PS C:\> Get-Help ``` This command displays help about the Windows PowerShell help system. ### Example 2 -``` + +```powershell PS C:\> Get-Help * ``` This command displays a list of the available help topics. ### Example 3 -``` + +```powershell PS C:\> Get-Help Get-Alias PS C:\> Help Get-Alias PS C:\> Get-Alias -? @@ -120,186 +145,241 @@ The "Get-Help" and "-?" commands display the information on a single page. The "Help" command displays the information one page at a time. ### Example 4 -``` + +```powershell PS C:\> Get-Help about_* ``` This command displays a list of the conceptual topics included in Windows PowerShell help. All of these topics begin with the characters "about_". -To display a particular help file, type "get-help \, for example, "Get-Help about_Signing". +To display a particular help file, type "Get-Help \, for example, "Get-Help about_Signing". -This command displays the conceptual topics only when the help files for those topics are installed on the computer. +This command displays the conceptual topics only when the help files for those topics are +installed on the computer. For information about downloading and installing help files in Windows PowerShell 3.0, see Update-Help. ### Example 5 -``` -The first command uses the **Get-Help** cmdlet to get help for the Get-Command cmdlet. Without help files, **Get-Help** display the cmdlet name, syntax and alias of **Get-Command**, and prompts you to use the Update-Help cmdlet to get the newest help files. + +The first command uses the **Get-Help** cmdlet to get help for the Get-Command cmdlet. +Without help files, **Get-Help** display the cmdlet name, syntax and alias of **Get-Command**, +and prompts you to use the Update-Help cmdlet to get the newest help files. + +```powershell PS C:\> Get-Help Get-Command +``` + +```Output NAME Get-Command - SYNTAX - + Get-Command [[-Name] ] [-CommandType {Alias | Function | Filter | Cmdlet | ExternalScript | Application | Script | All}] [[-ArgumentList] ] [-Module ] [-Syntax] [-TotalCount ] [] - - Get-Command [-Noun ] [-Verb ] [[-ArgumentList] ] [-Module ] [-Syntax] + Get-Command [-Noun ] [-Verb ] [[-ArgumentList] ] [-Module ] [-Syntax] [-TotalCount ] [] - - ALIASES - gcm - + gcm REMARKS Get-Help cannot find the help files for this cmdlet on this computer. It is displaying only partial help. To download and install help files for this cmdlet, use Update-Help. +``` + +The second command runs the Update-Help cmdlet without parameters. +This command downloads help files from the Internet for all of the modules in the current session +and installs them on the local computer.This command works only when the local computer is +connected to the Internet. If your computer is not connected to the Internet, you might be able +to install help files from a network share. For more information, see Save-Help. -The second command runs the Update-Help cmdlet without parameters. This command downloads help files from the Internet for all of the modules in the current session and installs them on the local computer.This command works only when the local computer is connected to the Internet. If your computer is not connected to the Internet, you might be able to install help files from a network share. For more information, see Save-Help. +```powershell PS C:\> Update-Help +``` + +Now that the help files are downloaded, we can repeat the first command in the sequence. +This command gets help for the **Get-Command** cmdlet. The cmdlet now gets more extensive help +for **Get-Command** and you can use the **Detailed**, **Full**, **Example**, and **Parameter** +parameters of **Get-Help** to customize the displays.You can use the **Get-Help** cmdlet as soon +as the Update-Help command completes. You do not need to restart Windows PowerShell. -Now that the help files are downloaded, we can repeat the first command in the sequence. This command gets help for the **Get-Command** cmdlet. The cmdlet now gets more extensive help for **Get-Command** and you can use the **Detailed**, **Full**, **Example**, and **Parameter** parameters of **Get-Help** to customize the displays.You can use the **Get-Help** cmdlet as soon as the Update-Help command completes. You do not need to restart Windows PowerShell. +```powershell PS C:\> Get-Help Get-Command ``` This example shows how to download and install new or updated help files for a module. It uses features that were introduced in Windows PowerShell 3.0. -The example compares the help that **Get-Help** displays for commands when you do not have help files installed on your computer and when you do have help files. -You can use the same command sequence to update the help files on your computer so that your local help content is never obsolete. +The example compares the help that **Get-Help** displays for commands when you do not have help +files installed on your computer and when you do have help files. +You can use the same command sequence to update the help files on your computer so that your +local help content is never obsolete. -To download and install the help files for the commands that come with Windows PowerShell, and for any modules in the $pshome\Modules directory, open Windows PowerShell with the "Run as administrator" option. -If you are not a member of the Administrators group on the computer, you cannot download help for these modules. -However, you can use the **Online** parameter to open the online version of help for a command, and you can read the help for Windows PowerShell in the TechNet Library beginning at http://go.microsoft.com/fwlink/?LinkID=107116http://go.microsoft.com/fwlink/?LinkID=107116. +To download and install the help files for the commands that come with Windows PowerShell, and +for any modules in the $pshome\Modules directory, open Windows PowerShell with the "Run as +administrator" option. +If you are not a member of the Administrators group on the computer, you cannot download help for +these modules. +However, you can use the **Online** parameter to open the online version of help for a command, +and you can read the help for Windows PowerShell in the TechNet Library beginning at http://go.microsoft.com/fwlink/?LinkID=107116http://go.microsoft.com/fwlink/?LinkID=107116. ### Example 6 -``` + +```powershell PS C:\> Get-Help ls -Detailed ``` -This command displays detailed help for the Get-ChildItem cmdlet by specifying one of its aliases, "ls." The **Detailed** parameter of **Get-Help** gets the detailed view of the help topic, which includes parameter descriptions and examples. +This command displays detailed help for the Get-ChildItem cmdlet by specifying one of its aliases +"ls." The **Detailed** parameter of **Get-Help** gets the detailed view of the help topic, which +includes parameter descriptions and examples. To see the complete help topic for a cmdlet, use the **Full** parameter. -The **Full** and **Detailed** parameters are effective only when help files for the command are installed on the computer. +The **Full** and **Detailed** parameters are effective only when help files for the command are +installed on the computer. ### Example 7 -``` + +```powershell PS C:\> Get-Help Format-Table -Full ``` -This command uses the **Full** parameter of **Get-Help** to display the full view help for the Format-Table cmdlet. -The full view of help includes parameter descriptions, examples, and a table of technical details about the parameters. +This command uses the **Full** parameter of **Get-Help** to display the full view help for the +Format-Table cmdlet. +The full view of help includes parameter descriptions, examples, and a table of technical details +about the parameters. The **Full** parameter is effective only when help files for the command are installed on the computer. ### Example 8 -``` + +```powershell PS C:\> Get-Help Start-Service -Examples ``` This command displays examples of using the Start-Service cmdlet. -It uses the **Examples** parameter of **Get-Help** to display only the Examples section of the cmdlet help topics. +It uses the **Examples** parameter of **Get-Help** to display only the Examples section of the +cmdlet help topics. The **Examples** parameter is effective only when help files for the command are installed on the computer. ### Example 9 -``` + +```powershell PS C:\> Get-Help Format-List -Parameter GroupBy ``` -This command uses the **Parameter** parameter of **Get-Help** to display a detailed description of the **GroupBy** parameter of the Format-List cmdlet. -For detailed descriptions of all parameters of the **Format-List** cmdlet, type "`Get-Help Format-List -Parameter *`". +This command uses the **Parameter** parameter of **Get-Help** to display a detailed description +of the **GroupBy** parameter of the Format-List cmdlet. +For detailed descriptions of all parameters of the **Format-List** cmdlet, type +"`Get-Help Format-List -Parameter *`". ### Example 10 -``` + +```powershell PS C:\> Get-Help Add-Member -Full | Out-String -Stream | Select-String -Pattern Clixml ``` This example shows how to search for a word in particular cmdlet help topic. -This command searches for the word "Clixml" in the full version of the help topic for the Add-Member cmdlet. +This command searches for the word "Clixml" in the full version of the help topic for the +Add-Member cmdlet. -Because the **Get-Help** cmdlet generates a **MamlCommandHelpInfo** object, not a string, you need to use a cmdlet that transforms the help topic content into a string, such as Out-String or Out-File. +Because the **Get-Help** cmdlet generates a **MamlCommandHelpInfo** object, not a string, you +need to use a cmdlet that transforms the help topic content into a string, such as Out-String or Out-File. ### Example 11 -``` + +```powershell PS C:\> Get-Help Get-Member -Online ``` This command displays the online version of the help topic for the Get-Member cmdlet. ### Example 12 -``` + +```powershell PS C:\> Get-Help remoting ``` This command displays a list of topics that include the word "remoting." -When you enter a word that does not appear in any topic title, **Get-Help** displays a list of topics that include that word. +When you enter a word that does not appear in any topic title, **Get-Help** displays a list of +topics that include that word. ### Example 13 -``` -The first command uses the **Path** parameter of **Get-Help** to specify the provider path. This command can be entered at any path location. + +The first command uses the **Path** parameter of **Get-Help** to specify the provider path. +This command can be entered at any path location. + +```powershell PS C:\> Get-Help Get-Item -Path SQLSERVER:\DataCollection +``` +```Output NAME Get-Item - SYNOPSIS Gets a collection of Server objects for the local computer and any computers - to which you have made a SQL Server PowerShell connection. - ... +``` -The second command uses the Set-Location cmdlet (alias = "cd") to navigate to the provider path. From that location, even without the **Path** parameter, the **Get-Help** command gets the provider-specific help for the **Get-Item** cmdlet. +The second command uses the Set-Location cmdlet (alias = "cd") to navigate to the provider path. +From that location, even without the **Path** parameter, the **Get-Help** command gets the +provider-specific help for the **Get-Item** cmdlet. + +```powershell PS C:\> cd SQLSERVER:\DataCollection SQLSERVER:\DataCollection> Get-Help Get-Item +``` +```Output NAME Get-Item - SYNOPSIS Gets a collection of Server objects for the local computer and any computers - to which you have made a SQL Server PowerShell connection. - ... +``` +The third command shows that a **Get-Help** command in a file system path, and without the +**Path** parameter, gets the standard help for the **Get-Item** cmdlet. -The third command shows that a **Get-Help** command in a file system path, and without the **Path** parameter, gets the standard help for the **Get-Item** cmdlet. +```powershell PS C:\> Get-Item +``` +```Output NAME Get-Item - SYNOPSIS Gets the item at the specified location. ... ``` -This example shows how to get help that explains how to use the Get-Item cmdlet in the **DataCollection** node of the Windows PowerShell SQL Server provider. +This example shows how to get help that explains how to use the Get-Item cmdlet in the +**DataCollection** node of the Windows PowerShell SQL Server provider. The example shows two ways of getting the provider-specific help for **Get-Item**. You can also get provider-specific help for cmdlets online in the section that describes the provider. -For example, for provider-specific online help for the New-Item cmdlet in each WSMan provider path, see http://go.microsoft.com/fwlink/?LinkID=158676http://go.microsoft.com/fwlink/?LinkID=158676. +For example, for provider-specific online help for the New-Item cmdlet in each WSMan provider path, see +http://go.microsoft.com/fwlink/?LinkID=158676http://go.microsoft.com/fwlink/?LinkID=158676. ### Example 14 -``` + +```powershell PS C:\> Get-Help C:\PS-Test\MyScript.ps1 ``` @@ -309,6 +389,7 @@ For information about writing help for your functions and scripts, see about_Com ## PARAMETERS ### -Category + Displays help only for items in the specified category and their aliases. Valid values are **Alias**, **Cmdlet**, **Function**, **Provider**, **Workflow**, and **HelpFile**. Conceptual topics are in the **HelpFile** category. @@ -316,7 +397,7 @@ Conceptual topics are in the **HelpFile** category. ```yaml Type: String[] Parameter Sets: (All) -Aliases: +Aliases: Accepted values: Alias, Cmdlet, Provider, General, FAQ, Glossary, HelpFile, ScriptCommand, Function, Filter, ExternalScript, All, DefaultHelp, Workflow Required: False @@ -327,6 +408,7 @@ Accept wildcard characters: False ``` ### -Component + Displays commands with the specified component value, such as "Exchange." Enter a component name. Wildcards are permitted. @@ -335,7 +417,7 @@ This parameter has no effect on displays of conceptual ("About_") help. ```yaml Type: String[] Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -345,6 +427,7 @@ Accept wildcard characters: False ``` ### -Detailed + Adds parameter descriptions and examples to the basic help display. This parameter is effective only when help files are for the command are installed on the computer. @@ -353,7 +436,7 @@ It has no effect on displays of conceptual ("About_") help. ```yaml Type: SwitchParameter Parameter Sets: DetailedView -Aliases: +Aliases: Required: True Position: Named @@ -363,6 +446,7 @@ Accept wildcard characters: False ``` ### -Examples + Displays only the name, synopsis, and examples. To display only the examples, type "(Get-Help \).Examples". @@ -382,7 +466,9 @@ Accept wildcard characters: False ``` ### -Full -Displays the entire help topic for a cmdlet, including parameter descriptions and attributes, examples, input and output object types, and additional notes. + +Displays the entire help topic for a cmdlet, including parameter descriptions and attributes, +examples, input and output object types, and additional notes. This parameter is effective only when help files are for the command are installed on the computer. It has no effect on displays of conceptual ("About_") help. @@ -390,7 +476,7 @@ It has no effect on displays of conceptual ("About_") help. ```yaml Type: SwitchParameter Parameter Sets: AllUsersView -Aliases: +Aliases: Required: False Position: Named @@ -400,6 +486,7 @@ Accept wildcard characters: False ``` ### -Functionality + Displays help for items with the specified functionality. Enter the functionality. Wildcards are permitted. @@ -409,7 +496,7 @@ This parameter has no effect on displays of conceptual ("About_") help. ```yaml Type: String[] Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -419,22 +506,29 @@ Accept wildcard characters: False ``` ### -Name + Gets help about the specified command or concept. -Enter the name of a cmdlet, function, provider, script, or workflow, such as "Get-Member", a conceptual topic name, such as "about_Objects", or an alias, such as "ls". -Wildcards are permitted in cmdlet and provider names, but you cannot use wildcards to find the names of function help and script help topics. +Enter the name of a cmdlet, function, provider, script, or workflow, such as "Get-Member", +a conceptual topic name, such as "about_Objects", or an alias, such as "ls". +Wildcards are permitted in cmdlet and provider names, but you cannot use wildcards to find the +names of function help and script help topics. -To get help for a script that is not located in a path that is listed in the Path environment variable, type the path and file name of the script . +To get help for a script that is not located in a path that is listed in the Path environment +variable, type the path and file name of the script . If you enter the exact name of a help topic, **Get-Help** displays 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 match any help topic titles, **Get-Help** displays a list of topics that include that word in their 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 match any help topic titles, **Get-Help** displays a list of +topics that include that word in their contents. -The names of conceptual topics, such as "about_Objects", must be entered in English, even in non-English versions of Windows PowerShell. +The names of conceptual topics, such as "about_Objects", must be entered in English, even in +non-English versions of Windows PowerShell. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: 0 @@ -444,16 +538,21 @@ Accept wildcard characters: False ``` ### -Online + Displays the online version of a help topic in the default Internet browser. This parameter is valid only for cmdlet, function, workflow and script help topics. You cannot use the **Online** parameter in **Get-Help** commands in a remote session. -For information about supporting this feature in help topics that you write, see about_Comment_Based_Help (http://go.microsoft.com/fwlink/?LinkID=144309), and "Supporting Online Help" (http://go.microsoft.com/fwlink/?LinkID=242132), and [How to Write Cmdlet Help](https://go.microsoft.com/fwlink/?LinkID=123415) in the MSDN library. +For information about supporting this feature in help topics that you write, see: + +- [about_Comment_Based_Help](http://go.microsoft.com/fwlink/?LinkID=144309) +- [Supporting Online Help](http://go.microsoft.com/fwlink/?LinkID=242132) +- [How to Write Cmdlet Help](https://go.microsoft.com/fwlink/?LinkID=123415) ```yaml Type: SwitchParameter Parameter Sets: Online -Aliases: +Aliases: Required: True Position: Named @@ -463,6 +562,7 @@ Accept wildcard characters: False ``` ### -Parameter + Displays only the detailed descriptions of the specified parameters. Wildcards are permitted. @@ -471,7 +571,7 @@ This parameter has no effect on displays of conceptual ("About_") help. ```yaml Type: String Parameter Sets: Parameters -Aliases: +Aliases: Required: True Position: Named @@ -481,23 +581,28 @@ Accept wildcard characters: False ``` ### -Path + Gets help that explains how the cmdlet works in the specified provider path. Enter a Windows PowerShell provider path. -This parameter gets a customized version of a cmdlet help topic that explains how the cmdlet works in the specified Windows PowerShell provider path. -This parameter is effective only for help about a provider cmdlet and only when the provider includes a custom version of the provider cmdlet help topic in its help file. +This parameter gets a customized version of a cmdlet help topic that explains how the cmdlet +works in the specified Windows PowerShell provider path. +This parameter is effective only for help about a provider cmdlet and only when the provider +includes a custom version of the provider cmdlet help topic in its help file. To use this parameter, install the help file for the module that includes the provider. -To see the custom cmdlet help for a provider path, go to the provider path location and enter a **Get-Help** command or, from any path location, use the **Path** parameter of Get-Help to specify the provider path. +To see the custom cmdlet help for a provider path, go to the provider path location and enter a +**Get-Help** command or, from any path location, use the **Path** parameter of Get-Help to +specify the provider path. You can also find custom cmdlet help online in the provider help section of the help topics. -For example, you can find help for the **New-Item** cmdlet in the Wsman:\*\ClientCertificate path (http://go.microsoft.com/fwlink/?LinkID=158676). +For example, you can find help for the **New-Item** cmdlet in the Wsman:\*\ClientCertificate path [New-Item](http://go.microsoft.com/fwlink/?LinkID=158676). For more information about Windows PowerShell providers, see [about_Providers](About/about_Providers.md). ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -507,6 +612,7 @@ Accept wildcard characters: False ``` ### -Role + Displays help customized for the specified user role. Enter a role. Wildcards are permitted. @@ -518,7 +624,7 @@ This parameter has no effect on help for the core cmdlets. ```yaml Type: String[] Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -528,10 +634,13 @@ Accept wildcard characters: False ``` ### -ShowWindow + Displays the help topic in a window for easier reading. -The window includes a "Find" search feature and a "Settings" box that lets you set options for the display, including options to display only selected sections of a help topic. +The window includes a "Find" search feature and a "Settings" box that lets you set options for +the display, including options to display only selected sections of a help topic. -The **ShowWindow** parameter supports help topics for commands (cmdlets, functions, CIM commands, workflows, scripts) and conceptual "About" topics. +The **ShowWindow** parameter supports help topics for commands (cmdlets, functions, CIM commands, +workflows, scripts) and conceptual "About" topics. It does not support provider help. This parameter is introduced in Windows PowerShell 3.0. @@ -539,7 +648,7 @@ This parameter is introduced in Windows PowerShell 3.0. ```yaml Type: SwitchParameter Parameter Sets: ShowWindow -Aliases: +Aliases: Required: True Position: Named @@ -549,60 +658,73 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, +-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, +-WarningAction, and -WarningVariable. For more information, see: +[about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216) ## INPUTS ### None + You cannot pipe objects to this cmdlet. ## OUTPUTS ### ExtendedCmdletHelpInfo -If you run **Get-Help** on a command that does not have a help file, **Get-Help** returns an ExtendedCmdletHelpInfo object that represents autogenerated help. + +If you run **Get-Help** on a command that does not have a help file, **Get-Help** returns an +ExtendedCmdletHelpInfo object that represents autogenerated help. ### System.String + If you get a conceptual help topic, **Get-Help** returns it as a string. ### MamlCommandHelpInfo + If you get a command that has a help file, **Get-Help** returns a **MamlCommandHelpInfo** object. ## NOTES -* Without parameters, "Get-Help" displays information about the Windows PowerShell help system. -* Windows PowerShell 3.0 does not come with help files. To download and install the help files that **Get-Help** reads, use the Update-Help cmdlet. You can use the **Update-Help** cmdlet to download and install help files for the core commands that come with Windows PowerShell and for any modules that you install. You can also use it to update the help files so that the help on your computer is never outdated. - You can also read the help topics about the commands that come with Windows PowerShell online beginning at http://go.microsoft.com/fwlink/?LinkID=107116. - -* **Get-Help** displays help in the locale set for Windows or in the fallback language for that locale. If you do not have help files for the primary or fallback locale, **Get-Help** behaves as though there are no help files on the computer. To get help for a different locale, use Region and Language in Control Panel to change the settings for Windows. -* The full view of help (-Full) includes a table of information about the parameters. The table includes the following fields: - - - Required: Indicates whether the parameter is required (true) or optional (false). - - - Position: Indicates whether the parameter is named or positional (numbered). -Positional parameters must appear in a specified place in the command. - - - "Named" indicates that the parameter name is required, but that the parameter can appear anywhere in the command. - - - \ indicates that the parameter name is optional, but when the name is omitted, the parameter must be in the place specified by the number. -For example, "2" indicates that when the parameter name is omitted, the parameter must be the second (2) or only unnamed parameter in the command. -When the parameter name is used, the parameter can appear anywhere in the command. - - - Default value: The parameter value that Windows PowerShell uses if you do not include the parameter in the command. - - - Accepts pipeline input: Indicates whether you can (true) or cannot (false) send objects to the parameter through a pipeline. -"By Property Name" means that the pipelined object must have a property with the same name as the parameter name. - - - Accepts wildcard characters: Indicates whether the value of a parameter can include wildcard characters, such as * and ?. +- **Update-Help** cmdlet + - Windows PowerShell 3.0 does not include help files. + - To download and install the help files that **Get-Help** reads, use the **Update-Help** cmdlet. + - Download and install help files for any Windows PowerShell Cmdlets and for any third-party modules. + - You can also use it to update the help files so that the help on your computer is never outdated. + - Online help topics about Windows PowerShell Cmdlets can be found online + - Starting with [Scripting with Windows PowerShell](http://go.microsoft.com/fwlink/?LinkID=107116). + +- Localization Support + - **Get-Help** displays help in the locale set for the Windows operating system. + - Fallback language support is avialable. + - **Get-Help** behaves as if there are no help files on the computer if: + - You do not have help files for the primary locale or, + - You do not have help files for the fallback locale + - To get help for a different locale, use Region and Language in Control Panel to change the settings. + +- Parameter Notes: + - No Parameters used + - **Get-Help** displays information about the Windows PowerShell help system. + - Required: Indicates whether the parameter is required (true) or optional (false). + - Position: Indicates whether the parameter is named or positional (numbered). + - Positional parameters must appear in a specified place in the command. + - Named: Indicates that the parameter name is required but does not have a required position. + - Number: Indicates that the parameter name is optional, but the parameter must be in that positon. + - For example, "2" indicates that when the parameter name is omitted: + - The parameter must be the second (2) or + - Only unnamed parameter in the command. + - When the parameter name is used, the parameter can appear anywhere in the command. + - Default value: + - The parameter value that Windows PowerShell uses if you do not include the parameter in the command. + - Accepts pipeline input: Indicates whether objects can be sent throught the pipeleine: + - you can (true) or, + - cannot (false) + - By Property Name: Indicates that the pipelined object must have a property with the same name. + - Accepts wildcard characters: Indicates whether wildcard characters can be used. ## RELATED LINKS [Updatable Help Status Table (http://go.microsoft.com/fwlink/?LinkID=270007)](http://go.microsoft.com/fwlink/?LinkID=270007) - [about_Command_Syntax](About/about_Command_Syntax.md) - [Get-Command](Get-Command.md) - -[about_Comment_Based_Help](About/about_Comment_Based_Help.md) - -[about_Parameters](About/about_Parameters.md) - diff --git a/reference/5.0/Microsoft.PowerShell.Core/Get-Help.md b/reference/5.0/Microsoft.PowerShell.Core/Get-Help.md index c7b869056476..03868610b72a 100644 --- a/reference/5.0/Microsoft.PowerShell.Core/Get-Help.md +++ b/reference/5.0/Microsoft.PowerShell.Core/Get-Help.md @@ -11,52 +11,63 @@ title: Get-Help # Get-Help ## SYNOPSIS + Displays information about Windows PowerShell commands and concepts. ## SYNTAX ### AllUsersView (Default) + ``` Get-Help [[-Name] ] [-Path ] [-Category ] [-Component ] [-Functionality ] [-Role ] [-Full] [] ``` ### DetailedView + ``` Get-Help [[-Name] ] [-Path ] [-Category ] [-Component ] [-Functionality ] [-Role ] [-Detailed] [] ``` ### Examples + ``` Get-Help [[-Name] ] [-Path ] [-Category ] [-Component ] [-Functionality ] [-Role ] [-Examples] [] ``` ### Parameters + ``` Get-Help [[-Name] ] [-Path ] [-Category ] [-Component ] [-Functionality ] [-Role ] -Parameter [] ``` ### Online + ``` Get-Help [[-Name] ] [-Path ] [-Category ] [-Component ] [-Functionality ] [-Role ] [-Online] [] ``` ### ShowWindow + ``` Get-Help [[-Name] ] [-Path ] [-Category ] [-Component ] [-Functionality ] [-Role ] [-ShowWindow] [] ``` ## DESCRIPTION -The **Get-Help** cmdlet displays information about Windows PowerShell concepts and commands, including cmdlets, functions, CIM commands, workflows, providers, aliases and scripts. -To get help for a Windows PowerShell command, type `Get-Help` followed by the command name, such as: `Get-Help Get-Process`. +The **Get-Help** cmdlet displays information about Windows PowerShell concepts and commands, +including cmdlets, functions, CIM commands, workflows, providers, aliases and scripts. + +To get help for a Windows PowerShell command, type `Get-Help` followed by the command name, such as: +`Get-Help Get-Process`. To get a list of all help topics on your system, type `Get-Help *`. -You can display the whole help topic or use the parameters of the **Get-Help** cmdlet to get selected parts of the topic, such as the syntax, parameters, or examples. +You can display the whole help topic or use the parameters of the **Get-Help** cmdlet to get +selected parts of the topic, such as the syntax, parameters, or examples. Conceptual help topics in Windows PowerShell begin with "about_", such as "about_Comparison_Operators". To see all "about_" topics, type `Get-Help about_*`. @@ -65,51 +76,67 @@ To see a particular topic, type `Get-Help about_\`, such as `Get-He To get help for a Windows PowerShell provider, type `Get-Help` followed by the provider name. For example, to get help for the Certificate provider, type `Get-Help Certificate`. -In addition to `Get-Help`, you can also type `help` or `man`, which displays one screen of text at a time, or `\ -?`, which is identical to **Get-Help** but works only for commands. +In addition to `Get-Help`, you can also type `help` or `man`, which displays one screen of text +at a time, or `\ -?`, which is identical to **Get-Help** but works only for commands. **Get-Help** gets the help content that it displays from help files on your computer. Without the help files, **Get-Help** displays only basic information about commands. Some Windows PowerShell modules come with help files. -However, starting in Windows PowerShell 3.0, the modules that come with the Windows operating system do not include help files. +However, starting in Windows PowerShell 3.0, the modules that come with the Windows operating +system do not include help files. To download or update the help files for a module in Windows PowerShell 3.0, use the Update-Help cmdlet. You can also view the help topics for Windows PowerShell online in the TechNet Library. -To get the online version of a help topic, use the *Online* parameter, such as: `Get-Help Get-Process -Online`. -To read all of the help topics, see Scripting with Windows PowerShellhttp://go.microsoft.com/fwlink/?LinkID=107116 (http://go.microsoft.com/fwlink/?LinkID=107116) in the TechNet library. +To get the online version of a help topic, use the *Online* parameter, such as: +`Get-Help Get-Process -Online`. + +To read all of the help topics, see +[Scripting with Windows PowerShell](http://go.microsoft.com/fwlink/?LinkID=107116) -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** displays 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. +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** displays 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. **Get-Help** can get help topics 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", and then in a fallback locale. -Beginning in Windows PowerShell 3.0, if **Get-Help** does not find help in the fallback locale, it looks for help topics in English, "en-US", before it returns an error message or displaying auto-generated help. +**Get-Help** first looks for help files in the locale set for Windows, then in the parent locale, +such as "pt" for "pt-BR", and then in a fallback locale. +Beginning in Windows PowerShell 3.0, if **Get-Help** does not find help in the fallback locale, +it looks for help topics in English, "en-US", before it returns an error message or displaying +auto-generated help. For information about the symbols that **Get-Help** displays in the command syntax diagram, see about_Command_Syntax. For information about parameter attributes, such as **Required** and **Position**, see about_Parameters. -**TROUBLESHOOTING NOTE**: In Windows PowerShell 3.0 and Windows PowerShell 4.0, **Get-Help** cannot find About topics in modules unless the module is imported into the current session. +**TROUBLESHOOTING NOTE**: In Windows PowerShell 3.0 and Windows PowerShell 4.0, **Get-Help** +cannot find About topics in modules unless the module is imported into the current session. This is a known issue. -To get About topics in a module, import the module, either by using the Import-Module cmdlet or by running a cmdlet in the module. +To get About topics in a module, import the module, either by using the Import-Module cmdlet or +by running a cmdlet in the module. ## EXAMPLES ### Example 1: Display help about the help system -``` + +```powershell PS C:\> Get-Help ``` This command displays help about the Windows PowerShell help system. ### Example 2: Display available help topics -``` + +```powershell PS C:\> Get-Help * ``` This command displays a list of the available help topics. ### Example 3: Display basic information about a cmdlet -``` + +```powershell PS C:\> Get-Help Get-Alias PS C:\> Help Get-Alias PS C:\> Get-Alias -? @@ -120,187 +147,244 @@ The **Get-Help** and *?* commands display the information on a single page. The Help command displays the information one page at a time. ### Example 4: Display a list of conceptual topics -``` + +```powershell PS C:\> Get-Help about_* ``` This command displays a list of the conceptual topics included in Windows PowerShell help. All of these topics begin with the characters about_. -To display a particular help file, type get-help \, for example, `Get-Help about_Signing`. +To display a particular help file, type Get-Help \, for example, `Get-Help about_Signing`. -This command displays the conceptual topics only when the help files for those topics are installed on the computer. +This command displays the conceptual topics only when the help files for those topics are +installed on the computer. For information about downloading and installing help files in Windows PowerShell 3.0, see Update-Help. ### Example 5: Download and install help files -``` -The first command uses the **Get-Help** cmdlet to get help for the Get-Command cmdlet. Without help files, **Get-Help** display the cmdlet name, syntax and alias of **Get-Command**, and prompts you to use the **Update-Help** cmdlet to get the newest help files. + +The first command uses the **Get-Help** cmdlet to get help for the Get-Command cmdlet. +Without help files, **Get-Help** display the cmdlet name, syntax and alias of **Get-Command**, +and prompts you to use the **Update-Help** cmdlet to get the newest help files. + +```powershell PS C:\> Get-Help Get-Command +``` + +```Output NAME Get-Command - SYNTAX - + Get-Command [[-Name] ] [-CommandType {Alias | Function | Filter | Cmdlet | ExternalScript | Application | Script | All}] [[-ArgumentList] ] [-Module ] [-Syntax] [-TotalCount ] [] - - Get-Command [-Noun ] [-Verb ] [[-ArgumentList] ] [-Module ] [-Syntax] + Get-Command [-Noun ] [-Verb ] [[-ArgumentList] ] [-Module ] [-Syntax] [-TotalCount ] [] - - ALIASES - gcm - + gcm REMARKS Get-Help cannot find the help files for this cmdlet on this computer. It is displaying only partial help. To download and install help files for this cmdlet, use **Update-Help**. +``` + +The second command runs the **Update-Help** cmdlet without parameters. +This command downloads help files from the Internet for all of the modules in the current session +and installs them on the local computer. +This command works only when the local computer is connected to the Internet. +If your computer is not connected to the Internet, you might be able to install help files +from a network share. For more information, see Save-Help. -The second command runs the **Update-Help** cmdlet without parameters. This command downloads help files from the Internet for all of the modules in the current session and installs them on the local computer.This command works only when the local computer is connected to the Internet. If your computer is not connected to the Internet, you might be able to install help files from a network share. For more information, see Save-Help. +```powershell PS C:\> Update-Help +``` + +Now that the help files are downloaded, we can repeat the first command in the sequence. +This command gets help for the **Get-Command** cmdlet. +The cmdlet now gets more extensive help for **Get-Command** and you can use the +*Detailed*, *Full*, *Example*, and *Parameter* parameters of **Get-Help** to customize the displays. +You can use the **Get-Help** cmdlet as soon as the **Update-Help** command finishes. +You do not have to restart Windows PowerShell. -Now that the help files are downloaded, we can repeat the first command in the sequence. This command gets help for the **Get-Command** cmdlet. The cmdlet now gets more extensive help for **Get-Command** and you can use the *Detailed*, *Full*, *Example*, and *Parameter* parameters of **Get-Help** to customize the displays.You can use the **Get-Help** cmdlet as soon as the **Update-Help** command finishes. You do not have to restart Windows PowerShell. +```powershell PS C:\> Get-Help Get-Command ``` This example shows how to download and install new or updated help files for a module. It uses features that were introduced in Windows PowerShell 3.0. -The example compares the help that **Get-Help** displays for commands when you do not have help files installed on your computer and when you do have help files. -You can use the same command sequence to update the help files on your computer so that your local help content is never obsolete. +The example compares the help that **Get-Help** displays for commands when you do not have help +files installed on your computer and when you do have help files. +You can use the same command sequence to update the help files on your computer so that your +local help content is never obsolete. -To download and install the help files for the commands that come with Windows PowerShell, and for any modules in the $pshome\Modules directory, open Windows PowerShell by using the Run as administrator option. -If you are not a member of the Administrators group on the computer, you cannot download help for these modules. -However, you can use the *Online* parameter to open the online version of help for a command, and you can read the help for Windows PowerShell in the TechNet library starting at Scripting with Windows PowerShellhttp://go.microsoft.com/fwlink/?LinkID=107116 (http://go.microsoft.com/fwlink/?LinkID=107116). +To download and install the help files for the commands that come with Windows PowerShell, and +for any modules in the $pshome\Modules directory, open Windows PowerShell by using the Run as +administrator option. +If you are not a member of the Administrators group on the computer, you cannot download help for +these modules. +However, you can use the *Online* parameter to open the online version of help for a command, and +you can read the help for Windows PowerShell in the TechNet library starting at: +[Scripting with Windows PowerShell](http://go.microsoft.com/fwlink/?LinkID=107116) ### Example 6: Display detailed help -``` + +```powershell PS C:\> Get-Help ls -Detailed ``` This command displays detailed help for the Get-ChildItem cmdlet by specifying one of its aliases, ls. -The *Detailed* parameter of **Get-Help** gets the detailed view of the help topic, which includes parameter descriptions and examples. +The *Detailed* parameter of **Get-Help** gets the detailed view of the help topic, +which includes parameter descriptions and examples. To see the complete help topic for a cmdlet, use the *Full* parameter. -The *Full* and *Detailed* parameters are effective only when help files for the command are installed on the computer. +The *Full* and *Detailed* parameters are effective only when help files for the command are +installed on the computer. ### Example 7: Display full information for a cmdlet -``` + +```powershell PS C:\> Get-Help Format-Table -Full ``` -This command uses the *Full* parameter of **Get-Help** to display the full view help for the Format-Table cmdlet. -The full view of help includes parameter descriptions, examples, and a table of technical details about the parameters. +This command uses the *Full* parameter of **Get-Help** to display the full view help for the +Format-Table cmdlet. +The full view of help includes parameter descriptions, examples, and a table of technical details +about the parameters. The *Full* parameter is effective only when help files for the command are installed on the computer. ### Example 8: Display examples for a cmdlet -``` + +```powershell PS C:\> Get-Help Start-Service -Examples ``` This command displays examples of using the Start-Service cmdlet. -It uses the *Examples* parameter of **Get-Help** to display only the Examples section of the cmdlet help topics. +It uses the *Examples* parameter of **Get-Help** to display only the Examples section of the +cmdlet help topics. The *Examples* parameter is effective only when help files for the command are installed on the computer. ### Example 9: Display parameter help -``` + +```powershell PS C:\> Get-Help Format-List -Parameter GroupBy ``` -This command uses the *Parameter* parameter of **Get-Help** to display a detailed description of the *GroupBy* parameter of the Format-List cmdlet. -For detailed descriptions of all parameters of the **Format-List** cmdlet, type `Get-Help Format-List -Parameter *`. +This command uses the *Parameter* parameter of **Get-Help** to display a detailed description of +the *GroupBy* parameter of the Format-List cmdlet. +For detailed descriptions of all parameters of the **Format-List** cmdlet, type +`Get-Help Format-List -Parameter *`. ### Example 10: Search for a word in cmdlet help -``` + +```powershell PS C:\> Get-Help Add-Member -Full | Out-String -Stream | Select-String -Pattern Clixml ``` This example shows how to search for a word in particular cmdlet help topic. This command searches for the word Clixml in the full version of the help topic for the Add-Member cmdlet. -Because the **Get-Help** cmdlet generates a **MamlCommandHelpInfo** object, not a string, you have to use a cmdlet that transforms the help topic content into a string, such as Out-String or Out-File. +Because the **Get-Help** cmdlet generates a **MamlCommandHelpInfo** object, not a string, +you have to use a cmdlet that transforms the help topic content into a string, such as Out-String +or Out-File. ### Example 11: Display online version of help -``` + +```powershell PS C:\> Get-Help Get-Member -Online ``` This command displays the online version of the help topic for the Get-Member cmdlet. ### Example 12: Display a list of topics that include a word -``` + +```powershell PS C:\> Get-Help remoting ``` This command displays a list of topics that include the word remoting. -When you enter a word that does not appear in any topic title, **Get-Help** displays a list of topics that include that word. +When you enter a word that does not appear in any topic title, **Get-Help** displays a list of +topics that include that word. ### Example 13: Display provider specific help -``` -The first command uses the *Path* parameter of **Get-Help** to specify the provider path. This command can be entered at any path location. + +The first command uses the *Path* parameter of **Get-Help** to specify the provider path. +This command can be entered at any path location. + +```powershell PS C:\> Get-Help Get-Item -Path SQLSERVER:\DataCollection +``` +```Output NAME Get-Item - SYNOPSIS Gets a collection of Server objects for the local computer and any computers - to which you have made a SQL Server PowerShell connection. - ... +``` -The second command uses the Set-Location cmdlet (alias = "cd") to navigate to the provider path. From that location, even without the *Path* parameter, the **Get-Help** command gets the provider-specific help for the **Get-Item** cmdlet. +The second command uses the Set-Location cmdlet (alias = "cd") to navigate to the provider path. +From that location, even without the *Path* parameter, the **Get-Help** command gets the +provider-specific help for the **Get-Item** cmdlet. + +```powershell PS C:\> cd SQLSERVER:\DataCollection SQLSERVER:\DataCollection> Get-Help Get-Item +``` +```Output NAME Get-Item - SYNOPSIS Gets a collection of Server objects for the local computer and any computers - to which you have made a SQL Server PowerShell connection. - ... +``` +The third command shows that a **Get-Help** command in a file system path, and without the +*Path* parameter, gets the standard help for the **Get-Item** cmdlet. -The third command shows that a **Get-Help** command in a file system path, and without the *Path* parameter, gets the standard help for the **Get-Item** cmdlet. +```powershell PS C:\> Get-Item +``` +```Output NAME Get-Item - SYNOPSIS Gets the item at the specified location. ... ``` -This example shows how to get help that explains how to use the Get-Item cmdlet in the **DataCollection** node of the Windows PowerShellSQL Server provider. +This example shows how to get help that explains how to use the Get-Item cmdlet in the +**DataCollection** node of the Windows PowerShellSQL Server provider. The example shows two ways of getting the provider-specific help for **Get-Item**. You can also get provider-specific help for cmdlets online in the section that describes the provider. -For example, for provider-specific online help for the **New-Item** cmdlet in each WSMan provider path, see New-Item for ClientCertificatehttp://go.microsoft.com/fwlink/?LinkID=158676 in the TechNet library. +For example, for provider-specific online help for the **New-Item** cmdlet in each WSMan provider +path, see [New-Item for ClientCertificate](http://go.microsoft.com/fwlink/?LinkID=158676) ### Example 14: Display help for a script -``` + +```powershell PS C:\> Get-Help C:\PS-Test\MyScript.ps1 ``` @@ -310,33 +394,34 @@ For information about how to write help for your functions and scripts, see abou ## PARAMETERS ### -Category + Displays help only for items in the specified category and their aliases. The acceptable values for this parameter are: -- Alias -- Cmdlet -- Provider -- General -- FAQ -- Glossary -- HelpFile -- ScriptCommand -- Function -- Filter -- ExternalScript -- All -- DefaultHelp -- Workflow -- DscResource -- Class -- Configuration +- Alias +- Cmdlet +- Provider +- General +- FAQ +- Glossary +- HelpFile +- ScriptCommand +- Function +- Filter +- ExternalScript +- All +- DefaultHelp +- Workflow +- DscResource +- Class +- Configuration Conceptual topics are in the HelpFile category. ```yaml Type: String[] Parameter Sets: (All) -Aliases: +Aliases: Accepted values: Alias, Cmdlet, Provider, General, FAQ, Glossary, HelpFile, ScriptCommand, Function, Filter, ExternalScript, All, DefaultHelp, Workflow, DscResource, Class, Configuration Required: False @@ -347,6 +432,7 @@ Accept wildcard characters: False ``` ### -Component + Displays commands with the specified component value, such as "Exchange." Enter a component name. Wildcard characters are permitted. @@ -355,7 +441,7 @@ This parameter has no effect on displays of conceptual ("About_") help. ```yaml Type: String[] Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -365,6 +451,7 @@ Accept wildcard characters: False ``` ### -Detailed + Adds parameter descriptions and examples to the basic help display. This parameter is effective only when help files are for the command are installed on the computer. @@ -373,7 +460,7 @@ It has no effect on displays of conceptual ("About_") help. ```yaml Type: SwitchParameter Parameter Sets: DetailedView -Aliases: +Aliases: Required: True Position: Named @@ -383,6 +470,7 @@ Accept wildcard characters: False ``` ### -Examples + Displays only the name, synopsis, and examples. To display only the examples, type `(Get-Help \).Examples`. @@ -392,7 +480,7 @@ It has no effect on displays of conceptual ("About_") help. ```yaml Type: SwitchParameter Parameter Sets: Examples -Aliases: +Aliases: Required: True Position: Named @@ -402,8 +490,10 @@ Accept wildcard characters: False ``` ### -Full + Displays the whole help topic for a cmdlet. -This includes parameter descriptions and attributes, examples, input and output object types, and additional notes. +This includes parameter descriptions and attributes, examples, input and output object types, +and additional notes. This parameter is effective only when help files are for the command are installed on the computer. It has no effect on displays of conceptual ("About_") help. @@ -411,7 +501,7 @@ It has no effect on displays of conceptual ("About_") help. ```yaml Type: SwitchParameter Parameter Sets: AllUsersView -Aliases: +Aliases: Required: False Position: Named @@ -421,6 +511,7 @@ Accept wildcard characters: False ``` ### -Functionality + Displays help for items with the specified functionality. Enter the functionality. Wildcard characters are permitted. @@ -430,7 +521,7 @@ This parameter has no effect on displays of conceptual ("About_") help. ```yaml Type: String[] Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -440,22 +531,29 @@ Accept wildcard characters: False ``` ### -Name + Gets help about the specified command or concept. -Enter the name of a cmdlet, function, provider, script, or workflow, such as `Get-Member`, a conceptual topic name, such as `about_Objects`, or an alias, such as `ls`. -Wildcard characters are permitted in cmdlet and provider names, but you cannot use wildcard characters to find the names of function help and script help topics. +Enter the name of a cmdlet, function, provider, script, or workflow, such as `Get-Member`, +a conceptual topic name, such as `about_Objects`, or an alias, such as `ls`. +Wildcard characters are permitted in cmdlet and provider names, but you cannot use wildcard +characters to find the names of function help and script help topics. -To get help for a script that is not located in a path that is listed in the Path environment variable, type the path and file name of the script. +To get help for a script that is not located in a path that is listed in the Path environment +variable, type the path and file name of the script. If you enter the exact name of a help topic, **Get-Help** displays 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 match any help topic titles, **Get-Help** displays a list of topics that include that word in their 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 match any help topic titles, **Get-Help** displays a list of +topics that include that word in their contents. -The names of conceptual topics, such as `about_Objects`, must be entered in English, even in non-English versions of Windows PowerShell. +The names of conceptual topics, such as `about_Objects`, must be entered in English, even in +non-English versions of Windows PowerShell. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: 0 @@ -465,16 +563,21 @@ Accept wildcard characters: False ``` ### -Online + Displays the online version of a help topic in the default Internet browser. This parameter is valid only for cmdlet, function, workflow and script help topics. You cannot use the *Online* parameter in **Get-Help** commands in a remote session. -For information about supporting this feature in help topics that you write, see about_Comment_Based_Help (http://go.microsoft.com/fwlink/?LinkID=144309), and Supporting Online Help (http://go.microsoft.com/fwlink/?LinkID=242132), and [How to Write Cmdlet Help](https://go.microsoft.com/fwlink/?LinkID=123415) in the MSDN library. +For information about supporting this feature in help topics that you write, see: + +- [about_Comment_Based_Help](http://go.microsoft.com/fwlink/?LinkID=144309) +- [Supporting Online Help](http://go.microsoft.com/fwlink/?LinkID=242132) +- [How to Write Cmdlet Help](https://go.microsoft.com/fwlink/?LinkID=123415) ```yaml Type: SwitchParameter Parameter Sets: Online -Aliases: +Aliases: Required: True Position: Named @@ -484,6 +587,7 @@ Accept wildcard characters: False ``` ### -Parameter + Displays only the detailed descriptions of the specified parameters. Wildcards are permitted. @@ -492,7 +596,7 @@ This parameter has no effect on displays of conceptual ("About_") help. ```yaml Type: String Parameter Sets: Parameters -Aliases: +Aliases: Required: True Position: Named @@ -502,23 +606,29 @@ Accept wildcard characters: False ``` ### -Path + Gets help that explains how the cmdlet works in the specified provider path. Enter a Windows PowerShell provider path. -This parameter gets a customized version of a cmdlet help topic that explains how the cmdlet works in the specified Windows PowerShell provider path. -This parameter is effective only for help about a provider cmdlet and only when the provider includes a custom version of the provider cmdlet help topic in its help file. +This parameter gets a customized version of a cmdlet help topic that explains how the cmdlet +works in the specified Windows PowerShell provider path. +This parameter is effective only for help about a provider cmdlet and only when the provider +includes a custom version of the provider cmdlet help topic in its help file. To use this parameter, install the help file for the module that includes the provider. -To see the custom cmdlet help for a provider path, go to the provider path location and enter a **Get-Help** command or, from any path location, use the *Path* parameter of **Get-Help** to specify the provider path. +To see the custom cmdlet help for a provider path, go to the provider path location and enter a +**Get-Help** command or, from any path location, use the *Path* parameter of **Get-Help** to +specify the provider path. You can also find custom cmdlet help online in the provider help section of the help topics. -For example, you can find help for the **New-Item** cmdlet in the Wsman:\*\ClientCertificate path (http://go.microsoft.com/fwlink/?LinkID=158676). +For example, you can find help for the **New-Item** cmdlet in the Wsman:\*\ClientCertificate path +[http://go.microsoft.com/fwlink/?LinkID=158676](http://go.microsoft.com/fwlink/?LinkID=158676) For more information about Windows PowerShell providers, see [about_Providers](About/about_Providers.md). ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -528,6 +638,7 @@ Accept wildcard characters: False ``` ### -Role + Displays help customized for the specified user role. Enter a role. Wildcard characters are permitted. @@ -539,7 +650,7 @@ This parameter has no effect on help for the core cmdlets. ```yaml Type: String[] Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -549,11 +660,13 @@ Accept wildcard characters: False ``` ### -ShowWindow + Displays the help topic in a window for easier reading. The window includes a Find search feature and a Settings box that lets you set options for the display. These include options to display only selected sections of a help topic. -The *ShowWindow* parameter supports help topics for commands, which include cmdlets, functions, CIM commands, workflows, and scripts, and conceptual About topics. +The *ShowWindow* parameter supports help topics for commands, which include cmdlets, functions, +CIM commands, workflows, and scripts, and conceptual About topics. It does not support provider help. This parameter was introduced in Windows PowerShell 3.0. @@ -561,7 +674,7 @@ This parameter was introduced in Windows PowerShell 3.0. ```yaml Type: SwitchParameter Parameter Sets: ShowWindow -Aliases: +Aliases: Required: True Position: Named @@ -571,65 +684,73 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, +-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, +-WarningAction, and -WarningVariable. For more information, see: +[about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216) ## INPUTS ### None + You cannot pipe objects to this cmdlet. ## OUTPUTS ### ExtendedCmdletHelpInfo -If you run **Get-Help** on a command that does not have a help file, **Get-Help** returns an ExtendedCmdletHelpInfo object that represents autogenerated help. + +If you run **Get-Help** on a command that does not have a help file, **Get-Help** returns +an ExtendedCmdletHelpInfo object that represents autogenerated help. ### System.String + If you get a conceptual help topic, **Get-Help** returns it as a string. ### MamlCommandHelpInfo + If you get a command that has a help file, **Get-Help** returns a **MamlCommandHelpInfo** object. ## NOTES -* If you do not specify parameters, **Get-Help** displays information about the Windows PowerShell help system. -* Windows PowerShell 3.0 does not include help files. To download and install the help files that **Get-Help** reads, use the **Update-Help** cmdlet. You can use the **Update-Help** cmdlet to download and install help files for the core commands that come with Windows PowerShell and for any modules that you install. You can also use it to update the help files so that the help on your computer is never outdated. - - You can also read the help topics about the commands that come with Windows PowerShell online starting at Scripting with Windows PowerShellhttp://go.microsoft.com/fwlink/?LinkID=107116 (http://go.microsoft.com/fwlink/?LinkID=107116). - -* **Get-Help** displays help in the locale set for the Windows operating system or in the fallback language for that locale. If you do not have help files for the primary or fallback locale, **Get-Help** behaves as if there are no help files on the computer. To get help for a different locale, use Region and Language in Control Panel to change the settings. -* The full view of help includes a table of information about the parameters. The table includes the following fields: - - Required. -Indicates whether the parameter is required (true) or optional (false). - - - Position. -Indicates whether the parameter is named or positional (numbered). -Positional parameters must appear in a specified place in the command. - - ---- "Named" indicates that the parameter name is required, but that the parameter can appear anywhere in the command. - - ---- \ indicates that the parameter name is optional, but when the name is omitted, the parameter must be in the place specified by the number. -For example, "2" indicates that when the parameter name is omitted, the parameter must be the second (2) or only unnamed parameter in the command. -When the parameter name is used, the parameter can appear anywhere in the command. - - - Default value. -The parameter value that Windows PowerShell uses if you do not include the parameter in the command. - - - Accepts pipeline input. -Indicates whether you can (true) or cannot (false) send objects to the parameter through a pipeline. -"By Property Name" means that the pipelined object must have a property that has the same name as the parameter name. - - - Accepts wildcard characters. -Indicates whether the value of a parameter can include wildcard characters, such as * and ?. +- **Update-Help** cmdlet + - Windows PowerShell 3.0 does not include help files. + - To download and install the help files that **Get-Help** reads, use the **Update-Help** cmdlet. + - Download and install help files for any Windows PowerShell Cmdlets and for any third-party modules. + - You can also use it to update the help files so that the help on your computer is never outdated. + - Online help topics about Windows PowerShell Cmdlets can be found online + - Starting with [Scripting with Windows PowerShell](http://go.microsoft.com/fwlink/?LinkID=107116). + +- Localization Support + - **Get-Help** displays help in the locale set for the Windows operating system. + - Fallback language support is avialable. + - **Get-Help** behaves as if there are no help files on the computer if: + - You do not have help files for the primary locale or, + - You do not have help files for the fallback locale + - To get help for a different locale, use Region and Language in Control Panel to change the settings. + +- Parameter Notes: + - No Parameters used + - **Get-Help** displays information about the Windows PowerShell help system. + - Required: Indicates whether the parameter is required (true) or optional (false). + - Position: Indicates whether the parameter is named or positional (numbered). + - Positional parameters must appear in a specified place in the command. + - Named: Indicates that the parameter name is required but does not have a required position. + - Number: Indicates that the parameter name is optional, but the parameter must be in that positon. + - For example, "2" indicates that when the parameter name is omitted: + - The parameter must be the second (2) or + - Only unnamed parameter in the command. + - When the parameter name is used, the parameter can appear anywhere in the command. + - Default value: + - The parameter value that Windows PowerShell uses if you do not include the parameter in the command. + - Accepts pipeline input: Indicates whether objects can be sent throught the pipeleine: + - you can (true) or, + - cannot (false) + - By Property Name: Indicates that the pipelined object must have a property with the same name. + - Accepts wildcard characters: Indicates whether wildcard characters can be used. ## RELATED LINKS [Updatable Help Status Table (http://go.microsoft.com/fwlink/?LinkID=270007)](http://go.microsoft.com/fwlink/?LinkID=270007) - [about_Command_Syntax](About/about_Command_Syntax.md) - [Get-Command](Get-Command.md) - -[about_Comment_Based_Help](About/about_Comment_Based_Help.md) - -[about_Parameters](About/about_Parameters.md) - diff --git a/reference/5.1/Microsoft.PowerShell.Core/Get-Help.md b/reference/5.1/Microsoft.PowerShell.Core/Get-Help.md index 7288c23a4907..3eeddc4b489a 100644 --- a/reference/5.1/Microsoft.PowerShell.Core/Get-Help.md +++ b/reference/5.1/Microsoft.PowerShell.Core/Get-Help.md @@ -11,52 +11,64 @@ title: Get-Help # Get-Help ## SYNOPSIS + Displays information about Windows PowerShell commands and concepts. ## SYNTAX ### AllUsersView (Default) + ``` Get-Help [[-Name] ] [-Path ] [-Category ] [-Component ] [-Functionality ] [-Role ] [-Full] [] ``` ### DetailedView + ``` Get-Help [[-Name] ] [-Path ] [-Category ] [-Component ] [-Functionality ] [-Role ] [-Detailed] [] ``` ### Examples + ``` Get-Help [[-Name] ] [-Path ] [-Category ] [-Component ] [-Functionality ] [-Role ] [-Examples] [] ``` ### Parameters + ``` Get-Help [[-Name] ] [-Path ] [-Category ] [-Component ] [-Functionality ] [-Role ] -Parameter [] ``` ### Online + ``` Get-Help [[-Name] ] [-Path ] [-Category ] [-Component ] [-Functionality ] [-Role ] [-Online] [] ``` ### ShowWindow + ``` Get-Help [[-Name] ] [-Path ] [-Category ] [-Component ] [-Functionality ] [-Role ] [-ShowWindow] [] ``` ## DESCRIPTION -The **Get-Help** cmdlet displays information about Windows PowerShell concepts and commands, including cmdlets, functions, CIM commands, workflows, providers, aliases and scripts. -To get help for a Windows PowerShell command, type `Get-Help` followed by the command name, such as: `Get-Help Get-Process`. +The **Get-Help** cmdlet displays information about Windows PowerShell concepts and commands, +including cmdlets, functions, CIM commands, workflows, providers, aliases and scripts. + +To get help for a Windows PowerShell command, type `Get-Help` followed by the command name, such as: +`Get-Help Get-Process`. + To get a list of all help topics on your system, type `Get-Help *`. -You can display the whole help topic or use the parameters of the **Get-Help** cmdlet to get selected parts of the topic, such as the syntax, parameters, or examples. +You can display the whole help topic or use the parameters of the **Get-Help** cmdlet to get +selected parts of the topic, such as the syntax, parameters, or examples. Conceptual help topics in Windows PowerShell begin with "about_", such as "about_Comparison_Operators". To see all "about_" topics, type `Get-Help about_*`. @@ -65,51 +77,67 @@ To see a particular topic, type `Get-Help about_\`, such as `Get-He To get help for a Windows PowerShell provider, type `Get-Help` followed by the provider name. For example, to get help for the Certificate provider, type `Get-Help Certificate`. -In addition to `Get-Help`, you can also type `help` or `man`, which displays one screen of text at a time, or `\ -?`, which is identical to **Get-Help** but works only for commands. +In addition to `Get-Help`, you can also type `help` or `man`, which displays one screen of text +at a time, or `\ -?`, which is identical to **Get-Help** but works only for commands. **Get-Help** gets the help content that it displays from help files on your computer. Without the help files, **Get-Help** displays only basic information about commands. Some Windows PowerShell modules come with help files. -However, starting in Windows PowerShell 3.0, the modules that come with the Windows operating system do not include help files. +However, starting in Windows PowerShell 3.0, the modules that come with the Windows operating +system do not include help files. + To download or update the help files for a module in Windows PowerShell 3.0, use the Update-Help cmdlet. You can also view the help topics for Windows PowerShell online in the TechNet Library. -To get the online version of a help topic, use the *Online* parameter, such as: `Get-Help Get-Process -Online`. -To read all of the help topics, see Scripting with Windows PowerShellhttp://go.microsoft.com/fwlink/?LinkID=107116 (http://go.microsoft.com/fwlink/?LinkID=107116) in the TechNet library. - -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** displays 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. +To get the online version of a help topic, use the *Online* parameter, such as: +`Get-Help Get-Process -Online`. +To read all of the help topics, see Scripting with Windows PowerShell[http://go.microsoft.com/fwlink/?LinkID=107116](http://go.microsoft.com/fwlink/?LinkID=107116) +in the TechNet library. + +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** displays 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. **Get-Help** can get help topics 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", and then in a fallback locale. -Beginning in Windows PowerShell 3.0, if **Get-Help** does not find help in the fallback locale, it looks for help topics in English, "en-US", before it returns an error message or displaying auto-generated help. +**Get-Help** first looks for help files in the locale set for Windows, then in the parent locale, +such as "pt" for "pt-BR", and then in a fallback locale. +Beginning in Windows PowerShell 3.0, if **Get-Help** does not find help in the fallback locale, +it looks for help topics in English, "en-US", before it returns an error message or displaying +auto-generated help. For information about the symbols that **Get-Help** displays in the command syntax diagram, see about_Command_Syntax. For information about parameter attributes, such as **Required** and **Position**, see about_Parameters. -**TROUBLESHOOTING NOTE**: In Windows PowerShell 3.0 and Windows PowerShell 4.0, **Get-Help** cannot find About topics in modules unless the module is imported into the current session. +**TROUBLESHOOTING NOTE**: In Windows PowerShell 3.0 and Windows PowerShell 4.0, **Get-Help** +cannot find About topics in modules unless the module is imported into the current session. This is a known issue. -To get About topics in a module, import the module, either by using the Import-Module cmdlet or by running a cmdlet in the module. +To get About topics in a module, import the module, either by using the Import-Module cmdlet or +by running a cmdlet in the module. ## EXAMPLES ### Example 1: Display help about the help system -``` + +```powershell PS C:\> Get-Help ``` This command displays help about the Windows PowerShell help system. ### Example 2: Display available help topics -``` + +```powershell PS C:\> Get-Help * ``` This command displays a list of the available help topics. ### Example 3: Display basic information about a cmdlet -``` + +```powershell PS C:\> Get-Help Get-Alias PS C:\> Help Get-Alias PS C:\> Get-Alias -? @@ -120,187 +148,237 @@ The **Get-Help** and *?* commands display the information on a single page. The Help command displays the information one page at a time. ### Example 4: Display a list of conceptual topics -``` + +```powershell PS C:\> Get-Help about_* ``` This command displays a list of the conceptual topics included in Windows PowerShell help. All of these topics begin with the characters about_. -To display a particular help file, type get-help \, for example, `Get-Help about_Signing`. +To display a particular help file, type Get-Help \, for example, `Get-Help about_Signing`. -This command displays the conceptual topics only when the help files for those topics are installed on the computer. +This command displays the conceptual topics only when the help files for those topics are +installed on the computer. For information about downloading and installing help files in Windows PowerShell 3.0, see Update-Help. ### Example 5: Download and install help files -``` -The first command uses the **Get-Help** cmdlet to get help for the Get-Command cmdlet. Without help files, **Get-Help** display the cmdlet name, syntax and alias of **Get-Command**, and prompts you to use the **Update-Help** cmdlet to get the newest help files. + +The first command uses the **Get-Help** cmdlet to get help for the Get-Command cmdlet. +Without help files, **Get-Help** display the cmdlet name, syntax and alias of **Get-Command**, +and prompts you to use the **Update-Help** cmdlet to get the newest help files. + +```powershell PS C:\> Get-Help Get-Command +``` + +```Output NAME Get-Command - SYNTAX - Get-Command [[-Name] ] [-CommandType {Alias | Function | Filter | Cmdlet | ExternalScript | Application | - Script | All}] [[-ArgumentList] ] [-Module ] [-Syntax] [-TotalCount ] [] - - Get-Command [-Noun ] [-Verb ] [[-ArgumentList] ] [-Module ] [-Syntax] - +Get-Command [-Noun ] [-Verb ] [[-ArgumentList] ] [-Module ] [-Syntax] [-TotalCount ] [] - - ALIASES - gcm - + gcm REMARKS Get-Help cannot find the help files for this cmdlet on this computer. It is displaying only partial help. To download and install help files for this cmdlet, use **Update-Help**. +``` + +The second command runs the **Update-Help** cmdlet without parameters. +This command downloads help files from the Internet for all of the modules in the current session +and installs them on the local computer. +This command works only when the local computer is connected to the Internet. +If your computer is not connected to the Internet, you might be able to install help files from +a network share. +For more information, see Save-Help. -The second command runs the **Update-Help** cmdlet without parameters. This command downloads help files from the Internet for all of the modules in the current session and installs them on the local computer.This command works only when the local computer is connected to the Internet. If your computer is not connected to the Internet, you might be able to install help files from a network share. For more information, see Save-Help. +```powershell PS C:\> Update-Help +``` + +Now that the help files are downloaded, we can repeat the first command in the sequence. +This command gets help for the **Get-Command** cmdlet. +The cmdlet now gets more extensive help for **Get-Command** and you can use the +*Detailed*, *Full*, *Example*, and *Parameter* parameters of **Get-Help** to customize the displays. +You can use the **Get-Help** cmdlet as soon as the **Update-Help** command finishes. +You do not have to restart Windows PowerShell. -Now that the help files are downloaded, we can repeat the first command in the sequence. This command gets help for the **Get-Command** cmdlet. The cmdlet now gets more extensive help for **Get-Command** and you can use the *Detailed*, *Full*, *Example*, and *Parameter* parameters of **Get-Help** to customize the displays.You can use the **Get-Help** cmdlet as soon as the **Update-Help** command finishes. You do not have to restart Windows PowerShell. +```powershell PS C:\> Get-Help Get-Command ``` This example shows how to download and install new or updated help files for a module. It uses features that were introduced in Windows PowerShell 3.0. -The example compares the help that **Get-Help** displays for commands when you do not have help files installed on your computer and when you do have help files. -You can use the same command sequence to update the help files on your computer so that your local help content is never obsolete. +The example compares the help that **Get-Help** displays for commands when you do not have +help files installed on your computer and when you do have help files. +You can use the same command sequence to update the help files on your computer so that your +local help content is never obsolete. -To download and install the help files for the commands that come with Windows PowerShell, and for any modules in the $pshome\Modules directory, open Windows PowerShell by using the Run as administrator option. -If you are not a member of the Administrators group on the computer, you cannot download help for these modules. -However, you can use the *Online* parameter to open the online version of help for a command, and you can read the help for Windows PowerShell in the TechNet library starting at Scripting with Windows PowerShellhttp://go.microsoft.com/fwlink/?LinkID=107116 (http://go.microsoft.com/fwlink/?LinkID=107116). +To download and install the help files for the commands that come with Windows PowerShell, and +for any modules in the $pshome\Modules directory, open Windows PowerShell by using the Run as +administrator option. +If you are not a member of the Administrators group on the computer, you cannot download help for +these modules. +However, you can use the *Online* parameter to open the online version of help for a command, and +you can read the help for Windows PowerShell in the TechNet library starting at Scripting with +Windows PowerShell[http://go.microsoft.com/fwlink/?LinkID=107116](http://go.microsoft.com/fwlink/?LinkID=107116). ### Example 6: Display detailed help -``` + +```powershell PS C:\> Get-Help ls -Detailed ``` This command displays detailed help for the Get-ChildItem cmdlet by specifying one of its aliases, ls. -The *Detailed* parameter of **Get-Help** gets the detailed view of the help topic, which includes parameter descriptions and examples. +The *Detailed* parameter of **Get-Help** gets the detailed view of the help topic, which includes +parameter descriptions and examples. To see the complete help topic for a cmdlet, use the *Full* parameter. -The *Full* and *Detailed* parameters are effective only when help files for the command are installed on the computer. +The *Full* and *Detailed* parameters are effective only when help files for the command are +installed on the computer. ### Example 7: Display full information for a cmdlet -``` + +```powershell PS C:\> Get-Help Format-Table -Full ``` -This command uses the *Full* parameter of **Get-Help** to display the full view help for the Format-Table cmdlet. -The full view of help includes parameter descriptions, examples, and a table of technical details about the parameters. +This command uses the *Full* parameter of **Get-Help** to display the full view help for the +Format-Table cmdlet. +The full view of help includes parameter descriptions, examples, and a table of technical details +about the parameters. The *Full* parameter is effective only when help files for the command are installed on the computer. ### Example 8: Display examples for a cmdlet -``` + +```powershell PS C:\> Get-Help Start-Service -Examples ``` This command displays examples of using the Start-Service cmdlet. -It uses the *Examples* parameter of **Get-Help** to display only the Examples section of the cmdlet help topics. +It uses the *Examples* parameter of **Get-Help** to display only the Examples section of the +cmdlet help topics. The *Examples* parameter is effective only when help files for the command are installed on the computer. ### Example 9: Display parameter help -``` + +```powershell PS C:\> Get-Help Format-List -Parameter GroupBy ``` -This command uses the *Parameter* parameter of **Get-Help** to display a detailed description of the *GroupBy* parameter of the Format-List cmdlet. -For detailed descriptions of all parameters of the **Format-List** cmdlet, type `Get-Help Format-List -Parameter *`. +This command uses the *Parameter* parameter of **Get-Help** to display a detailed description of +the *GroupBy* parameter of the Format-List cmdlet. +For detailed descriptions of all parameters of the **Format-List** cmdlet, +type `Get-Help Format-List -Parameter *`. ### Example 10: Search for a word in cmdlet help -``` + +```powershell PS C:\> Get-Help Add-Member -Full | Out-String -Stream | Select-String -Pattern Clixml ``` This example shows how to search for a word in particular cmdlet help topic. This command searches for the word Clixml in the full version of the help topic for the Add-Member cmdlet. -Because the **Get-Help** cmdlet generates a **MamlCommandHelpInfo** object, not a string, you have to use a cmdlet that transforms the help topic content into a string, such as Out-String or Out-File. +Because the **Get-Help** cmdlet generates a **MamlCommandHelpInfo** object, not a string, you +have to use a cmdlet that transforms the help topic content into a string, such as Out-String or Out-File. ### Example 11: Display online version of help -``` + +```powershell PS C:\> Get-Help Get-Member -Online ``` This command displays the online version of the help topic for the Get-Member cmdlet. ### Example 12: Display a list of topics that include a word -``` + +```powershell PS C:\> Get-Help remoting ``` This command displays a list of topics that include the word remoting. -When you enter a word that does not appear in any topic title, **Get-Help** displays a list of topics that include that word. +When you enter a word that does not appear in any topic title, **Get-Help** displays a list of +topics that include that word. ### Example 13: Display provider specific help -``` -The first command uses the *Path* parameter of **Get-Help** to specify the provider path. This command can be entered at any path location. + +The first command uses the *Path* parameter of **Get-Help** to specify the provider path. +This command can be entered at any path location. + +```powershell PS C:\> Get-Help Get-Item -Path SQLSERVER:\DataCollection +``` +```Output NAME - Get-Item - SYNOPSIS - Gets a collection of Server objects for the local computer and any computers - to which you have made a SQL Server PowerShell connection. - ... +``` -The second command uses the Set-Location cmdlet (alias = "cd") to navigate to the provider path. From that location, even without the *Path* parameter, the **Get-Help** command gets the provider-specific help for the **Get-Item** cmdlet. +The second command uses the Set-Location cmdlet (alias = "cd") to navigate to the provider path. +From that location, even without the *Path* parameter, the **Get-Help** command gets the +provider-specific help for the **Get-Item** cmdlet. + +```powershell PS C:\> cd SQLSERVER:\DataCollection SQLSERVER:\DataCollection> Get-Help Get-Item +``` +```Output NAME - Get-Item - SYNOPSIS - Gets a collection of Server objects for the local computer and any computers - to which you have made a SQL Server PowerShell connection. - ... +``` +The third command shows that a **Get-Help** command in a file system path, and without the +*Path* parameter, gets the standard help for the **Get-Item** cmdlet. -The third command shows that a **Get-Help** command in a file system path, and without the *Path* parameter, gets the standard help for the **Get-Item** cmdlet. +```powershell PS C:\> Get-Item +``` +```Output NAME - Get-Item - SYNOPSIS - Gets the item at the specified location. ... ``` -This example shows how to get help that explains how to use the Get-Item cmdlet in the **DataCollection** node of the Windows PowerShellSQL Server provider. +This example shows how to get help that explains how to use the Get-Item cmdlet in the +**DataCollection** node of the Windows PowerShellSQL Server provider. The example shows two ways of getting the provider-specific help for **Get-Item**. You can also get provider-specific help for cmdlets online in the section that describes the provider. -For example, for provider-specific online help for the **New-Item** cmdlet in each WSMan provider path, see New-Item for ClientCertificatehttp://go.microsoft.com/fwlink/?LinkID=158676 in the TechNet library. +For example, for provider-specific online help for the **New-Item** cmdlet in each WSMan provider +path, see New-Item for ClientCertificate +[http://go.microsoft.com/fwlink/?LinkID=158676](http://go.microsoft.com/fwlink/?LinkID=158676) +in the TechNet library. ### Example 14: Display help for a script -``` + +```powershell PS C:\> Get-Help C:\PS-Test\MyScript.ps1 ``` @@ -310,33 +388,34 @@ For information about how to write help for your functions and scripts, see abou ## PARAMETERS ### -Category + Displays help only for items in the specified category and their aliases. The acceptable values for this parameter are: -- Alias -- Cmdlet -- Provider -- General -- FAQ -- Glossary -- HelpFile -- ScriptCommand -- Function -- Filter -- ExternalScript -- All -- DefaultHelp -- Workflow -- DscResource -- Class -- Configuration +- Alias +- Cmdlet +- Provider +- General +- FAQ +- Glossary +- HelpFile +- ScriptCommand +- Function +- Filter +- ExternalScript +- All +- DefaultHelp +- Workflow +- DscResource +- Class +- Configuration Conceptual topics are in the HelpFile category. ```yaml Type: String[] Parameter Sets: (All) -Aliases: +Aliases: Accepted values: Alias, Cmdlet, Provider, General, FAQ, Glossary, HelpFile, ScriptCommand, Function, Filter, ExternalScript, All, DefaultHelp, Workflow, DscResource, Class, Configuration Required: False @@ -347,6 +426,7 @@ Accept wildcard characters: False ``` ### -Component + Displays commands with the specified component value, such as "Exchange." Enter a component name. Wildcard characters are permitted. @@ -355,7 +435,7 @@ This parameter has no effect on displays of conceptual ("About_") help. ```yaml Type: String[] Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -365,6 +445,7 @@ Accept wildcard characters: False ``` ### -Detailed + Adds parameter descriptions and examples to the basic help display. This parameter is effective only when help files are for the command are installed on the computer. @@ -373,7 +454,7 @@ It has no effect on displays of conceptual ("About_") help. ```yaml Type: SwitchParameter Parameter Sets: DetailedView -Aliases: +Aliases: Required: True Position: Named @@ -383,6 +464,7 @@ Accept wildcard characters: False ``` ### -Examples + Displays only the name, synopsis, and examples. To display only the examples, type `(Get-Help \).Examples`. @@ -392,7 +474,7 @@ It has no effect on displays of conceptual ("About_") help. ```yaml Type: SwitchParameter Parameter Sets: Examples -Aliases: +Aliases: Required: True Position: Named @@ -402,8 +484,10 @@ Accept wildcard characters: False ``` ### -Full + Displays the whole help topic for a cmdlet. -This includes parameter descriptions and attributes, examples, input and output object types, and additional notes. +This includes parameter descriptions and attributes, examples, input and output object types, +and additional notes. This parameter is effective only when help files are for the command are installed on the computer. It has no effect on displays of conceptual ("About_") help. @@ -411,7 +495,7 @@ It has no effect on displays of conceptual ("About_") help. ```yaml Type: SwitchParameter Parameter Sets: AllUsersView -Aliases: +Aliases: Required: False Position: Named @@ -421,6 +505,7 @@ Accept wildcard characters: False ``` ### -Functionality + Displays help for items with the specified functionality. Enter the functionality. Wildcard characters are permitted. @@ -430,7 +515,7 @@ This parameter has no effect on displays of conceptual ("About_") help. ```yaml Type: String[] Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -440,22 +525,29 @@ Accept wildcard characters: False ``` ### -Name + Gets help about the specified command or concept. -Enter the name of a cmdlet, function, provider, script, or workflow, such as `Get-Member`, a conceptual topic name, such as `about_Objects`, or an alias, such as `ls`. -Wildcard characters are permitted in cmdlet and provider names, but you cannot use wildcard characters to find the names of function help and script help topics. +Enter the name of a cmdlet, function, provider, script, or workflow, such as `Get-Member`, +a conceptual topic name, such as `about_Objects`, or an alias, such as `ls`. +Wildcard characters are permitted in cmdlet and provider names, but you cannot use wildcard +characters to find the names of function help and script help topics. -To get help for a script that is not located in a path that is listed in the Path environment variable, type the path and file name of the script. +To get help for a script that is not located in a path that is listed in the Path environment +variable, type the path and file name of the script. If you enter the exact name of a help topic, **Get-Help** displays 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 match any help topic titles, **Get-Help** displays a list of topics that include that word in their 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 match any help topic titles, **Get-Help** displays a list of +topics that include that word in their contents. -The names of conceptual topics, such as `about_Objects`, must be entered in English, even in non-English versions of Windows PowerShell. +The names of conceptual topics, such as `about_Objects`, must be entered in English, even in +non-English versions of Windows PowerShell. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: 0 @@ -465,16 +557,21 @@ Accept wildcard characters: False ``` ### -Online + Displays the online version of a help topic in the default Internet browser. This parameter is valid only for cmdlet, function, workflow and script help topics. You cannot use the *Online* parameter in **Get-Help** commands in a remote session. -For information about supporting this feature in help topics that you write, see about_Comment_Based_Help (http://go.microsoft.com/fwlink/?LinkID=144309), and Supporting Online Help (http://go.microsoft.com/fwlink/?LinkID=242132), and [How to Write Cmdlet Help](https://go.microsoft.com/fwlink/?LinkID=123415) in the MSDN library. +For information about supporting this feature in help topics that you write,see + +- [about_Comment_Based_Help](http://go.microsoft.com/fwlink/?LinkID=144309) +- [Supporting Online Help](http://go.microsoft.com/fwlink/?LinkID=242132) +- [How to Write Cmdlet Help](https://go.microsoft.com/fwlink/?LinkID=123415) ```yaml Type: SwitchParameter Parameter Sets: Online -Aliases: +Aliases: Required: True Position: Named @@ -484,6 +581,7 @@ Accept wildcard characters: False ``` ### -Parameter + Displays only the detailed descriptions of the specified parameters. Wildcards are permitted. @@ -492,7 +590,7 @@ This parameter has no effect on displays of conceptual ("About_") help. ```yaml Type: String Parameter Sets: Parameters -Aliases: +Aliases: Required: True Position: Named @@ -502,23 +600,29 @@ Accept wildcard characters: False ``` ### -Path + Gets help that explains how the cmdlet works in the specified provider path. Enter a Windows PowerShell provider path. -This parameter gets a customized version of a cmdlet help topic that explains how the cmdlet works in the specified Windows PowerShell provider path. -This parameter is effective only for help about a provider cmdlet and only when the provider includes a custom version of the provider cmdlet help topic in its help file. +This parameter gets a customized version of a cmdlet help topic that explains how the cmdlet +works in the specified Windows PowerShell provider path. +This parameter is effective only for help about a provider cmdlet and only when the provider +includes a custom version of the provider cmdlet help topic in its help file. To use this parameter, install the help file for the module that includes the provider. -To see the custom cmdlet help for a provider path, go to the provider path location and enter a **Get-Help** command or, from any path location, use the *Path* parameter of **Get-Help** to specify the provider path. +To see the custom cmdlet help for a provider path, go to the provider path location and enter a +**Get-Help** command or, from any path location, use the *Path* parameter of **Get-Help** to +specify the provider path. You can also find custom cmdlet help online in the provider help section of the help topics. -For example, you can find help for the **New-Item** cmdlet in the Wsman:\*\ClientCertificate path (http://go.microsoft.com/fwlink/?LinkID=158676). +For example, you can find help for the **New-Item** cmdlet in the Wsman:\*\ClientCertificate path +[http://go.microsoft.com/fwlink/?LinkID=158676](http://go.microsoft.com/fwlink/?LinkID=158676). For more information about Windows PowerShell providers, see [about_Providers](About/about_Providers.md). ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -528,6 +632,7 @@ Accept wildcard characters: False ``` ### -Role + Displays help customized for the specified user role. Enter a role. Wildcard characters are permitted. @@ -539,7 +644,7 @@ This parameter has no effect on help for the core cmdlets. ```yaml Type: String[] Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -549,11 +654,13 @@ Accept wildcard characters: False ``` ### -ShowWindow + Displays the help topic in a window for easier reading. The window includes a Find search feature and a Settings box that lets you set options for the display. These include options to display only selected sections of a help topic. -The *ShowWindow* parameter supports help topics for commands, which include cmdlets, functions, CIM commands, workflows, and scripts, and conceptual About topics. +The *ShowWindow* parameter supports help topics for commands, which include cmdlets, functions, +CIM commands, workflows, and scripts, and conceptual About topics. It does not support provider help. This parameter was introduced in Windows PowerShell 3.0. @@ -561,7 +668,7 @@ This parameter was introduced in Windows PowerShell 3.0. ```yaml Type: SwitchParameter Parameter Sets: ShowWindow -Aliases: +Aliases: Required: True Position: Named @@ -571,61 +678,74 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, +-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, +-WarningAction, and -WarningVariable. For more information, see + +- [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216) ## INPUTS ### None + You cannot pipe objects to this cmdlet. ## OUTPUTS ### ExtendedCmdletHelpInfo -If you run **Get-Help** on a command that does not have a help file, **Get-Help** returns an ExtendedCmdletHelpInfo object that represents autogenerated help. + +If you run **Get-Help** on a command that does not have a help file, **Get-Help** returns an +ExtendedCmdletHelpInfo object that represents autogenerated help. ### System.String + If you get a conceptual help topic, **Get-Help** returns it as a string. ### MamlCommandHelpInfo + If you get a command that has a help file, **Get-Help** returns a **MamlCommandHelpInfo** object. ## NOTES -* If you do not specify parameters, **Get-Help** displays information about the Windows PowerShell help system. -* Windows PowerShell 3.0 does not include help files. To download and install the help files that **Get-Help** reads, use the **Update-Help** cmdlet. You can use the **Update-Help** cmdlet to download and install help files for the core commands that come with Windows PowerShell and for any modules that you install. You can also use it to update the help files so that the help on your computer is never outdated. - - You can also read the help topics about the commands that come with Windows PowerShell online starting at Scripting with Windows PowerShellhttp://go.microsoft.com/fwlink/?LinkID=107116 (http://go.microsoft.com/fwlink/?LinkID=107116). - -* **Get-Help** displays help in the locale set for the Windows operating system or in the fallback language for that locale. If you do not have help files for the primary or fallback locale, **Get-Help** behaves as if there are no help files on the computer. To get help for a different locale, use Region and Language in Control Panel to change the settings. -* The full view of help includes a table of information about the parameters. The table includes the following fields: - - - Required. -Indicates whether the parameter is required (true) or optional (false). - - - Position. -Indicates whether the parameter is named or positional (numbered). -Positional parameters must appear in a specified place in the command. - - ---- "Named" indicates that the parameter name is required, but that the parameter can appear anywhere in the command. - ---- \ indicates that the parameter name is optional, but when the name is omitted, the parameter must be in the place specified by the number. -For example, "2" indicates that when the parameter name is omitted, the parameter must be the second (2) or only unnamed parameter in the command. -When the parameter name is used, the parameter can appear anywhere in the command. - - - Default value. -The parameter value that Windows PowerShell uses if you do not include the parameter in the command. - - - Accepts pipeline input. -Indicates whether you can (true) or cannot (false) send objects to the parameter through a pipeline. -"By Property Name" means that the pipelined object must have a property that has the same name as the parameter name. - - - Accepts wildcard characters. -Indicates whether the value of a parameter can include wildcard characters, such as * and ?. +- **Update-Help** cmdlet + - Windows PowerShell 3.0 does not include help files. + - To download and install the help files that **Get-Help** reads, use the **Update-Help** cmdlet. + - Download and install help files for any Windows PowerShell Cmdlets and for any third-party modules. + - You can also use it to update the help files so that the help on your computer is never outdated. + - Online help topics about Windows PowerShell Cmdlets can be found online + - Starting with [Scripting with Windows PowerShell](http://go.microsoft.com/fwlink/?LinkID=107116). + +- Localization Support + - **Get-Help** displays help in the locale set for the Windows operating system. + - Fallback language support is avialable. + - **Get-Help** behaves as if there are no help files on the computer if: + - You do not have help files for the primary locale or, + - You do not have help files for the fallback locale + - To get help for a different locale, use Region and Language in Control Panel to change the settings. + +- Parameter Notes: + - No Parameters used + - **Get-Help** displays information about the Windows PowerShell help system. + - Required: Indicates whether the parameter is required (true) or optional (false). + - Position: Indicates whether the parameter is named or positional (numbered). + - Positional parameters must appear in a specified place in the command. + - Named: Indicates that the parameter name is required but does not have a required position. + - Number: Indicates that the parameter name is optional, but the parameter must be in that positon. + - For example, "2" indicates that when the parameter name is omitted: + - The parameter must be the second (2) or + - Only unnamed parameter in the command. + - When the parameter name is used, the parameter can appear anywhere in the command. + - Default value: + - The parameter value that Windows PowerShell uses if you do not include the parameter in the command. + - Accepts pipeline input: Indicates whether objects can be sent throught the pipeleine: + - you can (true) or, + - cannot (false) + - By Property Name: Indicates that the pipelined object must have a property with the same name. + - Accepts wildcard characters: Indicates whether wildcard characters can be used. ## RELATED LINKS [Updatable Help Status Table (http://go.microsoft.com/fwlink/?LinkID=270007)](http://go.microsoft.com/fwlink/?LinkID=270007) - [about_Command_Syntax](About/about_Command_Syntax.md) - [Get-Command](Get-Command.md) - diff --git a/reference/6/Microsoft.PowerShell.Core/Get-Help.md b/reference/6/Microsoft.PowerShell.Core/Get-Help.md index f6ee740efbf4..6a22358c28b7 100644 --- a/reference/6/Microsoft.PowerShell.Core/Get-Help.md +++ b/reference/6/Microsoft.PowerShell.Core/Get-Help.md @@ -11,46 +11,56 @@ title: Get-Help # Get-Help ## SYNOPSIS + Displays information about Windows PowerShell commands and concepts. ## SYNTAX ### AllUsersView (Default) + ``` Get-Help [[-Name] ] [-Path ] [-Category ] [-Component ] [-Functionality ] [-Role ] [-Full] [] ``` ### DetailedView + ``` Get-Help [[-Name] ] [-Path ] [-Category ] [-Component ] [-Functionality ] [-Role ] [-Detailed] [] ``` ### Examples + ``` Get-Help [[-Name] ] [-Path ] [-Category ] [-Component ] [-Functionality ] [-Role ] [-Examples] [] ``` ### Parameters + ``` Get-Help [[-Name] ] [-Path ] [-Category ] [-Component ] [-Functionality ] [-Role ] -Parameter [] ``` ### Online + ``` Get-Help [[-Name] ] [-Path ] [-Category ] [-Component ] [-Functionality ] [-Role ] [-Online] [] ``` ## DESCRIPTION -The **Get-Help** cmdlet displays information about Windows PowerShell concepts and commands, including cmdlets, functions, CIM commands, workflows, providers, aliases and scripts. -To get help for a Windows PowerShell command, type `Get-Help` followed by the command name, such as: `Get-Help Get-Process`. +The **Get-Help** cmdlet displays information about Windows PowerShell concepts and commands, +including cmdlets, functions, CIM commands, workflows, providers, aliases and scripts. + +To get help for a Windows PowerShell command, type `Get-Help` followed by the command name, such as: +`Get-Help Get-Process`. To get a list of all help topics on your system, type `Get-Help *`. -You can display the whole help topic or use the parameters of the **Get-Help** cmdlet to get selected parts of the topic, such as the syntax, parameters, or examples. +You can display the whole help topic or use the parameters of the **Get-Help** cmdlet to get +selected parts of the topic, such as the syntax, parameters, or examples. Conceptual help topics in Windows PowerShell begin with "about_", such as "about_Comparison_Operators". To see all "about_" topics, type `Get-Help about_*`. @@ -59,51 +69,66 @@ To see a particular topic, type `Get-Help about_\`, such as `Get-He To get help for a Windows PowerShell provider, type `Get-Help` followed by the provider name. For example, to get help for the Certificate provider, type `Get-Help Certificate`. -In addition to `Get-Help`, you can also type `help` or `man`, which displays one screen of text at a time, or `\ -?`, which is identical to **Get-Help** but works only for commands. +In addition to `Get-Help`, you can also type `help` or `man`, which displays one screen of text +at a time, or `\ -?`, which is identical to **Get-Help** but works only for commands. **Get-Help** gets the help content that it displays from help files on your computer. Without the help files, **Get-Help** displays only basic information about commands. Some Windows PowerShell modules come with help files. -However, starting in Windows PowerShell 3.0, the modules that come with the Windows operating system do not include help files. +However, starting in Windows PowerShell 3.0, the modules that come with the Windows operating +system do not include help files. To download or update the help files for a module in Windows PowerShell 3.0, use the Update-Help cmdlet. You can also view the help topics for Windows PowerShell online in the TechNet Library. -To get the online version of a help topic, use the *Online* parameter, such as: `Get-Help Get-Process -Online`. -To read all of the help topics, see Scripting with Windows PowerShellhttp://go.microsoft.com/fwlink/?LinkID=107116 (http://go.microsoft.com/fwlink/?LinkID=107116) in the TechNet library. - -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** displays 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. +To get the online version of a help topic, use the *Online* parameter, such as: +`Get-Help Get-Process -Online`. +To read all of the help topics, see +[Scripting with Windows PowerShell](http://go.microsoft.com/fwlink/?LinkID=107116) + +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** displays 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. **Get-Help** can get help topics 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", and then in a fallback locale. -Beginning in Windows PowerShell 3.0, if **Get-Help** does not find help in the fallback locale, it looks for help topics in English, "en-US", before it returns an error message or displaying auto-generated help. +**Get-Help** first looks for help files in the locale set for Windows, then in the parent locale, +such as "pt" for "pt-BR", and then in a fallback locale. +Beginning in Windows PowerShell 3.0, if **Get-Help** does not find help in the fallback locale, +it looks for help topics in English, "en-US", before it returns an error message or displaying +auto-generated help. For information about the symbols that **Get-Help** displays in the command syntax diagram, see about_Command_Syntax. For information about parameter attributes, such as **Required** and **Position**, see about_Parameters. -**TROUBLESHOOTING NOTE**: In Windows PowerShell 3.0 and Windows PowerShell 4.0, **Get-Help** cannot find About topics in modules unless the module is imported into the current session. +**TROUBLESHOOTING NOTE**: In Windows PowerShell 3.0 and Windows PowerShell 4.0, **Get-Help** +cannot find About topics in modules unless the module is imported into the current session. This is a known issue. -To get About topics in a module, import the module, either by using the Import-Module cmdlet or by running a cmdlet in the module. +To get About topics in a module, import the module, either by using the Import-Module cmdlet or +by running a cmdlet in the module. ## EXAMPLES ### Example 1: Display help about the help system -``` + +```powershell PS C:\> Get-Help ``` This command displays help about the Windows PowerShell help system. ### Example 2: Display available help topics -``` + +```powershell PS C:\> Get-Help * ``` This command displays a list of the available help topics. ### Example 3: Display basic information about a cmdlet -``` + +```powershell PS C:\> Get-Help Get-Alias PS C:\> Help Get-Alias PS C:\> Get-Alias -? @@ -114,187 +139,244 @@ The **Get-Help** and *?* commands display the information on a single page. The Help command displays the information one page at a time. ### Example 4: Display a list of conceptual topics -``` + +```powershell PS C:\> Get-Help about_* ``` This command displays a list of the conceptual topics included in Windows PowerShell help. All of these topics begin with the characters about_. -To display a particular help file, type get-help \, for example, `Get-Help about_Signing`. +To display a particular help file, type Get-Help \, for example, `Get-Help about_Signing`. -This command displays the conceptual topics only when the help files for those topics are installed on the computer. +This command displays the conceptual topics only when the help files for those topics are +installed on the computer. For information about downloading and installing help files in Windows PowerShell 3.0, see Update-Help. ### Example 5: Download and install help files -``` -The first command uses the **Get-Help** cmdlet to get help for the Get-Command cmdlet. Without help files, **Get-Help** display the cmdlet name, syntax and alias of **Get-Command**, and prompts you to use the **Update-Help** cmdlet to get the newest help files. + +The first command uses the **Get-Help** cmdlet to get help for the Get-Command cmdlet. +Without help files, **Get-Help** display the cmdlet name, syntax and alias of **Get-Command**, +and prompts you to use the **Update-Help** cmdlet to get the newest help files. + +```powershell PS C:\> Get-Help Get-Command +``` + +```Output NAME Get-Command - SYNTAX - + Get-Command [[-Name] ] [-CommandType {Alias | Function | Filter | Cmdlet | ExternalScript | Application | Script | All}] [[-ArgumentList] ] [-Module ] [-Syntax] [-TotalCount ] [] - - Get-Command [-Noun ] [-Verb ] [[-ArgumentList] ] [-Module ] [-Syntax] + Get-Command [-Noun ] [-Verb ] [[-ArgumentList] ] [-Module ] [-Syntax] [-TotalCount ] [] - - ALIASES - gcm - + gcm REMARKS Get-Help cannot find the help files for this cmdlet on this computer. It is displaying only partial help. To download and install help files for this cmdlet, use **Update-Help**. +``` + +The second command runs the **Update-Help** cmdlet without parameters. +This command downloads help files from the Internet for all of the modules in the current session +and installs them on the local computer.This command works only when the local computer is +connected to the Internet. If your computer is not connected to the Internet, you might be able +to install help files from a network share. For more information, see Save-Help. -The second command runs the **Update-Help** cmdlet without parameters. This command downloads help files from the Internet for all of the modules in the current session and installs them on the local computer.This command works only when the local computer is connected to the Internet. If your computer is not connected to the Internet, you might be able to install help files from a network share. For more information, see Save-Help. +```powershell PS C:\> Update-Help +``` + +Now that the help files are downloaded, we can repeat the first command in the sequence. +This command gets help for the **Get-Command** cmdlet. +The cmdlet now gets more extensive help for **Get-Command** and you can use the +*Detailed*, *Full*, *Example*, and *Parameter* parameters of **Get-Help** to customize the displays. +You can use the **Get-Help** cmdlet as soon as the **Update-Help** command finishes. +You do not have to restart Windows PowerShell. -Now that the help files are downloaded, we can repeat the first command in the sequence. This command gets help for the **Get-Command** cmdlet. The cmdlet now gets more extensive help for **Get-Command** and you can use the *Detailed*, *Full*, *Example*, and *Parameter* parameters of **Get-Help** to customize the displays.You can use the **Get-Help** cmdlet as soon as the **Update-Help** command finishes. You do not have to restart Windows PowerShell. +```powershell PS C:\> Get-Help Get-Command ``` This example shows how to download and install new or updated help files for a module. It uses features that were introduced in Windows PowerShell 3.0. -The example compares the help that **Get-Help** displays for commands when you do not have help files installed on your computer and when you do have help files. -You can use the same command sequence to update the help files on your computer so that your local help content is never obsolete. +The example compares the help that **Get-Help** displays for commands when you do not have help +files installed on your computer and when you do have help files. +You can use the same command sequence to update the help files on your computer so that your +local help content is never obsolete. -To download and install the help files for the commands that come with Windows PowerShell, and for any modules in the $pshome\Modules directory, open Windows PowerShell by using the Run as administrator option. -If you are not a member of the Administrators group on the computer, you cannot download help for these modules. -However, you can use the *Online* parameter to open the online version of help for a command, and you can read the help for Windows PowerShell in the TechNet library starting at Scripting with Windows PowerShellhttp://go.microsoft.com/fwlink/?LinkID=107116 (http://go.microsoft.com/fwlink/?LinkID=107116). +To download and install the help files for the commands that come with Windows PowerShell, and +for any modules in the $pshome\Modules directory, open Windows PowerShell by using the Run as +administrator option. +If you are not a member of the Administrators group on the computer, you cannot download help for +these modules. +However, you can use the *Online* parameter to open the online version of help for a command, and +you can read the help for Windows PowerShell in the TechNet library starting at +[Scripting with Windows PowerShell](http://go.microsoft.com/fwlink/?LinkID=107116). ### Example 6: Display detailed help -``` + +```powershell PS C:\> Get-Help ls -Detailed ``` This command displays detailed help for the Get-ChildItem cmdlet by specifying one of its aliases, ls. -The *Detailed* parameter of **Get-Help** gets the detailed view of the help topic, which includes parameter descriptions and examples. +The *Detailed* parameter of **Get-Help** gets the detailed view of the help topic, +which includes parameter descriptions and examples. To see the complete help topic for a cmdlet, use the *Full* parameter. -The *Full* and *Detailed* parameters are effective only when help files for the command are installed on the computer. +The *Full* and *Detailed* parameters are effective only when help files for the command are +installed on the computer. ### Example 7: Display full information for a cmdlet -``` + +```powershell PS C:\> Get-Help Format-Table -Full ``` -This command uses the *Full* parameter of **Get-Help** to display the full view help for the Format-Table cmdlet. -The full view of help includes parameter descriptions, examples, and a table of technical details about the parameters. +This command uses the *Full* parameter of **Get-Help** to display the full view help for the +Format-Table cmdlet. +The full view of help includes parameter descriptions, examples, and a table of technical details +about the parameters. The *Full* parameter is effective only when help files for the command are installed on the computer. ### Example 8: Display examples for a cmdlet -``` + +```powershell PS C:\> Get-Help Start-Service -Examples ``` This command displays examples of using the Start-Service cmdlet. -It uses the *Examples* parameter of **Get-Help** to display only the Examples section of the cmdlet help topics. +It uses the *Examples* parameter of **Get-Help** to display only the Examples section of the +cmdlet help topics. The *Examples* parameter is effective only when help files for the command are installed on the computer. ### Example 9: Display parameter help -``` + +```powershell PS C:\> Get-Help Format-List -Parameter GroupBy ``` -This command uses the *Parameter* parameter of **Get-Help** to display a detailed description of the *GroupBy* parameter of the Format-List cmdlet. -For detailed descriptions of all parameters of the **Format-List** cmdlet, type `Get-Help Format-List -Parameter *`. +This command uses the *Parameter* parameter of **Get-Help** to display a detailed description of +the *GroupBy* parameter of the Format-List cmdlet. +For detailed descriptions of all parameters of the **Format-List** cmdlet, type +`Get-Help Format-List -Parameter *`. ### Example 10: Search for a word in cmdlet help -``` + +```powershell PS C:\> Get-Help Add-Member -Full | Out-String -Stream | Select-String -Pattern Clixml ``` This example shows how to search for a word in particular cmdlet help topic. This command searches for the word Clixml in the full version of the help topic for the Add-Member cmdlet. -Because the **Get-Help** cmdlet generates a **MamlCommandHelpInfo** object, not a string, you have to use a cmdlet that transforms the help topic content into a string, such as Out-String or Out-File. +Because the **Get-Help** cmdlet generates a **MamlCommandHelpInfo** object, not a string, +you have to use a cmdlet that transforms the help topic content into a string, +such as Out-String or Out-File. ### Example 11: Display online version of help -``` + +```powershell PS C:\> Get-Help Get-Member -Online ``` This command displays the online version of the help topic for the Get-Member cmdlet. ### Example 12: Display a list of topics that include a word -``` + +```powershell PS C:\> Get-Help remoting ``` This command displays a list of topics that include the word remoting. -When you enter a word that does not appear in any topic title, **Get-Help** displays a list of topics that include that word. +When you enter a word that does not appear in any topic title, **Get-Help** displays a list +of topics that include that word. ### Example 13: Display provider specific help -``` -The first command uses the *Path* parameter of **Get-Help** to specify the provider path. This command can be entered at any path location. + +The first command uses the *Path* parameter of **Get-Help** to specify the provider path. +This command can be entered at any path location. + +```powershell PS C:\> Get-Help Get-Item -Path SQLSERVER:\DataCollection +``` +```Output NAME Get-Item - SYNOPSIS Gets a collection of Server objects for the local computer and any computers - to which you have made a SQL Server PowerShell connection. - ... +``` + +The second command uses the Set-Location cmdlet (alias = "cd") to navigate to the provider path. +From that location, even without the *Path* parameter, the **Get-Help** command gets the +provider-specific help for the **Get-Item** cmdlet. -The second command uses the Set-Location cmdlet (alias = "cd") to navigate to the provider path. From that location, even without the *Path* parameter, the **Get-Help** command gets the provider-specific help for the **Get-Item** cmdlet. +```powershell PS C:\> cd SQLSERVER:\DataCollection SQLSERVER:\DataCollection> Get-Help Get-Item +``` +```Output NAME Get-Item - SYNOPSIS Gets a collection of Server objects for the local computer and any computers - to which you have made a SQL Server PowerShell connection. - ... +``` +The third command shows that a **Get-Help** command in a file system path, and without the +*Path* parameter, gets the standard help for the **Get-Item** cmdlet. -The third command shows that a **Get-Help** command in a file system path, and without the *Path* parameter, gets the standard help for the **Get-Item** cmdlet. +```powershell PS C:\> Get-Item +``` +```Output NAME Get-Item - SYNOPSIS Gets the item at the specified location. ... ``` -This example shows how to get help that explains how to use the Get-Item cmdlet in the **DataCollection** node of the Windows PowerShellSQL Server provider. +This example shows how to get help that explains how to use the Get-Item cmdlet in the +**DataCollection** node of the Windows PowerShellSQL Server provider. The example shows two ways of getting the provider-specific help for **Get-Item**. You can also get provider-specific help for cmdlets online in the section that describes the provider. -For example, for provider-specific online help for the **New-Item** cmdlet in each WSMan provider path, see New-Item for ClientCertificatehttp://go.microsoft.com/fwlink/?LinkID=158676 in the TechNet library. +For example, for provider-specific online help for the **New-Item** cmdlet in each WSMan provider +path, see +[New-Item for ClientCertificate](http://go.microsoft.com/fwlink/?LinkID=158676) in the TechNet library. ### Example 14: Display help for a script -``` + +```powershell PS C:\> Get-Help C:\PS-Test\MyScript.ps1 ``` @@ -304,33 +386,34 @@ For information about how to write help for your functions and scripts, see abou ## PARAMETERS ### -Category + Displays help only for items in the specified category and their aliases. The acceptable values for this parameter are: -- Alias -- Cmdlet -- Provider -- General -- FAQ -- Glossary -- HelpFile -- ScriptCommand -- Function -- Filter -- ExternalScript -- All -- DefaultHelp -- Workflow -- DscResource -- Class -- Configuration +- Alias +- Cmdlet +- Provider +- General +- FAQ +- Glossary +- HelpFile +- ScriptCommand +- Function +- Filter +- ExternalScript +- All +- DefaultHelp +- Workflow +- DscResource +- Class +- Configuration Conceptual topics are in the HelpFile category. ```yaml Type: String[] Parameter Sets: (All) -Aliases: +Aliases: Accepted values: Alias, Cmdlet, Provider, General, FAQ, Glossary, HelpFile, ScriptCommand, Function, Filter, ExternalScript, All, DefaultHelp, Workflow, DscResource, Class, Configuration Required: False @@ -341,6 +424,7 @@ Accept wildcard characters: False ``` ### -Component + Displays commands with the specified component value, such as "Exchange." Enter a component name. Wildcard characters are permitted. @@ -349,7 +433,7 @@ This parameter has no effect on displays of conceptual ("About_") help. ```yaml Type: String[] Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -359,6 +443,7 @@ Accept wildcard characters: False ``` ### -Detailed + Adds parameter descriptions and examples to the basic help display. This parameter is effective only when help files are for the command are installed on the computer. @@ -367,7 +452,7 @@ It has no effect on displays of conceptual ("About_") help. ```yaml Type: SwitchParameter Parameter Sets: DetailedView -Aliases: +Aliases: Required: True Position: Named @@ -377,6 +462,7 @@ Accept wildcard characters: False ``` ### -Examples + Displays only the name, synopsis, and examples. To display only the examples, type `(Get-Help \).Examples`. @@ -386,7 +472,7 @@ It has no effect on displays of conceptual ("About_") help. ```yaml Type: SwitchParameter Parameter Sets: Examples -Aliases: +Aliases: Required: True Position: Named @@ -396,8 +482,10 @@ Accept wildcard characters: False ``` ### -Full + Displays the whole help topic for a cmdlet. -This includes parameter descriptions and attributes, examples, input and output object types, and additional notes. +This includes parameter descriptions and attributes, examples, input and output object types, +and additional notes. This parameter is effective only when help files are for the command are installed on the computer. It has no effect on displays of conceptual ("About_") help. @@ -405,7 +493,7 @@ It has no effect on displays of conceptual ("About_") help. ```yaml Type: SwitchParameter Parameter Sets: AllUsersView -Aliases: +Aliases: Required: False Position: Named @@ -415,6 +503,7 @@ Accept wildcard characters: False ``` ### -Functionality + Displays help for items with the specified functionality. Enter the functionality. Wildcard characters are permitted. @@ -424,7 +513,7 @@ This parameter has no effect on displays of conceptual ("About_") help. ```yaml Type: String[] Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -434,22 +523,29 @@ Accept wildcard characters: False ``` ### -Name + Gets help about the specified command or concept. -Enter the name of a cmdlet, function, provider, script, or workflow, such as `Get-Member`, a conceptual topic name, such as `about_Objects`, or an alias, such as `ls`. -Wildcard characters are permitted in cmdlet and provider names, but you cannot use wildcard characters to find the names of function help and script help topics. +Enter the name of a cmdlet, function, provider, script, or workflow, such as `Get-Member`, +a conceptual topic name, such as `about_Objects`, or an alias, such as `ls`. +Wildcard characters are permitted in cmdlet and provider names, but you cannot use wildcard +characters to find the names of function help and script help topics. -To get help for a script that is not located in a path that is listed in the Path environment variable, type the path and file name of the script. +To get help for a script that is not located in a path that is listed in the Path environment +variable, type the path and file name of the script. If you enter the exact name of a help topic, **Get-Help** displays 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 match any help topic titles, **Get-Help** displays a list of topics that include that word in their 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 match any help topic titles, **Get-Help** displays a list of +topics that include that word in their contents. -The names of conceptual topics, such as `about_Objects`, must be entered in English, even in non-English versions of Windows PowerShell. +The names of conceptual topics, such as `about_Objects`, must be entered in English, even in +non-English versions of Windows PowerShell. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: 0 @@ -459,16 +555,21 @@ Accept wildcard characters: False ``` ### -Online + Displays the online version of a help topic in the default Internet browser. This parameter is valid only for cmdlet, function, workflow and script help topics. You cannot use the *Online* parameter in **Get-Help** commands in a remote session. -For information about supporting this feature in help topics that you write, see about_Comment_Based_Help (http://go.microsoft.com/fwlink/?LinkID=144309), and Supporting Online Help (http://go.microsoft.com/fwlink/?LinkID=242132), and [How to Write Cmdlet Help](https://go.microsoft.com/fwlink/?LinkID=123415) in the MSDN library. +For information about supporting this feature in help topics that you write, see: + +- [about_Comment_Based_Help](http://go.microsoft.com/fwlink/?LinkID=144309) +- [Supporting Online Help](http://go.microsoft.com/fwlink/?LinkID=242132) +- [How to Write Cmdlet Help](https://go.microsoft.com/fwlink/?LinkID=123415) ```yaml Type: SwitchParameter Parameter Sets: Online -Aliases: +Aliases: Required: True Position: Named @@ -478,6 +579,7 @@ Accept wildcard characters: False ``` ### -Parameter + Displays only the detailed descriptions of the specified parameters. Wildcards are permitted. @@ -486,7 +588,7 @@ This parameter has no effect on displays of conceptual ("About_") help. ```yaml Type: String Parameter Sets: Parameters -Aliases: +Aliases: Required: True Position: Named @@ -496,23 +598,28 @@ Accept wildcard characters: False ``` ### -Path + Gets help that explains how the cmdlet works in the specified provider path. Enter a Windows PowerShell provider path. -This parameter gets a customized version of a cmdlet help topic that explains how the cmdlet works in the specified Windows PowerShell provider path. -This parameter is effective only for help about a provider cmdlet and only when the provider includes a custom version of the provider cmdlet help topic in its help file. +This parameter gets a customized version of a cmdlet help topic that explains how the cmdlet +works in the specified Windows PowerShell provider path. +This parameter is effective only for help about a provider cmdlet and only when the provider +includes a custom version of the provider cmdlet help topic in its help file. To use this parameter, install the help file for the module that includes the provider. -To see the custom cmdlet help for a provider path, go to the provider path location and enter a **Get-Help** command or, from any path location, use the *Path* parameter of **Get-Help** to specify the provider path. +To see the custom cmdlet help for a provider path, go to the provider path location and enter a +**Get-Help** command or, from any path location, use the *Path* parameter of **Get-Help** to +specify the provider path. You can also find custom cmdlet help online in the provider help section of the help topics. -For example, you can find help for the **New-Item** cmdlet in the Wsman:\*\ClientCertificate path (http://go.microsoft.com/fwlink/?LinkID=158676). +For example, you can find help for the **New-Item** cmdlet in the Wsman:\*\ClientCertificate path[http://go.microsoft.com/fwlink/?LinkID=158676](http://go.microsoft.com/fwlink/?LinkID=158676) For more information about Windows PowerShell providers, see [about_Providers](About/about_Providers.md). ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -522,6 +629,7 @@ Accept wildcard characters: False ``` ### -Role + Displays help customized for the specified user role. Enter a role. Wildcard characters are permitted. @@ -533,7 +641,7 @@ This parameter has no effect on help for the core cmdlets. ```yaml Type: String[] Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -543,61 +651,73 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, +-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, +-WarningAction, and -WarningVariable. For more information, see +[about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216) ## INPUTS ### None + You cannot pipe objects to this cmdlet. ## OUTPUTS ### ExtendedCmdletHelpInfo -If you run **Get-Help** on a command that does not have a help file, **Get-Help** returns an ExtendedCmdletHelpInfo object that represents autogenerated help. + +If you run **Get-Help** on a command that does not have a help file, **Get-Help** returns +an ExtendedCmdletHelpInfo object that represents autogenerated help. ### System.String + If you get a conceptual help topic, **Get-Help** returns it as a string. ### MamlCommandHelpInfo + If you get a command that has a help file, **Get-Help** returns a **MamlCommandHelpInfo** object. ## NOTES -* If you do not specify parameters, **Get-Help** displays information about the Windows PowerShell help system. -* Windows PowerShell 3.0 does not include help files. To download and install the help files that **Get-Help** reads, use the **Update-Help** cmdlet. You can use the **Update-Help** cmdlet to download and install help files for the core commands that come with Windows PowerShell and for any modules that you install. You can also use it to update the help files so that the help on your computer is never outdated. - You can also read the help topics about the commands that come with Windows PowerShell online starting at Scripting with Windows PowerShellhttp://go.microsoft.com/fwlink/?LinkID=107116 (http://go.microsoft.com/fwlink/?LinkID=107116). - -* **Get-Help** displays help in the locale set for the Windows operating system or in the fallback language for that locale. If you do not have help files for the primary or fallback locale, **Get-Help** behaves as if there are no help files on the computer. To get help for a different locale, use Region and Language in Control Panel to change the settings. -* The full view of help includes a table of information about the parameters. The table includes the following fields: - - - Required. -Indicates whether the parameter is required (true) or optional (false). - - - Position. -Indicates whether the parameter is named or positional (numbered). -Positional parameters must appear in a specified place in the command. - - ---- "Named" indicates that the parameter name is required, but that the parameter can appear anywhere in the command. - - ---- \ indicates that the parameter name is optional, but when the name is omitted, the parameter must be in the place specified by the number. -For example, "2" indicates that when the parameter name is omitted, the parameter must be the second (2) or only unnamed parameter in the command. -When the parameter name is used, the parameter can appear anywhere in the command. - - - Default value. -The parameter value that Windows PowerShell uses if you do not include the parameter in the command. - - - Accepts pipeline input. -Indicates whether you can (true) or cannot (false) send objects to the parameter through a pipeline. -"By Property Name" means that the pipelined object must have a property that has the same name as the parameter name. - - - Accepts wildcard characters. -Indicates whether the value of a parameter can include wildcard characters, such as * and ?. +- **Update-Help** cmdlet + - Windows PowerShell 3.0 does not include help files. + - To download and install the help files that **Get-Help** reads, use the **Update-Help** cmdlet. + - Download and install help files for any Windows PowerShell Cmdlets and for any third-party modules. + - You can also use it to update the help files so that the help on your computer is never outdated. + - Online help topics about Windows PowerShell Cmdlets can be found online + - Starting with [Scripting with Windows PowerShell](http://go.microsoft.com/fwlink/?LinkID=107116). + +- Localization Support + - **Get-Help** displays help in the locale set for the Windows operating system. + - Fallback language support is avialable. + - **Get-Help** behaves as if there are no help files on the computer if: + - You do not have help files for the primary locale or, + - You do not have help files for the fallback locale + - To get help for a different locale, use Region and Language in Control Panel to change the settings. + +- Parameter Notes: + - No Parameters used + - **Get-Help** displays information about the Windows PowerShell help system. + - Required: Indicates whether the parameter is required (true) or optional (false). + - Position: Indicates whether the parameter is named or positional (numbered). + - Positional parameters must appear in a specified place in the command. + - Named: Indicates that the parameter name is required but does not have a required position. + - Number: Indicates that the parameter name is optional, but the parameter must be in that positon. + - For example, "2" indicates that when the parameter name is omitted: + - The parameter must be the second (2) or + - Only unnamed parameter in the command. + - When the parameter name is used, the parameter can appear anywhere in the command. + - Default value: + - The parameter value that Windows PowerShell uses if you do not include the parameter in the command. + - Accepts pipeline input: Indicates whether objects can be sent throught the pipeleine: + - you can (true) or, + - cannot (false) + - By Property Name: Indicates that the pipelined object must have a property with the same name. + - Accepts wildcard characters: Indicates whether wildcard characters can be used. ## RELATED LINKS [Updatable Help Status Table (http://go.microsoft.com/fwlink/?LinkID=270007)](http://go.microsoft.com/fwlink/?LinkID=270007) - [about_Command_Syntax](About/about_Command_Syntax.md) - [Get-Command](Get-Command.md) -