So lesen Sie die PowerShell-Dokumentationssyntax

657
Kolob Canyon

Ich könnte eine gute Erklärung der PowerShell-Dokumentationssyntax verwenden:

> man Update-Help

SYNTAX Update-Help [[-Module] <string[]>] [[-SourcePath] <string[]>] [[-UICulture] <cultureinfo[]>] [-Recurse] [-Credential <pscredential>] [-UseDefaultCredentials]  [-Force] [<CommonParameters>]  Update-Help [[-Module] <string[]>] [[-UICulture] <cultureinfo[]>] [-LiteralPath <string[]>] [-Recurse] [-Credential <pscredential>] [-UseDefaultCredentials]  [-Force] [<CommonParameters>] 

Also versuchte ich den Mann zu aktualisieren:

> Update-Help Get-ChildItem

Error:

Update-Help : No Windows PowerShell modules were found that match the following pattern: Get-ChildItem. Verify the pattern and then try the command again.At line:1  char:1 + Update-Help Get-ChildItem + ~~~~~~~~~~~~~~~~~~~~~~~~~ + CategoryInfo : InvalidArgument: (Get-ChildItem:String) [Update-Help], Exception + FullyQualifiedErrorId : ModuleNotFound,Microsoft.PowerShell.Commands.UpdateHelpCommand 

Insbesondere möchte ich wissen, welche Parameter obligatorisch sind, welche Art von Parametern und müssen sie in einer bestimmten Reihenfolge angegeben werden?

0

1 Antwort auf die Frage

1
Zoredache

Man Update-Hilfe

Denken Sie zunächst daran, dass man (eigentlich Get-Help) nicht die vollständige Hilfe anzeigt, die standardmäßig für das Commandlet verfügbar ist. Die grundlegende Ausgabe gibt Ihnen auf eine leicht lesbare Weise einfach nicht das, was Sie brauchen.

Wenn Sie das Get-Help Update-Help -onlineoder verwenden, erhalten Get-Help Update-Help -ShowWindowSie viel mehr Details. Ein bisschen Information ist eine Auflistung der einzelnen Parameter, ihrer Position (falls sie ohne verwendet werden können -param), falls erforderlich, des Standardwerts usw.

Sie können Details zu einem bestimmten Parameter auch direkt über ein ähnliches Element abrufen Get-Help update-help -Parameter module.

Der wirklich nützliche Teil Get-Helpmeiner Meinung nach ist der Abschnitt mit Beispielen. get-help update-help -Examples. In der Regel erhalten Sie hier einige Beispiele für die Verwendung des Commandlets.

Da alle Powershell-Dokumente online sind, können Sie in der Regel eine Google / Bing-Suche durchführen powershell update-help, um einen Link zur Online-Dokumentation zu erhalten, der vollständig ist und meiner Meinung nach etwas lesbarer ist.

Update-Hilfe Get-ChildItem

Dies ist fehlgeschlagen, da Get-ChildItemes sich bei einem Befehlselement nicht um ein Modul handelt. Sie könnten einfach Update-Helpohne Parameter auskommen und es würde alles aktualisieren. Oder Sie können das Modul finden, das Get-ChildItemMitglied ist, und dieses Modul aktualisieren.

PS C:\users\public> get-command get-childitem  CommandType Name Version Source ----------- ---- ------- ------ Cmdlet Get-ChildItem 3.1.0.0 Microsoft.PowerShell.Management  PS C:\users\public> Update-Help -Module Microsoft.PowerShell.Management PS C:\users\public>  
Ein weiterer praktischer Schalter ist "-full". ZB `Get-Help Update-Help -full | mehr` root vor 7 Jahren 1