Powershell – 3 – Obtener ayuda

La ayuda es muy importante en el mundo en el que nos movemos y Windows Powershell tiene un buen sistema de ayuda a la vez que sencillo.

Vamos a ver como obtener ayuda en este entorno.

3.1- El cmdlet get-help

El commmandlet que Powershell pone a nuestra disposicion para obtener ayuda es: «get-help«.

Si introducimos «get-help» en la consola de Powershell, nos mostrara un resumen de la utilizacion de este cmdlet.

Podemos probarlo:

Esto es un resumen del commandlet «get-help«, si queremos que la ayuda este un poco mas detallada utilizaremos el parametro «-detailed» de la siguiente forma:

> get-help -detailed

o

> get-help -detailed get-help

En el commandlet anterior podemos identificar tres partes. Primero el commandlet «get-help» que es el comando en si. Despues el parametro «-detailed» que lo que hace es modificar la salida de «get-help» y en este caso lo que hace es darnos una version de la ayuda mas detallada con informacion adicional. Añadiendo este parametro podemos obtener un resultado mas amplio que si no lo utilizamos.

Y despues de «-detailed» escribimos el argumento, que es de lo que queremos obtener ayuda. En este caso queremos obtener ayuda del cmdlet «get-help«. Si no lo ponemos nos dará ayuda de la ayuda, que es lo mismo.

Para comparar el resultado de «get-help» con y sin el parametro «-detailed» podemos hacer la prueba. Antes lo hemos hecho sin detailed, pues ahora lo vamos a hacer con el:

Observamos que en este ultimo caso, la ayuda es bastante mas completa. You suelo utilizar siempre el parametro «-detailed«.

Como ultima parte del commandlet «get-help» debemos añadir el cmdlet o concepto del que queremos ayuda. En el ejemplo que hemos visto antes, le hemos indicado que queriamos ayuda precisamente del comando «get-help» (get-help -detailed get-help«).

No, no me he equivocado. Ademas de poder obtener ayuda de los diferentes commandlets de Windows Powershell, tambien podemos hacerlo con conceptos diferentes a comandos. Por ejemplo, para obtener ayuda sobre los operadores aritmeticos en Windows Powershell  pondremos:

> Get-help about_arithmetic_operators

3.2- Parametros de Get-help.

Tenemos disponibles varios parametros para usar junto con el cmdlet «get-help». Los mas insteresantes pueden ser:

-name <String>

Muestra ayuda sobre un tema conceptual o cmdlet que le especifiquemos. <String> representa el nombre de un cmdlet o un concepto. Se premite el uso de caracteres comodin. Este parametro es opcional, Esto quiere decir que si queremos indicarlo lo haremos y sino, pues no.

ejemplo:  get-help -name get-command (muestra ayuda del cmdlet «get-command»

-detailed <SwitchParameter>

Este ya lo hemos visto antes. Muestra informacion adicional.

-examples <SwithcParameter>

Muestra unicamente el apartado de ejemplos de la ayuda de un cmdlet o concepto. Este apartado de la ayuda de Powershell es muy interesante a la vez que util.

ejemplo: get-help -examples get-help (muestra los ejemplos de la ayuda del cmdlet «get-help«)

-full <SwitchParameter>

Muestra la ayuda completa de un cmdlet.

Hay varios parametros mas diponibles pero para hacernos una idea nos vale de momento con estos. De todas formas, como ya he comentado antes, podemos obtener informacion sobre el comando «get-help» de la siguiente forma:  get-help -detailed get-help.

3.3- Otras formas de obtener ayuda.

En este apartado, solo comentar las funciones: help y man. Ya veremos mas adelante lo que son las funciones y los Alias, pero por ahora nos quedamos con que existen y si queremos podemos probarlas:

> man

> help

Tambien disponemos de ayuda en forma de ficheros de texto en el directorio en el que esta instalado Windows Powershell que normalmente es: %windir%\system32\windows powershell\1.0\

Ahora deberiamos tener un poco mas claro el tema de como obtener ayuda en Windows Powershell.

De todas formas, ya sabeis, si teneis alguna duda sobre este u otro tema que se trata en este blog, pedeis enviarme un e-mail a: oscar(arroba)aprendeinformaticaconmigo.com

Venga, a pasarlo bien y nos vemos en el proximo articulo.

Otros articulos sobre Powershell:

——
Oscar Abad
http://www.xulak.com – Consultoría informática