PowerShell get-help命令

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

语法

语法1

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>]

语法2

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>]

语法3

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>]

语法4

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>]

语法5

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 - 此参数用于获取有关指定命令或概念的帮助。
-Path - 此参数用于获取帮助，该帮助说明cmdlet如何在指定的提供程序路径中工作。 要使用此参数，可以为包含提供程序的模块安装帮助文件。
-Category - 此参数仅用于显示指定类别及其别名中存在的那些项的帮助。以下是此参数可接受的值：

• All
• DefaultHelp
• Workflow
• DscResource
• Class
• Alias
• Glossary
• HelpFile
• ScriptCommand
• Function
• Filter
• Cmdlet
• Provider
• General
• FAQ
• ExternalScript
• Configuration

-Component - 此参数用于显示具有给定组件值的命令，接受通配符。
-Functionality - 此参数用于显示具有给定功能的项目的帮助，接受通配符。
-Role - 此参数用于显示为指定用户角色定制的帮助，接受通配符。
-Full - 此参数用于显示cmdlet的整个帮助文章。 仅当计算机上安装了帮助文件时，此选项才有效。
-Detailed - 此参数用于将示例和参数说明添加到基本帮助显示中。
-Examples - 此参数仅用于显示名称，大纲和示例。
-Parameter - 此是仅显示给定参数的详细描述的参数。

示例

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

PS E:\xntutor.com\powershell> get-help get-item                                          
名称
    Get-Item

语法
    Get-Item [-Path] <string[]>  [<CommonParameters>]

    Get-Item  [<CommonParameters>]


别名
    gi


备注
    Get-Help 在此计算机上找不到该 cmdlet 的帮助文件。它仅显示部分帮助。
        -- 若要下载并安装包含此 cmdlet 的模块的帮助文件，请使用 Update-Help。
        -- 若要联机查看此 cmdlet 的帮助主题，请键入: "Get-Help Get-Item -Online" 或
           转到 https://go.microsoft.com/fwlink/?LinkID=113319。

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

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

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

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

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

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

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

PS E:\xntutor.com\powershell> get-help get-item -online                                  PS E:\xntutor.com\powershell>

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

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

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

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