Get-Help 帮助信息

如下说明是翻译 PowerShell : help Get-Help 产生的帮助信息 .
译者 : Edengundam( 马涛 )
 
Get-Help
 
大纲
显示 Windows PowerShell cmdlets 和概念的相关信息 .
 
语法
Get-Help [[-name] <string>] [-component <string[]>] [-functionality <string[]>] [-role <string[]>] [-category <string[]>] [-full] [<CommonParameters>]
 
Get-Help [[-name] <string>] [-component <string[]>] [-functionality <string[]>] [-role <string[]>] [-category <string[]>] [-detailed] [<CommonParameters>]
 
Get-Help [[-name] <string>] [-component <string[]>] [-functionality <string[]>] [-role <string[]>] [-category <string[]>] [-examples] [<CommonParameters>]
 
Get-Help [[-name] <string>] [-component <string[]>] [-functionality <string[]>] [-role <string[]>] [-category <string[]>] [-parameter <string>] [<CommonParameters>]
 
详细描述
Get-Help cmdlet 显示 Windows PowerShell cmdlets 和概念的相关信息 . 你也可以使用 "Help {<cmdlet name> | <topic-name>" 或者 "<cmdlet-name> /?". "Help" 将会一次一个页面地显示帮助主题 . 然而 "/?" 在单一页上显示 cmdlet 的帮助 .
 
参数
 
-name <string>
请求指定 cmdlet 或概念主题的帮助信息 . <String> 表示 cmdlet 名称 , 例如 : Get-Member, 概念主题 , 例如 : "About_Object", 或者是别名 , 例如 : "ls". 允许使用通配符 . 参数名称 ("-Name") 为可选项 .
 
强制参数 ?
false
参数位置 ?
1
默认值
 
允许从管道绑定输入 ?
true ( 根据属性名 )
允许通配符扩展 ?
true
 
-component <string[]>
显示具有指定组件值的 cmdlet 列表 , 例如 : "Exchange." 核心 cmdlet 没有对应的组件属性值 .
 
强制参数 ?
false
参数位置 ?
named
默认值
 
允许从管道绑定输入 ?
false
允许通配符扩展 ?
false
 
-functionality <string[]>
显示具有指定功能的 cmdlet 帮助 . 核心 cmdlet 没有对应的功能属性值 .
 
强制参数 ?
false
参数位置 ?
named
默认值
 
允许从管道绑定输入 ?
false
允许通配符扩展 ?
false
 
-role <string[]>
为指定用户角色显示自定义帮助 . <String> 表示组织中扮演的角色 . 某些 cmdlet 将会个根据此参数值的不同显示不同的文本 . 此命令对于核心 cmdlet 没有作用 .
 
强制参数 ?
false
参数位置 ?
named
默认值
 
允许从管道绑定输入 ?
false
允许通配符扩展 ?
false
 
-category <string[]>
显示指定分类的帮助信息 .
<String> 的合法取值 :
 
·          Alias:    根据别名分类的 cmdlet 帮助 .
·          Cmdlet:  根据 cmdlet 名称分类的 cmdlet 帮助 .
·          HelpFile: 概念的帮助 ("About_" topics.)
 
强制参数 ?
false
参数位置 ?
named
默认值
 
允许从管道绑定输入 ?
false
允许通配符扩展 ?
false
 
-full <SwitchParameter>
显示 cmdlet 整个的帮助文件 , 包含了参数的技术性信息 . 当显示概念 ("About_") 帮助时 , 此参数无效 .
 
强制参数 ?
false
参数位置 ?
named
默认值
 
允许从管道绑定输入 ?
false
允许通配符扩展 ?
false
 
-detailed <SwitchParameter>
显示 cmdlet 的额外信息 , 包含参数描述信息 , cmdlet 的示例 . 当显示概念 ("About_") 帮助时 , 此参数无效 .
 
强制参数 ?
false
参数位置 ?
named
默认值
 
允许从管道绑定输入 ?
false
允许通配符扩展 ?
false
 
-examples <SwitchParameter>
显示使用此 cmdlet 的示例 . 这些示例包含在帮助的详细和完整视图中 . 此视图也包含了 cmdlet 的名称及其摘要描述 . 只显示示例 , 请键入 "(get-help <cmdlet-name>).examples".
 
强制参数 ?
false
参数位置 ?
named
默认值
 
允许从管道绑定输入 ?
false
允许通配符扩展 ?
false
 
-parameter <string>
显示指定参数的相信描述 . 这些描述包含在帮助的完整视图中 . 允许使用通配符 .
 
强制参数 ?
false
参数位置 ?
named
默认值
 
允许从管道绑定输入 ?
false
允许通配符扩展 ?
true
 
