. Crie um PowerShell 3.0 sistema de ajuda facilmente acessível - Tudo Sobre Tecnologia

Faça ajuda para PowerShell mais acessível com um método concebido para extrair e rastreamento de informações no sistema built-in. 
PSHlp_Intro_Image_9-16-2013.png


Se você estiver usando ou estão apenas começando a usar o PowerShell, as chances são de que você já esteve em algumas expedições Google para aprender a usar os vários comandos disponíveis no PowerShell. Enquanto isso é tudo muito bem, você deve saber que PowerShell em si é repleta de Ajuda muito detalhado que pode realmente ser útil como você descobrir como colocar PowerShell para trabalhar.
Por exemplo, o Amparo no PowerShell fornece descrições detalhadas e sintaxe para cada comando e inclui exemplos, bem como links para mais fontes de informação. No entanto, toda esta informação está trancado em interface de linha de comando do PowerShell. Felizmente, criaram um sistema para extrair e manter o controle das informações embalado em PowerShell, tornando-o mais acessível. Vamos dar uma olhada mais de perto.

Visão global

Na minha técnica de sistema de Ajuda PowerShell, você vai ser basicamente a criação de um conjunto de arquivos de texto especialmente nomeados em uma pasta. Com o formato de nomenclatura especial eu vou lhe mostrar, todos os seus arquivos serão organizados de tal forma que eles são fáceis de acompanhar, tornando assim mais fácil para encontrar exatamente o que você está procurando quando você precisar de ajuda.
Tenha em mente que este sistema é projetado para ser criado em uma base necessária. Você realmente não vai querer sentar e criar arquivos de ajuda para cada comando único em PowerShell ao mesmo tempo. Em outras palavras, você vai querer criar um arquivo de ajuda quando você está investigando e usando um comando para uma tarefa específica. Dessa forma, quando você está trabalhando com o comando agora e no futuro, o arquivo de Ajuda estará prontamente disponível.

Preparação

Antes de começarmos, há duas coisas que você precisa fazer para se preparar para o seu sistema de Ajuda PowerShell. A primeira coisa que você precisa fazer é criar uma pasta na qual deseja armazenar seus arquivos. No meu sistema exemplo, eu criei uma pasta chamada PowerShell no diretório raiz do drive C. Se o fizer, irá torná-lo mais fácil de trabalhar a partir da linha de comando, desde que você não terá que lidar com nomes de caminhos longos.
A segunda coisa que você precisa fazer é certificar-se de que a versão de linha de comando interno do sistema de ajuda PowerShell é atual. Para fazer isso, navegue até a pasta PowerShell no File Explorer. Abra o menu Arquivo no Gerenciador de Arquivos e selecione Abrir o Windows PowerShell | Abra o Windows PowerShell como administrador, como mostrado na Figura A. É claro que você vai ter que lidar com o prompt do UAC.

Figura A


PSHlp Fig a.png

Você vai precisar para abrir PowerShell como um administrador.
Uma vez que você está no PowerShell prompt, digite update-Ajuda e pressione enter. Quando o fizer, PowerShell vai baixar os novos arquivos de ajuda para os comandos do PowerShell e, em seguida, instalá-los em seu computador, como mostrado na Figura B. Vai demorar alguns minutos para o download e instalação do processo ocorra.

Figura B


PSHlp Fig b.png

Você pode baixar e instalar os novos arquivos de ajuda para PowerShell.

Construa uma lista de módulos

PowerShell está literalmente repleto de comandos em forma de cmdlets, scripts e funções. É por isso que eu sugiro que você começar a criar o seu sistema de Ajuda do PowerShell com uma lista dos módulos instalados. Você pode pensar em módulos como recipientes categóricas de comandos. Ao começar com uma lista de recipientes categóricas, vai mais facilmente ser capaz de encontrar o comando específico que você está procurando.
Para criar uma lista de módulos em PowerShell, digite a seguinte linha de comando no prompt PowerShell:
Get-Module-ListAvailable | Format-Table Name, ModuleType> A_List_of_Modules.txt
Se quebrar essa linha de comando para baixo em suas três partes, vamos ver que a parte principal desta linha de comando lista todos os módulos disponíveis.
Get-Module-ListAvailable
Esta lista é então canalizada para um cmdlet formatação que coloca a lista em uma tabela.
| Format-Table Name, ModuleType
A tabela formatada é então redirecionado para um arquivo de texto.
> A_List_of_Modules.txt

