Set-PSReadLineOption

Модуль:: PSReadLine Module

Настраивает поведение редактирования командной строки в PSReadLine.

Синтаксис

Default (По умолчанию)

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

Описание

Командлет Set-PSReadLineOption настраивает поведение модуля PSReadLine при редактировании командной строки. Для просмотра настроек PSReadLine используйте Get-PSReadLineOption.

Параметры, заданные этой командой, применяются только к текущему сеансу. Чтобы сохранить любые параметры, добавьте их в скрипт профиля. Дополнительные сведения см. в разделе about_Profiles и настройка среды оболочки.

Примеры

Пример 1. Настройка переднего плана и фоновых цветов

В этом примере PSReadLine настраивает отображение маркера комментария с зеленым текстом переднего плана на сером фоне. В escape-последовательности, используемой в примере, 32 представляет цвет переднего плана, а 47 — цвет фона.

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

Можно задать только цвет текста переднего плана. Например, ярко-зеленый цвет текста переднего плана для маркера комментария : "Comment"="`e[92m".

Пример 2. Настройка стиля колокола

В этом примере PSReadLine будет реагировать на ошибки или условия, требующие внимания пользователя. BellStyle установлен для выдачи звукового сигнала в 1221 Гц для 60 мс.

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

Замечание

Эта функция может работать не на всех хостах на платформах.

Пример 3: Установите несколько параметров

Set-PSReadLineOption Может установить несколько вариантов с помощью хеш-таблицы.

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

Хеш-таблица $PSReadLineOptions задает ключи и значения. Set-PSReadLineOption использует ключи и значения с для @PSReadLineOptions обновления параметров PSReadLine .

Ключи и значения, вводимые в имя хэш-таблицы, $PSReadLineOptions можно просмотреть в командной строке PowerShell.

Пример 4: Установите несколько вариантов цвета

В этом примере показано, как задать несколько значений цвета в одной команде.

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

Пример 5: Установка значений цвета для нескольких типов

В этом примере показаны три различных метода установки цвета маркеров, отображаемых в PSReadLine.

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

Пример 6: Используйте ViModeChangeHandler для отображения изменений режима Vi

В этом примере выполняется escape-последовательность VT при смене курсора в ответ на изменение режима 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

Функция OnViModeChange задает параметры курсора для режимов Vi : insert и command. ViModeChangeHandler использует Function: поставщик для ссылки на OnViModeChange в качестве объекта scriptblock.

Дополнительные сведения см. в разделе о поставщиках.

Пример 7. Использование HistoryHandler для фильтрации команд, добавленных в журнал

В следующем примере показано, как использовать его AddToHistoryHandler для предотвращения сохранения любых команд Git в журнал.

