Set-PSReadLineOption

Syntax

Default (Standard)

Set-PSReadLineOption
    [-EditMode <EditMode>]
    [-ContinuationPrompt <String>]
    [-HistoryNoDuplicates]
    [-AddToHistoryHandler <System.Func[System.String,System.Object]>]
    [-CommandValidationHandler <System.Action[System.Management.Automation.Language.CommandAst]>]
    [-HistorySearchCursorMovesToEnd]
    [-MaximumHistoryCount <Int32>]
    [-MaximumKillRingCount <Int32>]
    [-ShowToolTips]
    [-ExtraPromptLineCount <Int32>]
    [-DingTone <Int32>]
    [-DingDuration <Int32>]
    [-BellStyle <BellStyle>]
    [-CompletionQueryItems <Int32>]
    [-WordDelimiters <String>]
    [-HistorySearchCaseSensitive]
    [-HistorySaveStyle <HistorySaveStyle>]
    [-HistorySavePath <String>]
    [-AnsiEscapeTimeout <Int32>]
    [-PromptText <String[]>]
    [-ViModeIndicator <ViModeStyle>]
    [-ViModeChangeHandler <ScriptBlock>]
    [-Colors <Hashtable>]
    [-PredictionSource <PredictionSource>]
    [<CommonParameters>]

Beschreibung

Beispiele

Beispiel 1: Festlegen von Vordergrund- und Hintergrundfarben

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

Beispiel 2: Festlegen des Glockenstils

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

Beispiel 3: Festlegen mehrerer Optionen

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

Beispiel 4: Festlegen mehrerer Farboptionen

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

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

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

Parameter

-AddToHistoryHandler

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

Die ScriptBlock- empfängt die Befehlszeile als Eingabe. Wenn das ScriptBlock-$Truezurückgibt, wird die Befehlszeile dem Verlauf hinzugefügt.

Parametereigenschaften

Parametersätze

-AnsiEscapeTimeout

Diese Option ist spezifisch für Windows, wenn die Eingabe umgeleitet wird, z. B. wenn sie unter tmux oder screenausgeführt wird.

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 geschlossen wird, dass sie eine vollständige Escapesequenz erhalten hat.

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

Parametereigenschaften

Parametersätze

-BellStyle

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

Die folgenden Werte sind gültig:

• Audible: Kurzer Signalton.
• Visuelle: Text blinkt kurz.
• Keine: Kein Feedback.

Parametereigenschaften

Parametersätze

-Colors

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

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

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

• 256 Farbe
• 24-Bit-Farbe
• Vordergrund, Hintergrund oder beides
• Umgekehrt, fett

Weitere Informationen zu ANSI-Farbcodes finden Sie unter ANSI-Escape-Code in Wikipedia.

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.
• Zeichenfolgen-: Die Zeichenfolgentokenfarbe.
• Operator: Die Operatortokenfarbe.
• Variable: Die Farbe des Variablentokens.
• Command: Die Befehlstokenfarbe.
• Parameter: Die Parametertokenfarbe.
• Typ: Die Typtokenfarbe.
• Number: Die Farbe des Zahlentokens.
• Member-: Die Elementnamentokenfarbe.
• InlinePrediction: Die Farbe für die Inlineansicht des Vorhersagevorschlags.

Parametereigenschaften

Parametersätze

-CommandValidationHandler

Gibt eine ScriptBlock- an, die von ValidateAndAcceptLineaufgerufen 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, z. B. um häufige typografische Fehler zu beheben.

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

Parametereigenschaften

Parametersätze

-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, werden PSReadLineJa/Nein- aufgefordert, bevor die Fertigstellungselemente angezeigt werden.

Parametereigenschaften

Parametersätze

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

Parametereigenschaften

Parametersätze

-DingDuration

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

Parametereigenschaften

Parametersätze

-DingTone

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

Parametereigenschaften

Parametersätze

-EditMode

Gibt den Befehlszeilenbearbeitungsmodus an. Mit diesem Parameter werden alle durch Set-PSReadLineKeyHandlerfestgelegten Tastenbindungen zurückgesetzt.

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.

Verwenden Sie Get-PSReadLineKeyHandler, um die Schlüsselbindungen für die aktuell konfigurierte EditMode-anzuzeigen.

Parametereigenschaften

Parametersätze

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

Parametereigenschaften

Parametersätze

-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 wird die HistoryNoDuplicates-Eigenschaft des globalen PSConsoleReadLineOptions-Objekt auf Truefestgelegt. Mit diesem SwitchParameter- wird der Eigenschaftswert auf Truefestgelegt. Um den Eigenschaftswert zu ändern, müssen Sie den Wert des SwitchParameter- wie folgt angeben: -HistoryNoDuplicates:$False.

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

