詳しいヘルプ情報の取得Getting Detailed Help Information

Windows PowerShell には、Windows PowerShell の概念と言語について説明した詳しいヘルプ トピックが含まれています。Windows PowerShell includes detailed Help topics that explain Windows PowerShell concepts and the Windows PowerShell language. また、各コマンドレットおよびプロバイダーに関するヘルプ トピックや、多くの関数およびスクリプトに関するヘルプ トピックもあります。There are also Help topics for each cmdlet and provider and Help topics for many functions and scripts.

これらのヘルプ トピックはコマンド プロンプトで表示でき、Microsoft TechNet ライブラリで最新版のトピックを見ることもできます。You can display these Help topics at the command prompt or view the most recently updated versions of these topics in the Microsoft TechNet Library. Windows PowerShell Integrated Scripting Environment など、Windows PowerShell をホストする多くのプログラムでは、状況依存のヘルプやコンパイル済みヘルプ ファイル (.chm) などの追加のヘルプ機能が用意されています。Many programs that host Windows PowerShell, such as Windows PowerShell Integrated Scripting Environment, provide additional Help features, such as context-sensitive Help and compiled Help file (.chm).

コマンドレットのヘルプの表示Getting Help for Cmdlets

Windows PowerShell のコマンドレットに関するヘルプを表示するには、Get-Help [m2] コマンドレットを使用します。To get Help about Windows PowerShell cmdlets, use the Get-Help [m2] cmdlet. たとえば、Get-ChildItem [m2] コマンドレットのヘルプを表示するには、次のように入力します。For example, to get Help for the Get-ChildItem [m2] cmdlet, type:

get-help get-childitem

またはor

get-childitem -?

Get-Help コマンドレットに関するヘルプも表示できます。You can even get Help about the Get-Help cmdlet. たとえば、次のように入力します。For example:

get-help get-help

セッションのすべてのコマンドレットのヘルプ トピックの一覧を表示するには、次のように入力します。To get a list of all the cmdlet Help topics in your session, type:

get-help -category cmdlet

各ヘルプ トピックを 1 ページずつ表示するには、help 関数、またはそのエイリアスである man を使用します。To display one page of each Help topic at a time, use the help function or its alias man. たとえば、Get-ChildItem コマンドレットのヘルプを表示するには、次のように入力します。For example, to display Help for the Get-ChildItem cmdlet, type

man get-childitem

またはor

help get-childitem

パラメーターの説明や使用例など、コマンドレット、関数、またはスクリプトに関する詳細情報を表示するには、Get-Help コマンドレットの Detailed パラメーターを使用します。To display detailed information about a cmdlet, function, or script, including descriptions of its parameters and examples of its use, use the Detailed parameter of the Get-Help cmdlet. たとえば、Get-ChildItem コマンドレットに関する詳細情報を表示するには、次のように入力します。For example, to get detailed information about the Get-ChildItem cmdlet, type:

get-help get-childitem -detailed

ヘルプ トピックのすべての内容を表示するには、Get-Help コマンドレットの Full パラメーターを使用します。To display all content in the Help topic, use the Full parameter of the Get-Help cmdlet. たとえば、Get-ChildItem コマンドレットのヘルプ トピックの内容をすべて表示するには、次のように入力します。For example, to display all content in the Help topic for the Get-ChildItem cmdlet, type:

get-help get-childitem -full

コマンドレットのパラメーターに関する詳しいヘルプを表示するには、Get-Help コマンドレットの Parameter パラメーターを使用します。To get detailed Help about the parameters of a cmdlet, use the Parameter parameter of the Get-Help cmdlet. たとえば、Get-ChildItem コマンドレットのすべてのパラメーターの詳しいヘルプを表示するには、次のように入力します。For example, to get detailed Help for all of the parameters of the Get-ChildItem cmdlet, type:

get-help get-childitem -parameter *

ヘルプ トピック内の例だけを表示するには、Get-Help の Example パラメーターを使用します。To display only the examples in a Help topic, use the Example parameter of the Get-Help. たとえば、Get-ChildItem コマンドレットのヘルプ トピック内の例のみを表示するには、次のように入力します。For example, to display only the examples in the Help topic for the Get-ChildItem cmdlet, type:

get-help get-childitem -examples

作成したコマンドレットに関するヘルプ トピックを記述する方法については、MSDN ライブラリの「How to Write Cmdlet Help」 (コマンドレット ヘルプの記述方法) をご覧ください。For information about how to write Help topics for the cmdlets that you write, see How to Write Cmdlet Help in the MSDN library.

概念説明のヘルプの表示Getting Conceptual Help

Get-Help コマンドレットでは、Windows PowerShell 言語に関するトピックなど、Windows PowerShell の概念説明トピックの情報も表示されます。The Get-Help cmdlet also displays information about conceptual topics in Windows PowerShell, including topics about the Windows PowerShell language. 概念説明のヘルプ トピックには、"about_" というプレフィックスが付きます (about_line_editing など)。Conceptual Help topics begin with the "about_" prefix, such as about_line_editing. 概念説明のトピックの名前は、英語バージョン以外の Windows PowerShell でも英語で入力する必要があります。(The name of the conceptual topic must be entered in English even on non-English versions of Windows PowerShell.)

概念説明のトピックを一覧表示するには、次のように入力します。To display a list of conceptual topics, type:

get-help about_*

特定のヘルプ トピックを表示するには、次のように、トピック名を入力します。To display a particular Help topic, type the topic name, for example:

get-help about_command_syntax

Get-Help の DetailedParameterExamples などのパラメーターは、概念説明ヘルプ トピックの表示には効果がありません。The parameters of Get-Help, such as Detailed, Parameter, and Examples, have no effect on the display of conceptual Help topics.

プロバイダーに関するヘルプの表示Getting Help About Providers

Get-Help コマンドレットでは、Windows PowerShell プロバイダーに関する情報を表示できます。The Get-Help cmdlet displays information about Windows PowerShell providers. プロバイダーのヘルプを取得するには、"Get-Help" に続けてプロバイダー名を入力します。To get Help for a provider, type "Get-Help" followed by the provider name. たとえば、Registry プロバイダーのヘルプを取得するには、次のように入力します。For example, to get Help for the Registry provider, type:

get-help registry

セッションのすべてのプロバイダーのヘルプ トピックの一覧を表示するには、次のように入力します。To get a list of all the provider Help topics in your session, type

get-help -category provider

Get-Help の DetailedParameterExamples などのパラメーターは、プロバイダーに関するヘルプ トピックの表示には効果がありません。The parameters of Get-Help, such as Detailed, Parameter, and Examples, have no effect on the display of provider Help topics.

スクリプトおよび関数に関するヘルプの表示Getting Help About Scripts and Functions

Windows PowerShell の多くのスクリプトおよび関数には、ヘルプ トピックが用意されています。Many scripts and functions in Windows PowerShell have Help topics. Get-Help コマンドレットを使用して、スクリプトや関数のヘルプ トピックを表示できます。Use the Get-Help cmdlet to display the Help topics for scripts and functions.

関数のヘルプを表示するには、"get-help" に続けて関数名を入力します。To display the Help for a function, type "get-help" followed by the function name. たとえば、Disable-PSRemoting 関数のヘルプを表示するには、次のように入力します。For example, to get Help for the Disable-PSRemoting function, type:

get-help disable-psremoting

スクリプトのヘルプを表示するには、スクリプト ファイルへの完全修飾パスを入力します。To display the Help for a script, type the fully qualified path to the script file. スクリプトのパスが Path 環境変数に含まれている場合は、コマンドからパスを省略できます。If the script is in a path that is listed in the Path environment variable, you can omit the path from the command.

たとえば、"TestScript.ps1" という名前のスクリプトが C:\PS-Test ディレクトリに格納されている場合、このスクリプトのヘルプ トピックを表示するには、次のように入力します。For example, if you have a script called "TestScript.ps1" in your C:\PS-Test directory, to display the Help topic for the script, type:

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