$ScriptBlock = {
    param ([string]$Line)

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

Set-PSReadLineOption -AddToHistoryHandler $ScriptBlock

Скриптблок возвращается$false, если команда запущена.git Это имеет тот же эффект, что и возврат перечисления SkipAddingAddToHistory . Если команда не начинается, gitобработчик возвращает $true и PSReadLine сохраняет команду в журнале.

Пример 8. Использование CommandValidationHandler для проверки команды перед выполнением команды

В этом примере показано, как использовать параметр CommandValidationHandler для выполнения команды перед выполнением команды. В примере специально проверяется наличие команды с помощью вложенной команды gitcmt и заменяется полное имя commit. Таким образом можно создать сокращенные псевдонимы для вложенных команд.

# 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

Пример 9. Использование параметра PromptText

При возникновении ошибки синтаксического анализа PSReadLine изменяет часть приглашения на красный. Параметр PromptText сообщает PSReadLine части строки запроса, чтобы сделать красным.

Например, в следующем примере создается запрос, содержащий текущий путь, за которым следует символ> () и пробел.

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

Первая строка — это часть строки запроса, которую нужно сделать красной при возникновении ошибки синтаксического анализа. Вторая строка — это альтернативная строка, используемая при возникновении ошибки синтаксического анализа.

Параметры

-AddToHistoryHandler

Задает ScriptBlock , который управляет добавлением команд в журнал PSReadLine .

ScriptBlock получает командную строку в качестве входных данных.

ScripBlock должен возвращать элемент перечисления AddToHistoryOption, строковое имя одного из этих элементов или логическое значение. В приведенном ниже списке описываются возможные значения и их эффекты.

MemoryAndFile — добавьте команду в файл журнала и текущий сеанс.
MemoryOnly — добавьте команду в журнал только для текущего сеанса.
SkipAdding — Не добавляйте команду в файл журнала для текущего сеанса.
$false — То же, что и если бы значение было SkipAdding.
$true — То же, что и если бы значение было MemoryAndFile.

Свойства параметров

Тип:	Func<T,TResult>[System.String,System.Object]
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-AnsiEscapeTimeout

Этот параметр специфичен для Windows, когда ввод перенаправляется, например, при работе под или tmuxscreen.

При перенаправленном вводе в Windows многие ключи отправляются в виде последовательности символов, начинающейся с escape-символа. Невозможно отличить один escape-символ, за которым следуют другие символы, и действительную последовательность escape-последовательности.

Предполагается, что терминал может отправлять символы быстрее, чем пользователь вводит их. PSReadLine ожидает этого тайм-аута, прежде чем сделать вывод о том, что он получил полную escape-последовательность.

Если при вводе текста отображаются случайные или неожиданные символы, это время ожидания можно изменить.

Свойства параметров

Тип:	Int32
Default value:	100
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-BellStyle

Указывает, как PSReadLine реагирует на различные ошибки и неоднозначные условия.

Допустимы следующие значения.

Audible: короткий сигнал.
Визуальный: текстовые вспышки кратко.
Нет: нет отзывов.

Свойства параметров

Тип:	BellStyle
Default value:	Audible
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-Colors

Параметр Colors определяет различные цвета, используемые PSReadLine.

Аргумент — это хэш-таблица, в которой ключи указывают элементы и значения, указывающие цвет. Дополнительные сведения см. в about_Hash_Tables.

Цвета могут быть либо значением из ConsoleColor, например [ConsoleColor]::Red, , , либо допустимой escape-последовательностью ANSI. Допустимые escape-последовательности зависят от вашего терминала. В PowerShell 5.0 примером escape-последовательности для красного текста является $([char]0x1b)[91m. В PowerShell 6 и более поздней версии одна и та же escape-последовательность `e[91m. Вы можете указать другие escape-последовательности, включая следующие типы:

Добавлены два параметра цвета для поддержки ListView настройки в PSReadLine 2.2.0:

ListPredictionColor — задает цвет для ведущего > символа и имени источника в конце, например [History]. По умолчанию он используется DarkYellow в качестве цвета переднего плана.
ListPredictionSelectedColor — задайте цвет для указания выбранного элемента списка. По умолчанию он используется DarkBlack в качестве цвета фона.
256 цвет
24-разрядный цвет
Передний план, фон или и то, и другое
Инверсный, полужирный

Дополнительные сведения о коде цветов ANSI см. в статье Википедии ANSI escape-код.

Допустимые ключи включают:

ContinuationPrompt: цвет запроса на продолжение.
Акцент: Акцент на цвете. Например, совпадающий текст при поиске истории.
Ошибка: цвет ошибки. Например, в подсказке.
Выделение: цвет для выделения выбора меню или выделенного текста.
По умолчанию: цвет токена по умолчанию.
Комментарий: Цвет токена комментария.
Ключевое слово: цвет токена ключевого слова.
Строка: цвет токена строки.
Operator: Цвет токена оператора.
Переменная: цвет маркера переменной.
Команда: цвет маркера команды.
Параметр: Цвет токена параметра.
Тип: Цвет токена типа.
Число: Цвет числового маркера.
Участник: цвет маркера имени участника.
InlinePrediction: цвет встроенного представления прогнозного предложения.
ListPrediction: цвет для имени ведущего > символа и источника прогнозирования.
ListPredictionSelected: цвет выбранного прогноза в представлении списка.

Свойства параметров

Тип:	Hashtable
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-CommandValidationHandler

Задает ScriptBlock, вызываемую из ValidateAndAcceptLine. Если исключение возникает, проверка завершается ошибкой и сообщается об ошибке.

Перед созданием исключения обработчик проверки может поместить курсор в точку ошибки, чтобы упростить исправление. Обработчик проверки также может изменить командную строку на исправление распространенных типографических ошибок.

ValidateAndAcceptLine используется для предотвращения загромождения журнала с командами, которые не могут работать.

Свойства параметров

Тип:	Action<T>[CommandAst]
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-CompletionQueryItems

Указывает максимальное количество элементов завершения, отображаемых без запроса.

Если количество отображаемых элементов больше этого значения, PSReadLine запрашивает ответ "да" или "нет " перед отображением элементов завершения.

Свойства параметров

Тип:	Int32
Default value:	100
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-ContinuationPrompt

Указывает строку, отображаемую в начале последующих строк при вводе многострочного ввода. Значение по умолчанию равно двойному значению знаков (>>). Допустимая пустая строка.

Свойства параметров

Тип:	String
Default value:	>>
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-DingDuration

Указывает длительность сигнала, если BellStyle имеет значение Audible.

Свойства параметров

Тип:	Int32
Default value:	50ms
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-DingTone

Задает тон в Герце (Гц) звукового сигнала, если BellStyle установлено значение Audible.

Свойства параметров

Тип:	Int32
Default value:	1221
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-EditMode

Задает режим редактирования командной строки. Использование этого параметра сбрасывает все привязки ключей, заданные Set-PSReadLineKeyHandler.

Допустимы следующие значения.

Windows: ключевые привязки эмулируют PowerShell, cmd и Visual Studio. (по умолчанию в Windows)
Emacs: ключевые привязки эмулируют Bash или Emacs. (по умолчанию на платформах, отличных от Windows)
Vi: ключевые привязки эмулируют Vi.

Используйте Get-PSReadLineKeyHandler для просмотра привязок клавиш для текущего настроенного режима EditMode.

Свойства параметров

Тип:	EditMode
Default value:	Windows
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-ExtraPromptLineCount

Указывает количество дополнительных строк.

Если запрос охватывает несколько строк, укажите значение для этого параметра. Используйте эту опцию, если вы хотите, чтобы дополнительные строки были доступны, когда PSReadLine отображает запрос после показа некоторого вывода. Например, PSReadLine возвращает список завершений.

Эта опция нужна меньше, чем в предыдущих версиях PSReadLine, но полезна при InvokePrompt использовании функции.

Свойства параметров

Тип:	Int32
Default value:	0
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-HistoryNoDuplicates

Этот параметр управляет поведением отзыва. Повторяющиеся команды по-прежнему добавляются в файл журнала. Если этот параметр задан, при отзыве команд отображается только последнее вызов. Повторяющиеся команды добавляются в журнал для сохранения порядка во время отзыва. Однако обычно вы не хотите видеть команду несколько раз при отзыве или поиске в журнале.

По умолчанию свойство HistoryNoDuplicates глобального объекта PSConsoleReadLineOptions имеет значение True. Чтобы изменить значение свойства, необходимо указать значение параметра SwitchParameter следующим образом: -HistoryNoDuplicates:$false. Вы можете вернуться к True использованию только switchParameter, -HistoryNoDuplicates.

С помощью следующей команды вы можете задать значение свойства напрямую:

(Get-PSReadLineOption).HistoryNoDuplicates = $false

Свойства параметров

Тип:	SwitchParameter
Default value:	False
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-HistorySavePath

Указывает путь к файлу, в котором сохраняется журнал. Компьютеры под управлением Windows или других платформ хранят файл в разных местах. Имя файла хранится в переменной $($Host.Name)_history.txt, например ConsoleHost_history.txt.

Если этот параметр не используется, путь по умолчанию выглядит следующим образом:

Виндоус

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

отличных от Windows

$Env:XDG_DATA_HOME/powershell/PSReadLine/$($Host.Name)_history.txt
$HOME/.local/share/powershell/PSReadLine/$($Host.Name)_history.txt

Свойства параметров

Тип:	String
Default value:	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
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-HistorySaveStyle

Указывает, как PSReadLine сохраняет историю.

Допустимые значения приведены следующим образом:

SaveIncrementally: сохранение журнала после выполнения каждой команды и совместного использования в нескольких экземплярах PowerShell.
SaveAtExit: добавление файла журнала при выходе PowerShell.
SaveNothing: не используйте файл журнала.

Замечание

Если вы установите для HistorySaveStyleSaveNothing значение и установите его SaveIncrementally в дальнейшем в том же сеансе, PSReadLine сохраняет все команды, которые ранее выполнялись в сеансе.

Свойства параметров

Тип:	HistorySaveStyle
Default value:	SaveIncrementally
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-HistorySearchCaseSensitive

Указывает, что поиск по журналу учитывает регистр в таких функциях, как ReverseSearchHistory или HistorySearchBackward.

По умолчанию свойству HistorySearchCaseSensitive глобального объекта PSConsoleReadLineOptions присвоено значение False. С помощью этого SwitchParameter задает значение свойства .True Чтобы изменить значение свойства обратно, необходимо указать значение SwitchParameter следующим образом: -HistorySearchCaseSensitive:$false.

С помощью следующей команды вы можете задать значение свойства напрямую:

(Get-PSReadLineOption).HistorySearchCaseSensitive = $false

Свойства параметров

Тип:	SwitchParameter
Default value:	False
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-HistorySearchCursorMovesToEnd

Указывает, что курсор перемещается в конец команд, загруженных из журнала с помощью поиска. Если для этого параметра задано значение $false, курсор остается в положении, когда вы нажимали стрелки вверх или вниз.

По умолчанию свойству HistorySearchCursorMovesToEnd глобального объекта PSConsoleReadLineOptions присвоено значение False. Используя этот параметр SwitchParameter , установите значение свойства в True. Чтобы изменить значение свойства обратно, необходимо указать значение SwitchParameter следующим образом: -HistorySearchCursorMovesToEnd:$false.

С помощью следующей команды вы можете задать значение свойства напрямую:

(Get-PSReadLineOption).HistorySearchCursorMovesToEnd = $false

Свойства параметров

Тип:	SwitchParameter
Default value:	False
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-MaximumHistoryCount

Указывает максимальное количество команд для сохранения в истории PSReadLine .

Журнал PSReadLine отделен от журнала PowerShell.

Свойства параметров

Тип:	Int32
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-MaximumKillRingCount

Указывает максимальное количество элементов, хранящихся в круге убийства.

Свойства параметров

Тип:	Int32
Default value:	10
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-PredictionSource

Указывает источник для PSReadLine для получения прогнозных предложений.

Допустимые значения:

Нет — отключите прогнозную функцию IntelliSense (по умолчанию).
Журнал — включите функцию прогнозирования IntelliSense и используйте журнал PSReadLine в качестве единственного источника.
Подключаемый модуль — включите функцию прогнозного intelliSense и используйте подключаемые модули (CommandPrediction) в качестве единственного источника. Это значение было добавлено в PSReadLine 2.2.0
HistoryAndPlugin — включите прогнозную функцию IntelliSense и используйте журнал и подключаемый модуль в качестве источников. Это значение было добавлено в PSReadLine 2.2.0

Свойства параметров

Тип:	Microsoft.PowerShell.PredictionSource
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-PredictionViewStyle

Задает стиль для отображения прогнозного текста. Значение по умолчанию — InlineView.

InlineView - стиль, как существующий сегодня, как и в рыбной оболочке и zsh. (default)
ListView — предложения отображаются в раскрывающемся списке, и пользователи могут выбирать использование UpArrow и DownArrow.

Этот параметр был добавлен в PSReadLine 2.2.0

Свойства параметров

Тип:	Microsoft.PowerShell.PredictionViewStyle
Default value:	InlineView
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-PromptText

Этот параметр задает значение свойства PromptText . Значение по умолчанию — "> ".

PSReadLine анализирует функцию приглашения, чтобы определить, как изменить цвет только части приглашения. Этот анализ не является надежным на 100%. Используйте этот параметр, если PSReadLine изменяет приглашение неожиданным образом. Добавьте все завершающие пробелы.

Значение этого параметра может быть одной строкой или массивом двух строк. Первая строка — это часть строки запроса, которую необходимо изменить на красную, когда возникает ошибка синтаксического анализа. Вторая строка — это альтернативная строка, используемая при возникновении ошибки синтаксического анализа.

Свойства параметров

Тип:	String[]
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-ShowToolTips

При отображении возможных завершений подсказки отображаются в списке завершения.

Этот параметр включен по умолчанию. Эта опция не была включена по умолчанию в предыдущих версиях PSReadLine. Чтобы отключить, задайте для этого параметра значение $false.

Этот параметр и параметр были добавлены в PSReadLine 2.3.4.

По умолчанию свойству ShowToolTips глобального объекта PSConsoleReadLineOptions присвоено значение True. С помощью этого SwitchParameter задает значение свойства .True Чтобы изменить значение свойства, необходимо указать значение параметра SwitchParameter следующим образом: -ShowToolTips:$false.

С помощью следующей команды вы можете задать значение свойства напрямую:

(Get-PSReadLineOption).ShowToolTips = $false

Свойства параметров

Тип:	SwitchParameter
Default value:	True
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-TerminateOrphanedConsoleApps

Этот параметр задает для параметра TerminateOrphanedConsoleApps значение $true.

В Windows при нажатии клавиш CTRL+c для завершения процесса каждый процесс, подключенный к консоли, получает сигнал завершения, а не только активную оболочку. Иногда, когда оболочка запустила большое дерево дочерних процессов (представьте, что система сборки, например) некоторые процессы могут выйти, оставляя несколько процессов одновременно пытаясь использовать входные данные консоли.

При задании параметра $true значение PSReadLine записывает список процессов, которые в настоящее время подключены к консоли. После этого при каждом запуске PSReadLine он получит новый список процессов, подключенных к консоли, и завершит работу тех, которые не указаны в исходном списке.

Этот параметр и параметр были добавлены в PSReadLine 2.3.4.

Свойства параметров

Тип:	SwitchParameter
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-ViModeChangeHandler

Если для параметра ViModeIndicator задано Scriptзначение, предоставленный скрипт, будет вызываться каждый раз при изменении режима. Блок скрипта предоставляется один аргумент типа ViMode.

Этот параметр появился в PowerShell 7.

Свойства параметров

Тип:	ScriptBlock
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-ViModeIndicator

Этот параметр задает визуальный индикатор для текущего режима Vi . Либо режим вставки, либо командный режим.

Допустимы следующие значения.

Нет: нет индикатора.
Подсказка: Подсказка меняет цвет.
Курсор: Курсор изменяет размер.
Скрипт: Выводится текст, указанный пользователем.

Свойства параметров

Тип:	ViModeStyle
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-WordDelimiters

Задает символы, разделяющие слова для функций, таких как ForwardWord или KillWord.

Свойства параметров

Тип:	String
Default value:	;:,.[]{}()/\\|^&*-=+'"---
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

CommonParameters

Этот командлет поддерживает общие параметры: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction и -WarningVariable. Дополнительные сведения см. в разделе about_CommonParameters.

Входные данные

None

Невозможно передать объекты в этот командлет.

Выходные данные

None

Этот командлет не возвращает выходные данные.

Обратная связь

Были ли сведения на этой странице полезными?

Поделиться через

Set-PSReadLineOption

Синтаксис

Default (По умолчанию)

Описание

Примеры

Пример 1. Настройка переднего плана и фоновых цветов

Пример 2. Настройка стиля колокола

Пример 3: Установите несколько параметров

Пример 4: Установите несколько вариантов цвета

Пример 5: Установка значений цвета для нескольких типов

Пример 6: Используйте ViModeChangeHandler для отображения изменений режима Vi

Пример 7. Использование HistoryHandler для фильтрации команд, добавленных в журнал

Пример 8. Использование CommandValidationHandler для проверки команды перед выполнением команды

Пример 9. Использование параметра PromptText

Параметры

-AddToHistoryHandler

Свойства параметров

Наборы параметров

-AnsiEscapeTimeout

Свойства параметров

Наборы параметров

-BellStyle

Свойства параметров

Наборы параметров

-Colors

Свойства параметров

Наборы параметров

-CommandValidationHandler

Свойства параметров

Наборы параметров

-CompletionQueryItems

Свойства параметров

Наборы параметров

-ContinuationPrompt

Свойства параметров

Наборы параметров

-DingDuration

Свойства параметров

Наборы параметров

-DingTone

Свойства параметров

Наборы параметров

-EditMode

Свойства параметров

Наборы параметров

-ExtraPromptLineCount

Свойства параметров

Наборы параметров

-HistoryNoDuplicates

Свойства параметров

Наборы параметров

-HistorySavePath

Свойства параметров

Наборы параметров

-HistorySaveStyle

Свойства параметров

Наборы параметров

-HistorySearchCaseSensitive

Свойства параметров

Наборы параметров

-HistorySearchCursorMovesToEnd

Свойства параметров

Наборы параметров

-MaximumHistoryCount

Свойства параметров

Наборы параметров

-MaximumKillRingCount

Свойства параметров

Наборы параметров

-PredictionSource

Свойства параметров

Наборы параметров

-PredictionViewStyle

Свойства параметров

Наборы параметров

-PromptText

Свойства параметров

Наборы параметров

-ShowToolTips