Freigeben über

Set-PSReadLineOption

  • Referenz
Modul:
PSReadLine

Passt das Verhalten der Befehlszeilenbearbeitung in PSReadLine an.

Syntax

Set-PSReadLineOption
   [-EditMode <EditMode>]
   [-ContinuationPrompt <string>]
   [-HistoryNoDuplicates]
   [-AddToHistoryHandler <Func[string,Object]>]
   [-CommandValidationHandler <Action[CommandAst]>]
   [-HistorySearchCursorMovesToEnd]
   [-MaximumHistoryCount <int>]
   [-MaximumKillRingCount <int>]
   [-ShowToolTips]
   [-ExtraPromptLineCount <int>]
   [-DingTone <int>]
   [-DingDuration <int>]
   [-BellStyle <BellStyle>]
   [-CompletionQueryItems <int>]
   [-WordDelimiters <string>]
   [-HistorySearchCaseSensitive]
   [-HistorySaveStyle <HistorySaveStyle>]
   [-HistorySavePath <string>]
   [-AnsiEscapeTimeout <int>]
   [-PromptText <string[]>]
   [-ViModeIndicator <ViModeStyle>]
   [-ViModeChangeHandler <scriptblock>]
   [-PredictionSource <PredictionSource>]
   [-PredictionViewStyle <PredictionViewStyle>]
   [-Colors <hashtable>]
   [-TerminateOrphanedConsoleApps]
   [<CommonParameters>]

Beschreibung

Das Set-PSReadLineOption Cmdlet passt das Verhalten des PSReadLine-Moduls beim Bearbeiten der Befehlszeile an. Verwenden Sie Get-PSReadLineOptionzum Anzeigen der PSReadLine-Einstellungen .

Die von diesem Befehl festgelegten Optionen gelten nur für die aktuelle Sitzung. Um optionen beizubehalten, fügen Sie sie einem Profilskript hinzu. Weitere Informationen finden Sie unter about_Profiles und Anpassen der Shellumgebung.

Beispiele

Beispiel 1: Festlegen von Vordergrund- und Hintergrundfarben

In diesem Beispiel wird PSReadLine so festgelegt, dass das Kommentartoken mit grünem Vordergrundtext auf einem grauen Hintergrund angezeigt wird. In der im Beispiel verwendeten Escapesequenz stellt 32 die Vordergrundfarbe dar und 47 die Hintergrundfarbe.

Set-PSReadLineOption -Colors @{ "Comment"="`e[32;47m" }

Sie können festlegen, dass nur eine Vordergrundtextfarbe festgelegt werden soll. Beispiel: eine hellgrüne Vordergrundtextfarbe für das Kommentartoken : "Comment"="`e[92m".

Beispiel 2: Festlegen des Glockenstils

In diesem Beispiel reagiert PSReadLine auf Fehler oder Bedingungen, die die Aufmerksamkeit des Benutzers erfordern. Der BellStyle wird so eingestellt, dass bei 1221 Hz für 60 ms ein hörbarer Signalton ausgegeben wird.

Set-PSReadLineOption -BellStyle Audible -DingTone 1221 -DingDuration 60

Hinweis

Dieses Feature funktioniert möglicherweise nicht auf allen Hosts auf Plattformen.

Beispiel 3: Festlegen mehrerer Optionen

Set-PSReadLineOption kann mehrere Optionen mit einer Hashtabelle festlegen.

$PSReadLineOptions = @{
    EditMode = "Emacs"
    HistoryNoDuplicates = $true
    HistorySearchCursorMovesToEnd = $true
    Colors = @{
        "Command" = "#8181f7"
    }
}
Set-PSReadLineOption @PSReadLineOptions

Die $PSReadLineOptions Hashtabelle legt die Schlüssel und Werte fest. Set-PSReadLineOption verwendet die Schlüssel und Werte zum @PSReadLineOptions Aktualisieren der PSReadLine-Optionen .

Sie können die Schlüssel und Werte, die den Namen der Hashtabelle eingeben, $PSReadLineOptions in der PowerShell-Befehlszeile anzeigen.

Beispiel 4: Festlegen mehrerer Farboptionen

In diesem Beispiel wird gezeigt, wie Sie mehrere Farbwerte in einem einzigen Befehl festlegen.

