Obtendo informações detalhadas da Ajuda

Para acessar a Ajuda sobre cmdlets do Windows PowerShell, use o cmdlet Get-Help. Por exemplo, para obter Ajuda sobre o cmdlet Get-ChildItem, digite:

get-help get-childitem

ou

get-childitem -?

Você pode até mesmo obter Ajuda sobre o cmdlet Get-Help. Por exemplo:

get-help get-help

Para obter uma lista de todos os tópicos da Ajuda de cmdlet na sua sessão, digite:

get-help -category cmdlet

Para exibir uma página de cada tópico da Ajuda por vez, use a função help ou seu alias man. Por exemplo, para exibir a Ajuda sobre o cmdlet Get-ChildItem, digite

man get-childitem

ou

help get-childitem

Para exibir informações detalhadas sobre um cmdlet, uma função ou um script, incluindo descrições de seus parâmetros e exemplos de seu uso, use o parâmetro Detailed do cmdlet Get-Help. Por exemplo, para obter informações detalhadas sobre o cmdlet Get-ChildItem, digite:

get-help get-childitem -detailed

Para exibir todo o conteúdo do tópico da Ajuda, use o parâmetro Full do cmdlet Get-Help. Por exemplo, para exibir todo o conteúdo do tópico da Ajuda sobre o cmdlet Get-ChildItem, digite:

get-help get-childitem -full

Para obter Ajuda detalhada sobre os parâmetros de um cmdlet, use o parâmetro Parameter do cmdlet Get-Help. Por exemplo, para obter Ajuda detalhada sobre todos os parâmetros do cmdlet Get-ChildItem, digite:

get-help get-childitem -parameter *

Para exibir apenas os exemplos de um tópico da Ajuda, use o parâmetro Example de Get-Help. Por exemplo, para exibir apenas os exemplos do tópico da Ajuda do cmdlet Get-ChildItem, digite:

get-help get-childitem -examples

Para obter informações sobre como escrever tópicos da Ajuda sobre os cmdlets criados por você, consulte o tópico "How to Write Cmdlet Help" (em inglês) no MSDN.

O cmdlet Get-Help também exibe informações sobre tópicos conceituais no Windows PowerShell, incluindo tópicos sobre o idioma do Windows PowerShell. Os tópicos conceituais da Ajuda começam com o prefixo "about_", como about_line_editing. (O nome do tópico conceitual deve ser digitado em inglês, até mesmo em versões do Windows PowerShell que não sejam em inglês.)

Para exibir uma lista de tópicos conceituais, digite:

get-help about_*

Para exibir um tópico da Ajuda específico, digite o nome do tópico, por exemplo:

get-help about_command_syntax

Os parâmetros de Get-Help, como Detailed, Parameter e Examples, não têm nenhum efeito sobre a exibição dos tópicos conceituais da Ajuda.

O cmdlet Get-Help exibe informações sobre os provedores do Windows PowerShell. Para obter Ajuda sobre um provedor, digite "Get-Help" seguido do nome do provedor. Por exemplo, para obter Ajuda sobre o provedor Registry, digite:

get-help registry

Para obter uma lista de todos os tópicos da Ajuda de provedor na sua sessão, digite

get-help -category provider

Os parâmetros de Get-Help, como Detailed, Parameter e Examples, não têm nenhum efeito sobre a exibição dos tópicos da Ajuda de provedor.

Muitos scripts e funções do Windows PowerShell têm tópicos da Ajuda. Use o cmdlet Get-Help para exibir os tópicos da Ajuda sobre scripts e funções.

Para exibir a Ajuda sobre uma função, digite "get-help" seguido do nome da função. Por exemplo, para obter Ajuda para a função Disable-PSRemoting, digite:

get-help disable-psremoting

Para exibir o Ajuda sobre um script, digite o caminho totalmente qualificado para o arquivo de script. Se o script estiver em um caminho listado na variável de ambiente Path, você poderá omiti-lo no comando.

Por exemplo, se você tiver um script chamado "TestScript.ps1" no diretório C:\PS-Test, para exibir o tópico da Ajuda sobre o script, digite:

get-help c:\ps-test\TestScript.ps1

Os parâmetros que foram criados para exibir a Ajuda de cmdlet, como Detailed, Full, Examples e Parameter, também funcionam para a Ajuda de script e função. Entretanto, quando você exibe toda a Ajuda, digitando "get-help * ", a Ajuda sobre funções e scripts não aparece.

Para obter informações sobre como escrever tópicos da Ajuda para funções e scripts, consulte about_Functions, about_Scripts e about_Comment_Based_Help.

Se você estiver conectado à Internet, uma das melhores maneiras de obter Ajuda será exibindo os tópicos da Ajuda online. Como os tópicos online são de fácil atualização, provavelmente eles fornecerão o conteúdo mais atual.

Para obter Ajuda online, tente o parâmetro Online do cmdlet Get-Help. O parâmetro Online do cmdlet Get-Help funciona somente para a Ajuda de cmdlet, função e script. Você não pode usar o parâmetro Online com tópicos conceituais (Sobre) ou tópicos da Ajuda de provedor. Além disso, como esse recurso é opcional, ele não funciona para todos os tópicos da Ajuda de cmdlet, função ou script.

No entanto, todos os tópicos da Ajuda fornecidos com o Windows PowerShell, incluindo os tópicos da Ajuda de provedor e os tópicos conceituais (Sobre), estão disponíveis online na seção Windows PowerShell da Microsoft TechNet Library.

Para usar o parâmetro Online do cmdlet Get-Help, use o formato de comando a seguir.

get-help <command-name> -online

Por exemplo, para obter a versão online do tópico da Ajuda sobre o cmdlet Get-ChildItem, digite:

get-help get-childitem -online

Se uma versão online do tópico da Ajuda estiver disponível, ela será aberta no navegador padrão.

Se houver suporte para um tópico da Ajuda na Ajuda online, você também poderá exibir o endereço na Internet (URL) do tópico. Esse endereço aparece na seção Links Relacionados de um tópico da Ajuda.

Por exemplo, para ver a URL da versão online do cmdlet Add-Computer, digite:

get-help add-computer

A primeira linha da seção Links Relacionados do tópico é mostrada abaixo.

Online version: https://go.microsoft.com/fwlink/?LinkID=135194

Para obter informações sobre como fornecer suporte online para os tópicos da Ajuda, consulte about_Comment_Based_Help e "How to Write Cmdlet Help" (em inglês) (https://go.microsoft.com/fwlink/?LinkID=123415) na biblioteca do MSDN (Microsoft Developer Network).