Obter uma lista de comandos em um módulo

Uma vez que você tem uma lista de todos os módulos disponíveis, você pode escolher o módulo que você está interessado em descobrir o que os comandos estão nesse módulo.Para fazer isso, você vai digitar o seguinte comando no prompt de PowerShell:
Get-Command-Module {module-name} |. Format-Table Name, CommandType> Commands_in_ {module-name} txt
Onde {module-name} é o nome do módulo que você está interessado polegadas
Se quebrar essa linha de comando para baixo em suas três partes, vamos ver que a parte principal desta linha de comando lista todos os comandos no módulo.
Get-Command-Module {module-name}
Esta lista é então canalizada para um cmdlet formatação que coloca a lista em uma tabela.
| Format-Table Name, CommandType
A tabela formatada é então redirecionado para um arquivo de texto.
> Commands_in_ {module-name}. Txt

Criar o arquivo de Ajuda

Uma vez que você tem uma lista de todos os comandos em um módulo, você pode escolher o comando que você está interessado e gerar o arquivo de ajuda baseado em texto. Para fazer isso, você vai digitar o seguinte comando no prompt de PowerShell:
Get-Help-name {comando}> Help_for_ {command-name}. Txt
Onde {nome-do-comando} é o nome do comando que você está interessado polegadas
Se quebrar essa linha de comando para baixo em suas duas partes, vamos ver que a parte principal desta linha de comando acessa o conteúdo da Ajuda.
Get-Help-name {comando}
Esse conteúdo é então redirecionado para um arquivo de texto.
> Help_for_ {command-name}. Txt

Os resultados

Depois de ter criado alguns destes arquivos em sua pasta PowerShell, você vai começar a ver como a convenção de nomenclatura de arquivo irá organizar o seu sistema de Ajuda do PowerShell. Como você pode ver na figura C, a lista de módulos estarão no topo da pasta, a lista de comandos nos módulos será o próximo, ea ajuda para cada comando será na parte inferior.

Figura C


PSHlp Fig C.png

Meu arquivo convenção de nomenclatura mantém os arquivos bem organizados na pasta.
Quando você abre um arquivo de ajuda no bloco de notas ou WordPad, como mostrado na Figura D, você vai ver que cada arquivo de Ajuda contém seis seções de informações sobre o comando.
  • Nome
  • Sinopse
  • Sintaxe
  • Descrição
  • Links Relacionados
  • Observações

Figura D


PSHlp Fig D.png

Um arquivo de Ajuda aberto no WordPad.
As quatro primeiras seções fornecem informações muito básicas e são auto-explicativas, no entanto, as duas últimas seções oferecer mais assistência. Na seção Links, você vai encontrar uma lista de comandos relacionados que podem ajudá-lo a zero sobre a operação que você está tentando fazer uso.
A seção de comentários é de particular importância, uma vez que irá dizer-lhe como obter ainda mais informações sobre o comando. Por exemplo, você vai descobrir como obter exemplos do comando a ser utilizado, bem comFo a forma de obter informações mais detalhadas sobre o comando. Você também vai ver que você pode acessar a versão on-line de ajuda para um comando específico. (Tenha em mente que nem todos os comandos têm ajuda on-line que pode ser acessado a partir da linha de comando PowerShell.)
Usando esta técnica, agora você pode construir seu próprio sistema de ajuda, mais facilmente acessível, PowerShell.
Autor:

Sobre Greg Shultz

Greg Shultz é um escritor técnico freelance. Anteriormente, ele trabalhou como Documentação Especialista na indústria de software, um Especialista em Suporte Técnico no setor educacional, e um jornalista Técnico em indústria editorial do computador.

0 comentários Goocle+ 0 Facebook

Postar um comentário

 
Tudo Sobre Tecnologia © 2013-2020. Todos os direitos reservados. Tudo Sobre Tecnologia. Desenvolvido por TST
Topo