In Windows PowerShell sono inclusi argomenti della Guida dettagliati in cui vengono illustrati i concetti e il linguaggio di Windows PowerShell. Sono inoltre disponibili argomenti della Guida per ogni cmdlet e provider, nonché per molte funzioni e script.

È possibile visualizzare questi argomenti della Guida al prompt dei comandi oppure accedere alle versioni più aggiornate nella Microsoft TechNet Library. In molti programmi che ospitano Windows PowerShell, ad esempio Windows PowerShell Integrated Scripting Environment, vengono fornite ulteriori funzionalità della Guida, ad esempio la Guida sensibile al contesto e il file della Guida compilato (con estensione chm).

Visualizzazione della Guida relativa ai cmdlet

Per visualizzare la Guida relativa ai cmdlet di Windows PowerShell, utilizzare il cmdlet Get-Help. Ad esempio, per visualizzare la Guida per il cmdlet Get-ChildItem, digitare:

get-help get-childitem

oppure

get-childitem -?

È anche possibile visualizzare la Guida sul cmdlet Get-Help. Ad esempio:

get-help get-help

Per ottenere un elenco di tutti gli argomenti della Guida relativi ai cmdlet nella sessione, digitare:

get-help -category cmdlet

Per visualizzare una pagina alla volta di ogni argomento della Guida, utilizzare la funzione help o il relativo alias man. Ad esempio, per visualizzare la Guida per il cmdlet Get-ChildItem, digitare:

man get-childitem

oppure

help get-childitem

Per visualizzare informazioni dettagliate su un cmdlet, una funzione o uno script, incluse le descrizioni dei relativi parametri ed esempi del loro utilizzo, utilizzare il parametro Detailed del cmdlet Get-Help. Ad esempio, per ottenere informazioni dettagliate sul cmdlet Get-ChildItem, digitare:

get-help get-childitem -detailed

Per visualizzare tutto il contenuto dell'argomento della Guida, utilizzare il parametro Full del cmdlet Get-Help. Ad esempio, per visualizzare tutto il contenuto dell'argomento della Guida per il cmdlet Get-ChildItem, digitare:

get-help get-childitem -full

Per ottenere informazioni della Guida dettagliate sui parametri di un cmdlet, utilizzare il parametro Parameter del cmdlet Get-Help. Ad esempio, per ottenere informazioni dettagliate su tutti i parametri del cmdlet Get-ChildItem, digitare:

get-help get-childitem -parameter *

Per visualizzare solo gli esempi presenti in un argomento della Guida, utilizzare il parametro Example di Get-Help. Ad esempio, per visualizzare solo gli esempi dell'argomento della Guida per il cmdlet Get-ChildItem, digitare:

get-help get-childitem -examples

Per informazioni sulla modalità di scrittura di argomenti della Guida relativi ai cmdlet, vedere l'argomento relativo alla modalità di scrittura della Guida del cmdlet in MSDN.

Visualizzazione della Guida concettuale

Mediante il cmdlet Get-Help vengono inoltre visualizzate informazioni sugli argomenti concettuali in Windows PowerShell, inclusi quelli relativi al linguaggio di Windows PowerShell. Gli argomenti concettuali iniziano con il prefisso "about_", ad esempio about_line_editing. Il nome dell'argomento concettuale deve essere immesso in inglese, anche nelle versioni di Windows PowerShell non in lingua inglese.

Per visualizzare l'elenco degli argomenti dedicati ai concetti, digitare:

get-help about_*

Per visualizzare un determinato argomento della Guida, digitarne il nome, ad esempio:

get-help about_command_syntax

I parametri di Get-Help, ad esempio Detailed, Parameter e Examples, non influiscono sulla visualizzazione degli argomenti della Guida concettuale.

Visualizzazione della Guida sui provider

Il cmdlet Get-Help visualizza informazioni sui provider di Windows PowerShell. Per visualizzare la Guida per un provider, digitare "Get-Help" seguito dal nome del provider. Ad esempio, per ottenere l'argomento della Guida relativo al provider Registry, digitare:

get-help registry

Per ottenere un elenco di tutti gli argomenti della Guida relativi ai provider nella sessione, digitare:

get-help -category provider

I parametri di Get-Help, ad esempio Detailed, Parameter e Examples, non influiscono sulla visualizzazione degli argomenti della Guida relativi ai provider.

Visualizzazione della Guida relativa a script e funzioni

Sono disponibili argomenti della Guida relativi a numerosi script e funzioni. Utilizzare il cmdlet Get-Help per visualizzare gli argomenti della Guida relativi a script e funzioni.

Per visualizzare la Guida relativa a una funzione, digitare "get-help" seguito dal nome della funzione. Ad esempio, per visualizzare la Guida per la funzione Disable-PSRemoting, digitare:

get-help disable-psremoting

Per visualizzare la Guida relativa a uno script, digitare il percorso completo del file di script. Se lo script si trova in un percorso elencato nella variabile di ambiente Path, è possibile omettere il percorso dal comando.

Ad esempio, se si dispone di uno script denominato "TestScript.ps1" nella directory C:\PS-Test, per visualizzare il relativo argomento della Guida, digitare:

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

I parametri progettati per la visualizzazione della Guida relativa ai cmdlet, ad esempio Detailed, Full, Examples e Parameter, possono anche essere utilizzati per la Guida di script e funzioni. Tuttavia, quando si visualizza la Guida per intero digitando "get-help *", la Guida relativa alle funzioni e agli script non viene visualizzata.

Per informazioni sulla modalità di scrittura degli argomenti della Guida per funzioni e script, vedere about_Functions, about_Scripts e about_Comment_Based_Help.

Visualizzazione della Guida online

Se si dispone di connessione Internet, uno dei modi migliori per visualizzare la Guida consiste nel visualizzare gli argomenti online. Poiché gli argomenti online possono essere aggiornati con facilità, è probabile che contengano le informazioni più recenti.

Per visualizzare la Guida online, provare il parametro Online del cmdlet Get-Help. Il parametro Online del cmdlet Get-Help funziona unicamente per la Guida relativa a cmdlet, funzioni e script. Non è possibile utilizzare il parametro Online con argomenti concettuali (About) o argomenti della Guida relativa ai provider. Poiché questa funzionalità è facoltativa, non funziona necessariamente per ogni argomento della Guida relativa a cmdlet, funzioni o script.

Tuttavia, tutti gli argomenti della Guida forniti con Windows PowerShell, inclusi quelli della Guida relativa ai provider e gli argomenti concettuali (About), sono disponibili online nella sezione Windows PowerShell della Microsoft TechNet Library.

Per utilizzare il parametro Online del cmdlet Get-Help, utilizzare il formato di comando seguente.

get-help <command-name> -online

Ad esempio, per visualizzare la versione online dell'argomento della Guida relativo al cmdlet Get-ChildItem, digitare.

get-help get-childitem -online

La versione online eventualmente disponibile dell'argomento della Guida verrà visualizzata nel browser predefinito.

Se per un argomento della Guida è disponibile una versione online, è possibile visualizzare l'indirizzo Internet (URL) relativo. L'indirizzo Internet viene visualizzato nella sezione Collegamenti correlati di un argomento della Guida.

Ad esempio, per visualizzare l'URL per la versione online del cmdlet Add-Computer, digitare:

get-help add-computer

Di seguito è riportata la prima riga della sezione Collegamenti correlati dell'argomento.

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

Per informazioni su come fornire supporto online per gli argomenti della Guida, vedere about_Comment_Based_Help e l'articolo relativo alla modalità di scrittura della Guida relativa ai cmdlet (https://go.microsoft.com/fwlink/?LinkID=123415) in MSDN (Microsoft Developer Network) Library (le informazioni potrebbero essere in lingua inglese).

Vedere anche




Argomenti della Guida