DetailedFullExamplesParameter など、コマンドレットのヘルプを表示するためにデザインされているパラメーターは、スクリプトのヘルプや関数のヘルプにも使用できます。The parameters that were designed for displaying cmdlet Help, such as Detailed, Full, Examples, and Parameter, work for script Help and function Help, too. ただし、"get-help *" を入力してすべてのヘルプを表示した場合、関数およびスクリプトのヘルプは表示されません。However, when you display all Help, by typing "get-help *", Help for functions and scripts does not appear.

関数およびスクリプトに関するヘルプ トピックを記述する方法については、「about_Functions [m2]」、「about_Scripts」、「about_Comment_Based_Help」をご覧ください。For information about writing Help topics for your functions and scripts, see about_Functions [m2], about_Scripts, and about_Comment_Based_Help.

オンライン ヘルプの表示Getting Help Online

インターネットに接続している場合、ヘルプを見るための最も良い方法の 1 つは、ヘルプ トピックをオンラインで表示することです。If you are connected to the Internet, one of the best ways to get Help is to view the Help topics online. オンライン トピックは簡単に更新できるため、最新の情報が得られる可能性が高くなります。Because online topics are easy to update, they are likely to provide the most current content.

オンライン ヘルプを表示するには、Get-Help コマンドレットの Online パラメーターを使用します。To get Help online, try the Online parameter of the Get-Help cmdlet. Get-Help コマンドレットの Online パラメーターは、コマンドレットのヘルプ、関数のヘルプ、スクリプトのヘルプに対してのみ機能します。The Online parameter of the Get-Help cmdlet works only for cmdlet Help, function Help, and script Help. 概念説明のトピック ("about" ヘルプ) やプロバイダーに関するヘルプ トピックに対しては、Online パラメーターを使用できません。You cannot use the Online parameter with conceptual (About) topics or provider Help topics. また、この機能はオプションであるため、すべてのコマンドレット、関数、スクリプトのヘルプ トピックに有効なわけではありません。Also, because this feature is optional, it does not work for every cmdlet, function, or script Help topic.

ただし、プロバイダーのヘルプ トピックや概念説明 ("about" ヘルプ) トピックも含め、Windows PowerShell に付属するすべてのヘルプ トピックが、Microsoft TechNet ライブラリの Windows PowerShell セクションからオンラインで参照できるようになっています。However, all the Help topics that come with Windows PowerShell, including provider Help and conceptual (About) Help topics, are available online in the Windows PowerShell section of the Microsoft TechNet Library.

Get-Help コマンドレットの Online パラメーターを使用するには、次のコマンド形式を使用します。To use the Online parameter of the Get-Help cmdlet, use the following command format.

get-help <command-name> -online

たとえば、Get-ChildItem コマンドレットのヘルプ トピックのオンライン バージョンを表示するには、次のように入力します。For example, to get the online version of the Help topic about the Get-ChildItem cmdlet, type:

get-help get-childitem -online

ヘルプ トピックのオンライン バージョンが存在する場合には、既定のブラウザーにそのトピックが表示されます。If an online version of the Help topic is available, it will open in your default browser.

あるへルプ トピックに対してオンライン ヘルプがサポートされている場合、そのヘルプ トピックのインターネット アドレス (URL) を表示することもできます。If online Help is supported for a Help topic, you can also view the Internet address (URL) of the Help topic. インターネット アドレスは、ヘルプ トピックの「関連リンク」セクションに表示されます。The Internet address appears in the Related Links section of a Help topic.

たとえば、Add-Computer コマンドレットのオンライン ヘルプ トピックの URL を表示するには、次のように入力します。For example, to see the URL for the online version of the Add-Computer cmdlet, type:

get-help add-computer

トピックの「関連リンク」セクションの最初の行を次に示します。The first line in the Related Links section of the topic is shown below.

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

ヘルプ トピックのオンライン サポートを提供する方法については、「about_Comment_Based_Help」と MSDN ライブラリの 「How to Write Cmdlet Help」 (コマンドレット ヘルプの記述方法) をご覧ください。For information about how to provide online support for your Help topics, see about_Comment_Based_Help, and see How to Write Cmdlet Help in the MSDN library.

参照See Also