顯示 Windows PowerShell 命令和概念的相關資訊。

語法

Get-Help [-Full] [[-Name] <string>] [-Category <string[]>] [-Component <string[]>] [-Functionality <string[]>] [-Online] [-路徑 <string>] [-Role <string[]>] [<CommonParameters>]

Get-Help [-Detailed] [[-Name] <string>] [-Category <string[]>] [-Component <string[]>] [-Functionality <string[]>] [-Online] [-路徑 <string>] [-Role <string[]>] [<CommonParameters>]

Get-Help [-Examples] [[-Name] <string>] [-Category <string[]>] [-Component <string[]>] [-Functionality <string[]>] [-Online] [-路徑 <string>] [-Role <string[]>] [<CommonParameters>]

Get-Help [-Parameter <string>] [[-Name] <string>] [-Category <string[]>] [-Component <string[]>] [-Functionality <string[]>] [-Online] [-路徑 <string>] [-Role <string[]>] [<CommonParameters>]

描述

Get-Help Cmdlet 會顯示 Windows PowerShell 概念和命令的相關資訊,包括 Cmdlet、提供者、函數和指令碼。若要取得所有 Cmdlet 說明主題標題的清單,請輸入 "get-help *"。

如果您輸入 "Get-Help" 後面接著說明主題的確切名稱或特有文字,Get-Help 就會顯示該主題的內容。如果您輸入出現於數個說明主題的某一文字或文字模式,則 Get-Help 會列出所有符合的標題。如果您輸入的文字未出現在任一說明主題標題中,則 Get-Help 會列出其中內容包含該特定文字的主題。

除了 "get-help" 以外,您也可以輸入 "help" 或 "man" (一次顯示一頁文字),或輸入 "<Cmdlet 名稱> -?" (其作用與 Get-Help 相同,不過僅適用於 Cmdlet)。

您可以顯示整個說明檔案或選定的檔案部分,例如語法、參數或範例。您也可以使用 Online 參數,在網際網路瀏覽器中顯示說明檔案的線上版本。這些參數對於概念性說明主題沒有作用。

Windows PowerShell 中的概念性說明主題會以 "about_" 為開頭,例如 "about_Comparison_Operators"。若要檢視所有 "about_" 主題,請輸入 "get-help about_*"。若要查看特定主題,請輸入 "get-help about_<topic-name>",例如 "get-help about_Comparison_Operators"。

參數

-Category <string[]>

顯示指定類別中的項目相關說明。有效值為 Alias、Cmdlet、Provider 和 HelpFile。概念性主題屬於 HelpFile 類別。

Category 是 Get-Help 傳回之 MamlCommandHelpInfo 物件的屬性。此參數不會影響概念性 ("about_") 說明所顯示的內容。

必要?

false

位置?

named

預設值

接受管線輸入?

false

接受萬用字元?

false

-Component <string[]>

顯示具有指定之元件值 (如 "Exchange") 的工具清單。請輸入元件名稱。允許使用萬用字元。

Component 是 Get-Help 傳回之 MamlCommandHelpInfo 物件的屬性。此參數不會影響概念 ("About_") 說明所顯示的內容。

必要?

false

位置?

named

預設值

接受管線輸入?

false

接受萬用字元?

false

-Detailed

將參數描述和範例新增至基本說明顯示。

此參數不會影響概念 ("About_") 說明所顯示的內容。

必要?

false

位置?

named

預設值

接受管線輸入?

false

接受萬用字元?

false

-Examples

只顯示名稱、概要和範例。若只要顯示範例,請輸入 "(get-help <Cmdlet 名稱>).examples"。

此參數不會影響概念 ("About_") 說明所顯示的內容。

必要?

false

位置?

named

預設值

接受管線輸入?

false

接受萬用字元?

false

-Full

顯示 Cmdlet 的整個說明檔案,包含參數說明和屬性、範例、輸入和輸出物件類型,以及其他附註。

此參數不會影響概念 ("About_") 說明所顯示的內容。

必要?

false

位置?

named

預設值

接受管線輸入?

false

接受萬用字元?

false

-Functionality <string[]>

顯示具有指定之功能的項目說明。請輸入功能。允許使用萬用字元。

Functionality 是 Get-Help 傳回之 MamlCommandHelpInfo 物件的屬性。此參數不會影響概念 ("About_") 說明所顯示的內容。

必要?

false

位置?

named

預設值

接受管線輸入?

false

接受萬用字元?

false

-Name <string>

要求指定之工具或概念性主題的相關說明。請輸入 Cmdlet、提供者、指令碼或函數名稱,例如 Get-Member、概念性主題名稱 (如 "about_Objects") 或別名 (如 "ls")。雖然您可以在 Cmdlet 和提供者名稱中使用萬用字元,但是無法使用萬用字元來尋找函數說明及指令碼說明主題的名稱。

若要為不在 Path 環境變數所列之路徑的指令碼取得說明,請輸入該指令碼的路徑和檔案名稱。

