Get-Help

Syntax

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

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

Get-Help
   [[-Name] <String>]
   [-Path <String>]
   [-Category <String[]>]
   -Examples
   [-Component <String[]>]
   [-Functionality <String[]>]
   [-Role <String[]>]
   [<CommonParameters>]

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

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

Get-Help
   [[-Name] <String>]
   [-Path <String>]
   [-Category <String[]>]
   [-Component <String[]>]
   [-Functionality <String[]>]
   [-Role <String[]>]
   -ShowWindow
   [<CommonParameters>]

Beschreibung

Das cmdlet Get-Help zeigt Informationen zu PowerShell-Konzepten und -Befehlen an, einschließlich Cmdlets, Funktionen, Common Information Model (CIM)-Befehlen, Workflows, Anbietern, Aliasen und Skripts.

Um Hilfe zu einem PowerShell-Cmdlet zu erhalten, geben Sie Get-Help gefolgt vom Cmdlet-Namen ein, z. B.: Get-Help Get-Process.

Konzeptionelle Hilfeartikel in PowerShell beginnen mit about_, zum Beispiel about_Comparison_Operators. Um alle About_ Artikel zu sehen, geben Sie Get-Help about_* ein. Wenn Sie einen bestimmten Artikel anzeigen möchten, geben Sie Get-Help about_<article-name>ein, z. B. Get-Help about_Comparison_Operators.

Um Hilfe für einen PowerShell-Anbieter zu erhalten, geben Sie Get-Help gefolgt vom Anbieternamen ein. Um z. B. Hilfe für den Zertifikatanbieter zu erhalten, geben Sie Get-Help Certificateein.

Sie können auch help oder maneingeben, wodurch jeweils ein Textbildschirm angezeigt wird. Oder, <cmdlet-name> -?, das mit Get-Helpidentisch ist, funktioniert jedoch nur für Cmdlets.

Get-Help holt sich die Hilfeinhalte, die es am Bildschirm anzeigt, aus den Hilfedateien auf Ihrem Computer. Ohne die Hilfedateien zeigt Get-Help nur grundlegende Informationen zu Cmdlets an. Einige PowerShell-Module enthalten Hilfedateien. Ab PowerShell 3.0 enthalten die Module, die im Windows-Betriebssystem enthalten sind, keine Hilfedateien. Um die Hilfedateien für ein Modul in PowerShell 3.0 herunterzuladen oder zu aktualisieren, verwenden Sie das cmdlet Update-Help.

Sie können die PowerShell-Hilfedokumente auch online anzeigen. Um die Onlineversion einer Hilfedatei abzurufen, verwenden Sie den Parameter Online, z. B.: Get-Help Get-Process -Online.

Wenn Sie Get-Help gefolgt vom genauen Namen eines Hilfeartikels oder von einem für einen Hilfeartikel eindeutigen Wort eingeben, zeigt Get-Help den Inhalt des Artikels an. Wenn Sie den genauen Namen eines Befehlsalias angeben, zeigt Get-Help die Hilfe für den ursprünglichen Befehl an. Wenn Sie ein Wort- oder Wortmuster eingeben, das in mehreren Hilfeartikeltiteln angezeigt wird, zeigt Get-Help eine Liste der übereinstimmenden Titel an. Wenn Sie Text eingeben, der in keinem Hilfeartikeltitel angezeigt wird, zeigt Get-Help eine Liste von Artikeln an, die diesen Text in ihren Inhalt einschließen.

Get-Help kann Hilfeartikel für alle unterstützten Sprachen und Sprachumgebungen abrufen. Get-Help sucht zuerst nach Hilfedateien im Gebietsschema für Windows, dann im übergeordneten Gebietsschema, z. B. pt für pt-BRund dann in einem Fallbackgebietsschema. Ab PowerShell 3.0, wenn Get-Help keine Hilfe in der Fallback-Sprache findet, sucht es nach Hilfeartikeln auf Englisch, en-US, bevor es eine Fehlermeldung zurückgibt oder automatisch generierte Hilfe anzeigt.

Um Informationen zu den Symbolen zu erhalten, die im Befehlssyntaxdiagramm von Get-Help angezeigt werden, lesen Sie about_Command_Syntax. Informationen zu Parameterattributen wie Required und Positionfinden Sie unter about_Parameters.

