PowerShell Alias - man
 記事記号:[mdAc63] 初版:2010/Dec/28

この文書は、Windows PowerShellのヘルプ機能で表示される内容を再構成したものです。

名前
    Get-Help
    
概要
    Windows PowerShell のコマンドと概念に関する情報を表示します。
    
構文
    Get-Help [-Full] [[-Name] <string>] [-Category <string[]>] [-Com
    ponent <string[]>] [-Functionality <string[]>] [-Online] [-Path 
    <string>] [-Role <string[]>] [<CommonParameters>]
    
    Get-Help [-Detailed] [[-Name] <string>] [-Category <string[]>] [
    -Component <string[]>] [-Functionality <string[]>] [-Online] [-P
    ath <string>] [-Role <string[]>] [<CommonParameters>]
    
    Get-Help [-Examples] [[-Name] <string>] [-Category <string[]>] [
    -Component <string[]>] [-Functionality <string[]>] [-Online] [-P
    ath <string>] [-Role <string[]>] [<CommonParameters>]
    
    Get-Help [-Parameter <string>] [[-Name] <string>] [-Category <
    string[]>] [-Component <string[]>] [-Functionality <string[]>
    ] [-Online] [-Path <string>] [-Role <string[]>] [<CommonParam
    eters>]
    
説明
    Get-Help コマンドレットは、コマンドレット、プロバイダー、関数、スクリプトな
    ど、Windows PowerShell の概念とコマンドに関する情報を表示します。すべてのコ
    マンドレットのヘルプ トピック タイトルの一覧を取得するには、「get-help *」と 
    入力します。
    
    「Get-Help」と入力した後、ヘルプ トピック名またはヘルプ トピックに固有の語を
    入力すると、Get-Help によってそのトピックの内容が表示されます。複数のヘルプ 
    トピック タイトルに示されている単語または単語パターンを入力した場合、Get-Hel
    p によって、一致するタイトルの一覧が表示されます。いずれのヘルプ トピック タ
    イトルにも使用されていない単語を入力した場合、Get-Help によって、内容にその
    単語が含まれるトピックの一覧が表示されます。
    
    「get-help」のほか、「help」または「man」、あるいは「<cmdlet-name> -?
    」と入力することもできます。「help」または「man」では一度に 1 画面分のテキス
    トが表示されます。「<cmdlet-name> -?」は、コマンドレットにのみ有効であ
    る点以外は Get-Help と同じです。
    
    ヘルプ ファイル全体を表示することも、構文、パラメーター、例など、ヘルプ ファ
    イルの一部を選択的に表示することもできます。また、Online パラメーターを使用
    すると、ヘルプ ファイルのオンライン バージョンをインターネット ブラウザーで
    表示できます。これらのパラメーターは概念説明のヘルプ トピックには影響しませ
    ん。
    
    Windows PowerShell の概念説明のヘルプ トピックは、先頭に "about_" が付きます 
    (about_Comparison_Operators など)。すべての "about_" トピックを参照するには、
    「get-help about_*」と入力します。特定のトピックを参照するには、「get-help a
    bout_<topic-name>」と入力します (たとえば「get-help about_Comparison_O
    perators」)。
    
