Set-PSReadLineOption

Składnia

Default (domyślnie)

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

Opis

Przykłady

Przykład 1. Ustawianie kolorów pierwszego planu i tła

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

Przykład 2. Ustawianie stylu dzwonka

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

Przykład 3. Ustawianie wielu opcji

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

Przykład 4. Ustawianie wielu opcji kolorów

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

Przykład 5. Ustawianie wartości kolorów dla wielu typów

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"
}

Przykład 6. Używanie programu ViModeChangeHandler do wyświetlania zmian trybu Vi

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

Parametry

-AddToHistoryHandler

Określa element ScriptBlock , który kontroluje, które polecenia są dodawane do historii PSReadLine .

ScriptBlock odbiera wiersz polecenia jako dane wejściowe. Jeśli ScriptBlock zwróci $True, wiersz polecenia jest dodawany do historii.

Właściwości parametru

Zestawy parametrów

-AnsiEscapeTimeout

Ta opcja jest specyficzna dla systemu Windows, gdy dane wejściowe są przekierowywane, na przykład podczas uruchamiania w obszarze tmux lub screen.

W przypadku przekierowanych danych wejściowych w systemie Windows wiele kluczy jest wysyłanych jako sekwencja znaków rozpoczynających się od znaku ucieczki. Nie można odróżnić pojedynczego znaku ucieczki, po którym następuje więcej znaków i prawidłowej sekwencji ucieczki.

Zakłada się, że terminal może wysyłać znaki szybciej niż typy użytkowników. PSReadLine czeka na ten limit czasu przed stwierdzeniem, że otrzymał pełną sekwencję ucieczki.

Jeśli podczas wpisywania są wyświetlane losowe lub nieoczekiwane znaki, możesz dostosować ten limit czasu.

Właściwości parametru

Zestawy parametrów

-BellStyle

Określa, jak PSReadLine reaguje na różne błędy i niejednoznaczne warunki.

Prawidłowe wartości są następujące:

• Audible: krótki sygnał dźwiękowy.
• Visual: tekst krótko.
• Brak: brak opinii.

Właściwości parametru

Zestawy parametrów

-Colors

Parametr kolory określa różne kolory używane przez PSReadLine.

Argument jest tabelą skrótów, w której klucze określają, który element, a wartości określają kolor. Aby uzyskać więcej informacji, zobacz about_Hash_Tables.

