Set-PSReadLineOption

Modul:

PSReadLine Module

Přizpůsobí chování úprav příkazového řádku v PSReadLine.

Syntaxe

Default (Výchozí)

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

Description

Rutina Set-PSReadLineOption při úpravě příkazového řádku přizpůsobí chování modulu PSReadLine. Pokud chcete zobrazit nastavení PSReadLine, použijte Get-PSReadLineOption.

Možnosti nastavené tímto příkazem se vztahují pouze na aktuální relaci. Pokud chcete zachovat všechny možnosti, přidejte je do skriptu profilu. Další informace naleznete v tématu about_Profiles a Přizpůsobení prostředí.

Příklady

Příklad 1: Nastavení barev popředí a pozadí

Tento příklad nastaví PSReadLine tak, aby zobrazoval token Komentář se zeleným textem popředí na šedém pozadí. V řídicí sekvenci použité v příkladu představuje 32 barvu popředí a 47 představuje barvu pozadí.

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

Můžete nastavit pouze barvu textu popředí. Například jasně zelená barva textu popředí pro Komentář token: "Comment"="`e[92m".

Příklad 2: Nastavení stylu zvonku

V tomto příkladu PSReadLine odpoví na chyby nebo podmínky, které vyžadují pozornost uživatele. BellStyle je nastaven na 1221 Hz pro 60 ms zvuková pípnutí.

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

Poznámka:

Tato funkce nemusí fungovat ve všech hostitelích na platformách.

Příklad 3: Nastavení více možností

Set-PSReadLineOption může nastavit více možností s tabulkou hash.

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

Tabulka hodnot hash $PSReadLineOptions nastaví klíče a hodnoty. Set-PSReadLineOption používá klíče a hodnoty s @PSReadLineOptions k aktualizaci možností PSReadLine.

Na příkazovém řádku PowerShellu můžete zobrazit klíče a hodnoty, které zadávají název tabulky hash, $PSReadLineOptions.

Příklad 4: Nastavení více možností barev

Tento příklad ukazuje, jak nastavit více než jednu hodnotu barvy v jednom příkazu.

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

Příklad 5: Nastavení hodnot barev pro více typů

Tento příklad ukazuje tři různé metody, jak nastavit barvu tokenů zobrazených v 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"
}

Příklad 6: Zobrazení změn režimu Vi Pomocí ViModeChangeHandler

Tento příklad vygeneruje řídicí znak změny kurzoru VT v reakci na změnu režimu 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

Funkce OnViModeChange nastaví možnosti kurzoru pro režimy Vi: insert a command. ViModeChangeHandler používá zprostředkovatele Function: odkazovat na OnViModeChange jako objekt bloku skriptu.

Pro více informací viz about_Providers.

Příklad 7: Použití HistoryHandler k filtrování příkazů přidaných do historie

Následující příklad ukazuje, jak pomocí AddToHistoryHandler zabránit uložení příkazů Git do historie.

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

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

Set-PSReadLineOption -AddToHistoryHandler $ScriptBlock

Skriptblock vrátí $false, pokud příkaz začal s git. To má stejný účinek jako vrácení SkipAddingAddToHistory výčtu. Pokud příkaz nezačíná git, vrátí obslužná rutina $true a PSReadLine uloží příkaz v historii.

Příklad 8: Použití CommandValidationHandler k ověření příkazu před jeho spuštěním

Tento příklad ukazuje, jak pomocí parametru CommandValidationHandler spustit příkaz před spuštěním příkazu. Příklad konkrétně zkontroluje příkaz git pod příkazem cmt a nahradí ho úplným názvem commit. Tímto způsobem můžete vytvořit zkratkové aliasy pro dílčí příkazy.

# 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

Příklad 9: Použití parametru PromptText

Pokud dojde k chybě analýzy, PSReadLine změní část výzvy červeně. Parametr PromptText říká PSReadLine části řetězce výzvy, aby byl červený.

Například následující příklad vytvoří výzvu, která obsahuje aktuální cestu následovanou znakem větší než (>) a mezerou.

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

První řetězec je část řetězce výzvy, kterou chcete v případě chyby analýzy zčervenat. Druhý řetězec je alternativní řetězec, který se použije, když dojde k chybě analýzy.

Parametry

-AddToHistoryHandler

Určuje ScriptBlock, který určuje, jak se příkazy přidají do historie PSReadLine.

