完成本地帮助的更新和保存之后,我们就可以使用这些帮助了,在PowerShell中可以通过Get-Help命令来了解当前的命令如何执行。Get-Help Cmdlet 有个别名Help,我们也可以通过Help 命令来进行。Get-Help 提供多个命令执行帮助和命令帮助显示方式,可以满足大家在各种不同的模式下实现帮助的显示。接下来针对不同的参数提供的不同业务场景来给大家分享下Get-Help 的命令。
获取命令行的帮助有多种显示方式,你可以找到合适的方式获取命令帮助。
如果我们使用Get-Help 后面跟上命令的方式,结果数据将会以摘要方式显示命令帮助。图4.75所示为命令无参数帮助内容的显示,这里会显示一些基本的摘要信息,包含并且不限于如下内容:
· 命令名称
· 命令执行摘要
· 命令具体语法
· 命令具体说明
· 命令相关链接
· 命令备注信息
图4.75 无参数帮助内容显示
当使用Get-Help Cmdlet(命令)的时候带上Detailed 参数,则会在命令的帮助内容中显示如图4.76所示的具体信息,将包含名称、摘要、语法、说明、参数等信息。
图4.76 使用Detailed参数获取信息
在命令帮助中如果仅仅需要示例,就可以用命令跟上Examples 参数来实现命令的案例介绍。以New-Item 为例,可以得到使用New-Item的各类案例,使用Examples 参数将显示如图4.77所示的具体信息。
图4.77 案例帮助具体信息
在Get-Help 的参数中,Full参数将显示命令中的所有内容。它除显示参数和案例之外,同样也会显示命令的描述、输入输出数据类型和一些其他的内容。如果需要最为完整的命令使用帮助,使用如图4.78所示的Full参数即可实现,信息将包含名称、摘要、语法、说明、参数、案例、备注、相关链接、注释、输入、输出等信息。
图4.78 使用Full参数显示的具体数据
在执行PowerShell命令的过程中可能不知道当前的Cmdlet存在哪些参数问题,参数是强制类型还是可选类型,参数是否支持管道符,相信大家在第一时间拿到命令的时候都会很迷糊,就使用Get-Help-Full进行查找,但是Full开关的内容实在太多而找不到重点,这时Parameter参数就有它的用武之地了。当希望获取当前命令的参数时,可以利用Get-Help Cmdlet-Parameter*来获取所有当前Cmdlet的参数,图4.79所示为New-Item Cmdlet 拥有的所有参数类型详细定义,这里会列出所有参数信息。
图4.79 获取命令参数相关内容
如果希望获取当前特定的参数的相关介绍,可以通过Parameter参数设置特定的参数名称,图4.80所示为特定的参数获取。
图4.80 获取特定参数的设定
目前所有命令的帮助显示结果都是在PowerShell交互环境中显示,有些朋友觉得显示的内容非常不直观。PowerShell 预留了以窗口方式显示命令帮助的信息,这时可以调用窗口显示命令帮助信息,我们只需要在Get-Help Cmdlet 参数后面跟上ShowWindow 参数就可以了。参数显示的内容等同于执行命令跟上的Full Swith参数,图4.81所示为通过窗口显示帮助信息内容。
图4.81 获取命令帮助具体信息
在帮助内容的所有参数中,还有一个很特别的参数,就是以在线网页方式打开帮助文件。以网页显示帮助文件的内容与Full 开关相同,这里显示的内容是在微软的帮助文档库里面的。如果希望了解最新的命令,我们可以使用微软在线文档库查询Cmdlet的用法,在线文档库的内容都是最新的帮助内容,而本地帮助文档库如果没有使用Update-Help进行更新,则会一直保持前一次更新的帮助内容。使用在线文档库的方式显示帮助也非常简单,可以直接通过Switch参数online实现网页方式展示Cmdlet的帮助内容。图4.82所示为在线网页方式显示PowerShell 命令帮助内容。
图4.82 以网页方式显示命令帮助内容