< 公共参数 >
此命令支持公共参数 : -Verbose, -Debug, -ErrorAction, -ErrorVariable, and -OutVariable. 更多信息 , 输入 , "get-help about_commonparameters".
 
返回类型
String, MamlCommandHelpInfo
 
注意
 
当不指定参数时 , "Get-Help" 显示 Windows PowerShell 帮助系统的帮助信息 .
 
当你指定单一的 cmdlet 或概念主题 , 例如 : "Get-Help Set-Item", Get-Help 将会显示该主题相关的帮助 . 当你指定了多个 cmdlet 或概念主题 , 例如 : "Get-Help *" or "Get-Help -Category HelpFile", Get-Help 将会显示匹配指定输入的 cmdlet 和主题列表 .
 
这里有 Get-Help 的三个变种 :
 
·          "Get-Help" 在一页上显示完整的帮助主题 .
·          "Help" 将帮助主题一次一页的显示 . 你可以对 Help 使用 Get-Help 的所有参数 . 语法为 : help {<cmdlet-name> | <topic-name>}<parameters>]
·          "-?" 显示 cmdlet 的基本信息 . 不允许使用通配符 , 不支持参数 . 你不能使用 "-?" 来显示概念主题 (about-*) 的帮助 . 语法为 : <cmdlet-name> -?
 
帮助的完整视图 (-full) 包含了关于参数信息的列表 . 表中包含了下面这些项 :
 
·          强制参数 指出此参数是必要的 (true) 或者可选的 (false).
·         位置 指出此参数是命名参数或位置参数 ( 编号的 ). 位置参数必须出现在命令的指定位置 .
·          "Named" 指出参数的名称是必须的 , 但是整个参数可以出现在命令的任何位置 .
·          <Number> 指出参数的名称是可选项 , 但是当名称被省略时 , 参数必须出现在指定的编号位置 . 例如 , "2" 指出当参数名称被省略后 , 参数必须出现在命令行中第二个位置 (2) 或者是唯一的非命名参数 .( 译注 : 这里并不完全 ) 当指定了参数名称 , 参数可以出现在命令的任意位置 .
·          默认值 : 如果在命令中你不包含此参数 , Windows PowerShell 使用此值作为默认值 .
·          允许从管道绑定输入 : 指定你可以 (true) 或不可以 (false) 通过管道向参数发送对象 . " 根据属性名称 " 意味着管道对象必须包含一个与参数同名的属性 .
·          接受通配符 : 指出参数值能够包含通配符 , 例如 : * ?.
 
1
 
C:/PS>get-help
 
此命令显示关于 Windows PowerShell 帮助系统的帮助 .
 
2
 
C:/PS>get-help *
 
此命令显示 Windows PowerShell 帮助系统的文件列表 .
 
3
 
C:/PS>get-help get-alias
 
C:/PS>help get-alias
 
C:/PS>get-alias -?
 
这些命令显示 get-alias cmdlet 的基本帮助信息 . "Get-Help" "-?" 命令在单独一页显示帮助信息 . 命令 "Help" 将会一次显示多页中的一页信息 .
 
4
 
C:/PS>get-help about_*
 
此命令显示 Windows PowerShell 中包含的概念主题列表 . 这些主题以字符 "about_" 开头 . 要显示特定的帮助文件 , 键入 "get-help <topic-name>, 例如 : "get-help about_signing".
 
5
 
C:/PS>get-help ls -detailed
 
此命令通过指定 Get-Childitem cmdlet 的一个别名 "ls" 来显示详细的帮助信息 . 参数 Detailed 请求显示帮助文件的详细视图 , 详细视图包含了参数描述和示例 . 要查看 cmdlet 帮助的完整视图 , 使用参数 Full.
 
6
 
C:/PS>get-help format-table -full
 
此命令显示 Format-Table cmdlet 帮助文件的完整视图 . 帮助的完整视图包括了参数描述 , 示例和参数技术细节的列表 .
 
7
 
C:/PS>get-help start-service -examples
 
此命令显示了在 Windows PowerShell 中使用 Start-Service 命令的示例 .
 
8
 
C:/PS>get-help get-childitem -parameter f*
 
此命令用来显示 Get-Childitem cmdlet 中以 "f" 开头 (filter and force) 的参数描述 . 要查看所有参数的描述 , 键入 "get-help get-childitem –parameter *".
 
9
 
C:/PS>(get-help write-output).syntax
 
此命令只显示 write-output cmdlet 的语法信息 . Syntax 是帮助对象上众多属性之一 ; 其他的还有 description, details, examples parameters. 要查看帮助对象上的所有属性和方法 , 键入 "get-help <cmdlet-name> | get-member", 例如 : "get-help start-service | get member".
 
相关链接
Get-Command
Get-PSDrive
Get-Member
 
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值