Windows PowerShell inclut des rubriques d'aide détaillées qui expliquent les concepts et le langage Windows PowerShell. Il existe également des rubriques d'aide pour chaque applet de commande et fournisseur, ainsi que des rubriques d'aide pour de nombreux scripts et fonctions.

Vous pouvez afficher ces rubriques d'aide à l'invite de commandes ou afficher les versions mises à jour les plus récentes de ces rubriques dans la bibliothèque TechNet de Microsoft. De nombreux programmes qui hébergent Windows PowerShell, tels que l'environnement d'écriture de scripts intégré Windows PowerShell Integrated Scripting Environment, proposent des fonctions d'aide supplémentaires, telles que l'aide contextuelle et un fichier d'aide compilé (.chm).

Obtention d'aide sur les applets de commande

Pour obtenir de l'aide sur les applets de commande Windows PowerShell, utilisez l'applet de commande Get-Help. Par exemple, pour obtenir de l'aide sur l'applet de commande Get-ChildItem, tapez :

get-help get-childitem

ou

get-childitem -?

Vous pouvez même obtenir de l'aide sur l'applet de commande Get-Help. Par exemple :

get-help get-help

Pour obtenir une liste de toutes les rubriques d'aide de l'applet de commande de votre session, tapez :

get-help -category cmdlet

Pour afficher une page de chaque rubrique d'aide à la fois, utilisez la fonction help ou son alias man. Par exemple, pour afficher l'aide de l'applet de commande Get-ChildItem, tapez :

man get-childitem

ou

help get-childitem

Pour afficher les informations détaillées à propos d'une applet de commande, d'une fonction ou d'un script, notamment les descriptions de ses paramètres et des exemples de son utilisation, utilisez le paramètre Detailed de l'applet de commande Get-Help. Par exemple, pour obtenir des informations détaillées sur l'applet de commande Get-ChildItem, tapez :

get-help get-childitem -detailed

Pour afficher tout le contenu de la rubrique d'aide, utilisez le paramètre Full de l'applet de commande Get-Help. Par exemple, pour afficher tout le contenu dans la rubrique d'aide de l'applet de commande Get-ChildItem, tapez :

get-help get-childitem -full

Pour obtenir l'aide détaillée relative aux paramètres d'une applet de commande, utilisez le paramètre Parameter de l'applet de commande Get-Help. Par exemple, pour obtenir l'aide détaillée relative à tous les paramètres de l'applet de commande Get-ChildItem, tapez :

get-help get-childitem -parameter *

Pour afficher uniquement les exemples d'une rubrique d'aide, utilisez le paramètre Example de Get-Help. Par exemple, pour afficher uniquement les exemples de la rubrique d'aide de l'applet de commande Get-ChildItem, tapez :

get-help get-childitem -examples

Pour plus d'informations sur la rédaction de rubriques d'aide pour les applets de commande que vous écrivez, consultez la rubrique « How to Write Cmdlet Help » (en anglais) dans MSDN.

Obtention d'aide conceptuelle

L'applet de commande Get-Help affiche également des informations relatives aux rubriques conceptuelles de Windows PowerShell, notamment les rubriques traitant du langage Windows PowerShell. Les rubriques d'aide contextuelle commencent par le préfixe « about_ », par exemple about_line_editing. (Le nom de la rubrique contextuelle doit être entré en anglais, même pour les versions non anglaises de Windows PowerShell.)

Pour afficher la liste des rubriques conceptuelles, tapez :

get-help about_*

Pour afficher une rubrique d'aide particulière, tapez son nom, par exemple :

get-help about_command_syntax

Les paramètres de Get-Help, tels que Detailed, Parameter et Examples, sont sans effet sur l'affichage des rubriques d'aide contextuelle.

Obtention d'aide sur les fournisseurs

L'applet de commande Get-Help affiche des informations sur les fournisseurs Windows PowerShell. Pour obtenir de l'aide sur un fournisseur, tapez « Get-Help », suivi du nom du fournisseur. Par exemple, pour obtenir de l'aide sur le fournisseur de Registre, tapez :

get-help registry

