Get-Help

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>] [-Role <string[]>] [<CommonParameters>]

Get-Help [-例] [[-Name] <string>] [-Category <string[]>] [-Component <string[]>] [-Functionality <string[]>] [-Online] [-Path <string>] [-Role <string[]>] [<CommonParameters>]

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

C:\PS>get-help

説明
-----------
このコマンドは、Windows PowerShell ヘルプ システムのヘルプを表示します。

C:\PS>get-help *

説明
-----------
このコマンドは、Windows PowerShell ヘルプ システムのすべてのヘルプ ファイルの一覧を表示します。

C:\PS>get-help get-alias

C:\PS>help get-alias

C:\PS>get-alias -?

説明
-----------
これらのコマンドは get-alias コマンドレットについての基本的な情報を表示します。"Get-Help" と "-?" コマンドは情報を 1 ページで表示します。"Help" コマンドは、情報を一度に 1 ページずつ表示します。

C:\PS>get-help about_*

説明
-----------
このコマンドは、Windows PowerShell ヘルプの概念的なトピックの一覧を表示します。これらすべてのトピックは "about_" で始まります。特定のヘルプ ファイルを表示するには、「get-help <topic-name>」と入力します (たとえば "get-help about_signing")。

C:\PS>get-help ls -detailed

説明
-----------
このコマンドは、Get-ChildItem コマンドレットのエイリアスの 1 つである "ls" を指定して Get-Childitem の詳細なヘルプを表示します。Detailed パラメーターを指定することにより、パラメーターの説明や例を含むヘルプ ファイルの詳細ビューが要求されます。コマンドレットの完全なヘルプ ファイルを参照するには、Full パラメーターを使用します。

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

説明
-----------
このコマンドは、Format-String コマンドレットのヘルプの完全ビューを表示します。ヘルプの完全ビューには、パラメーターの説明、例、およびパラメーターの技術的な詳細を示した表があります。

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

説明
-----------
このコマンドは、Windows PowerShell コマンドで start-service を使用する例を表示します。

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

説明
-----------
このコマンドは、"f" で始まる Get-ChildItem コマンドレットのパラメーター (filter と force) の説明を表示します。すべてのパラメーターの説明を表示するには、「get-help get-childitem parameter*」と入力します。

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

説明
-----------
このコマンドは、Write-Output コマンドレットの構文のみを表示します。

Syntax は、help オブジェクトのプロパティの 1 つにすぎません。この他に、description、details、examples、および parameters があります。ヘルプ オブジェクトのすべてのプロパティとメソッドを見つけるには、「get-help <cmdlet-name> | get-member」と入力します (たとえば「get-help start-service | get member」)。

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

説明
-----------
このコマンドを実行すると、コマンドレットに関する注が表示されます。注は、ヘルプ オブジェクトの alertSet プロパティに保存されます。

注には、概念説明の情報およびコマンドレットの使い方のヒントが含まれます。既定では、注は Get-Help の Full パラメーターを使用したときにのみ表示されますが、alertSet プロパティを使用して表示することもできます。

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

説明
-----------
この例は、特定のコマンドレットのヘルプ トピック内の語を検索する方法を示しています。このコマンドは、Add-Member コマンドレットの完全版ヘルプ トピックで "clixml" という語を検索します。

Get-Help コマンドレットは文字列ではなく MamlCommandHelpInfo オブジェクトを生成するので、Out-String や Out-File など、ヘルプ トピックの内容を文字列に変換するコマンドを使用する必要があります。

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

説明
-----------
このコマンドは、Get-Member コマンドレット ヘルプ トピックのオンライン バージョンを表示します。

C:\PS>get-help remoting

説明
-----------
このコマンドは、内容に "remoting" という語が含まれるトピックを一覧表示します。

いずれのトピック タイトルにも使用されていない単語を入力した場合、Get-Help によって、その単語が含まれるトピックの一覧が表示されます。

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.

...

説明
-----------
この例は、Windows PowerShell SQL Server プロバイダーの DataCollection ノードのコマンドレットの使用方法を説明する Get-Item コマンドレットのヘルプの取得方法を示しています。

この例は、Get-Item のカスタム ヘルプを取得する 2 つの方法を示しています。

最初のコマンドは、Get-Help の Path パラメーターを使用して、プロバイダー パスを指定します。このコマンドは任意のパスの場所で入力できます。

2 番目のコマンドは Set-Location コマンドレット (エイリアス = "cd") を使用して、プロバイダー パスに移動します。その場所から、Path パラメーターがなくても、Get-Help コマンドはプロバイダー パスのカスタム ヘルプを取得します。

3 番目のコマンドは、ファイル システム パスの Get-Help コマンドが Path パラメーターなしでも Get-Item コマンドレットの標準のヘルプを取得することを示しています。

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

説明
-----------
このコマンドは MyScript.ps1 スクリプトのヘルプを取得します。関数およびスクリプトに関するヘルプ トピックを記述する方法については、「about_Comment_Based_Help」を参照してください。