This is the built-in help made by Microsoft for the command 'help', in PowerShell version 2 - as retrieved from
Windows version 'Microsoft® Windows Vista™ Ultimate ' PowerShell help files on 2016-06-23.
For PowerShell version 3 and up, where you have Update-Help, this command was run just before creating the web pages from the help files.
Displays information about Windows PowerShell commands and concepts.
Get-Help [-Full] [[-Name] <string>] [-Category <string[]>] [-Component <string[]>] [-Functionality <string[]>] [-Online] [-Path <string>] [-Role
<string[]>] [<CommonParameters>]
Get-Help [-Detailed] [[-Name] <string>] [-Category <string[]>] [-Component <string[]>] [-Functionality <string[]>] [-Online] [-Path <string>] [-R
ole <string[]>] [<CommonParameters>]
Get-Help [-Examples] [[-Name] <string>] [-Category <string[]>] [-Component <string[]>] [-Functionality <string[]>] [-Online] [-Path <string>] [-R
ole <string[]>] [<CommonParameters>]
Get-Help [-Parameter <string>] [[-Name] <string>] [-Category <string[]>] [-Component <string[]>] [-Functionality <string[]>] [-Online] [-Path <st
ring>] [-Role <string[]>] [<CommonParameters>]
The Get-Help cmdlet displays information about Windows PowerShell concepts and commands, including cmdlets, providers, functions and scripts. To
get a list of all cmdlet help topic titles, type "get-help *".
If you type "Get-Help" followed by the exact name of a help topic, or by a word unique to a help topic, Get-Help 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.
In addition to "get-help", you can also type "help" or "man", which displays one screen of text at a time, or "<cmdlet-name> -?", which is identi
cal to Get-Help but works only for cmdlets.
You can display the entire help file or selected parts of the file, such as the syntax, parameters, or examples. You can also use the Online para
meter to display an online version of a help file in your Internet browser. These parameters have no effect on conceptual help topics.
Conceptual help topics in Windows PowerShell begin with "about_", such as "about_Comparison_Operators". To see all "about_" topics, type "get-hel
p about_*". To see a particular topic, type "get-help about_<topic-name>", such as "get-help about_Comparison_Operators".
<
Online version: http://go.microsoft.com/fwlink/?LinkID=113316
about_Comment_Based_Help
Get-Command
Get-PSDrive
Get-Member
<
-------------------------- EXAMPLE 1 --------------------------
C:\PS>get-help
Description
-----------
This command displays help about the Windows PowerShell help system.
-------------------------- EXAMPLE 2 --------------------------
C:\PS>get-help *
Description
-----------
This command displays a list of all help files in the Windows PowerShell help system.
-------------------------- EXAMPLE 3 --------------------------
C:\PS>get-help get-alias
C:\PS>help get-alias
C:\PS>get-alias -?
Description
-----------
These commands display basic information about the get-alias cmdlet. The "Get-Help" and "-?" commands display the information on a single page. T
he "Help" command displays the information one page at a time.
-------------------------- EXAMPLE 4 --------------------------
C:\PS>get-help about_*
Description
-----------
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 <topic-name>, for example, "get-help about_signing".
-------------------------- EXAMPLE 5 --------------------------
C:\PS>get-help ls -detailed
Description
-----------
This command displays detailed help for the Get-ChildItem cmdlet by specifying one of its aliases, "ls." The Detailed parameter requests the deta
iled view of the help file, which includes parameter descriptions and examples. To see the complete help file for a cmdlet, use the Full paramete
r.
-------------------------- EXAMPLE 6 --------------------------
C:\PS>get-help format-string -full
Description
-----------
This command displays the full view help for the Format-String cmdlet. The full view of help includes parameter descriptions, examples, and a tab
le of technical details about the parameters.
-------------------------- EXAMPLE 7 --------------------------
C:\PS>get-help start-service -examples
Description
-----------
This command displays examples of using start-service in Windows PowerShell commands.
-------------------------- EXAMPLE 8 --------------------------
C:\PS>get-help get-childitem -parameter f*
Description
-----------
This command displays descriptions of the parameters of the Get-ChildItem cmdlet that begin with "f" (filter and force). For descriptions of all
parameters, type "get-help get-childitem parameter*".
-------------------------- EXAMPLE 9 --------------------------
C:\PS>(get-help write-output).syntax
Description
-----------
This command displays only the syntax of the Write-Output cmdlet.
Syntax is one of many properties of help objects; others are description, details, examples, and parameters. To find all properties and methods o
f help objects, type "get-help <cmdlet-name> | get-member"; for example, "get-help start-service | get member".
-------------------------- EXAMPLE 10 --------------------------
C:\PS>(get-help trace-command).alertset
Description
-----------
This command displays the notes about the cmdlet. The notes are stored in the alertSet property of the help object.
The notes include conceptual information and tips for using the cmdlet. By default, the notes are displayed only when you use the Full parameter
of Get-Help, but you can also display them by using the alertSet property.
-------------------------- EXAMPLE 11 --------------------------
C:\PS>get-help add-member -full | out-string -stream | select-string -pattern clixml
Description
-----------
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 t
he help topic for the Add-Member cmdlet.
Because the Get-Help cmdlet generates a MamlCommandHelpInfo object, not a string, you need to use a command that transforms the help topic conten
t into a string, such as Out-String or Out-File.
-------------------------- EXAMPLE 12 --------------------------
C:\PS>get-help get-member -online
Description
-----------
This command displays the online version of the help topic for the Get-Member cmdlet.
-------------------------- EXAMPLE 13 --------------------------
C:\PS>get-help remoting
Description
-----------
This command displays a list of topics that include the word "remoting" in their contents.
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 14 --------------------------
C:\PS>get-help get-item -path SQLSERVER:\DataCollection
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.
...
C:\PS> cd SQLSERVER:\DataCollection
C:\PS> SQLSERVER:\DataCollection> get-help get-item
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.
...
C:\PS> Get-Item
NAME
Get-Item
SYNOPSIS
Gets the item at the specified location.
...
Description
-----------
This example shows how to get help for the Get-Item cmdlet that explains how to use the cmdlet in the DataCollection node of the Windows PowerShe
ll SQL Server provider.
The example shows two ways of getting the custom help for Get-Item.
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 second command uses the Set-Location cmdlet (alias = "cd") to go to the provider path. From that location, even without the Path parameter, t
he Get-Help command gets the custom help for the provider path.
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 cm
dlet.
-------------------------- EXAMPLE 15 --------------------------
C:\PS>get-help c:\ps-test\MyScript.ps1
Description
-----------
This command gets help for the MyScript.ps1 script. For information about writing help for your functions and scripts, see about_Comment_Based_He
lp.