Beginnend mit PSReadLine v2.2.2 wird das Modul mit zwei Funktionen ausgeliefert, die schnellen Zugriff auf Hilfe bieten, während Sie einen Befehl in der Befehlszeile eingeben. Die Hilfe wird im Terminal in einem alternativen Bildschirmpuffer mit Paging angezeigt.

Wenn Sie die Taste F1 drücken, ruft die PSReadLineShowCommandHelp-Funktion Get-Help -Full den Namen des Cmdlets auf, das sich am nächsten links vom Cursor befindet. Wenn sich der Cursor unmittelbar links neben einem Parameter befindet, springt die Funktion zur Beschreibung dieses Parameters im vollständigen Hilfethema. Wenn Sie Q drücken, um die Hilfeansicht zu beenden, werden Sie an der Befehlszeile an derselben Cursorposition zurückgegeben, damit Sie mit der Eingabe des Befehls fortfahren können.

Wenn Sie die Tastenkombination Alt+hverwenden, zeigt die PSReadLine-ShowParameterHelp-Funktion Hilfeinformationen für den Parameter unmittelbar links neben dem Cursor an. Der Hilfetext wird unterhalb der Befehlszeile angezeigt. Auf diese Weise können Sie die Beschreibung des Parameters anzeigen und mit der Eingabe des Befehls fortfahren.

Weitere Informationen finden Sie unter Verwenden der dynamischen Hilfe.

Beispiele

Beispiel 1: Anzeigen grundlegender Hilfeinformationen zu einem Cmdlet

In diesen Beispielen werden grundlegende Hilfeinformationen zum Cmdlet Format-Table angezeigt.

Get-Help Format-Table
Get-Help -Name Format-Table
Format-Table -?

Get-Help <cmdlet-name> ist die einfachste und standardsyntax des Cmdlets Get-Help. Sie können den Parameter Name weglassen.

Die Syntax <cmdlet-name> -? funktioniert nur für Cmdlets.

Beispiel 2: Gleichzeitiges Anzeigen grundlegender Informationen auf einer Seite

In diesen Beispielen werden grundlegende Hilfeinformationen zum cmdlet Format-Table jeweils jeweils auf einer Seite angezeigt.

help Format-Table
man Format-Table
Get-Help Format-Table | Out-Host -Paging

help ist eine Funktion, die intern das Get-Help-Cmdlet ausführt und das Ergebnis seitenweise anzeigt.

man ist ein Alias für die help-Funktion.

Get-Help Format-Table sendet das Objekt durch die Pipeline. Out-Host -Paging empfängt die Ausgabe aus der Pipeline und zeigt sie seitenweise an. Weitere Informationen finden Sie unter Out-Host.

Beispiel 3: Anzeigen weiterer Informationen für ein Cmdlet

In diesen Beispielen werden ausführlichere Hilfeinformationen zum Cmdlet Format-Table angezeigt.

Get-Help Format-Table -Detailed
Get-Help Format-Table -Full

Der Parameter "Detaillierte Ansicht" zeigt die detaillierte Ansicht des Hilfeartikels an, die Beschreibungen der Parameter und Beispiele enthält.

Der Full-Parameter zeigt die vollständige Ansicht des Hilfeartikels an, die Parameterbeschreibungen, Beispiele, Eingabe- und Ausgabeobjekttypen und zusätzliche Hinweise enthält.

Die Parameter Detailed und Full sind nur für die Befehle wirksam, für die Hilfedateien auf dem Computer installiert sind. Die Parameter sind nicht wirksam für die konzeptionellen (about_) Hilfeartikel.

Beispiel 4: Anzeigen ausgewählter Teile eines Cmdlets mithilfe von Parametern

In diesen Beispielen werden ausgewählte Teile der Hilfe zum Cmdlet Format-Table angezeigt.

Get-Help Format-Table -Examples
Get-Help Format-Table -Parameter *
Get-Help Format-Table -Parameter GroupBy

Im Parameter Examples werden der NAME-Abschnitt und der SYNOPSIS-Abschnitt der Hilfedatei sowie alle Beispiele angezeigt. Sie können keine Beispielnummer angeben, da Examples Parameter ein Switch-Parameter ist.

Der Parameter Parameter zeigt nur die Beschreibungen der angegebenen Parameter an. Wenn Sie nur das Sternchen (*) als Wildcardzeichen angeben, werden die Beschreibungen aller Parameter angezeigt. Wenn Parameter einen Parameternamen wie GroupByangibt, werden Informationen zu diesem Parameter angezeigt.

