詳細なヘルプ情報の取得

Windows PowerShell のコマンドレットに関するヘルプを表示するには、Get-Help コマンドレットを使用します。たとえば、Get-ChildItem コマンドレットのヘルプを表示するには、次のように入力します。

get-help get-childitem

または

get-childitem -?

Get-Help コマンドレットに関するヘルプも表示できます。次にその例を示します。

get-help get-help

セッションでコマンドレットに関するすべてのヘルプ トピックの一覧を表示するには、次のように入力します。

get-help -category cmdlet

各ヘルプ トピックを 1 ページずつ表示するには、help 関数、またはそのエイリアスである man を使用します。たとえば、Get-ChildItem コマンドレットのヘルプを表示するには、次のように入力します。

man get-childitem

または

help get-childitem

パラメーターの説明や使用例など、コマンドレット、関数、またはスクリプトに関する詳細情報を表示するには、Get-Help コマンドレットの Detailed パラメーターを使用します。たとえば、Get-ChildItem コマンドレットに関する詳細情報を表示するには、次のように入力します。

get-help get-childitem -detailed

ヘルプ トピックのすべての内容を表示するには、Get-Help コマンドレットの Full パラメーターを使用します。たとえば、Get-ChildItem コマンドレットのヘルプ トピックの内容をすべて表示するには、次のように入力します。

get-help get-childitem -full

コマンドレットのパラメーターに関する詳細なヘルプを表示するには、Get-Help コマンドレットの Parameter パラメーターを使用します。たとえば、Get-ChildItem コマンドレットのすべてのパラメーターの詳細なヘルプを表示するには、次のように入力します。

get-help get-childitem -parameter *

ヘルプ トピック内の例だけを表示するには、Get-Help コマンドレットの Example パラメーターを使用します。たとえば、Get-ChildItem コマンドレットのヘルプ トピック内のサンプルのみを表示するには、次のように入力します。

get-help get-childitem -examples

作成したコマンドレットに関するヘルプ トピックを記述する方法については、MSDN の「How to Write Cmdlet Help (コマンドレット ヘルプの記述方法)」を参照してください。

Get-Help コマンドレットでは、Windows PowerShell 言語に関するトピックなど、Windows PowerShell の概念説明トピックの情報も表示されます。概念説明のヘルプ トピックには、"about_" というプレフィックスが付きます (about_line_editing など)。概念説明のトピックの名前は、英語バージョン以外の Windows PowerShell でも英語で入力する必要があります。

概念説明のトピックを一覧表示するには、次のように入力します。

get-help about_*

特定のヘルプ トピックを表示するには、次のように、トピック名を入力します。

get-help about_command_syntax

Get-Help の Detailed、Parameter、Examples などのパラメーターは、概念説明ヘルプ トピックの表示には効果がありません。

Get-Help コマンドレットでは、Windows PowerShell プロバイダーに関する情報を表示できます。プロバイダーのヘルプを取得するには、"Get-Help" に続けてプロバイダー名を入力します。たとえば、Registry プロバイダーのヘルプを取得するには、次のように入力します。

get-help registry

セッションでプロバイダーに関するすべてのヘルプ トピックの一覧を表示するには、次のように入力します。

get-help -category provider

Get-Help の Detailed、Parameter、Examples などのパラメーターは、プロバイダーに関するヘルプ トピックの表示には効果がありません。

Windows PowerShell の多くのスクリプトおよび関数には、ヘルプ トピックが用意されています。Get-Help コマンドレットを使用して、スクリプトや関数のヘルプ トピックを表示できます。

関数のヘルプを表示するには、"get-help" に続けて関数名を入力します。たとえば、Disable-PSRemoting 関数のヘルプを表示するには、次のように入力します。

get-help disable-psremoting

スクリプトのヘルプを表示するには、スクリプト ファイルへの完全修飾パスを入力します。スクリプトのパスが Path 環境変数に含まれている場合は、コマンドからパスを省略できます。

たとえば、"TestScript.ps1" という名前のスクリプトが C:\PS-Test ディレクトリに格納されている場合、このスクリプトのヘルプ トピックを表示するには、次のように入力します。

get-help c:\ps-test\TestScript.ps1

Detailed、Full、Examples、Parameter など、コマンドレットのヘルプを表示するためにデザインされているパラメーターは、スクリプトのヘルプや関数のヘルプにも使用できます。ただし、"get-help *" を入力してすべてのヘルプを表示した場合、関数およびスクリプトのヘルプは表示されません。

関数およびスクリプトに関するヘルプ トピックを記述する方法については、「about_Functions」、「about_Scripts」、および「about_Comment_Based_Help」を参照してください。

インターネットに接続している場合、ヘルプを見るための最も良い方法の 1 つは、ヘルプ トピックをオンラインで表示することです。オンライン トピックは簡単に更新できるため、最新の情報が得られる可能性が高くなります。

オンライン ヘルプを表示するには、Get-Help コマンドレットの Online パラメーターを使用します。Get-Help コマンドレットの Online パラメーターは、コマンドレットのヘルプ、関数のヘルプ、およびスクリプトのヘルプに対してのみ機能します。概念説明のトピック ("about" ヘルプ) やプロバイダーに関するヘルプ トピックに対しては、Online パラメーターを使用できません。また、この機能はオプションであるため、すべてのコマンドレット、関数、スクリプトのヘルプ トピックに有効なわけではありません。

ただし、プロバイダーのヘルプ トピックや概念説明 ("about" ヘルプ) トピックも含め、Windows PowerShell に付属するすべてのヘルプ トピックが、Microsoft TechNet ライブラリの Windows PowerShell セクションからオンラインで参照できるようになっています。

Get-Help コマンドレットの Online パラメーターを使用するには、次のコマンド形式を使用します。

get-help <command-name> -online

たとえば、Get-ChildItem コマンドレットのヘルプ トピックのオンライン バージョンを表示するには、次のように入力します。

get-help get-childitem -online

ヘルプ トピックのオンライン バージョンが存在する場合には、既定のブラウザーにそのトピックが表示されます。

あるへルプ トピックに対してオンライン ヘルプがサポートされている場合、そのヘルプ トピックのインターネット アドレス (URL) を表示することもできます。インターネット アドレスは、ヘルプ トピックの「関連リンク」セクションに表示されます。

たとえば、Add-Computer コマンドレットのオンライン ヘルプ トピックの URL を表示するには、次のように入力します。

get-help add-computer

トピックの「関連リンク」セクションの最初の行を次に示します。

Online version: https://go.microsoft.com/fwlink/?LinkID=135194

ヘルプ トピックのオンライン サポートを提供する方法については、「about_Comment_Based_Help」、および MSDN (Microsoft Developer Network) ライブラリの「How to Write Cmdlet Help (コマンドレット ヘルプの記述方法)」(https://go.microsoft.com/fwlink/?LinkID=123415) を参照してください。