ScriptBlock obdrží příkazový řádek jako vstup.

ScripBlock by měl vrátit člena AddToHistoryOption výčtu, název řetězce jednoho z těchto členů nebo logickou hodnotu. Následující seznam popisuje možné hodnoty a jejich účinky.

• MemoryAndFile – přidejte příkaz do souboru historie a aktuální relace.
• MemoryOnly – přidání příkazu do historie pouze pro aktuální relaci
• SkipAdding – Nepřidávejte příkaz do souboru historie pro aktuální relaci.
• $false – stejné jako v případě, že byla hodnota SkipAdding.
• $true – stejné jako v případě, že byla hodnota MemoryAndFile.

Vlastnosti parametru

Typ:	Func<T,TResult>[System.String,System.Object]
Default value:	None
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-AnsiEscapeTimeout

Tato možnost je specifická pro Systém Windows při přesměrování vstupu, například při spuštění pod tmux nebo screen.

Při přesměrování vstupu ve Windows se mnoho klíčů odesílá jako posloupnost znaků začínající řídicím znakem. Není možné rozlišovat mezi jedním řídicím znakem následovaným více znaky a platnou řídicí sekvencí.

Předpokladem je, že terminál může znaky odesílat rychleji než typ uživatele. PSReadLine počká na tento časový limit, než skončí, že obdržel úplnou řídicí sekvenci.

Pokud se při psaní zobrazí náhodné nebo neočekávané znaky, můžete tento časový limit upravit.

Vlastnosti parametru

Typ:	Int32
Default value:	100
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-BellStyle

Určuje, jak PSReadLine reagovat na různé chybové a nejednoznačné podmínky.

Platné hodnoty jsou následující:

• zvukovou: krátká pípnutí.
• Vizuální: Text krátce bliká.
• Žádné: Žádná zpětná vazba.

Vlastnosti parametru

Typ:	BellStyle
Default value:	Audible
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-Colors

Parametr Colors určuje různé barvy používané PSReadLine.

Argument je tabulka hash, kde klíče určují prvky a hodnoty určují barvu. Další informace najdete v tématu about_Hash_Tables.