Diese Parameter sind für die konzeptionellen (about_) Hilfeartikel nicht wirksam.

Beispiel 5: Anzeigen der Onlineversion der Hilfe

In diesem Beispiel wird die Onlineversion des Hilfeartikels für das Cmdlet Format-Table in Ihrem Standardwebbrowser angezeigt.

Get-Help Format-Table -Online

Beispiel 6: Hilfe über das Hilfesystem am Bildschirm anzeigen

Das Cmdlet Get-Help ohne Parameter zeigt Informationen zum PowerShell-Hilfesystem an.

Get-Help

Beispiel 7: Anzeigen verfügbarer Hilfeartikel

In diesem Beispiel wird eine Liste aller auf Ihrem Computer verfügbaren Hilfeartikel angezeigt.

Get-Help *

Beispiel 8: Anzeigen einer Liste von konzeptuellen Artikeln

In diesem Beispiel wird eine Liste der konzeptionellen Artikel angezeigt, die in der PowerShell-Hilfe enthalten sind. Alle diese Artikel beginnen mit den Zeichen about_. Um eine bestimmte Hilfedatei anzuzeigen, geben Sie Get-Help \<about_article-name\>ein, z. B. Get-Help about_Signing.

Es werden nur die konzeptionellen Artikel mit hilfedateien angezeigt, die auf Ihrem Computer installiert sind. Informationen zum Herunterladen und Installieren von Hilfedateien in PowerShell 3.0 finden Sie unter Update-Help-.

Get-Help about_*

Beispiel 9: Suchen nach einem Wort in der Cmdlet-Hilfe

In diesem Beispiel wird gezeigt, wie Sie in einem Cmdlet-Hilfeartikel nach einem Wort suchen.

Get-Help Add-Member -Full | Out-String -Stream | Select-String -Pattern Clixml

the Export-Clixml cmdlet to save the instance of the object, including the additional members...
can use the Import-Clixml cmdlet to re-create the instance of the object from the information...
Export-Clixml
Import-Clixml

Get-Help verwendet den Parameter Full, um Hilfeinformationen für Add-Memberabzurufen. Das MamlCommandHelpInfo-Objekt wird durch die Pipeline geschickt. Out-String verwendet den parameter Stream, um das Objekt in eine Zeichenfolge zu konvertieren. Select-String verwendet den Parameter Pattern, um in der Zeichenfolge nach Clixmlzu suchen.

Beispiel 10: Anzeigen einer Liste von Artikeln, die ein Wort enthalten

Dieses Beispiel zeigt eine Liste von Artikeln an, die das Wort remoting enthalten.

Wenn Sie ein Wort eingeben, das in keinem Artikeltitel angezeigt wird, zeigt Get-Help eine Liste von Artikeln an, die dieses Wort enthalten.

Get-Help -Name remoting

Name                              Category  Module                    Synopsis
----                              --------  ------                    --------
Install-PowerShellRemoting.ps1    External                            Install-PowerShellRemoting.ps1
Disable-PSRemoting                Cmdlet    Microsoft.PowerShell.Core Prevents remote users...
Enable-PSRemoting                 Cmdlet    Microsoft.PowerShell.Core Configures the computer...

Beispiel 11: Anbieterspezifische Hilfe anzeigen

In diesem Beispiel werden zwei Möglichkeiten zum Abrufen der anbieterspezifischen Hilfe für Get-Itemgezeigt. Diese Befehle rufen eine Hilfe ab, die erklärt, wie das Cmdlet Get-Item im Knoten DataCollection des PowerShell SQL Server-Anbieters zu verwenden ist.

Im ersten Beispiel wird der parameter Get-HelpPath verwendet, um den Pfad des SQL Server-Anbieters anzugeben. Da der Pfad des Anbieters angegeben ist, können Sie den Befehl von einem beliebigen Pfadspeicherort aus ausführen.

Im zweiten Beispiel wird Set-Location verwendet, um zum Pfad des SQL Server-Anbieters zu navigieren. Von diesem Speicherort aus ist der Path Parameter nicht erforderlich, damit Get-Help die anbieterspezifische Hilfe abrufen kann.

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.
    ...

Set-Location SQLSERVER:\DataCollection
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.
    ...

Beispiel 12: Anzeigen der Hilfe für ein Skript

