Get-Help コマンドレットは、Windows PowerShell について学習するために役立つツールです。コマンドレットの説明を読み、概念を理解し、言語トピックを参照することで、Windows PowerShell の使い方がわかるようになります。
最初は、ヘルプ システム自体に関するトピックから学習することをお勧めします。Windows PowerShell でヘルプ システムに関する情報を表示するには、次のように入力します。
get-help
その次は、Get-Help、Get-Command、Get-Process、Get-Service、Get-Eventlog などの基本的なコマンドレットについて学習することをお勧めします。
コマンドレットの簡易ヘルプを表示するには、"get-help" に続けてコマンドレット名を入力します。たとえば、Get-Command コマンドレットのヘルプを表示するには、次のように入力します。
get-help get-command
コマンドレット ヘルプが適切に書式設定されない場合 (つまり、XMLNS タグで開始されている場合) は、システムの Windows PowerShell 実行ポリシーにより、コマンドレットのヘルプを書式設定するための構成ファイルの読み込みがブロックされている可能性があります。実行ポリシーに関する情報を参照するには、次のように入力します。
get-help about_execution_policies
パラメーターの説明や例を含むコマンドレットの詳細なヘルプを表示するには、Get-Help の Detailed パラメーターを使用します。たとえば、Get-Command コマンドレットの詳細なヘルプを表示するには、次のように入力します。
get-help get-command -detailed
コマンドレットおよびそのパラメーターの技術情報を含め、コマンドレットに関して利用可能なすべてのヘルプを表示するには、Full パラメーターを使用します。たとえば、Get-Command コマンドレットの完全なヘルプを表示するには、次のように入力します。
get-help get-command -full
ヘルプ ファイルの一部だけを表示することもできます。例だけを表示するには、Examples パラメーターを使用します。たとえば、Get-Command コマンドレットの例を表示するには、次のように入力します。
get-help get-command -examples
パラメーターの詳細な説明だけを表示するには、Get-Help の Parameter パラメーターを使用します。パラメーターの名前を指定できるほか、ワイルドカード文字 (*) を使用してすべてのパラメーターを指定できます。たとえば、Get-Command の TotalCount パラメーターの説明を表示するには、次のように入力します。
get-help get-command -parameter totalcount
Get-Command コマンドレットのすべてのパラメーターを表示するには、次のように入力します。
get-help get-command -parameter *
また、Windows PowerShell のヘルプは、Microsoft TechNet ライブラリの
Windows PowerShell v.2 では、Get-Help コマンドレットの Online パラメーターを使用して、コマンドレットのヘルプ トピックのオンライン バージョンを表示できます。既定では、Online パラメーターは TechNet ライブラリのヘルプ トピックにリンクされています。
たとえば、Get-Process コマンドレットのヘルプ トピックのオンライン バージョンを表示するには、次のように入力します。
get-help get-process -online
Get-Help を呼び出すいずれかの Windows PowerShell 関数を使用することもできます。Help 関数は、一度に 1 画面分のヘルプを表示します。Man 関数は、UNIX の Man ページのようなヘルプを表示します。Help 関数と Man 関数を使用して Get-Command コマンドレットのヘルプを表示するには、次のように入力します。
man get-command
または
help get-command
特定のヘルプ トピックを要求すると、Get-Help によってトピックの内容が表示されます。しかし、ワイルドカード文字を使用して複数のトピックを要求した場合は、Get-Help によってトピックの一覧が表示されます。たとえば、"Get" 系コマンドレットのヘルプ トピックの一覧を表示するには、次のように入力します。
get-help get-*
Windows PowerShell の概念説明のヘルプ トピックには、"about_" が付きます。Windows PowerShell の概念に関するヘルプを表示するには、"get-help" に続けてその概念の名前を入力します (概念の名前は、英語バージョン以外の Windows PowerShell でも英語で入力する必要があります)。
たとえば、ワイルドカードに関するヘルプを表示するには、次のように入力します。
get-help about_wildcards
Windows PowerShell のすべての概念説明のヘルプ トピックの一覧を表示するには、次のように入力します。
get-help about_*
ヘルプ トピックを読み、例を実際に試すことで、Windows PowerShell の使い方がわかるようになります。
関連項目