パラメーター
    -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 [<SwitchParameter>]
        パラメーターの説明と例を基本的なヘルプ表示に追加します。
        
        このパラメーターは概念説明の ("about_") ヘルプの表示には影響しません。
        
        必須                         false
        位置                         named
        既定値                       
        パイプライン入力を許可する   false
        ワイルドカード文字を許可する false
        
    -Examples [<SwitchParameter>]
        名前、概要、および例のみを表示します。例のみを表示するには、「(get-help 
        <コマンドレット名>).examples」と入力します。
        
        このパラメーターは概念説明の ("about_") ヘルプの表示には影響しません。
        
        必須                         false
        位置                         named
        既定値                       
        パイプライン入力を許可する   false
        ワイルドカード文字を許可する false
        
    -Full [<SwitchParameter>]
        パラメーターの説明と属性、例、入力オブジェクト型と出力オブジェクト型、追
        加の注など、コマンドレットの完全なヘルプ ファイルを表示します。
        
        このパラメーターは概念説明の ("about_") ヘルプの表示には影響しません。
        
        必須                         false
        位置                         named
        既定値                       
        パイプライン入力を許可する   false
        ワイルドカード文字を許可する false
        
    -Functionality <string[]>
        指定された機能を持つ項目のヘルプを表示します。機能を入力します。ワイルド
        カードを使用できます。
        
        Functionality は、Get-Help が返す MamlCommandHelpInfo オブジェクトのプロ
        パティです。このパラメーターは概念説明の ("about_") ヘルプの表示には影響
        しません。
        
        必須                         false
        位置                         named
        既定値                       
        パイプライン入力を許可する   false
        ワイルドカード文字を許可する false
        
    -Name <string>
        指定されたツールまたは概念的なトピックのヘルプを要求します。コマンドレッ
        ト、プロバイダー、スクリプト、または関数名 (例: Get-Member)、概念的なト
        ピック名 (例: "about_Objects")、またはエイリアス (例: "ls") を入力します。
        コマンドレットおよびプロバイダーの名前にはワイルドカードを使用できますが、
        関数およびスクリプトのヘルプの名前を検索するときにはワイルドカードを使用
        できません。
        
        Path 環境変数に指定されているパスにないスクリプトのヘルプを取得するには、
        スクリプトのパスとファイル名を入力します。
        
        ヘルプ トピックの正確な名前を入力した場合、Get-Help によって、トピックの
        内容が表示されます。複数のヘルプ トピック タイトルに示されている単語また
        は単語パターンを入力した場合、Get-Help によって、一致するタイトルの一覧
        が表示されます。いずれのヘルプ トピック タイトルにも一致しない単語を入力
        した場合、Get-Help によって、内容にその単語が含まれるトピックの一覧が表
        示されます。
        
        about_objects などの概念説明のトピック名は、日本語バージョンの Windows P
        owerShell でも英語で入力する必要があります。
        
        必須                         false
        位置                         1
        既定値                       
        パイプライン入力を許可する   true (ByPropertyName)
        ワイルドカード文字を許可する false
        
    -Online [<SwitchParameter>]
        ヘルプ トピックのオンライン バージョンを、既定のインターネット ブラウザ
        ーで表示します。このパラメーターは、コマンドレット、関数、およびスクリプ
        トのヘルプ トピックの場合にのみ有効です。
        
        Get-Help は、コマンドレット、関数、またはスクリプトのヘルプ トピックで「
        関連リンク」セクションの最初の項目に表示されるインターネット アドレス (U
        RI (Uniform Resource Identifier)) を使用します。このパラメーターは、ヘル
        プ トピックに "Http" または "Https" から始まる URI が含まれており、なお
        かつインターネット ブラウザーがシステムにインストールされている場合にの
        み有効です。
        
        記述するヘルプ トピックでのこの機能のサポートについては、「about_Comment
        _Based_Help」と、MSDN (Microsoft Developer Network) ライブラリの「How to 
        Write Cmdlet Help (コマンドレット ヘルプの記述方法)」(http://go.microsof
        t.com/fwlink/?LinkID=123415) を参照してください。
        
        必須                         false
        位置                         named
        既定値                       なし
        パイプライン入力を許可する   false
        ワイルドカード文字を許可する false
        
    -Parameter <string>
        指定されたパラメーターの詳細説明のみを表示します。ワイルドカードを使用で
        きます。
        
        このパラメーターは概念説明の ("about_") ヘルプの表示には影響しません。
        
        必須                         false
        位置                         named
        既定値                       
        パイプライン入力を許可する   false
        ワイルドカード文字を許可する false
        
    -Path <string>
        指定されたプロバイダー パスでコマンドレットがどのように動作しているかを
        説明するヘルプを取得します。Windows PowerShell プロバイダー パスを入力し
        ます。
        
        このパラメーターは、指定した Windows PowerShell プロバイダー パスでのコ
        マンドレットの動作について説明するコマンドレット ヘルプ トピックのカスタ
        ム バージョンを取得します。このパラメーターは、プロバイダー コマンドレッ
        トのヘルプと、プロバイダー コマンドレット ヘルプ トピックのカスタム バー
        ジョンがプロバイダーに含まれる場合にのみ有効です。
        
        プロバイダー パスのカスタム コマンドレット ヘルプを表示するには、プロバ
        イダー パスの場所に移動して Get-Help コマンドを入力するか、いずれかのパ
        スの場所から Get-Help の Path パラメーターを使用してプロバイダー パスを
        指定します。詳細については、「about_Providers」を参照してください。
        
        必須                         false
        位置                         named
        既定値                       
        パイプライン入力を許可する   false
        ワイルドカード文字を許可する false
        
    -Role <string[]>
        指定されたユーザー ロール向けにカスタマイズされたヘルプを表示します。ロ
        ールを入力します。ワイルドカードを使用できます。
        
        ユーザーが組織内で果たす役割を入力します。コマンドレットによっては、この
        パラメーターの値に応じて異なるヘルプ ファイルのテキストが表示される場合
        があります。このパラメーターは、コアのコマンドレットのヘルプには影響しま
        せん。
        
        必須                         false
        位置                         named
        既定値                       
        パイプライン入力を許可する   false
        ワイルドカード文字を許可する false
        
    <CommonParameters>
        このコマンドレットは、次の共通パラメーターをサポートします: Verbose、
        Debug、ErrorAction、ErrorVariable、WarningAction、WarningVariable、
        OutBuffer、および OutVariable。詳細については、
        「get-help about_commonparameters」と入力してヘルプを参照してください。
    
