詳しいヘルプ情報の取得Getting detailed help information

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

これらのヘルプ記事はコマンド プロンプトで表示でき、PowerShell ドキュメント オンラインでこれらの記事の最新版を確認することもできます。You can display these Help articles at the command prompt or view the most recently updated versions of these articles in the PowerShell documentation online.

コマンドレットのヘルプの表示Getting help for cmdlets

PowerShell のコマンドレットに関するヘルプを表示するには、Get-Help コマンドレットを使用します。To get Help about PowerShell cmdlets, use the Get-Help cmdlet. たとえば、Get-ChildItem コマンドレットのヘルプを表示するには、次のように入力します。For example, to get Help for the Get-ChildItem 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 articles in your session, type:

Get-Help -Category Cmdlet

各ヘルプ記事を 1 ページずつ表示するには、help 関数またはそのエイリアスである man を使用します。To display one page of each Help article 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, 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 article, use the Full parameter of the Get-Help cmdlet. たとえば、Get-ChildItem コマンドレットのヘルプ記事の内容をすべて表示するには、次のように入力します。For example, to display all content in the Help article 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-HelpExample パラメーターを使用します。To display only the examples in a Help article, use the Examples parameter of the Get-Help. たとえば、Get-ChildItem コマンドレットのヘルプ記事の例だけを表示するには、次のように入力します。For example, to display only the examples in the Help article for the Get-ChildItemcmdlet, type:

Get-Help Get-ChildItem -Examples

作成したコマンドレットに関するヘルプ記事を記述する方法については、「How to Write Cmdlet Help」(コマンドレット ヘルプの記述方法) を参照してください。For information about how to write Help articles for the cmdlets that you write, see How to Write Cmdlet Help.

概念説明のヘルプの表示Getting conceptual help

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

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

Get-Help about_*

特定のヘルプ記事を表示するには、次のように記事の名前を入力します。To display a particular Help article, type the article name, for example:

Get-Help about_command_syntax

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

プロバイダーに関するヘルプの表示Getting help about providers

Get-Help コマンドレットでは、PowerShell プロバイダーに関する情報を表示できます。The Get-Help cmdlet displays information about 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 articles in your session, type

Get-Help -Category provider

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

スクリプトおよび関数に関するヘルプの表示Getting help about scripts and functions

PowerShell の多くのスクリプトおよび関数には、ヘルプ記事が用意されています。Many scripts and functions in PowerShell have Help articles. Get-Help コマンドレットを使用して、スクリプトや関数のヘルプ記事を表示します。Use the Get-Help cmdlet to display the Help articles 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 path to the script file. スクリプトが Path 環境変数に一覧表示されたパスにない場合は、完全修飾パスを使用する必要があります。If the script is not in a path listed in the Path environment variable, you must use the fully qualified path.

たとえば、"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 article for the script, type:

Get-Help c:\ps-test\TestScript.ps1

コマンドレットのヘルプを表示するように設計されたパラメーターは、スクリプトと関数のヘルプにも有効です。The parameters that are designed for displaying cmdlet Help work for script and function Help, too. ただし、Get-Help * を実行している場合、スクリプトと関数のヘルプは表示されません。However, help for functions and scripts is not shown when you run Get-Help *.

関数とスクリプトのヘルプ記事の記述については、次の記事を参照してください。For information about writing Help articles for your functions and scripts, see the following articles:

オンラインでのヘルプの表示Getting help online

オンラインでのヘルプ記事の表示は、ヘルプを表示するための最善の方法の 1 つです。Viewing the Help articles online is one of the best ways to get help. オンラインの記事は、より簡単に最新のコンテンツに更新して提供できます。Online articles are easier to update and provide the most current content.

オンライン ヘルプを表示するには、Get-Help コマンドレットの Online パラメーターを使用します。To get Help online, use the Online parameter of the Get-Help cmdlet. プロバイダー ヘルプや概念説明 (About) のヘルプ記事など、PowerShell に付属しているすべてのヘルプ記事は、PowerShell ドキュメントでオンラインから利用できます。All the Help articles that come with PowerShell, including provider Help and conceptual (About) Help articles, are available online in the PowerShell documentation.

注意

概念説明の記事 (about_*) やプロバイダー ヘルプの記事では、Online パラメーターを使用できません。You can't use the Online parameter with conceptual (about_*) or provider Help articles. オンライン ヘルプはオプションであるため、すべてのコマンドレット、関数、またはスクリプトで有効なわけではありません。Online help is optional, so it does not work for every cmdlet, function, or script.

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

Get-Help Get-ChildItem -Online

PowerShell では、既定のブラウザーで記事を開きます。PowerShell opens the article in your default browser. あるへルプ記事のオンライン ヘルプがサポートされている場合は、そのヘルプ記事の URL を表示することもできます。If online Help is supported for a Help article, you can also view the URL of the Help article. URL は、ヘルプ記事の「関連リンク」セクションに表示されます。The URL appears in the Related Links section of a Help article.

たとえば、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 article is shown below.

Online version: http://go.microsoft.com/fwlink/?LinkId=821564

ヘルプ記事のオンライン サポートを提供する方法については、about_Comment_Based_Help を参照してください。For information about how to provide online support for your Help articles, see about_Comment_Based_Help.

関連項目See also