O cmdlet Get-Help é uma ferramenta útil para conhecer o Windows PowerShell. É possível aprender a usar o Windows PowerShell lendo as descrições dos cmdlets, aprendendo sobre os conceitos e explorando os tópicos de linguagem.
O primeiro tópico de interesse talvez seja o próprio sistema de Ajuda. Para exibir informações sobre o sistema de Ajuda no Windows PowerShell, digite:
get-help
Em seguida, talvez você esteja interessado em conhecer alguns dos cmdlets básicos, como Get-Help, Get-Command, Get-Process, Get-Service e Get-Eventlog.
Para mostrar a exibição mais simples da Ajuda de um cmdlet, digite "get-help" seguido do nome do cmdlet. Por exemplo, para obter Ajuda sobre o cmdlet Get-Command, digite:
get-help get-command
Se a Ajuda do cmdlet não estiver formatada corretamente, ou seja, se iniciar com marcas XMLNS, a diretiva de execução do Windows PowerShell no seu sistema talvez tenha impedido o carregamento do arquivo de configuração que formata a Ajuda do cmdlet. Para obter mais informações sobre diretivas de execução, digite:
get-help about_execution_policies
Para exibir a Ajuda detalhada de um cmdlet, inclusive descrições de parâmetros e exemplos, use o parâmetro Detailed de Get-Help. Por exemplo, para obter Ajuda detalhada sobre o cmdlet Get-Command, digite:
get-help get-command -detailed
Para exibir toda a Ajuda disponível para um cmdlet, inclusive informações técnicas sobre o cmdlet e seus parâmetros, use o parâmetro Full. Por exemplo, para obter Ajuda completa sobre o cmdlet Get-Command, digite:
get-help get-command -full
É possível também exibir partes selecionadas do arquivo de Ajuda. Para ver apenas os exemplos, use o parâmetro Examples. Por exemplo, para exibir os exemplos do cmdlet Get-Command, digite:
get-help get-command -examples
Para ver apenas as descrições detalhadas de parâmetros, use o parâmetro Parameter de Get-Help. É possível especificar o nome de um parâmetro ou usar o caractere curinga (*) para especificar todos os parâmetros. Por exemplo, para ver uma descrição do parâmetro TotalCount de Get-Command, digite:
get-help get-command -parameter totalcount
Para ver todos os parâmetros do cmdlet Get-Command, digite:
get-help get-command -parameter *
A Ajuda do Windows PowerShell também está disponível online na Microsoft TechNet Library, no tópico
No Windows PowerShell v.2, você pode usar o parâmetro Online do cmdlet Get-Help para exibir a versão online do tópico da Ajuda de um cmdlet. Por padrão, o parâmetro Online está vinculado aos tópicos da Ajuda da TechNet Library.
Por exemplo, para abrir a versão online do tópico da Ajuda do cmdlet Get-Process, digite:
get-help get-process -online
É possível também usar uma das funções do Windows PowerShell que chamam o Get-Help. A função Help exibe uma tela de Ajuda por vez. A função Man exibe Ajuda semelhante às páginas Man no UNIX. Para usar as funções Help e Man para exibir a Ajuda do cmdlet Get-Command, digite:
man get-command
ou
help get-command
Quando você solicitar um tópico da Ajuda específico, Get-Help exibirá o conteúdo do tópico, mas quando você usar caracteres curinga para solicitar mais de um tópico, o Get-Help exibirá uma lista de tópicos. Por exemplo, para ver uma lista de tópicos da Ajuda para os cmdlets "Get", digite:
get-help get-*
Os tópicos da Ajuda que explicam conceitos no Windows PowerShell começam com "about_". Para exibir Ajuda sobre um conceito do Windows PowerShell, digite "get-help" seguido do nome do conceito. (O nome do conceito deve ser digitado em inglês, até mesmo em versões do Windows PowerShell que não sejam em inglês.)
Por exemplo, para obter Ajuda sobre caracteres curingas, digite:
get-help about_wildcards
Para exibir uma lista de todos os tópicos da Ajuda conceitual no Windows PowerShell, digite:
get-help about_*
Lendo os tópicos da Ajuda e experimentando os exemplos, você aprenderá a usar o Windows PowerShell.
See Also