Barvy mohou být buď hodnota z ConsoleColor, například [ConsoleColor]::Red, nebo platnou řídicí sekvenci ANSI. Platné řídicí sekvence závisí na terminálu. V PowerShellu 5.0 je příklad řídicí sekvence pro červený text $([char]0x1b)[91m. V PowerShellu 6 a novějším je stejná řídicí sekvence `e[91m. Můžete zadat další řídicí sekvence, včetně následujících typů:

Byla přidána dvě nastavení barev pro podporu přizpůsobení ListView v PSReadLine 2.2.0:

• ListPredictionColor – nastavte barvu úvodního znaku > a koncového názvu zdroje, například [History]. Ve výchozím nastavení používá DarkYellow jako barvu popředí.

• ListPredictionSelectedColor – nastavte barvu pro označení položky seznamu. Ve výchozím nastavení používá jako barvu pozadí DarkBlack.

• 256 barev

• 24bitová barva

• Popředí, pozadí nebo obojí

• Inverzní, tučné

Další informace o kódech barev ANSI naleznete v článku Wikipedie řídicí kód ANSI.

Mezi platné klíče patří:

• ContinuationPrompt: Barva výzvy k pokračování.
• zdůraznění: Barva zvýraznění. Například odpovídající text při hledání historie.
• Chyba: Barva chyby. Například v příkazovém řádku.
• výběr: Barva, která zvýrazní výběr nabídky nebo vybraný text.
• Výchozí: Výchozí barva tokenu.
• Komentář: Barva tokenu komentáře.
• Klíčové slovo: Barva tokenu klíčového slova.
• Řetězcová: Barva tokenu řetězce.
• Operátor: Barva tokenu operátoru.
• Proměnná: Barva tokenu proměnné.
• Command: Barva tokenu příkazu.
• Parametr: Barva tokenu parametru.
• Typ: Barva tokenu typu.
• Číslo: Barva číselného tokenu.
• členské: Barva tokenu názvu člena.
• InlinePrediction: Barva vloženého zobrazení prediktivního návrhu.
• ListPrediction: Barva úvodního znaku > a názvu zdroje předpovědi.
• ListPredictionSelected: Barva vybrané předpovědi v zobrazení seznamu.

Vlastnosti parametru

Typ:	Hashtable
Default value:	None
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-CommandValidationHandler

Určuje ScriptBlock, který je volána z ValidateAndAcceptLine. Pokud dojde k vyvolání výjimky, ověření selže a zobrazí se chyba.

Před vyvolání výjimky může obslužná rutina ověření umístit kurzor na místo chyby, aby se usnadnila oprava. Obslužná rutina ověřování může také změnit příkazový řádek tak, aby opravil běžné typografické chyby.

ValidateAndAcceptLine se používá k tomu, aby se zabránilo nepřehledným funkcím historie pomocí příkazů, které nefungují.

Vlastnosti parametru

Typ:	Action<T>[CommandAst]
Default value:	None
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-CompletionQueryItems

Určuje maximální počet položek dokončení, které se zobrazí bez výzvy.

Pokud je počet zobrazených položek větší než tato hodnota, PSReadLine před zobrazením položek dokončení zobrazí výzvu ano/ne.

Vlastnosti parametru

Typ:	Int32
Default value:	100
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-ContinuationPrompt

Určuje řetězec zobrazený na začátku následujících řádků při zadání víceřádkového vstupu. Výchozí hodnota je dvou znaménka větší než (>>). Prázdný řetězec je platný.

Vlastnosti parametru

Typ:	String
Default value:	>>
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-DingDuration

Určuje dobu trvání pípnutí, pokud je BellStyle nastavena na Zvukovou.

Vlastnosti parametru

Typ:	Int32
Default value:	50ms
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-DingTone

Určuje tón v Hertzu (Hz) pípnutí, když je BellStyle nastavena na Zvuková.

Vlastnosti parametru

Typ:	Int32
Default value:	1221
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-EditMode

Určuje režim úprav příkazového řádku. Pomocí tohoto parametru se resetují všechny klíčové vazby nastavené Set-PSReadLineKeyHandler.

Platné hodnoty jsou následující:

• Windows: Klávesové vazby emulují PowerShell, cmd a Visual Studio. (výchozí ve Windows)
• emacs: Klíčové vazby emulují Bash nebo Emacs. (výchozí nastavení na platformách jiných než Windows)
• Vi: Klíčové vazby emulují Vi.

Pomocí Get-PSReadLineKeyHandler zobrazte klíčové vazby pro aktuálně nakonfigurované EditMode .

Vlastnosti parametru

Typ:	EditMode
Default value:	Windows
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-ExtraPromptLineCount

Určuje počet řádků navíc.

Pokud výzva pokrývá více než jeden řádek, zadejte hodnotu pro tento parametr. Tuto možnost použijte, pokud chcete, aby byly při PSReadLine zobrazení výzvy po zobrazení výstupu k dispozici další řádky. Například PSReadLine vrátí seznam dokončení.

Tato možnost je nutná méně než v předchozích verzích PSReadLine, ale je užitečná při použití funkce InvokePrompt.

Vlastnosti parametru

Typ:	Int32
Default value:	0
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-HistoryNoDuplicates

Tato možnost řídí chování odvolání. Duplicitní příkazy se stále přidávají do souboru historie. Pokud je tato možnost nastavená, zobrazí se při odvolání příkazů pouze nejnovější vyvolání. Opakované příkazy se přidají do historie, aby se zachovalo pořadí během odvolání. Příkaz ale obvykle nechcete při odvolání nebo prohledávání historie zobrazit několikrát.

Ve výchozím nastavení je vlastnost HistoryNoDuplicates globálního objektu PSConsoleReadLineOptions nastavena na True. Chcete-li změnit hodnotu vlastnosti, je nutné zadat hodnotu SwitchParameter následujícím způsobem: -HistoryNoDuplicates:$false. Zpět na True můžete nastavit pomocí SwitchParameter , -HistoryNoDuplicates.

Pomocí následujícího příkazu můžete hodnotu vlastnosti nastavit přímo:

(Get-PSReadLineOption).HistoryNoDuplicates = $false

Vlastnosti parametru

Typ:	SwitchParameter
Default value:	False
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-HistorySavePath

Určuje cestu k souboru, do kterého je uložena historie. Počítače s platformami Windows nebo jiné platformy než Windows ukládají soubor do různých umístění. Název souboru je uložen v proměnné $($Host.Name)_history.txt, například ConsoleHost_history.txt.

Pokud tento parametr nepoužíváte, výchozí cesta je následující:

Windows

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

jiných systémů než Windows

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

Vlastnosti parametru

Typ:	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
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-HistorySaveStyle

Určuje, jak psReadLine ukládat historii.

Platné hodnoty jsou následující:

• SaveIncrementally: Uložení historie po spuštění každého příkazu a sdílení napříč několika instancemi PowerShellu
• SaveAtExit: Při ukončení PowerShellu připojte soubor historie.
• SaveNothing: Nepoužívejte soubor historie.

Poznámka:

Pokud nastavíte HistorySaveStyle na SaveNothing a pak ho nastavíte na SaveIncrementally později ve stejné relaci, nástroj PSReadLine uloží všechny příkazy, které byly dříve spuštěny v relaci.

Vlastnosti parametru

Typ:	HistorySaveStyle
Default value:	SaveIncrementally
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-HistorySearchCaseSensitive

Určuje, že vyhledávání historie rozlišují malá a velká písmena ve funkcích, jako jsou ReverseSearchHistory nebo HistorySearchBackward.

Ve výchozím nastavení je vlastnost HistorySearchCaseSensitive globální PSConsoleReadLineOptions objekt nastaven na False. Pomocí tohoto SwitchParameter nastaví hodnotu vlastnosti na True. Chcete-li změnit hodnotu vlastnosti zpět, je nutné zadat hodnotu SwitchParameter následujícím způsobem: -HistorySearchCaseSensitive:$false.

Pomocí následujícího příkazu můžete hodnotu vlastnosti nastavit přímo:

(Get-PSReadLineOption).HistorySearchCaseSensitive = $false

Vlastnosti parametru

Typ:	SwitchParameter
Default value:	False
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-HistorySearchCursorMovesToEnd

Označuje, že kurzor se přesune na konec příkazů, které načítáte z historie pomocí vyhledávání. Pokud je tento parametr nastavený na $false, kurzor zůstane na pozici, ve které byl při stisknutí šipek nahoru nebo dolů.

Ve výchozím nastavení je vlastnost HistorySearchCursorMovesToEnd globálního objektu PSConsoleReadLineOptions nastavena na False. Pomocí tohoto SwitchParameter nastavit hodnotu vlastnosti na True. Chcete-li změnit hodnotu vlastnosti zpět, je nutné zadat hodnotu SwitchParameter následujícím způsobem: -HistorySearchCursorMovesToEnd:$false.

Pomocí následujícího příkazu můžete hodnotu vlastnosti nastavit přímo:

(Get-PSReadLineOption).HistorySearchCursorMovesToEnd = $false

Vlastnosti parametru

Typ:	SwitchParameter
Default value:	False
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-MaximumHistoryCount

Určuje maximální počet příkazů, které se mají uložit v historii PSReadLine.

historie PSReadLine je oddělená od historie PowerShellu.

Vlastnosti parametru

Typ:	Int32
Default value:	None
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-MaximumKillRingCount

Určuje maximální počet položek uložených v okruhu kill.

Vlastnosti parametru

Typ:	Int32
Default value:	10
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-PredictionSource

Určuje zdroj psReadLine pro získání prediktivních návrhů.

Platné hodnoty jsou:

• Žádné – zakažte funkci prediktivní technologie IntelliSense (výchozí).
• Historie – povolte prediktivní funkci IntelliSense a jako jediný zdroj používejte historii PSReadLine.
• plugin – povolte prediktivní funkci IntelliSense a jako jediný zdroj používejte moduly plug-in (CommandPrediction). Tato hodnota byla přidána v PSReadLine 2.2.0
• HistoryAndPlugin – povolte prediktivní funkci IntelliSense a jako zdroje používejte historii i modul plug-in. Tato hodnota byla přidána v PSReadLine 2.2.0

Vlastnosti parametru

Typ:	Microsoft.PowerShell.PredictionSource
Default value:	None
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-PredictionViewStyle

Nastaví styl zobrazení prediktivního textu. Výchozí hodnota je inlineView.

• InlineView - styl jako dnes, podobně jako v rybím shellu a zsh. (default)
• ListView – návrhy se vykreslují v rozevíracím seznamu a uživatelé můžou vybrat UpArrow a DownArrow.

Tento parametr byl přidán do PSReadLine 2.2.0.

Vlastnosti parametru

Typ:	Microsoft.PowerShell.PredictionViewStyle
Default value:	InlineView
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-PromptText

Tento parametr nastaví hodnotu vlastnosti PromptText. Výchozí hodnota je "> ".

PSReadLine analyzuje funkci výzvy, abyste zjistili, jak změnit jenom barvu části výzvy. Tato analýza není 100% spolehlivá. Tuto možnost použijte, pokud PSReadLine mění výzvu neočekávanými způsoby. Zahrňte všechny koncové prázdné znaky.

Hodnota tohoto parametru může být jeden řetězec nebo pole dvou řetězců. První řetězec je část řetězce výzvy, kterou chcete změnit na červenou, když dojde k chybě analýzy. Druhý řetězec je alternativní řetězec, který se použije, když dojde k chybě analýzy.

Vlastnosti parametru

Typ:	String[]
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-ShowToolTips

Při zobrazování možných dokončení se popisy zobrazují v seznamu dokončení.

Tato možnost je ve výchozím nastavení povolená. Tato možnost nebyla ve výchozím nastavení povolena v předchozích verzích PSReadLine. Chcete-li tuto možnost zakázat, nastavte tuto možnost na $false.

Tento parametr a možnost byly přidány v PSReadLine 2.3.4.

Ve výchozím nastavení je vlastnost ShowToolTips globálního objektu PSConsoleReadLineOptions nastavena na True. Pomocí tohoto SwitchParameter nastaví hodnotu vlastnosti na True. Chcete-li změnit hodnotu vlastnosti, je nutné zadat hodnotu SwitchParameter následujícím způsobem: -ShowToolTips:$false.

Pomocí následujícího příkazu můžete hodnotu vlastnosti nastavit přímo:

(Get-PSReadLineOption).ShowToolTips = $false

Vlastnosti parametru

Typ:	SwitchParameter
Default value:	True
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-TerminateOrphanedConsoleApps

Tento parametr nastaví TerminateOrphanedConsoleApps možnost $true.

Když ve Windows stisknete Ctrl+c ukončíte proces, každý proces připojený ke konzole obdrží signál ukončení, a ne jenom aktivní prostředí. Někdy, když prostředí spustilo nějaký velký strom podřízených procesů (představte si například, že systém sestavení) některé procesy mohou ukončit a současně opustit více procesů, které se snaží využívat vstup konzoly.

Při nastavení TerminateOrphanedConsoleApps možnost $true, PSReadLine zaznamenává seznam procesů, které jsou aktuálně připojené ke konzole. Po každém spuštění PSReadLine se pak zobrazí nový seznam procesů připojených ke konzole a ukončí ty, které nejsou v původním seznamu.

Tento parametr a možnost byly přidány v PSReadLine 2.3.4.

Vlastnosti parametru

Typ:	SwitchParameter
Default value:	None
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-ViModeChangeHandler

Pokud je ViModeIndicator nastaven na Script, vyvolá se zadaný blok skriptu při každé změně režimu. Blok skriptu je zadán jeden argument typu ViMode.

Tento parametr byl představen v PowerShellu 7.

Vlastnosti parametru

Typ:	ScriptBlock
Default value:	None
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-ViModeIndicator

Tato možnost nastaví vizuální indikátor pro aktuální režim Vi. Režim vložení nebo režim příkazů.

Platné hodnoty jsou následující:

• Žádné: Neexistuje žádný indikátor.
• výzva: Výzva se změní na barvu.
• Kurzor: Kurzor se změní.
• skript: Text zadaný uživatelem se vytiskne.

Vlastnosti parametru

Typ:	ViModeStyle
Default value:	None
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-WordDelimiters

Určuje znaky, které odděluje slova pro funkce, jako jsou ForwardWord nebo KillWord.

Vlastnosti parametru

Typ:	String
Default value:	;:,.[]{}()/\|^&*-=+'"---
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

CommonParameters

Tato rutina podporuje běžné parametry: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction a -WarningVariable. Další informace najdete v about_CommonParameters.

Vstupy

None

Do tohoto cmdletu nemůžete předávat objekty.

Výstupy

None

Tento cmdlet nevrátí žádný výstup.

Související odkazy

• about_PSReadLine
• Get-PSReadLineKeyHandler
• Get-PSReadLineOption
• Remove-PSReadLineKeyHandler
• Set-PSReadLineKeyHandler