PowerShell Get-Help调用命令

本文概述

• 句法
• 参数
• 例子

PowerShell Get-Help cmdlet用于显示有关PowerShell命令和概念的信息。它显示信息, 包括功能, 提供程序, 工作流, 脚本和cmdlet的别名。要获取有关PowerShell cmdlet的帮助, 请键入Get-Help, 然后键入cmdlet的名称, 例如：Get-Help Set-Item。我们还可以获取有关PowerShell提供程序的帮助, 键入Get-Help cmdlet, 然后键入提供程序名称。

句法

Get-Help 
[[-Name] <string>] 
[-Path <string>] 
[-Category {Alias | Cmdlet | Provider | General | FAQ | Glossary | HelpFile | ScriptCommand | Function | Filter | ExternalScript | All |DefaultHelp | Workflow | DscResource | Class | Configuration}] 
[-Component <string[]>] 
[-Functionality <string[]>] 
[-Role <string[]>] 
[-Full]  
[<CommonParameters>]

Get-Help 
[[-Name] <string>] 
-Detailed 
[-Path <string>] 
[-Category {Alias | Cmdlet | Provider | General | FAQ | Glossary | HelpFile | ScriptCommand | Function | Filter | ExternalScript |All | DefaultHelp | Workflow | DscResource | Class | Configuration}] 
[-Component <string[]>] 
[-Functionality <string[]>] 
[-Role <string[]>]  
[<CommonParameters>]

Get-Help 
[[-Name] <string>] 
-Examples 
[-Path <string>] 
[-Category {Alias | Cmdlet | Provider | General | FAQ | Glossary | HelpFile | ScriptCommand | Function | Filter | ExternalScript |All | DefaultHelp | Workflow | DscResource | Class | Configuration}] 
[-Component <string[]>] 
[-Functionality <string[]>] 
[-Role <string[]>]  
[<CommonParameters>]

Get-Help 
[[-Name] <string>] 
-Parameter <string> 
[-Path <string>] 
[-Category {Alias | Cmdlet | Provider | General | FAQ | Glossary | HelpFile | ScriptCommand | Function | Filter |ExternalScript | All | DefaultHelp | Workflow | DscResource | Class | Configuration}] 
[-Component <string[]>] 
[-Functionality <string[]>] 
[-Role <string[]>]  
[<CommonParameters>]

Get-Help 
[[-Name] <string>] 
-Online 
[-Path <string>] 
[-Category {Alias | Cmdlet | Provider | General | FAQ | Glossary | HelpFile | ScriptCommand | Function | Filter | ExternalScript |All | DefaultHelp | Workflow | DscResource | Class | Configuration}] 
[-Component <string[]>] 
[-Functionality <string[]>] 
[-Role <string[]>]  
[<CommonParameters>]

参数

-Name

-Name参数用于获取有关指定命令或概念的帮助。

-路径

-Path参数用于获取帮助, 该帮助说明cmdlet如何在指定的提供程序路径中工作。要使用此参数, 我们可以为包含提供程序的模块安装帮助文件。

-类别

-Category参数仅用于显示指定类别及其别名中存在的那些项的帮助。以下是此参数可接受的值：

• 所有
• 默认帮助
• 工作流程
• DscResource
• 类
• 别名
• 词汇表
• 帮助文件
• 脚本命令
• 函数
• 过滤
• Cmdlet
• 提供者
• 一般
• 常问问题
• 外部脚本
• 组态

-零件

-Component参数用于显示具有给定组件值的命令。接受通配符。

-功能

-Functionality参数用于显示具有给定功能的项目的帮助。接受通配符。

-角色

-Role参数用于显示为指定用户角色定制的帮助。接受通配符。

-充分

-Full参数用于显示cmdlet的整个帮助文章。仅当计算机上安装了帮助文件时, 此选项才有效。

-详细

-Detailed参数用于将示例和参数说明添加到基本帮助显示中。

-例子

-Examples参数仅用于显示名称, 大纲和示例。

-参数

-Parameter是仅显示给定参数的详细描述的参数。

-线上

-Online参数用于在默认浏览器中显示帮助文章的在线版本。它仅对功能, cmdlet, 工作流和脚本帮助文章有效。我们不能在远程会话中将此参数与Get-Help cmdlet一起使用。

例子

示例1：显示有关cmdlet的基本帮助信息

此示例中的cmdlet用于在PowerShell控制台上显示有关get-Item cmdlet的基本帮助信息。

示例2：显示cmdlet的更多信息

此示例中的cmdlet用于显示更多详细信息, 以获取有关get-Item cmdlet的帮助。

此cmdlet中使用-Detailed参数来显示帮助文章的详细视图, 其中包括参数说明和示例。

-Full参数用于显示帮助文章的完整视图, 其中包括参数, 描述, 输入和输出对象类型以及附加说明的示例。

示例3：显示cmdlet的选定部分

此示例中的cmdlet用于显示get-Item cmdlet的选定部分。

示例4：显示cmdlet帮助的在线版本

此示例中的cmdlet用于在默认的Web浏览器中显示get-Item cmdlet的帮助文章的在线版本。

示例5：显示有关PowerShell帮助系统的帮助

此示例中的cmdlet用于显示有关PowerShell帮助系统的信息。

示例6：显示可用的帮助文章

此示例中的cmdlet用于显示计算机上可用的帮助文章列表。