(Get-PSReadLineOption).HistoryNoDuplicates = $False

Parametereigenschaften

Parametersätze

-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
• $env:HOME/.local/share/powershell/PSReadLine/$($host.Name)_history.txt

Parametereigenschaften

Parametersätze

-HistorySaveStyle

Gibt an, wie PSReadLine- den Verlauf speichert.

Gültige Werte sind wie folgt:

• SaveIncrementally: Speichern des Verlaufs, nachdem jeder Befehl ausgeführt und für mehrere Instanzen von PowerShell freigegeben wurde.
• SaveAtExit-: Anfügeverlaufsdatei beim Beenden von PowerShell.
• SaveNothing: Verwenden Sie keine Verlaufsdatei.

Parametereigenschaften

Parametersätze

-HistorySearchCaseSensitive

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

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

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

(Get-PSReadLineOption).HistorySearchCaseSensitive = $False

Parametereigenschaften

Parametersätze

-HistorySearchCursorMovesToEnd

Gibt an, dass der Cursor mithilfe einer Suche zum Ende der Befehle wechselt, die Sie aus dem Verlauf laden. Wenn dieser Parameter auf $Falsefestgelegt 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 Falsefestgelegt. Mit diesem SwitchParameter den Eigenschaftswert auf Truefestlegen. Um den Eigenschaftswert wieder zu ändern, müssen Sie den Wert der SwitchParameter- wie folgt angeben: -HistorySearchCursorMovesToEnd:$False.

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

(Get-PSReadLineOption).HistorySearchCursorMovesToEnd = $False

Parametereigenschaften

Parametersätze

-MaximumHistoryCount

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

PSReadLine- Verlauf ist vom PowerShell-Verlauf getrennt.

Parametereigenschaften

Parametersätze

-MaximumKillRingCount

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

Parametereigenschaften

Parametersätze

-PredictionSource

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

Gültige Werte sind:

• Keine: Deaktivieren Sie die Funktion für vorausschauende Vorschläge
• Verlauf: Erhalten Sie Vorhersagevorschläge nur aus der Historie

Parametereigenschaften

Parametersätze

-PromptText

Wenn ein Analysefehler auftritt, ändert PSReadLine- einen Teil der Eingabeaufforderung rot. PSReadLine analysiert Ihre Eingabeaufforderungsfunktion, um zu bestimmen, wie nur die Farbe eines Teils der Eingabeaufforderung geändert werden soll. 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.

Wenn Ihre Eingabeaufforderungsfunktion beispielsweise wie im folgenden Beispiel aussieht:

function prompt { Write-Host -NoNewLine -ForegroundColor Yellow "$pwd"; return "# " }

Stellen Sie dann ein:

Set-PSReadLineOption -PromptText "# "

Parametereigenschaften

Parametersätze

-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-standardmäßig nicht aktiviert. Zum Deaktivieren legen Sie diese Option auf $Falsefest.

Standardmäßig ist die ShowToolTips- eigenschaft der globalen PSConsoleReadLineOptions-Objekt auf Truefestgelegt. Mit diesem SwitchParameter- wird der Eigenschaftswert auf Truefestgelegt. 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

Parametereigenschaften

Parametersätze

-ViModeChangeHandler

Wenn die ViModeIndicator- auf Scriptfestgelegt ist, wird der bereitgestellte Skriptblock bei jeder Änderung des Modus aufgerufen. Der Skriptblock wird ein Argument vom Typ ViModebereitgestellt.

Dieser Parameter wurde in PowerShell 7 eingeführt.

Parametereigenschaften

Parametersätze

-ViModeIndicator

Diese Option legt die visuelle Anzeige für den aktuellen Vi-Modus fest. Der Einfügemodus oder der Befehlsmodus.

Die folgenden Werte sind gültig:

• Keine: Es gibt keinen Hinweis.
• Aufforderung: Die Eingabeaufforderung ändert die Farbe.
• Cursor: Der Cursor ändert die Größe.
• Skript-: Vom Benutzer angegebener Text wird gedruckt.

Parametereigenschaften

Parametersätze

-WordDelimiters

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

Parametereigenschaften

Parametersätze

CommonParameters

Eingaben

None

Ausgaben

None

Ähnliche Themen

• Über_PSReadLine
• Get-PSReadLineKeyHandler
• Get-PSReadLineOption
• Remove-PSReadLineKeyHandler
• Set-PSReadLineKeyHandler