Como ler a sintaxe da documentação do PowerShell

Question

Eu poderia usar uma boa explicação da sintaxe de documentação do PowerShell:

> man Update-Help

SYNTAX
    Update-Help [[-Module] <string[]>] [[-SourcePath] <string[]>] [[-UICulture] <cultureinfo[]>] [-Recurse] [-Credential <pscredential>] [-UseDefaultCredentials] 
    [-Force]  [<CommonParameters>]

    Update-Help [[-Module] <string[]>] [[-UICulture] <cultureinfo[]>] [-LiteralPath <string[]>] [-Recurse] [-Credential <pscredential>] [-UseDefaultCredentials] 
    [-Force]  [<CommonParameters>]

Então eu tentei atualizar o homem:

> Update-Help Get-ChildItem

Erro:

Update-Help : No Windows PowerShell modules were found that match the following pattern: Get-ChildItem. Verify the pattern and then try the command again.At line:1 
char:1
+ Update-Help Get-ChildItem
+ ~~~~~~~~~~~~~~~~~~~~~~~~~
    + CategoryInfo          : InvalidArgument: (Get-ChildItem:String) [Update-Help], Exception
    + FullyQualifiedErrorId : ModuleNotFound,Microsoft.PowerShell.Commands.UpdateHelpCommand

Em particular, quero saber quais parâmetros são obrigatórios, quais são os tipos desses parâmetros e eles precisam vir em uma ordem específica?

    

Answer 1

man Update-Help

Primeiro, tenha em mente que man (realmente Get-Help) não mostrará a ajuda completa que está disponível para o commandlet por padrão. A saída básica, simplesmente não fornece o que você precisa de maneira fácil de ler.

Se você usar o Get-Help Update-Help -online ou Get-Help Update-Help -ShowWindow , obterá muito mais detalhes. Um bit de informação é uma listagem de cada parâmetro, sua posição (se eles podem ser usados sem o -param ), se for obrigatório, o valor padrão e assim por diante.

Você também pode obter detalhes sobre um parâmetro específico diretamente usando algo como Get-Help update-help -Parameter module .

A parte realmente útil de Get-Help na minha opinião é a seção de exemplos. %código%. Isso normalmente lhe dará vários exemplos de como usar o commandlet.

Como todos os documentos do PowerHell estão on-line, você pode fazer uma pesquisa no Google / Bing como get-help update-help -Examples para obter um link para o documentação on-line que está completa e é um pouco mais fácil de ler na minha opinião.

Update-Help Get-ChildItem

Isso falhou porque powershell update-help é um commandlet, não um módulo. Você poderia simplesmente fazer Get-ChildItem sem parâmetros e atualizaria tudo. Ou você pode encontrar o módulo do qual Update-Help é membro e atualizar esse módulo.

PS C:\users\public> get-command get-childitem

CommandType Name          Version Source
----------- ----          ------- ------
Cmdlet      Get-ChildItem 3.1.0.0 Microsoft.PowerShell.Management

PS C:\users\public> Update-Help -Module Microsoft.PowerShell.Management
PS C:\users\public>