Kolory mogą być wartością z ConsoleColor, na przykład [ConsoleColor]::Redlub prawidłową sekwencją ucieczki ANSI. Prawidłowe sekwencje ucieczki zależą od terminalu. W programie PowerShell 5.0 przykładowa sekwencja ucieczki dla czerwonego tekstu jest $([char]0x1b)[91m. W programie PowerShell 6 lub nowszym ta sama sekwencja ucieczki to `e[91m. Można określić inne sekwencje ucieczki, w tym następujące typy:

• Kolor 256
• Kolor 24-bitowy
• Pierwszy plan, tło lub oba
• Odwrotność, pogrubienie

Aby uzyskać więcej informacji na temat kodów kolorów ANSI, zobacz kod ucieczki ANSI w Wikipedii.

Prawidłowe klucze obejmują:

• ContinuationPrompt: kolor monitu kontynuacji.
• wyróżnienie: kolor wyróżnienia. Na przykład pasujący tekst podczas wyszukiwania historii.
• błąd: kolor błędu. Na przykład w wierszu polecenia.
• zaznaczenie: kolor wyróżnienia zaznaczenia menu lub zaznaczonego tekstu.
• domyślny: domyślny kolor tokenu.
• Komentarz: kolor tokenu komentarza.
• słowo kluczowe: kolor tokenu słowa kluczowego.
• ciąg: kolor tokenu ciągu.
• Operator: kolor tokenu operatora.
• zmiennej: kolor tokenu zmiennej.
• command: kolor tokenu polecenia.
• Parametr: kolor tokenu parametru.
• Typ: kolor tokenu typu.
• numer: kolor tokenu liczbowego.
• elementu członkowskiego: kolor tokenu nazwy elementu członkowskiego.
• InlinePrediction: kolor wbudowanego widoku sugestii predykcyjnej.

Właściwości parametru

Zestawy parametrów

-CommandValidationHandler

Określa ScriptBlock wywoływany z ValidateAndAcceptLine. Jeśli zgłaszany jest wyjątek, walidacja zakończy się niepowodzeniem i zostanie zgłoszony błąd.

Przed zgłoszeniem wyjątku program obsługi walidacji może umieścić kursor w punkcie błędu, aby ułatwić jego naprawienie. Program obsługi poprawności może również zmienić wiersz polecenia, na przykład w celu poprawienia typowych błędów typograficznych.

validateAndAcceptLine służy do unikania bałaganu historii za pomocą poleceń, które nie mogą działać.

Właściwości parametru

Zestawy parametrów

-CompletionQueryItems

Określa maksymalną liczbę elementów uzupełniania, które są wyświetlane bez monitowania.

Jeśli liczba elementów do wyświetlenia jest większa niż ta wartość, polecenie PSReadLine monituje tak/nie przed wyświetleniem elementów ukończenia.

Właściwości parametru

Zestawy parametrów

-ContinuationPrompt

Określa ciąg wyświetlany na początku kolejnych wierszy po wprowadzeniu danych wejściowych z wieloma wierszami. Wartość domyślna to dwukrotnie większe niż znaki (>>). Pusty ciąg jest prawidłowy.

Właściwości parametru

Zestawy parametrów

-DingDuration

Określa czas trwania sygnału dźwiękowego, gdy BellStyle jest ustawiona na Audible.

Właściwości parametru

Zestawy parametrów

-DingTone

Określa ton w hertz (Hz) sygnału sygnału, gdy BellStyle jest ustawiona na Audible.

Właściwości parametru

Zestawy parametrów

-EditMode

Określa tryb edycji wiersza polecenia. Za pomocą tego parametru resetuje wszystkie powiązania kluczy ustawione przez Set-PSReadLineKeyHandler.

Prawidłowe wartości są następujące:

• windows: powiązania kluczy emulują program PowerShell, cmd i program Visual Studio.
• Emacs: Powiązania emulują powłokę Bash lub Emacs.
• Vi: powiązania kluczy emulują vi.

Użyj Get-PSReadLineKeyHandler, aby wyświetlić powiązania kluczy dla aktualnie skonfigurowanego EditMode.

Właściwości parametru

Zestawy parametrów

-ExtraPromptLineCount

Określa liczbę dodatkowych wierszy.

Jeśli monit obejmuje więcej niż jeden wiersz, określ wartość tego parametru. Użyj tej opcji, jeśli chcesz, aby dodatkowe wiersze były dostępne, gdy psReadLine wyświetla monit po wyświetleniu niektórych danych wyjściowych. Na przykład PSReadLine zwraca listę uzupełniania.

Ta opcja jest potrzebna mniej niż w poprzednich wersjach psReadLine, ale jest przydatna, gdy jest używana funkcja InvokePrompt.

Właściwości parametru

Zestawy parametrów

-HistoryNoDuplicates

Ta opcja steruje zachowaniem odwołania. Zduplikowane polecenia są nadal dodawane do pliku historii. Po ustawieniu tej opcji podczas przywoływania poleceń pojawia się tylko najnowsze wywołanie. Powtarzające się polecenia są dodawane do historii w celu zachowania kolejności podczas odwoływania. Jednak zazwyczaj nie chcesz wyświetlać polecenia wiele razy podczas odwoływania lub przeszukiwania historii.

Domyślnie właściwość HistoryNoDuplicates globalnej PSConsoleReadLineOption s jest ustawiona na True. Za pomocą tej SwitchParameter ustawia wartość właściwości na True. Aby zmienić wartość właściwości, należy określić wartość SwitchParameter w następujący sposób: -HistoryNoDuplicates:$False.

Za pomocą następującego polecenia można ustawić wartość właściwości bezpośrednio:

(Get-PSReadLineOption).HistoryNoDuplicates = $False

Właściwości parametru

Zestawy parametrów

-HistorySavePath

Określa ścieżkę do pliku, w którym jest zapisywana historia. Komputery z systemem Windows lub platformami innych niż Windows przechowują plik w różnych lokalizacjach. Nazwa pliku jest przechowywana w zmiennej $($host.Name)_history.txt, na przykład ConsoleHost_history.txt.

Jeśli nie używasz tego parametru, domyślna ścieżka jest następująca:

Windows

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

innych niż Windows

• $env:XDG_DATA_HOME/powershell/PSReadLine/$($host.Name)_history.txt
• $env:HOME/.local/share/powershell/PSReadLine/$($host.Name)_history.txt

Właściwości parametru

Zestawy parametrów

-HistorySaveStyle

Określa sposób zapisywania historii PSReadLine.

Prawidłowe wartości są następujące:

• ZapiszPrzyrostowo: Zapisz historię po wykonaniu każdego polecenia i udostępnij ją w wielu wystąpieniach programu PowerShell.
• SaveAtExit: Dołącz plik historii po zamknięciu programu PowerShell.
• SaveNothing: Nie używaj pliku historii.

Właściwości parametru

Zestawy parametrów

-HistorySearchCaseSensitive

Określa, że wyszukiwanie historii jest uwzględniane wielkość liter w funkcjach, takich jak ReverseSearchHistory lub HistorySearchBackward.

Domyślnie właściwość HistorySearchCaseSensitive globalnej PSConsoleReadLineOption s jest ustawiona na False. Za pomocą tej SwitchParameter ustawia wartość właściwości na True. Aby zmienić wartość właściwości z powrotem, należy określić wartość SwitchParameter w następujący sposób: -HistorySearchCaseSensitive:$False.

Za pomocą następującego polecenia można ustawić wartość właściwości bezpośrednio:

(Get-PSReadLineOption).HistorySearchCaseSensitive = $False

Właściwości parametru

Zestawy parametrów

-HistorySearchCursorMovesToEnd

Wskazuje, że kursor przechodzi na koniec poleceń ładowanych z historii przy użyciu wyszukiwania. Gdy ten parametr jest ustawiony na $False, kursor pozostaje w położeniu, w którym był po naciśnięciu strzałek w górę lub w dół.

Domyślnie właściwość HistorySearchCursorMovesToEnd globalnej PSConsoleReadLineOption s jest ustawiona na False. Za pomocą tej SwitchParameter ustaw wartość właściwości na True. Aby zmienić wartość właściwości z powrotem, należy określić wartość SwitchParameter w następujący sposób: -HistorySearchCursorMovesToEnd:$False.

Za pomocą następującego polecenia można ustawić wartość właściwości bezpośrednio:

(Get-PSReadLineOption).HistorySearchCursorMovesToEnd = $False

Właściwości parametru

Zestawy parametrów

-MaximumHistoryCount

Określa maksymalną liczbę poleceń do zapisania w historii PSReadLine.

historia PSReadLine jest oddzielona od historii programu PowerShell.

Właściwości parametru

Zestawy parametrów

-MaximumKillRingCount

Określa maksymalną liczbę elementów przechowywanych w pierścieniu kill.

Właściwości parametru

Zestawy parametrów

-PredictionSource

Określa źródło elementu PSReadLine, aby uzyskać sugestie predykcyjne.

Prawidłowe wartości to:

• Brak: wyłącz funkcję sugestii predykcyjnych
• Historia: otrzymuj sugestie predykcyjne tylko z historii

Właściwości parametru

Zestawy parametrów

-PromptText

W przypadku wystąpienia błędu analizy PSReadLine zmienia część monitu na czerwono. psReadLine analizuje funkcję monitu, aby określić, jak zmienić tylko kolor części monitu. Ta analiza nie jest niezawodna w 100%.

Użyj tej opcji, jeśli PSReadLine zmienia monit w nieoczekiwany sposób. Uwzględnij wszelkie białe znaki końcowe.

Na przykład, jeśli funkcja monitu wyglądała podobnie do poniższego przykładu:

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

Następnie ustaw:

Set-PSReadLineOption -PromptText "# "

Właściwości parametru

Zestawy parametrów

-ShowToolTips

Podczas wyświetlania możliwych uzupełniania etykietki narzędzi są wyświetlane na liście uzupełniania.

Ta opcja jest domyślnie włączona. Ta opcja nie została domyślnie włączona w poprzednich wersjach PSReadLine. Aby wyłączyć, ustaw tę opcję na $False.

Domyślnie właściwość ShowToolTips globalnego PSConsoleReadLineOption s jest ustawiona na True. Za pomocą tej SwitchParameter ustawia wartość właściwości na True. Aby zmienić wartość właściwości, należy określić wartość SwitchParameter w następujący sposób: -ShowToolTips:$False.

Za pomocą następującego polecenia można ustawić wartość właściwości bezpośrednio:

(Get-PSReadLineOption).ShowToolTips = $False

Właściwości parametru

Zestawy parametrów

-ViModeChangeHandler

Gdy ViModeIndicator jest ustawiona na Script, udostępniony blok skryptu będzie wywoływany za każdym razem, gdy tryb ulegnie zmianie. Blok skryptu jest dostarczany jeden argument typu ViMode.

Ten parametr został wprowadzony w programie PowerShell 7.

Właściwości parametru

Zestawy parametrów

-ViModeIndicator

Ta opcja ustawia wizualne wskazanie dla bieżącego trybu Vi . Tryb wstawiania lub trybu polecenia.

Prawidłowe wartości są następujące:

• Brak: Nie ma wskazania.
• Monituj: monit zmienia kolor.
• Kursor: kursor zmienia rozmiar.
• skryptu: tekst określony przez użytkownika jest drukowany.

Właściwości parametru

Zestawy parametrów

-WordDelimiters

Określa znaki rozdzielające wyrazy dla funkcji, takich jak ForwardWord lub KillWord.

Właściwości parametru

Zestawy parametrów

CommonParameters

Dane wejściowe

None

Dane wyjściowe

None

Linki powiązane

• Informacje o PSReadLine
• Get-PSReadLineKeyHandler
• Get-PSReadLineOption (komenda PowerShell)
• Remove-PSReadLineKeyHandler
• Set-PSReadLineKeyHandler