如果您輸入說明主題的確切名稱,則 Get-Help 會顯示該主題的內容。如果您輸入出現於數個說明主題的某一文字或文字模式,則 Get-Help 會列出所有符合的標題。如果您輸入不符合任一說明主題標題的文字,則 Get-Help 會列出其中內容包含該特定文字的主題。

概念性主題 (例如 about_Objects) 的名稱必須以英文輸入,甚至是非英文版的 Windows PowerShell 也一樣。

必要?

false

位置?

1

預設值

接受管線輸入?

true (ByPropertyName)

接受萬用字元?

false

-Online

以預設的網際網路瀏覽器顯示說明主題的線上版本。此參數只適用於 Cmdlet、函數和指令碼說明主題。

Get-Help 會使用出現在 Cmdlet、函數或指令碼說明主題的<相關連結>一節之第一個項目中的網際網路位址 (統一資源識別項 [URI])。此參數只有當說明主題包含開頭為 "Http" 或 "Https" 的 URI,而且系統上已安裝網際網路瀏覽器時才有效。

如需在您所撰寫之說明主題中支援此功能的詳細資訊,請參閱 about_Comment_Based_Help,並參閱 MSDN (Microsoft Developer Network) Library 中的<如何撰寫 Cmdlet 說明>(英文),網址為 https://go.microsoft.com/fwlink/?LinkID=123415。

必要?

false

位置?

named

預設值

接受管線輸入?

false

接受萬用字元?

false

-Parameter <string>

只顯示指定之參數的詳細描述。允許使用萬用字元。

此參數不會影響概念 ("About_") 說明所顯示的內容。

必要?

false

位置?

named

預設值

接受管線輸入?

false

接受萬用字元?

false

-路徑 <string>

取得說明 Cmdlet 如何在指定之提供者路徑中運作的說明。請輸入 Windows PowerShell 提供者路徑。

此參數會取得 Cmdlet 說明主題的自訂版本,說明 Cmdlet 在指定之 Windows PowerShell 提供者路徑中的運作方式。此參數只對提供者 Cmdlet 的說明有效,並且只有當提供者包含提供者 Cmdlet 說明主題的自訂版本時才會生效。

若要查看某個提供者路徑的自訂 Cmdlet 說明,請移至該提供者路徑後再輸入 Get-Help 命令,或是從任一路徑位置使用 Get-Help 的 Path 參數指定提供者路徑。如需詳細資訊,請參閱 about_Providers。

必要?

false

位置?

named

預設值

接受管線輸入?

false

接受萬用字元?

false

-Role <string[]>

顯示指定的使用者角色的自訂化說明。請輸入角色。允許使用萬用字元。

請輸入使用者在組織中扮演的角色。某些 cmdlet 會依據此參數的值,在其說明檔中顯示不同的文字。核心 cmdlet 的說明內容不會受到此參數所影響。

必要?

false

位置?

named

預設值

接受管線輸入?

false

接受萬用字元?

false

<CommonParameters>

這個 Cmdlet 支援一般參數:-Verbose、-Debug、-ErrorAction、-ErrorVariable、-OutBuffer 和 -OutVariable。如需詳細資訊,請參閱 about_Commonparameters.

輸入和輸出

輸入型別是可經由管道輸出至 Cmdlet 的物件型別。傳回型別則是 Cmdlet 所傳回的物件型別。

輸入

您無法經由管道將物件輸出至這個 Cmdlet。

輸出

System.String 或 MamlCommandHelpInfo

如果您要求概念性主題,Get-Help 會以字串形式傳回此主題。如果您指定 Cmdlet、函數或指令碼的名稱,它會傳回 MamlCommandHelpInfo 物件。否則,Get-Help 就會傳回 $pshome 目錄中 Help.Format.ps1xml 檔案所指定的其中一個格式化檢視。

附註

如果沒有使用參數,"Get-Help" 就會顯示 Windows PowerShell 說明系統的相關資訊。

說明的完整檢視 (-full) 包括了內含參數相關資訊的資料表。這張資料表包含下列欄位:

-- Required:必要,指出此為必要 (true) 或選擇性 (false) 參數。

-- Position:位置,指出此為具名或位置 (有編號的) 參數。位置參數必須出現在命令中的指定位置。

-- "Named" 指出參數名稱屬於必要,但是參數可以出現在命令中的任何位置。

-- <Number> 指出參數名稱屬於選擇性,但是當省略此名稱時,參數就必須放在編號所指定的位置。例如,"2" 指出在省略參數名稱時,參數必須是命令中的第二個 (2) 參數或僅當作未命名的參數。如果有使用參數名稱,參數就可以出現在命令中的任何位置。

-- Default value:預設值,指 Windows PowerShell 在您未於命令中包括參數時所使用的參數值。

-- Accepts pipeline input:接受管線輸入,指出您可以 (true) 或不可以 (false) 透過管線將物件傳送到參數。"By Property Name" 表示此管線物件必須具有與該參數名稱相同名稱的屬性。

