Get-Help

概要

Windows Power Shell コマンドとコンセプトに関する情報を表示する。

構文

Get-Help [-Full | -Detailed | -Examples | -Parameter <string>] [[-name] <string>] [-Category <string[]>] [-Component <string[]>] [-Functionality <string[]>] [-Online] [-Path <string>] [-Role <string[]>] [<CommonParameters>]

詳細

• 「get-help *」でトピック一覧を取得
• 「get-help <トピック名>」でトピックの詳細を表示
• 「get-help <パターン>」でマッチするパターンの一覧を取得 (マッチするものがない場合はコンセプト内の検索結果を取得)
• 「help」「man」ではページ単位で内容を表示
• 「cmdlet -?」も「get-help」同じの動きをする (コマンドレット限定)

パラメータ

-Full

すべての内容を表示する。

-Detailed

基本的な内容+概要と例を表示する。

-Example

見出し+構文+例を表示する。

-Parameter <string>

特定のパラメータに関する詳細を表示する。

-name <string>

対象の名前を指定する。「-name」は省略することができる。

cmdletとproviderではワイルドカードを利用することができる。

-Category <string[]>

対象とするカテゴリーを指定する。

Alias, Cmdlet, Provider, HelpFileを指定することができる。

-Component <string[]>

対象とするコンポーネントを指定する。

-Functionality <string[]>

対象とするFunctionalityを指定する

-Online

デフォルトブラウザでオンラインヘルプを参照する。

-Path <string>

特定のプロバイダー上での動きについてのヘルプを参照する。

-Role <string[]>

ユーザロールごとのカスタマイズされたヘルプを参照する。

<CommonParameters>

Verbose, Debug,　ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, OutVariableを指定可能

使用例

• Get-Help Get-Help -Example
• Get-Help Get-*