Pour obtenir une liste de toutes les rubriques d'aide relatives au fournisseur de votre session, tapez :

get-help -category provider

Les paramètres de Get-Help, tels que Detailed, Parameter et Examples, sont sans effet sur l'affichage des rubriques d'aide relatives aux fournisseurs.

Obtention d'aide sur les scripts et les fonctions

De nombreux scripts et fonctions de Windows PowerShell proposent des rubriques d'aide. Utilisez l'applet de commande Get-Help pour afficher les rubriques d'aide relatives aux scripts et aux fonctions.

Pour afficher l'aide d'une fonction, tapez « get-help », suivi du nom de la fonction. Par exemple, pour obtenir de l'aide sur la fonction Disable-PSRemoting, tapez :

get-help disable-psremoting

Pour afficher l'aide d'un script, tapez le chemin d'accès complet au fichier de script. Si le script se trouve dans un chemin d'accès répertorié dans la variable d'environnement Path, vous pouvez omettre le chemin d'accès de la commande.

Par exemple, si vous avez un script appelé « TestScript.ps1 » dans votre répertoire C:\ps-test, pour afficher la rubrique d'aide du script, tapez :

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

Les paramètres conçus pour afficher l'aide des applets de commande, tels que Detailed, Full, Examples et Parameter, fonctionnent également pour l'aide des scripts et des fonctions. Toutefois, lorsque vous affichez toute l'aide en tapant « get-help * », l'aide des fonctions et des scripts n'apparaît pas.

Pour plus d'informations sur l'écriture de rubriques d'aide pour vos fonctions et scripts, consultez about_Functions, about_Scripts et about_Comment_Based_Help.

Obtention de l'aide en ligne

Si vous êtes connecté à Internet, l'une des meilleures méthodes pour obtenir de l'aide consiste à consulter les rubriques d'aide en ligne. Étant donné que les rubriques en ligne sont faciles à mettre à jour, elles sont plus susceptibles de vous fournir du contenu actualisé.

Pour obtenir l'Aide en ligne, essayez le paramètre Online de l'applet de commande Get-Help. Le paramètre Online de l'applet de commande Get-Help fonctionne uniquement pour l'aide des applets de commande, des fonctions et des scripts. Vous ne pouvez pas utiliser le paramètre Online avec les rubriques d'aide conceptuelle (À propos de) ou les rubriques d'aide relatives aux fournisseurs. En outre, étant donné que cette fonctionnalité est facultative, elle ne fonctionne pas pour l'intégralité des rubriques d'aide relatives aux applets de commande, fonctions et scripts.

Toutefois, toutes les rubriques d'aide fournies avec Windows PowerShell, notamment les rubriques d'aide sur les fournisseurs et les rubriques d'aide contextuelle (À propos de), sont disponibles en ligne dans la section Windows PowerShell de la bibliothèque TechNet de Microsoft.

Pour utiliser le paramètre Online de l'applet de commande Get-Help, utilisez le format de commande suivant.

get-help <command-name> -online

Par exemple, pour obtenir la version en ligne de la rubrique d'aide relative à l'applet de commande Get-ChildItem, tapez :

get-help get-childitem -online

Si une version en ligne de la rubrique d'aide est disponible, elle s'ouvrira dans votre navigateur par défaut.

Si l'Aide en ligne est prise en charge pour une rubrique d'aide, vous pouvez également voir l'adresse Internet (URL) de la rubrique en question. L'adresse Internet apparaît dans la section Liens connexes d'une rubrique d'aide.

Par exemple, pour consulter l'URL de la version en ligne de l'applet de commande Add-Computer, tapez :

get-help add-computer

La première ligne de la section Liens connexes de la rubrique est présentée ci-dessous.

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

Pour plus d'informations sur la fourniture de support en ligne pour vos rubriques d'aide, consultez about_Comment_Based_Help, ainsi que la rubrique « How to Write Cmdlet Help » (en anglais) (https://go.microsoft.com/fwlink/?LinkID=123415) de la bibliothèque MSDN (Microsoft Developer Network).

Voir aussi




Table des matières