-- Accepts wildcard characters:接受萬用字元,指出參數的值是否可以包含萬用字元,例如,* 和 ?。

範例 1

C:\PS>get-help

描述
-----------
這個命令會顯示 Windows PowerShell 說明系統的相關說明。






範例 2

C:\PS>get-help *

描述
-----------
這個命令會顯示在 Windows PowerShell 說明系統中之所有說明檔案的清單。






範例 3

C:\PS>get-help get-alias

C:\PS>help get-alias

C:\PS>get-alias -?

描述
-----------
這些命令會顯示 get-alias Cmdlet 的基本資訊。"Get-Help" 和 "-?" 命令會將資訊顯示在單一頁面中。"Help" 命令會一次顯示一頁資訊。






範例 4

C:\PS>get-help about_*

描述
-----------
這個命令會顯示包括在 Windows PowerShell 說明中之概念主題的清單。這些主題的開頭都會是 "about_" 字元。若要顯示特定的說明檔案,請輸入 "get-help <主題名稱>",例如 "get-help about_signing"。






範例 5

C:\PS>get-help ls -detailed

描述
-----------
這個命令會指定 Get-ChildItem Cmdlet 的其中一個別名 ("ls"),藉以顯示其詳細說明。Detailed 參數會要求此說明檔案的詳細檢視,其中會包含參數描述和範例。若要查看 Cmdlet 的完整說明檔案,請使用 Full 參數。






範例 6

C:\PS>get-help format-string -full

描述
-----------
這個命令會顯示 Format-String cmdlet 說明的完整檢視。說明的完整檢視包括了參數描述、範例,以及內含這些參數之相關技術性詳細資料的表格。






範例 7

C:\PS>get-help start-service -examples

描述
-----------
這個命令會顯示在 Windows PowerShell 命令中使用 start-service 的範例。






範例 8

C:\PS>get-help get-childitem -parameter f*

描述
-----------
這個命令會顯示開頭為 "f" 之 Get-ChildItem Cmdlet 參數 (filter 和 force) 的描述。如需所有參數的描述,請輸入 "get-help get-childitem parameter*"。






範例 9

C:\PS>(get-help write-output).syntax

描述
-----------
這個命令只會顯示 Write-Output Cmdlet 的語法。

語法是說明物件的多種屬性其中之一;其他屬性還包括描述、詳細資料、範例和參數。若要找出說明物件的所有屬性和方法,請輸入 "get-help <Cmdlet 名稱> | get-member",例如 "get-help start-service | get member"。






範例 10

C:\PS>(get-help trace-command).alertset

描述
-----------
這個命令只會顯示 Cmdlet 的附註。這些附註是儲存在說明物件的 alertSet 屬性中。

附註包含概念資訊和 Cmdlet 的使用提示。根據預設,只有在使用 Get-Help 的 Full 參數時才會顯示附註,但是也可以透過使用 alertSet 屬性顯示附註。






範例 11

C:\PS>get-help add-member -full | out-string -stream | select-string -pattern clixml

描述
-----------
在這個範例中,會示範如何搜尋特定 Cmdlet 說明主題中的文字。這個命令會在 Add-Member Cmdlet 的完整說明主題版本中搜尋 "clixml" 一字。

因為 Get-Help Cmdlet 會產生 MamlCommandHelpInfo 物件而不是字串,所以您需要使用可將說明主題內容轉換為字串的命令,例如 Out-String 或 Out-File。






範例 12

C:\PS>get-help get-member -online

描述
-----------
這個命令會顯示 Get-Member Cmdlet 說明主題的線上版本。






範例 13

C:\PS>get-help remoting

描述
-----------
這個命令會顯示其內容包含 "remoting" 一字的主題清單。

如果您輸入的文字未出現在任一說明主題標題中,則 Get-Help 會列出包含該特定文字的主題。






範例 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.

...

描述
-----------
在這個範例中,會示範如何取得 Get-Item Cmdlet 的說明,以描述如何在 Windows PowerShell SQL Server 提供者的 DataCollection 節點中使用 Cmdlet。

此範例示範兩種取得 Get-Item 自訂說明的方式。

第一個命令會使用 Get-Help 的 Path 參數指定提供者路徑。這個命令可於任何路徑位置輸入。

第二個命令會使用 Set-Location Cmdlet (別名為 "cd") 移至提供者路徑。即使不指定 Path 參數,Get-Help 命令從該位置也能取得提供者路徑的自訂說明。

第三個命令示範檔案系統路徑中的 Get-Help 命令 (不指定 Path 路徑) 取得 Get-Item Cmdlet 的標準說明。






範例 15

C:\PS>get-help c:\ps-test\MyScript.ps1

描述
-----------
這個命令會取得 MyScript.ps1 指令碼的說明。如需針對函數和指令碼撰寫說明的詳細資訊,請參閱 about_Comment_Based_Help。






請參閱




目錄