Windows PowerShell enthält ausführliche Hilfethemen, in denen die Begriffe und die Sprache von Windows PowerShell erläutert werden. Zudem sind Hilfethemen zu den einzelnen Cmdlets und Anbietern sowie zu vielen Funktionen und Skripts verfügbar.
Diese Hilfethemen können Sie an der Eingabeaufforderung oder als jeweils aktuelle Version in der Microsoft TechNet-Bibliothek anzeigen. Zahlreiche Programme, die Windows PowerShell hosten, z. B. Windows PowerShell ISE (Integrated Scripting Environment), bieten zusätzliche Hilfefeatures, z. B. kontextbezogene Hilfe und kompilierte Hilfedateien (".chm").
Aufrufen von Hilfe für Cmdlets
Hilfe zu Windows PowerShell-Cmdlets erhalten Sie mit dem Cmdlet Get-Help. Hilfe zum Cmdlet Get-ChildItem erhalten Sie daher mit folgendem Befehl:
get-help get-childitem
oder
get-childitem -?
Auch zum Cmdlet "Get-Help" können Sie Hilfe aufrufen. Beispiel:
get-help get-help
Eine Liste aller Cmdlet-Hilfethemen in der Sitzung rufen Sie wie folgt auf:
get-help -category cmdlet
Zum Anzeigen jeweils einer einzelnen Hilfeseite verwenden Sie die Funktion help oder deren Alias man. Hilfe zum Cmdlet "Get-ChildItem" zeigen Sie beispielsweise mit folgendem Befehl an:
man get-childitem
oder
help get-childitem
Ausführliche Informationen zu einem Cmdlet, einer Funktion oder einem Skript, mit Beschreibungen der zugehörigen Parameter und Verwendungsbeispielen, zeigen Sie mit dem Detailed-Parameter des Cmdlet "Get-Help" an. Ausführliche Informationen zum Cmdlet "Get-ChildItem" rufen Sie z. B. mit folgendem Befehl ab:
get-help get-childitem -detailed
Wenn Sie den gesamten Inhalt im Hilfethema anzeigen möchten, verwenden Sie den Full-Parameter des Cmdlet "Get-Help". Um beispielsweise den gesamten Inhalt des Hilfethemas zum Cmdlet "Get-ChildItem" anzuzeigen, geben Sie Folgendes ein:
get-help get-childitem -full
Ausführliche Hilfe zu den Parametern eines Cmdlet rufen Sie mit dem Parameter-Parameter des Cmdlet "Get-Help" ab. Wenn Sie zum Beispiel ausführliche Hilfe für alle Parameter des Cmdlet "Get-ChildItem" aufrufen möchten, geben Sie Folgendes ein:
get-help get-childitem -parameter *
Wenn sie nur die Beispiele in einem Hilfethema anzeigen möchten, verwenden Sie den Example-Parameter von Get-Help. Wenn Sie beispielsweise nur die Beispiele im Hilfethema zum Cmdlet "Get-ChildItem" anzeigen möchten, geben Sie Folgendes ein:
get-help get-childitem -examples
Informationen zum Erstellen von Hilfethemen zu den von Ihnen geschriebenen Cmdlets finden Sie auf MSDN im Thema zum Erstellen von Cmdlet-Hilfe.
Aufrufen von grundsätzlichen Hilfeinformationen
Mit dem Cmdlet "Get-Help" können Sie auch Informationen zu grundsätzlichen Themen in Windows PowerShell anzeigen, u. a. Themen zur Windows PowerShell-Sprache. Hilfethemen mit grundsätzlichen Informationen beginnen mit dem Präfix "about_", z. B. "about_line_editing". (Der Name des konzeptuellen Themas muss auch in nicht englischen Versionen von Windows PowerShell auf Englisch eingegeben werden.)
Zum Anzeigen einer Liste derartiger Themen geben Sie Folgendes ein:
get-help about_*
Wenn Sie ein bestimmtes Hilfethema anzeigen möchten, geben Sie den Thementitel ein, z. B.:
get-help about_command_syntax
Die Parameter von Get-Help, z. B. Detailed, Parameter und Examples, haben keine Auswirkungen auf die Anzeige von Hilfethemen mit grundsätzlichen Informationen.
Aufrufen von Hilfe zu Anbietern
Mit dem Cmdlet "Get-Help" zeigen Sie Informationen zu Windows PowerShell-Anbietern an. Zum Aufrufen von Hilfe zu einem Anbieter geben Sie "Get-Help" und dann den Anbieternamen ein. Hilfeinformationen zum Registrierungsanbieter können Sie z. B. mit folgendem Befehl abrufen:
get-help registry
Eine Liste aller Anbieter-Hilfethemen in der Sitzung rufen Sie wie folgt auf:
get-help -category provider
Die Parameter von Get-Help, z. B. Detailed Parameter und Examples, haben keine Auswirkungen auf die Anzeige von Hilfethemen zu Anbietern.
Aufrufen von Hilfe zu Skripts und Funktionen
Zahlreichen Skripts und Funktionen in Windows PowerShell sind Hilfethemen zugeordnet. Mit dem Cmdlet "Get-Help" können Sie die Hilfethemen für Skripts und Funktionen anzeigen.
Zum Anzeigen der Hilfe für eine Funktion geben Sie "get-help" und dann den Funktionsnamen ein. Beispielsweise geben Sie Folgendes ein, um Hilfe für die Funktion "Disable-PSRemoting" abzurufen:
get-help disable-psremoting
Wenn Sie die Hilfe für ein Skript anzeigen möchten, geben Sie den vollqualifizierten Pfad zur Skriptdatei ein. Wenn sich das Skript unter einem Pfad befindet, der in der Path-Umgebungsvariable aufgeführt ist, können Sie den Pfad im Befehl weglassen.
Zum Anzeigen des Hilfethemas zum Skript "TestScript.ps1" im Verzeichnis "C:\PS-Test" geben Sie z. B. Folgendes ein:
get-help c:\ps-test\TestScript.ps1
Die Parameter, die zum Anzeigen von Hilfe zu Cmdlets entworfen wurden, z. B. Detailed, Full, Examples und Parameter, können für Skripthilfe und auch Funktionshilfe verwendet werden. Wenn Sie jedoch die gesamte Hilfe anzeigen möchten, wird durch Eingabe von "get-help * " keine Hilfe für Funktionen und Skripts angezeigt.
Informationen zum Erstellen von Hilfethemen für Funktionen und Skripts finden Sie unter about_Functions, about_Scripts und about_Comment_Based_Help.
Aufrufen von Onlinehilfe
Wenn Sie mit dem Internet verbunden sind, bietet es sich an, Hilfethemen online aufzurufen. Da Onlinethemen leicht aktualisiert werden können, sind diese in den meisten Fällen auf dem neuesten Stand.
Zum Aufrufen von Onlinehilfe verwenden Sie den Online-Parameter des Cmdlet "Get-Help". Der Online-Parameter des Cmdlet "Get-Help" kann nur für Cmdlet-Hilfe, Funktionshilfe und Skripthilfe verwendet werden. Sie können den Online-Parameter nicht für konzeptuelle Themen (Infothemen) oder Anbieterhilfethemen verwenden. Da es sich um ein optionales Feature handelt, kann er zudem nicht für jedes Cmdlet-, Funktions- oder Skripthilfethema verwendet werden.
Alle Hilfethemen, die mit Windows PowerShell ausgeliefert werden, u. a. Anbieter- und konzeptuelle (Info-)Hilfethemen, sind jedoch online im Abschnitt
Wenn Sie den Online-Parameter des Cmdlet "Get-Help" verwenden möchten, verwenden Sie das folgende Befehlsformat.
get-help <command-name> -online
Wenn Sie beispielsweise die Onlineversion des Hilfethemas zum Cmdlet "Get-ChildItem" aufrufen möchten, geben Sie Folgendes ein:
get-help get-childitem -online
Wenn eine Onlineversion des Hilfethemas verfügbar ist, wird es im Standardbrowser geöffnet.
Wenn Onlinehilfe für ein Hilfethema unterstützt wird, können Sie auch die Internetadresse (URL) des Hilfethemas anzeigen. Die Internetadresse wird im Abschnitt "Verwandte Links" eines Hilfethemas angezeigt.
Wenn Sie zum Beispiel die URL für die Onlineversion des Cmdlets "Add-Computer" anzeigen möchten, geben Sie Folgendes ein:
get-help add-computer
Die erste Zeile im Abschnitt "Verwandte Links" des Themas wird unten dargestellt.
Online version: https://go.microsoft.com/fwlink/?LinkID=135194
Informationen zum Bereitstellen des Onlinesupports für die Hilfethemen finden Sie unter about_Comment_Based_Help und in der MSDN Library (Microsoft Developer Network) im Thema zum Erstellen von Cmdlet-Hilfe (
Siehe auch