In diesem Beispiel wird die Hilfe für den MyScript.ps1 script. Informationen darüber, wie Sie Hilfe für Ihre Funktionen und Skripte schreiben, finden Sie unter about_Comment_Based_Help.

Get-Help -Name C:\PS-Test\MyScript.ps1

Parameter

-Category

-Component

-Detailed

-Examples

-Full

-Functionality

-Name

-Online

-Parameter

-Path

-Role

-ShowWindow

Eingaben

None

Sie können keine Objekte an dieses Cmdlet weiterleiten.

Ausgaben

ExtendedCmdletHelpInfo

Wenn Sie Get-Help für einen Befehl ausführen, der keine Hilfedatei enthält, gibt Get-Help ein ExtendedCmdletHelpInfo-Objekt zurück, das die automatisch generierte Hilfe darstellt.

String

Wenn Sie einen konzeptionellen Hilfeartikel erhalten, gibt Get-Help ihn als Zeichenfolge zurück.

MamlCommandHelpInfo

Wenn Sie einen Befehl mit einer Hilfedatei erhalten, gibt Get-Help ein MamlCommandHelpInfo-Objekt zurück.

Hinweise

PowerShell 3.0 enthält keine Hilfedateien. Verwenden Sie das Cmdlet Get-Help, um die Hilfedateien herunterzuladen und zu installieren, die Update-Help liest. Sie können das Cmdlet Update-Help verwenden, um Hilfedateien für die wichtigsten Befehle herunterzuladen und zu installieren, die in PowerShell enthalten sind, sowie für alle Module, die Sie installieren. Sie können sie auch verwenden, um die Hilfedateien zu aktualisieren, damit die Hilfe auf Ihrem Computer niemals veraltet ist.

Sie können auch die Hilfeartikel zu den Befehlen lesen, die mit PowerShell online verfügbar sind, beginnend mit Erste Schritte mit Windows PowerShell.

Get-Help zeigt Hilfe im für das Windows-Betriebssystem festgelegten Gebietsschema oder in der Ausweichsprache für dieses Gebietsschema an. Wenn Sie keine Hilfedateien für das primäre oder das Ersatzgebietsschema haben, verhält sich Get-Help so, als ob es keine Hilfedateien auf dem Computer gäbe. Um Hilfe für eine andere Region zu erhalten, verwenden Sie in der Systemsteuerung Region und Sprache, um die Einstellungen zu ändern. Unter Windows 10 oder höher, Einstellungen, Uhrzeit & Sprache.

Die vollständige Ansicht der Hilfe enthält eine Tabelle mit Informationen zu den Parametern. Die Tabelle enthält die folgenden Felder:

• Erforderlich. Gibt an, ob der Parameter erforderlich ist (true) oder optional (false).

• Position. Gibt an, ob der Parameter benannt oder positional (numerisch) ist. Positionsparameter müssen an einer angegebenen Stelle im Befehl angezeigt werden.

• Named gibt an, dass der Parametername erforderlich ist, der Parameter aber an beliebiger Stelle im Befehl erscheinen kann.

• Numerische gibt an, dass der Parametername optional ist, aber wenn der Name weggelassen wird, muss der Parameter an der durch die Zahl angegebenen Stelle sein. Beispielsweise gibt 2 an, dass, wenn der Parametername weggelassen wird, der Parameter der zweite oder der einzige unbenannte Parameter im Befehl sein muss. Wenn der Parametername verwendet wird, kann der Parameter an einer beliebigen Stelle im Befehl angezeigt werden.

• Standardwert. Der Parameterwert oder das Standardverhalten, das PowerShell verwendet, wenn Sie den Parameter nicht in den Befehl einschließen.

• Akzeptiert Eingaben aus der Pipeline. Gibt an, ob Objekte über eine Pipeline an den Parameter gesendet werden können (true) oder nicht (false). By Property Name bedeutet, dass das weitergeleitete Objekt eine Eigenschaft aufweisen muss, die denselben Namen wie der Parametername hat.

• Akzeptiert Wildcard-Zeichen. Gibt an, ob der Wert eines Parameters Platzhalterzeichen enthalten kann, z. B. ein Sternchen (*) oder Fragezeichen (?).

Ähnliche Themen

• about_Command_Syntax
• about_Comment_Based_Help
• Get-Command
• Unterstützung einer aktualisierbaren Hilfe
• Update-Help
• Schreiben von kommentarbasierten Hilfethemen
• Schreiben einer Hilfe für PowerShell-Cmdlets