Set-PSReadLineOption -Colors @{
  Command            = 'Magenta'
  Number             = 'DarkGray'
  Member             = 'DarkGray'
  Operator           = 'DarkGray'
  Type               = 'DarkGray'
  Variable           = 'DarkGreen'
  Parameter          = 'DarkGreen'
  ContinuationPrompt = 'DarkGray'
  Default            = 'DarkGray'
}

Beispiel 5: Festlegen von Farbwerten für mehrere Typen

Dieses Beispiel zeigt drei verschiedene Methoden zum Festlegen der Farbe von Token, die in PSReadLine angezeigt werden.

Set-PSReadLineOption -Colors @{
 # Use a ConsoleColor enum
 "Error" = [ConsoleColor]::DarkRed

 # 24 bit color escape sequence
 "String" = "$([char]0x1b)[38;5;100m"

 # RGB value
 "Command" = "#8181f7"
}

Beispiel 6: Verwenden von ViModeChangeHandler zum Anzeigen von Vi-Modusänderungen

In diesem Beispiel wird ein Cursoränderungs-VT-Escape als Reaktion auf eine Änderung des Vi-Modus ausgegeben.

function OnViModeChange {
    if ($args[0] -eq 'Command') {
        # Set the cursor to a blinking block.
        Write-Host -NoNewLine "`e[1 q"
    } else {
        # Set the cursor to a blinking line.
        Write-Host -NoNewLine "`e[5 q"
    }
}
Set-PSReadLineOption -ViModeIndicator Script -ViModeChangeHandler $Function:OnViModeChange

Die OnViModeChange-Funktion legt die Cursoroptionen für die Vi-Modi fest: Einfügen und Befehl. ViModeChangeHandler verwendet den Function: Anbieter, um auf OnViModeChange als Skriptblockobjekt zu verweisen.

Weitere Informationen finden Sie unter about_Providers.

Beispiel 7: Verwenden des Verlaufshandlers zum Filtern von Befehlen, die dem Verlauf hinzugefügt wurden

Das folgende Beispiel zeigt, wie Sie das AddToHistoryHandler Speichern von Git-Befehlen im Verlauf verhindern.

$ScriptBlock = {
    Param([string]$line)

    if ($line -match "^git") {
        return $false
    } else {
        return $true
    }
}

Set-PSReadLineOption -AddToHistoryHandler $ScriptBlock

Der Scriptblock gibt zurück $false , wenn der Befehl mit git. Dies hat die gleiche Wirkung wie das Zurückgeben der SkipAdding AddToHistory-Enumeration . Wenn der Befehl nicht beginnt git, gibt der Handler den Befehl zurück $true und PSReadLine speichert den Befehl im Verlauf.

Beispiel 8: Verwenden von CommandValidationHandler zum Überprüfen eines Befehls vor der Ausführung

In diesem Beispiel wird gezeigt, wie Sie den CommandValidationHandler-Parameter verwenden, um einen Überprüfungsbefehl auszuführen, bevor er ausgeführt wird. Im Beispiel wird speziell nach dem Befehl git mit dem Unterbefehl cmt gesucht und durch den vollständigen Namen commitersetzt. Auf diese Weise können Sie Kurzhandalias für Unterbefehle erstellen.

# Load the namespace so you can use the [CommandAst] object type
using namespace System.Management.Automation.Language

Set-PSReadLineOption -CommandValidationHandler {
    param([CommandAst]$CommandAst)

    switch ($CommandAst.GetCommandName()) {
        'git' {
            $gitCmd = $CommandAst.CommandElements[1].Extent
            switch ($gitCmd.Text) {
                'cmt' {
                    [Microsoft.PowerShell.PSConsoleReadLine]::Replace(
                        $gitCmd.StartOffset, $gitCmd.EndOffset - $gitCmd.StartOffset, 'commit')
                }
            }
        }
    }
}
# This checks the validation script when you hit enter
Set-PSReadLineKeyHandler -Chord Enter -Function ValidateAndAcceptLine

Beispiel 9: Verwenden des PromptText-Parameters

Wenn ein Analysefehler auftritt, ändert PSReadLine einen Teil der Eingabeaufforderung rot. Der PromptText-Parameter weist PSReadLine den Teil der Aufforderungszeichenfolge an, rot zu machen.