入力
    None
        パイプを使用してこのコマンドレットにオブジェクトを渡すことはできません。
    
出力
    System.String または MamlCommandHelpInfo
        概念説明のトピックを要求した場合、Get-Help は文字列を返します。コマンド
        レット、関数、またはスクリプトの名前が指定された場合は、MamlCommandHelpI
        nfo オブジェクトを返します。それ以外の場合、Get-Help は $pshome ディレク
        トリの Help.Format.ps1xml ファイルで指定されている書式設定されたビューの 
        1 つを返します。
    
メモ
        パラメーターがない場合、"Get-Help" は Windows PowerShell のヘルプ システ
        ムについての情報を表示します。
        
        ヘルプの完全ビュー (-full) には、パラメーターに関する情報の表が含まれま
        す。この表には次のフィールドがあります。
        
        -- 必須: パラメーターが必須 (True) とオプション (False) のどちらであるか
        を示します。
        
        -- 位置: パラメーターが名前指定と位置指定 (番号) のどちらであるかを示しま
        す。位置指定パラメーターは、コマンド内の指定された場所に記述する必要があ
        ります。
        
        -- "Named" は、そのパラメーター名が必須ではあるが、コマンド内の任意の場所
        に記述できることを示します。
        
        -- <数値> は、パラメーター名が省略可能であるが、名前を省略するとき
        にはパラメーターを数値で指定された場所に記述する必要があることを示します。
        たとえば、"2" は、パラメーター名を省略するときにはパラメーターをコマンド
        の 2 番目に記述するか、そのパラメーターが唯一の名前のないパラメーターで
        なければならないことを示します。パラメーター名を使用する場合、パラメータ
        ーはコマンド内の任意の場所に記述できます。
        
        -- 既定値: コマンドにパラメーターが指定されていない場合に Windows PowerS
        hell が使用するパラメーター値です。
        
        -- パイプライン入力を許可する: パイプラインを介してオブジェクトをパラメ
        ーターに送ることが可能 (True) か、不可能 (False) かを示します。"By Prope 
        rtyName" は、パイプラインを介して送られるオブジェクトにパラメーター名と
        同じ名前のプロパティがある必要があることを示します。
        
        -- ワイルドカード文字を許可する: パラメーターの値に "*" や "?" などのワ
        イルドカード文字を指定できるかどうかを示します。
        
    -------------------------- 例 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 コマンドレットについての基本的な情報を表示しま
    す。"Get-Help" と "-?" コマンドは情報を 1 ページで表示します。"Help" コマン
    ドは、情報を一度に 1 ページずつ表示します。
    
    -------------------------- 例 4 --------------------------
    C:\PS>get-help about_*
    
    説明
    -----------
    このコマンドは、Windows PowerShell ヘルプの概念的なトピックの一覧を表示しま
    す。これらすべてのトピックは "about_" で始まります。特定のヘルプ ファイルを
    表示するには、「get-help <topic-name>」と入力します (たとえば "get-hel
    p about_signing")。
    
    -------------------------- 例 5 --------------------------
    C:\PS>get-help ls -detailed
    
    説明
    -----------
    このコマンドは、Get-ChildItem コマンドレットのエイリアスの 1 つである "ls" 
    を指定して Get-Childitem の詳細なヘルプを表示します。Detailed パラメーターを
    指定することにより、パラメーターの説明や例を含むヘルプ ファイルの詳細ビュー
    が要求されます。コマンドレットの完全なヘルプ ファイルを参照するには、Full パ
    ラメーターを使用します。
    
    -------------------------- 例 6 --------------------------
    C:\PS>get-help format-string -full
    
    説明
    -----------
    このコマンドは、Format-String コマンドレットのヘルプの完全ビューを表示します。
    ヘルプの完全ビューには、パラメーターの説明、例、およびパラメーターの技術的な
    詳細を示した表があります。
    
    -------------------------- 例 7 --------------------------
    C:\PS>get-help start-service -examples
    
    説明
    -----------
    このコマンドは、Windows PowerShell コマンドで start-service を使用する例を表
    示します。
    
    -------------------------- 例 8 --------------------------
    C:\PS>get-help get-childitem -parameter f*
    
    説明
    -----------
    このコマンドは、"f" で始まる Get-ChildItem コマンドレットのパラメーター (fil
    ter と force) の説明を表示します。すべてのパラメーターの説明を表示するには、
    「get-help get-childitem parameter*」と入力します。
    
    -------------------------- 例 9 --------------------------
    C:\PS>(get-help write-output).syntax
    
    説明
    -----------
    このコマンドは、Write-Output コマンドレットの構文のみを表示します。
    
    Syntax は、help オブジェクトのプロパティの 1 つにすぎません。この他に、descr
    iption、details、examples、および parameters があります。ヘルプ オブジェクト
    のすべてのプロパティとメソッドを見つけるには、「get-help <cmdlet-name> 
    | get-member」と入力します (たとえば「get-help start-service | get member」)。
    
    -------------------------- 例 10 --------------------------
    C:\PS>(get-help trace-command).alertset
    
    説明
    -----------
    このコマンドを実行すると、コマンドレットに関する注が表示されます。注は、ヘル
    プ オブジェクトの alertSet プロパティに保存されます。
    
    注には、概念説明の情報およびコマンドレットの使い方のヒントが含まれます。既定
    では、注は Get-Help の Full パラメーターを使用したときにのみ表示されますが、
    alertSet プロパティを使用して表示することもできます。
    
    -------------------------- 例 11 --------------------------
    C:\PS>get-help add-member -full | out-string -stream | select-string -pat
    tern clixml
    
    説明
    -----------
    この例は、特定のコマンドレットのヘルプ トピック内の語を検索する方法を示して
    います。このコマンドは、Add-Member コマンドレットの完全版ヘルプ トピックで "
    clixml" という語を検索します。
    
    Get-Help コマンドレットは文字列ではなく MamlCommandHelpInfo オブジェクトを生
    成するので、Out-String や Out-File など、ヘルプ トピックの内容を文字列に変換
    するコマンドを使用する必要があります。
    
    -------------------------- 例 12 --------------------------
    C:\PS>get-help get-member -online
    
    説明
    -----------
    このコマンドは、Get-Member コマンドレット ヘルプ トピックのオンライン バージ
    ョンを表示します。
    
    -------------------------- 例 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 compu
        ters 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 compu
        ters 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 コマンドレットの標準のヘルプを取得することを示してい
    ます。
    
    -------------------------- 例 15 --------------------------
    C:\PS>get-help c:\ps-test\MyScript.ps1
    
    説明
    -----------
    このコマンドは MyScript.ps1 スクリプトのヘルプを取得します。関数およびスクリ
    プトに関するヘルプ トピックを記述する方法については、「about_Comment_Based_H
    elp」を参照してください。
    
関連するリンク
    Online version: http://go.microsoft.com/fwlink/?LinkID=113316
    about_Comment_Based_Help 
    Get-Command 
    Get-PSDrive 
    Get-Member 
	
記事で解説しているパソコンの環境
 基本ソフト: Windows 7
 キーワード: Windows PowerShell、ヘルプ、Alias、man
ご利用数: 1969056
感想・要望・問い合わせは こちら