Windows PowerShell 包括介绍 Windows PowerShell 概念和 Windows PowerShell 语言的详细帮助主题。另外还包括每个 cmdlet 和提供程序的帮助主题,以及很多函数和脚本的帮助主题。

您可以在命令提示符下显示这些帮助主题,也可以在 Microsoft TechNet Library 中查看这些主题的最近更新版本。承载 Windows PowerShell 的很多程序(例如 Windows PowerShell 集成脚本环境)提供了其他一些帮助功能,例如上下文相关帮助和已编译的帮助文件 (.chm)。

获取 Cmdlet 帮助

若要获取有关 Windows PowerShell cmdlet 的帮助,请使用 Get-Help cmdlet。例如,若要获取 Get-ChildItem cmdlet 的帮助,请键入:

get-help get-childitem

get-childitem -?

您甚至还可以获取有关 Get-Help cmdlet 的帮助。例如:

get-help get-help

若要在会话中获取所有 cmdlet 帮助主题的列表,请键入:

get-help -category cmdlet

若要每次显示每个帮助主题的一页,请使用 help 函数或其别名 man。例如,若要显示 Get-ChildItem cmdlet 的帮助,请键入

man get-childitem

help get-childitem

若要显示有关 cmdlet、函数或脚本的详细信息,包括其参数说明和使用示例,请使用 Get-Help cmdlet 的 Detailed 参数。例如,若要获取有关 Get-ChildItem cmdlet 的详细信息,请键入:

get-help get-childitem -detailed

若要显示帮助主题中的所有内容,请使用 Get-Help cmdlet 的 Full 参数。例如,若要显示 Get-ChildItem cmdlet 的帮助主题的所有内容,请键入:

get-help get-childitem -full

若要获取有关 cmdlet 的参数的详细帮助,请使用 Get-Help cmdlet 的 Parameter 参数。例如,若要获取 Get-ChildItem cmdlet 的所有参数的详细帮助,请键入:

get-help get-childitem -parameter *

若要仅显示帮助主题中的示例,请使用 Get-Help 的 Example 参数。例如,若要仅显示 Get-ChildItem cmdlet 的帮助主题中的示例,请键入:

get-help get-childitem -examples

有关如何为您编写的 cmdlet 编写帮助主题的信息,请参阅 MSDN 中的“如何编写 Cmdlet 帮助”这一主题。

获取概念性帮助

Get-Help cmdlet 还显示有关 Windows PowerShell 中的概念性主题的信息,包括有关 Windows PowerShell 语言的主题。概念性帮助主题以“about_”前缀开头,例如 about_line_editing。(概念性主题的名称必须用英文输入,即使在非英文版的 Windows PowerShell 上也是如此。)

若要显示概念性主题的列表,请键入:

get-help about_*

若要显示特定的帮助主题,请键入主题名称,例如:

get-help about_command_syntax

Get-Help 的各个参数(例如 DetailedParameterExamples)对概念性帮助主题的显示没有影响。

获取有关提供程序的帮助

Get-Help cmdlet 显示有关 Windows PowerShell 提供程序的信息。若要获取提供程序的帮助,请键入“Get-Help”,并在后面键入提供程序名称。例如,若要获取 Registry 提供程序的帮助,请键入:

get-help registry

若要在会话中获取所有提供程序帮助主题的列表,请键入

get-help -category provider

Get-Help 的各个参数(例如 DetailedParameterExamples)对提供程序帮助主题的显示没有影响。

获取有关脚本和函数的帮助

Windows PowerShell 中的很多脚本和函数具有相应的帮助主题。使用 Get-Help cmdlet 可以显示脚本和函数的帮助主题。

若要显示函数的帮助,请键入“get-help”,并在后面键入函数名称。例如,若要获取 Disable-PSRemoting 函数的帮助,请键入:

get-help disable-psremoting

若要显示脚本的帮助,请键入脚本文件的完全限定路径。如果脚本位于 Path 环境变量中所列的路径中,则可在命令中省略路径。

例如,如果在您的 C:\PS-Test 目录下有一个名为“TestScript.ps1”的脚本,若要显示该脚本的帮助主题,请键入:

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

用于显示 cmdlet 帮助的参数(例如 Detailed FullExamplesParameter)也适用于脚本帮助和函数帮助。但是,在通过键入“get-help *”来显示所有帮助时,不会显示函数和脚本的帮助。

有关如何编写函数和脚本的帮助主题的信息,请参阅 about_Functionsabout_Scriptsabout_Comment_Based_Help

获取联机帮助

如果连接到 Internet,则获取帮助的最佳方式之一是联机查看帮助主题。由于联机主题易于更新,因此它们很可能提供最新的内容。

若要获取联机帮助,请尝试使用 Get-Help cmdlet 的 Online 参数。Get-Help cmdlet 的 Online 参数仅适用于 cmdlet 帮助、函数帮助和脚本帮助。不能将 Online 参数用于概念性 (About) 主题或提供程序帮助主题。此外,由于此功能是可选的,因此它并非适用于每个 cmdlet、函数或脚本帮助主题。

但是,Windows PowerShell 随附的所有帮助主题都可在 Microsoft TechNet Library 的 Windows PowerShell 部分中联机查看,包括提供程序帮助和概念性 (About) 帮助主题。

若要使用 Get-Help cmdlet 的 Online 参数,请使用以下命令格式。

get-help <command-name> -online

例如,若要获取有关 Get-ChildItem cmdlet 的帮助主题的联机版本,请键入:

get-help get-childitem -online

如果提供了帮助主题的联机版本,则它将在默认浏览器中打开。

如果支持帮助主题的联机帮助,则还可以查看帮助主题的 Internet 地址 (URL)。Internet 地址显示在帮助主题的“相关链接”部分中。

例如,若要查看 Add-Computer cmdlet 的联机版本的 URL,请键入:

get-help add-computer

主题的“相关链接”部分的第一行如下所示。

联机版本:https://go.microsoft.com/fwlink/?LinkID=135194

有关如何为帮助主题提供联机支持的信息,请参阅 about_Comment_Based_Help,另外也可参阅 MSDN (Microsoft Developer Network) Library 中的“如何编写 Cmdlet 帮助” (https://go.microsoft.com/fwlink/?LinkID=123415)。

另请参阅




目录