Im folgenden Beispiel wird beispielsweise eine Eingabeaufforderung erstellt, die den aktuellen Pfad enthält, gefolgt von dem Größer-als-Zeichen (>) und einem Leerzeichen.

function prompt { "PS $pwd> " }`
Set-PSReadLineOption -PromptText '> ' # change the '>' character red
Set-PSReadLineOption -PromptText '> ', 'X ' # replace the '>' character with a red 'X'

Die erste Zeichenfolge ist der Teil der Eingabeaufforderungszeichenfolge, den Sie rot machen möchten, wenn ein Analysefehler auftritt. Die zweite Zeichenfolge ist eine alternative Zeichenfolge, die verwendet werden soll, wenn ein Analysefehler auftritt.

Parameter

-AddToHistoryHandler

Gibt einen ScriptBlock an, der steuert, wie Befehle zum PSReadLine-Verlauf hinzugefügt werden.

ScriptBlock empfängt die Befehlszeile als Eingabe.

ScripBlock sollte ein Element der AddToHistoryOption-Enumeration, den Zeichenfolgennamen eines dieser Member oder einen booleschen Wert zurückgeben. In der folgenden Liste werden die möglichen Werte und deren Auswirkungen beschrieben.

  • MemoryAndFile – Fügen Sie den Befehl der Verlaufsdatei und der aktuellen Sitzung hinzu.
  • MemoryOnly – Fügen Sie den Befehl nur für die aktuelle Sitzung zum Verlauf hinzu.
  • SkipAdding – Fügen Sie den Befehl nicht zur Verlaufsdatei für die aktuelle Sitzung hinzu.
  • $false - Identisch mit der Angabe des Werts SkipAdding.
  • $true - Identisch mit der Angabe des Werts MemoryAndFile.
Typ:Func<T,TResult>[System.String,System.Object]
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-AnsiEscapeTimeout

Diese Option ist spezifisch für Windows, wenn die Eingabe umgeleitet wird, z. B. bei Ausführung unter tmux oder screen.

Bei umgeleiteten Eingaben unter Windows werden viele Tasten als Abfolge von Zeichen gesendet, die mit dem Escapezeichen beginnen. Es ist unmöglich, zwischen einem einzelnen Escapezeichen zu unterscheiden, gefolgt von weiteren Zeichen und einer gültigen Escapesequenz.

Es wird davon ausgegangen, dass das Terminal die Zeichen schneller senden kann als ein Benutzer. PSReadLine wartet auf dieses Timeout, bevor sie zu dem Schluss kommt, dass sie eine vollständige Escapesequenz erhalten hat.

Wenn beim Eingeben zufällige oder unerwartete Zeichen angezeigt werden, können Sie dieses Timeout anpassen.

Typ:Int32
Position:Named
Standardwert:100
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-BellStyle

Gibt an, wie PSReadLine auf verschiedene Fehler- und mehrdeutige Bedingungen reagiert.

Die folgenden Werte sind gültig:

  • Hörbar: Kurzer Signalton.
  • Visual: Text blinkt kurz.
  • Keine: Kein Feedback.
Typ:BellStyle
Position:Named
Standardwert:Audible
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-Colors

Der Parameter Colors gibt verschiedene Farben an, die von PSReadLine verwendet werden.

Das Argument ist eine Hashtabelle, in der die Schlüssel die Elemente und die Werte die Farbe angeben. Weitere Informationen finden Sie unter about_Hash_Tables.

Farben können entweder ein Wert aus ConsoleColor sein, z [ConsoleColor]::Red. B. oder eine gültige ANSI-Escapesequenz. Gültige Escapesequenzen hängen vom Terminal ab. In PowerShell 5.0 ist $([char]0x1b)[91meine Beispiel-Escapesequenz für roten Text . In PowerShell 6 und höher ist `e[91mdie gleiche Escapesequenz . Sie können andere Escapesequenzen angeben, einschließlich der folgenden Typen:

Zur Unterstützung der Anpassung der ListView in PSReadLine 2.2.0 hinzugefügten Farbeinstellungen wurden zwei Farbeinstellungen hinzugefügt:

  • ListPredictionColor - Festlegen der Farbe für das führende > Zeichen und den nachgestellten Quellnamen, z [History]. B. . Standardmäßig wird sie als Vordergrundfarbe verwendet DarkYellow .

  • ListPredictionSelectedColor – Festlegen der Farbe für die Angabe, dass ein Listenelement ausgewählt ist. Standardmäßig wird sie als Hintergrundfarbe verwendet DarkBlack .

  • 256 Farbe

  • 24-Bit-Farbe

  • Vordergrund, Hintergrund oder beides

  • Umgekehrt, fett

Weitere Informationen zu ANSI-Farbcodes finden Sie im Wikipedia-Artikel ANSI-Escapecode.

Zu den gültigen Schlüsseln gehören:

  • ContinuationPrompt: Die Farbe der Fortsetzungsaufforderung.
  • Hervorhebung: Die Hervorhebungsfarbe. Beispiel: der übereinstimmende Text beim Durchsuchen des Verlaufs.
  • Fehler: Die Fehlerfarbe. Beispiel: in der Eingabeaufforderung.
  • Auswahl: Die Farbe zum Hervorheben der Menüauswahl oder des markierten Texts.
  • Standard: Die Standardtokenfarbe.
  • Kommentar: Die Farbe des Kommentartokens.
  • Schlüsselwort: Die Schlüsselworttokenfarbe.
  • Zeichenfolge: Die Zeichenfolgentokenfarbe.
  • Operator: Die Operatortokenfarbe.
  • Variable: Die Farbe des Variablentokens.
  • Befehl: Die Befehlstokenfarbe.
  • Parameter: Die Parametertokenfarbe.
  • Typ: Die Typtokenfarbe.
  • Zahl: Die Farbe des Zahlentokens.
  • Member: Die Farbe des Membernamentokens.
  • InlinePrediction: Die Farbe für die Inlineansicht des Vorhersagevorschlags.
  • ListPrediction: Die Farbe für den Namen der führenden > Zeichen- und Vorhersagequelle.
  • ListPredictionSelected: Die Farbe für die ausgewählte Vorhersage in der Listenansicht.
Typ:Hashtable
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-CommandValidationHandler

Gibt einen ScriptBlock an, der von ValidateAndAcceptLine aufgerufen wird. Wenn eine Ausnahme ausgelöst wird, schlägt die Überprüfung fehl, und der Fehler wird gemeldet.

Vor dem Auslösen einer Ausnahme kann der Überprüfungshandler den Cursor an den Punkt des Fehlers setzen, um die Behebung zu vereinfachen. Ein Überprüfungshandler kann auch die Befehlszeile ändern, um häufige typografische Fehler zu beheben.

ValidateAndAcceptLine wird verwendet, um zu vermeiden, dass Der Verlauf mit Befehlen überladen wird, die nicht funktionieren können.

Typ:Action<T>[CommandAst]
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-CompletionQueryItems

Gibt die maximale Anzahl von Abschlusselementen an, die ohne Aufforderung angezeigt werden.

Wenn die Anzahl der anzuzeigenden Elemente größer als dieser Wert ist, fordert PSReadLine "ja/nein" auf, bevor die Abschlusselemente angezeigt werden.

Typ:Int32
Position:Named
Standardwert:100
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-ContinuationPrompt

Gibt die Zeichenfolge an, die am Anfang der nachfolgenden Zeilen angezeigt wird, wenn mehrzeilige Eingaben eingegeben werden. Der Standardwert ist doppelt größer als zeichen (>>). Eine leere Zeichenfolge ist gültig.

Typ:String
Position:Named
Standardwert:>>
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-DingDuration

Gibt die Dauer des Signaltons an, wenn BellStyle auf "Audible" festgelegt ist.

Typ:Int32
Position:Named
Standardwert:50ms
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-DingTone

Gibt den Ton in Hertz (Hz) des Signaltons an, wenn BellStyle auf "Audible" festgelegt ist.

Typ:Int32
Position:Named
Standardwert:1221
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-EditMode

Gibt den Befehlszeilenbearbeitungsmodus an. Mit diesem Parameter werden alle von diesem Parameter festgelegten Tastenbindungen zurückgesetzt.Set-PSReadLineKeyHandler

Die folgenden Werte sind gültig:

  • Windows: Schlüsselbindungen emulieren PowerShell, cmd und Visual Studio.
  • Emacs: Schlüsselbindungen emulieren Bash oder Emacs.
  • Vi: Schlüsselbindungen emulieren Vi.

Wird verwendet Get-PSReadLineKeyHandler , um die Schlüsselbindungen für den aktuell konfigurierten EditMode anzuzeigen.

Typ:EditMode
Position:Named
Standardwert:Windows
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-ExtraPromptLineCount

Gibt die Anzahl der zusätzlichen Zeilen an.

Wenn sich die Eingabeaufforderung über mehrere Zeilen erstreckt, geben Sie einen Wert für diesen Parameter an. Verwenden Sie diese Option, wenn zusätzliche Zeilen verfügbar sein sollen, wenn PSReadLine die Eingabeaufforderung anzeigt, nachdem eine Ausgabe angezeigt wurde. Beispielsweise gibt PSReadLine eine Liste der Fertigstellungen zurück.

Diese Option ist weniger als in früheren Versionen von PSReadLine erforderlich, ist aber nützlich, wenn die InvokePrompt Funktion verwendet wird.

Typ:Int32
Position:Named
Standardwert:0
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-HistoryNoDuplicates

Diese Option steuert das Rückrufverhalten. Der Verlaufsdatei werden weiterhin doppelte Befehle hinzugefügt. Wenn diese Option festgelegt ist, wird beim Abrufen von Befehlen nur der letzte Aufruf angezeigt. Wiederholte Befehle werden dem Verlauf hinzugefügt, um die Sortierung während des Rückrufs beizubehalten. Normalerweise möchten Sie den Befehl jedoch nicht mehrmals anzeigen, wenn Sie den Verlauf zurückrufen oder durchsuchen.

Standardmäßig ist die HistoryNoDuplicates-Eigenschaft des globalen PSConsoleReadLineOptions-Objekts auf festgelegt True. Um den Eigenschaftswert zu ändern, müssen Sie den Wert des SwitchParameter wie folgt angeben: -HistoryNoDuplicates:$False Sie können mit nur dem SwitchParameter-Steuerelement -HistoryNoDuplicatesauf "Zurück" zurückgesetzt True werden.

Mit dem folgenden Befehl können Sie den Eigenschaftswert direkt festlegen:

(Get-PSReadLineOption).HistoryNoDuplicates = $False

Typ:SwitchParameter
Position:Named
Standardwert:False
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-HistorySavePath

Gibt den Pfad zu der Datei an, in der der Verlauf gespeichert wird. Computer, auf denen Windows- oder Nicht-Windows-Plattformen ausgeführt werden, speichern die Datei an verschiedenen Speicherorten. Der Dateiname wird in einer Variablen $($Host.Name)_history.txtgespeichert, z. B ConsoleHost_history.txt. .

Wenn Sie diesen Parameter nicht verwenden, lautet der Standardpfad wie folgt:

Windows

  • $env:APPDATA\Microsoft\Windows\PowerShell\PSReadLine\$($Host.Name)_history.txt

Nicht-Windows

  • $env:XDG_DATA_HOME/powershell/PSReadLine/$($Host.Name)_history.txt
  • $HOME/.local/share/powershell/PSReadLine/$($Host.Name)_history.txt
Typ:String
Position:Named
Standardwert:A file named $($Host.Name)_history.txt in $env:APPDATA\Microsoft\Windows\PowerShell\PSReadLine on Windows and $env:XDG_DATA_HOME/powershell/PSReadLine or $HOME/.local/share/powershell/PSReadLine on non-Windows platforms
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-HistorySaveStyle

Gibt an, wie PSReadLine den Verlauf speichert.

Gültige Werte sind:

  • SaveIncrementally: Speichern des Verlaufs, nachdem jeder Befehl ausgeführt und für mehrere Instanzen von PowerShell freigegeben wurde.
  • SaveAtExit: Anfügen der Verlaufsdatei, wenn PowerShell beendet wird.
  • SaveNothing: Verwenden Sie keine Verlaufsdatei.

Hinweis

Wenn Sie "HistorySaveStyle" auf "HistorySaveStyleSaveNothing" festlegen und diese SaveIncrementally dann später in derselben Sitzung festlegen, speichert PSReadLine alle Befehle, die zuvor in der Sitzung ausgeführt werden.

Typ:HistorySaveStyle
Position:Named
Standardwert:SaveIncrementally
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-HistorySearchCaseSensitive

Gibt an, dass bei der Verlaufssuche die Groß-/Kleinschreibung in Funktionen wie ReverseSearchHistory oder HistorySearchBackward beachtet wird.

Standardmäßig ist die HistorySearchCaseSensitive-Eigenschaft des globalen PSConsoleReadLineOptions-Objekts auf festgelegt False. Mit diesem SwitchParameter wird der Eigenschaftswert auf True. Um den Eigenschaftswert wieder zu ändern, müssen Sie den Wert des SwitchParameter wie folgt angeben: -HistorySearchCaseSensitive:$False

Mit dem folgenden Befehl können Sie den Eigenschaftswert direkt festlegen:

(Get-PSReadLineOption).HistorySearchCaseSensitive = $False

Typ:SwitchParameter
Position:Named
Standardwert:False
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-HistorySearchCursorMovesToEnd

Gibt an, dass der Cursor mithilfe einer Suche zum Ende der Befehle wechselt, die Sie aus dem Verlauf laden. Wenn dieser Parameter auf $False festgelegt ist, verbleibt der Cursor an der Position, an der er war, als Sie die NACH-OBEN- oder NACH-UNTEN-TASTE gedrückt haben.

Standardmäßig ist die HistorySearchCursorMovesToEnd-Eigenschaft des globalen PSConsoleReadLineOptions-Objekts auf festgelegt False. Legen Sie mit diesem SwitchParameter den Eigenschaftswert auf True. Um den Eigenschaftswert wieder zu ändern, müssen Sie den Wert des SwitchParameter wie folgt angeben: -HistorySearchCursorMovesToEnd:$False

Mit dem folgenden Befehl können Sie den Eigenschaftswert direkt festlegen:

(Get-PSReadLineOption).HistorySearchCursorMovesToEnd = $False

Typ:SwitchParameter
Position:Named
Standardwert:False
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-MaximumHistoryCount

Gibt die maximale Anzahl von Befehlen an, die im PSReadLine-Verlauf gespeichert werden sollen.

Der PSReadLine-Verlauf ist vom PowerShell-Verlauf getrennt.

Typ:Int32
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-MaximumKillRingCount

Gibt die maximale Anzahl der im Kill-Ring gespeicherten Elemente an.

Typ:Int32
Position:Named
Standardwert:10
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-PredictionSource

Gibt die Quelle für PSReadLine an, um Vorhersagevorschläge zu erhalten.

Gültige Werte sind:

  • None – Deaktivieren Sie das Predictive IntelliSense-Feature (Standard).
  • Verlauf – Aktivieren Sie das Predictive IntelliSense-Feature, und verwenden Sie den PSReadLine-Verlauf als einzige Quelle.
  • Plug-In – aktivieren Sie das Predictive IntelliSense-Feature und verwenden Sie die Plug-Ins (CommandPrediction) als einzige Quelle. Dieser Wert wurde in PSReadLine 2.2.0 hinzugefügt.
  • HistoryAndPlugin – Aktivieren Sie das predictive IntelliSense-Feature, und verwenden Sie sowohl Verlauf als auch Plug-In als Quellen. Dieser Wert wurde in PSReadLine 2.2.0 hinzugefügt.
Typ:Microsoft.PowerShell.PredictionSource
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-PredictionViewStyle

Legt die Formatvorlage für die Anzeige des Vorhersagetexts fest. Der Standardwert ist InlineView.

  • InlineView - der Stil heute, ähnlich wie in Fischschale und zsh. (Standard)
  • ListView – Vorschläge werden in einer Dropdownliste gerendert, und Benutzer können mithilfe von UpArrow und DownArrow auswählen.

Dieser Parameter wurde in PSReadLine 2.2.0 hinzugefügt.

Typ:Microsoft.PowerShell.PredictionViewStyle
Position:Named
Standardwert:InlineView
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-PromptText

Dieser Parameter legt den Wert der PromptText-Eigenschaft fest. Der Standardwert ist "> ".

PSReadLine analysiert Ihre Eingabeaufforderungsfunktion, um zu bestimmen, wie nur die Farbe eines Teils der Eingabeaufforderung geändert wird. Diese Analyse ist nicht 100 % zuverlässig. Verwenden Sie diese Option, wenn PSReadLine Ihre Eingabeaufforderung auf unerwartete Weise ändert. Schließen Sie nachfolgende Leerzeichen ein.

Der Wert dieses Parameters kann eine einzelne Zeichenfolge oder ein Array von zwei Zeichenfolgen sein. Die erste Zeichenfolge ist der Teil ihrer Eingabeaufforderungszeichenfolge, der bei einem Analysefehler in Rot geändert werden soll. Die zweite Zeichenfolge ist eine alternative Zeichenfolge, die verwendet werden soll, wenn ein Analysefehler auftritt.

Typ:String[]
Position:Named
Standardwert:>
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-ShowToolTips

Wenn mögliche Fertigstellungen angezeigt werden, werden QuickInfos in der Liste der Fertigstellungen angezeigt.

Diese Option ist standardmäßig aktiviert. Diese Option wurde in früheren Versionen von PSReadLine nicht standardmäßig aktiviert. Um die Option zu deaktivieren, legen Sie diese Option auf $False.

Dieser Parameter und diese Option wurden in PSReadLine 2.3.4 hinzugefügt.

Standardmäßig ist die ShowToolTips-Eigenschaft des globalen PSConsoleReadLineOptions-Objekts auf festgelegt True. Mit diesem SwitchParameter wird der Eigenschaftswert auf True. Um den Eigenschaftswert zu ändern, müssen Sie den Wert des SwitchParameter wie folgt angeben: -ShowToolTips:$False

Mit dem folgenden Befehl können Sie den Eigenschaftswert direkt festlegen:

(Get-PSReadLineOption).ShowToolTips = $False

Typ:SwitchParameter
Position:Named
Standardwert:True
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-TerminateOrphanedConsoleApps

Dieser Parameter legt die Option TerminateOrphanedConsoleApps auf $true.

Wenn Sie unter Windows STRG+C drücken, um einen Prozess zu beenden, empfängt jeder an eine Konsole angefügte Prozess ein Endsignal, im Gegensatz zu der aktiven Shell. Manchmal, wenn eine Shell eine große Struktur von untergeordneten Prozessen gestartet hat (stellen Sie sich z. B. ein Buildsystem vor), können einige Prozesse beendet werden, sodass mehrere Prozesse gleichzeitig versuchen, Konsoleneingaben zu nutzen.

Wenn Sie die Option "TerminateOrphanedConsoleApps" auf "$trueTerminateOrphanedApps" festlegen, zeichnet PSReadLine die Liste der Prozesse auf, die derzeit an die Konsole angefügt sind. Anschließend wird bei jeder Ausführung von PSReadLine eine neue Liste der Prozesse abgerufen, die an die Konsole angefügt sind, und diese beenden, die nicht in der ursprünglichen Liste enthalten sind.

Dieser Parameter und diese Option wurden in PSReadLine 2.3.4 hinzugefügt.

Typ:SwitchParameter
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-ViModeChangeHandler

Wenn der ViModeIndicator auf Script"" festgelegt ist, wird der bereitgestellte Skriptblock jedes Mal aufgerufen, wenn sich der Modus ändert. Der Skriptblock wird ein Argument vom Typ ViModebereitgestellt.

Dieser Parameter wurde in PowerShell 7 eingeführt.

Typ:ScriptBlock
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-ViModeIndicator

Mit dieser Option wird der visuelle Indikator für den aktuellen Vi-Modus festgelegt. Der Einfügemodus oder der Befehlsmodus.

Die folgenden Werte sind gültig:

  • Keine: Es gibt keinen Indikator.
  • Eingabeaufforderung: Die Eingabeaufforderung ändert die Farbe.
  • Cursor: Der Cursor ändert die Größe.
  • Skript: Vom Benutzer angegebener Text wird gedruckt.
Typ:ViModeStyle
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-WordDelimiters

Gibt die Zeichen an, die Wörter für Funktionen wie ForwardWord oder KillWord trennen.

Typ:String
Position:Named
Standardwert:;:,.[]{}()/\|^&*-=+'"---
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

Eingaben

None

Sie können keine Objekte an dieses Cmdlet weiterleiten.

Ausgaben

None

Dieses Cmdlet gibt keine Ausgabe zurück.