Get-Help

Get-Help [-Full] [[-Name] <string>] [-Category <string[]>] [-Component <string[]>] [-Functionality <string[]>] [-Online] [-Path <string>] [-Role <string[]>] [<CommonParameters>]

Get-Help [-Detailed] [[-Name] <string>] [-Category <string[]>] [-Component <string[]>] [-Functionality <string[]>] [-Online] [-Path <string>] [-Role <string[]>] [<CommonParameters>]

Get-Help [-Ejemplos] [[-Name] <string>] [-Category <string[]>] [-Component <string[]>] [-Functionality <string[]>] [-Online] [-Path <string>] [-Role <string[]>] [<CommonParameters>]

Get-Help [-Parameter <string>] [[-Name] <string>] [-Category <string[]>] [-Component <string[]>] [-Functionality <string[]>] [-Online] [-Path <string>] [-Role <string[]>] [<CommonParameters>]

C:\PS>get-help

Descripción
-----------
Este comando muestra la Ayuda acerca del sistema de Ayuda de Windows PowerShell.

C:\PS>get-help *

Descripción
-----------
Este comando muestra una lista de todos los archivos del sistema de Ayuda de Windows PowerShell.

C:\PS>get-help get-alias

C:\PS>help get-alias

C:\PS>get-alias -?

Descripción
-----------
Estos comandos muestran información básica acerca del cmdlet get-alias. Los comandos "Get-Help" y "-?" muestran la información en una sola página. El comando "Help" muestra la información, página a página.

C:\PS>get-help about_*

Descripción
-----------
Este comando muestra una lista de los temas conceptuales incluidos en la Ayuda de Windows PowerShell. Todos estos temas comienzan por los caracteres "about_". Para mostrar un archivo de Ayuda concreto, escriba "get-help <nombreDeTema>", por ejemplo, "get-help about_signing".

C:\PS>get-help ls -detailed

Descripción
-----------
Este comando muestra la Ayuda detallada referente al cmdlet Get-ChildItem especificando uno de sus alias, "ls". El parámetro Detailed solicita la vista detallada del archivo de Ayuda, que incluye descripciones de parámetros y ejemplos. Para ver el archivo de Ayuda completo de un cmdlet, use el parámetro Full.

C:\PS>get-help format-string -full

Descripción
-----------
Este comando muestra la vista completa de la Ayuda del cmdlet Format-String. Esta vista completa de la Ayuda incluye descripciones, ejemplos y una tabla de información técnica acerca de los parámetros.

C:\PS>get-help start-service -examples

Descripción
-----------
Este comando muestra ejemplos del uso de start-service en comandos de Windows PowerShell.

C:\PS>get-help get-childitem -parameter f*

Descripción
-----------
Este comando muestra descripciones de los parámetros del cmdlet Get-ChildItem que empiezan por "f" (filter y force). Para obtener las descripciones de todos los parámetros, escriba "get-help get-childitem parameter*".

C:\PS>(get-help write-output).syntax

Descripción
-----------
Este comando muestra únicamente la sintaxis del cmdlet Write-Output. 

La sintaxis es una de muchas propiedades de los objetos de Ayuda, otras son la descripción, información detallada, ejemplos y parámetros. Para buscar todas las propiedades y métodos de los objetos de Ayuda, escriba "get-help <nombreDeCmdlet> | get-member", por ejemplo, "get-help start-service | get member".

C:\PS>(get-help trace-command).alertset

Descripción
-----------
Este comando muestra las notas acerca del cmdlet. Las notas se almacenan en la propiedad alertSet del objeto de ayuda.

Las notas incluyen información conceptual y sugerencias para utilizar el cmdlet. De forma predeterminada, las notas se muestran solamente cuando se utiliza el parámetro Full de Get-Help, pero también se pueden mostrar utilizando la propiedad alertSet.

C:\PS>get-help add-member -full | out-string -stream | select-string -pattern clixml

Descripción
-----------
En este ejemplo se muestra la forma de buscar una palabra en un tema de Ayuda de cmdlet concreto. Este comando busca la palabra "clixml" en la versión completa del tema de Ayuda referente al cmdlet Add-Member. 

Dado que el cmdlet Get-Help genera un objeto MamlCommandHelpInfo, no una cadena, se necesita utilizar un comando que transforme el contenido del tema de Ayuda en una cadena, como Out-String u Out-File.

C:\PS>get-help get-member -online

Descripción
-----------
Este comando muestra la versión en pantalla del tema de Ayuda referente al cmdlet Get-Member.

C:\PS>get-help remoting

Descripción
-----------
Este comando muestra una lista de temas que incluyen la palabra "remoting" (comunicación remota) en su contenido. 

Si escribe una palabra que no aparece en ningún título de temas, Get-Help mostrará una lista de temas que incluyen esa palabra.

C:\PS>get-help get-item -path SQLSERVER:\DataCollection

NAME
    Get-Item

SYNOPSIS
    Gets a collection of Server objects for the local computer and any computers to which you have made a SQL Server PowerShell connection.       
...

C:\PS> cd SQLSERVER:\DataCollection
C:\PS> SQLSERVER:\DataCollection> get-help get-item


NAME
    Get-Item

SYNOPSIS
    Gets a collection of Server objects for the local computer and any computers to which you have made a SQL Server PowerShell connection.       
...


C:\PS> Get-Item

NAME
    Get-Item

SYNOPSIS
    Gets the item at the specified location.

...

Descripción
-----------
En este ejemplo se muestra la forma de obtener ayuda para el cmdlet Get-Item que explica cómo se utiliza el cmdlet en el nodo DataCollection del proveedor SQL Server de Windows PowerShell.

En el ejemplo se muestran dos maneras de obtener ayuda personalizada para Get-Item. 

El primer comando utiliza el parámetro Path de Get-Help para especificar la ruta de acceso del proveedor. Este comando se puede escribir en cualquier ubicación de ruta de acceso.

El segundo comando utiliza el cmdlet Set-Location (alias = "cd") para ir a la ruta de acceso del proveedor. Desde esa ubicación, incluso sin el parámetro Path, el comando Get-Help obtiene la ayuda personalizada para la ruta de acceso del proveedor.

El tercer comando muestra ese comando Get-Help en una ruta de acceso al sistema de archivos y, sin el parámetro Path, obtiene la ayuda estándar para el cmdlet Get-Item.

C:\PS>get-help c:\ps-test\MyScript.ps1

Descripción
-----------
Este comando obtiene la Ayuda para el script MyScript.ps1. Para obtener información sobre cómo escribir ayuda para las funciones y los scripts, vea about_Comment_Based_Help.