Set-PSReadLineOption

Modul:
PSReadLine Module

Testre szabja a parancssori szerkesztés viselkedését PSReadLine.

Syntax

Default (Alapértelmezett) 

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

A Set-PSReadLineOption parancsmag testre szabja a PSReadLine modul viselkedését a parancssor szerkesztésekor. A PSReadLine beállításainak megtekintéséhez használja a Get-PSReadLineOption.

A parancs által megadott beállítások csak az aktuális munkamenetre vonatkoznak. A beállítások megőrzéséhez adja hozzá őket egy profilszkripthez. További információ: about_Profiles és A rendszerhéj-környezet testreszabása.

Példák

1. példa: Előtér- és háttérszínek beállítása

Ez a példa beállítja PSReadLine, hogy a Megjegyzés jogkivonatot zöld előtérszöveggel, szürke háttérrel jelenítse meg. A példában használt escape sorozatban 32 az előtérszínt, 47 a háttérszínt.

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

Dönthet úgy, hogy csak az előtérben lévő szövegszínt állítja be. Például a Megjegyzés jogkivonat világoszöld előtérszíne: "Comment"="`e[92m".

2. példa: Harangstílus beállítása

Ebben a példában PSReadLine reagál a felhasználói figyelmet igénylő hibákra vagy feltételekre. A BellStyle 1221 Hz 60 ms-os hangjelzésre van beállítva.

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

Megjegyzés:

Előfordulhat, hogy ez a funkció nem minden gazdagépen működik a platformokon.

3. példa: Több beállítás megadása

Set-PSReadLineOption több beállítást is megadhat kivonattáblával.

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

A $PSReadLineOptions kivonattábla beállítja a kulcsokat és az értékeket. Set-PSReadLineOption a @PSReadLineOptions billentyűkkel és értékekkel frissíti a PSReadLine beállításait.

Megtekintheti a kivonattábla nevét beírt kulcsokat és értékeket, $PSReadLineOptions a PowerShell parancssorában.

4. példa: Több színbeállítás beállítása

Ez a példa bemutatja, hogyan állíthat be több színértéket egyetlen parancsban.

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

5. példa: Színértékek beállítása több típushoz

Ez a példa három különböző módszert mutat be a PSReadLine megjelenített jogkivonatok színének beállítására.

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. példa: A ViModeChangeHandler használata a Vi mód változásainak megjelenítéséhez

Ez a példa egy Vi módváltásra válaszul a kurzorváltoztatási VT-feloldójelet bocsátja ki.

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

Az OnViModeChange függvény a Vi módok kurzorbeállítását adja meg: beszúrás és parancs. A ViModeChangeHandler a szolgáltató használatával hivatkozik az Function:OnViModeChange-ra szkriptblokk-objektumként.

További információért lásd a about_Providerscímű részt.

7. példa: Az előzményekhez hozzáadott parancsok szűrése a HistoryHandler használatával

Az alábbi példa bemutatja, hogyan használható a AddToHistoryHandler a git-parancsok előzményekbe való mentésének megakadályozására.

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

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

Set-PSReadLineOption -AddToHistoryHandler $ScriptBlock

A szkriptblokk $false ad vissza, ha a parancs gitkezdődött. Ennek ugyanaz a hatása, mint a SkipAddingAddToHistory enumerálása. Ha a parancs nem gitkezdődik, a kezelő visszaadja a $true, és a PSReadLine menti a parancsot az előzményekben.

8. példa: Parancs érvényesítése a CommandValidationHandlerrel a végrehajtás előtt

Ez a példa bemutatja, hogyan használhatja a CommandValidationHandler paramétert egy érvényesítési parancs futtatásához a végrehajtás előtt. A példa kifejezetten ellenőrzi, hogy a parancs git az alparancs cmt, és a teljes névre commit. Így rövidített aliasokat hozhat létre az alparancsokhoz.

# 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. példa: A PromptText paraméter használata

Elemzési hiba esetén PSReadLine módosítja a kérés egy részét pirosra. A PromptText paraméter azt jelzi PSReadLine-nak, a parancssori sztring egy részét pirosra.

Az alábbi példa például létrehoz egy parancssort, amely tartalmazza az aktuális elérési utat, majd a nagyobb karaktert (>) és egy szóközt.

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

Az első sztring a parancssori sztring azon része, amelyet elemzési hiba esetén pirosra szeretne tenni. A második sztring egy másodlagos sztring, amelyet elemzési hiba esetén használhat.

Paraméterek

-AddToHistoryHandler

A PSReadLine előzményeihez parancsok hozzáadását szabályozó ScriptBlock.

A ScriptBlock bemenetként fogadja a parancssort.

A ScripBlock az AddToHistoryOption enumerálásának egy tagját, az egyik tag sztringnevét vagy logikai értéket kell visszaadnia. Az alábbi lista a lehetséges értékeket és azok hatásait ismerteti.

  • MemoryAndFile – Adja hozzá a parancsot az előzményfájlhoz és az aktuális munkamenethez.
  • MemoryOnly – Csak az aktuális munkamenet előzményeihez adja hozzá a parancsot.
  • SkipAdding – Ne adja hozzá a parancsot az aktuális munkamenet előzményfájljában.
  • $false – Ugyanaz, mintha az érték SkipAddingvolna.
  • $true – Ugyanaz, mintha az érték MemoryAndFilevolna.

Paramétertulajdonságok

Típus:

Func<T,TResult>[System.String,System.Object]

Alapértelmezett érték:None
Támogatja a helyettesítő karaktereket:False
DontShow:False

Paraméterkészletek

(All)
Position:Named
Kötelező:False
Folyamatból származó érték:False
Folyamatból származó érték tulajdonságnév alapján:False
Fennmaradó argumentumokból származó érték:False

-AnsiEscapeTimeout

Ez a beállítás a Windows a bemenet átirányítása esetén, például tmux vagy screen alatt való futtatáskor.

A Windows átirányított bemenete esetén a rendszer számos kulcsot küld el karaktersorozatként a feloldó karaktertől kezdve. Nem lehet megkülönböztetni egyetlen menekülő karaktert, majd több karaktert és érvényes menekülési sorozatot.

A feltételezés az, hogy a terminál gyorsabban tudja elküldeni a karaktereket, mint egy felhasználó. PSReadLine vár erre az időtúllépésre, mielőtt arra következtet, hogy teljes feloldási sorozatot kapott.

Ha véletlenszerű vagy váratlan karaktereket lát a beíráskor, módosíthatja ezt az időtúllépést.

Paramétertulajdonságok

Típus:Int32
Alapértelmezett érték:100
Támogatja a helyettesítő karaktereket:False
DontShow:False

Paraméterkészletek

(All)
Position:Named
Kötelező:False
Folyamatból származó érték:False
Folyamatból származó érték tulajdonságnév alapján:False
Fennmaradó argumentumokból származó érték:False

-BellStyle

Meghatározza, hogy PSReadLine hogyan reagál a különböző hibákra és nem egyértelmű feltételekre.

Az érvényes értékek a következők:

  • Audible: Egy rövid sípszó.
  • Visual: Rövid ideig villog a szöveg.
  • None: Nincs visszajelzés.

Paramétertulajdonságok

Típus:BellStyle
Alapértelmezett érték:Audible
Támogatja a helyettesítő karaktereket:False
DontShow:False

Paraméterkészletek

(All)
Position:Named
Kötelező:False
Folyamatból származó érték:False
Folyamatból származó érték tulajdonságnév alapján:False
Fennmaradó argumentumokból származó érték:False

-Colors

A Színek paraméter a PSReadLine által használt különböző színeket határozza meg.

Az argumentum egy kivonattábla, amelyben a kulcsok határozzák meg az elemeket, az értékek pedig a színt. További információ: about_Hash_Tables.

A színek lehetnek ConsoleColorértékei , például [ConsoleColor]::Red, vagy egy érvényes ANSI-feloldási sorozat. Az érvényes menekülési sorozatok a termináltól függenek. A PowerShell 5.0-ban a piros szövegre példaként $([char]0x1b)[91m. A PowerShell 6-ban és újabbban ugyanaz a feloldósorozat `e[91m. Más feloldósorozatokat is megadhat, például a következő típusokat:

A PSReadLine 2.2.0-s verziójában két színbeállítás lett hozzáadva a ListView testreszabásának támogatásához:

  • ListPredictionColor - adja meg a kezdő > karakter és a záró forrás nevét, például [History]. Alapértelmezés szerint DarkYellow használ előtérszínként.

  • ListPredictionSelectedColor - adja meg a listaelem kijelölésének színét. Alapértelmezés szerint háttérszínként DarkBlack használ.

  • 256 szín

  • 24 bites szín

  • Előtér, háttér vagy mindkettő

  • Inverz, félkövér

Az ANSI-színkódokkal kapcsolatos további információkért lásd a Wikipedia ANSI-feloldókódcímű cikket.

Az érvényes kulcsok a következők:

  • ContinuationPrompt: A folytatási kérés színe.
  • Emphasis: A kiemelés színe. Az előzmények keresésekor például az egyező szöveg.
  • Error: A hiba színe. Például a parancssorban.
  • Selection: A menükijelölés vagy a kijelölt szöveg kiemeléséhez használható szín.
  • Default: Az alapértelmezett jogkivonat színe.
  • Comment: A megjegyzés jogkivonatának színe.
  • Keyword: A kulcsszó jogkivonatának színe.
  • String: A sztring jogkivonatának színe.
  • Operator: Az operátor jogkivonatának színe.
  • Variable: A változó jogkivonat színe.
  • Command: A parancs jogkivonatának színe.
  • Parameter: A paraméter jogkivonatának színe.
  • Type: A típus jogkivonatának színe.
  • Number: A szám jogkivonat színe.
  • Member: A tagnév jogkivonatának színe.
  • InlinePrediction: A prediktív javaslat beágyazott nézetének színe.
  • ListPrediction: A kezdő > karakter színe és az előrejelzési forrás neve.
  • ListPredictionSelected: A kijelölt előrejelzés színe listanézetben.

Paramétertulajdonságok

Típus:Hashtable
Alapértelmezett érték:None
Támogatja a helyettesítő karaktereket:False
DontShow:False

Paraméterkészletek

(All)
Position:Named
Kötelező:False
Folyamatból származó érték:False
Folyamatból származó érték tulajdonságnév alapján:False
Fennmaradó argumentumokból származó érték:False

-CommandValidationHandler

A ValidateAndAcceptLine -ból hívott ScriptBlock. Kivétel esetén az ellenőrzés meghiúsul, és a hiba megjelenik.

A kivétel kivetése előtt az érvényesítési kezelő a hiba pontjára helyezheti a kurzort, így könnyebben kijavítható. Az érvényesítési kezelő a parancssort is módosíthatja a gyakori tipográfiai hibák kijavítása érdekében.

ValidateAndAcceptLine használatával elkerülhető, hogy az előzmények nem működnek.

Paramétertulajdonságok

Típus:

Action<T>[CommandAst]

Alapértelmezett érték:None
Támogatja a helyettesítő karaktereket:False
DontShow:False

Paraméterkészletek

(All)
Position:Named
Kötelező:False
Folyamatból származó érték:False
Folyamatból származó érték tulajdonságnév alapján:False
Fennmaradó argumentumokból származó érték:False

-CompletionQueryItems

A kérés nélkül megjelenített befejező elemek maximális számát adja meg.

Ha a megjelenítendő elemek száma nagyobb ennél az értéknél, PSReadLine a befejezési elemek megjelenítése előtt igen/nem.

Paramétertulajdonságok

Típus:Int32
Alapértelmezett érték:100
Támogatja a helyettesítő karaktereket:False
DontShow:False

Paraméterkészletek

(All)
Position:Named
Kötelező:False
Folyamatból származó érték:False
Folyamatból származó érték tulajdonságnév alapján:False
Fennmaradó argumentumokból származó érték:False

-ContinuationPrompt

A többsoros bemenet beírásakor a következő sorok elején megjelenő sztringet adja meg. Az alapértelmezett érték a kétszerese a jeleknél (>>). Egy üres sztring érvényes.

Paramétertulajdonságok

Típus:String
Alapértelmezett érték:>>
Támogatja a helyettesítő karaktereket:False
DontShow:False

Paraméterkészletek

(All)
Position:Named
Kötelező:False
Folyamatból származó érték:False
Folyamatból származó érték tulajdonságnév alapján:False
Fennmaradó argumentumokból származó érték:False

-DingDuration

Megadja a hangjelzés időtartamát, amikor a BellStyle értéke Audible.

Paramétertulajdonságok

Típus:Int32
Alapértelmezett érték:50ms
Támogatja a helyettesítő karaktereket:False
DontShow:False

Paraméterkészletek

(All)
Position:Named
Kötelező:False
Folyamatból származó érték:False
Folyamatból származó érték tulajdonságnév alapján:False
Fennmaradó argumentumokból származó érték:False

-DingTone

A hangjelzés Hertzben (Hz) megadott hangjelzését adja meg, ha a BellStyle értéke Audible

Paramétertulajdonságok

Típus:Int32
Alapértelmezett érték:1221
Támogatja a helyettesítő karaktereket:False
DontShow:False

Paraméterkészletek

(All)
Position:Named
Kötelező:False
Folyamatból származó érték:False
Folyamatból származó érték tulajdonságnév alapján:False
Fennmaradó argumentumokból származó érték:False

-EditMode

Megadja a parancssori szerkesztési módot. Ezzel a paraméterrel alaphelyzetbe állítja a Set-PSReadLineKeyHandleráltal beállított kulcskötéseket.

Az érvényes értékek a következők:

  • Windows: A kulcskötések a PowerShellt, a parancsmagot és a Visual Studio emulálják. (alapértelmezés: Windows)
  • Emacs: A kulcskötések a Bash vagy az Emacs emulálását emulálják. (alapértelmezés nem Windows platformokon)
  • Vi: A kulcskötések vi.

A Get-PSReadLineKeyHandler használatával megtekintheti a jelenleg konfigurált EditModekulcskötéseit.

Paramétertulajdonságok

Típus:EditMode
Alapértelmezett érték:Windows
Támogatja a helyettesítő karaktereket:False
DontShow:False

Paraméterkészletek

(All)
Position:Named
Kötelező:False
Folyamatból származó érték:False
Folyamatból származó érték tulajdonságnév alapján:False
Fennmaradó argumentumokból származó érték:False

-ExtraPromptLineCount

A további sorok számát adja meg.

Ha a parancssor egynél több sort is átfog, adjon meg egy értéket ehhez a paraméterhez. Ezt a lehetőséget akkor használja, ha további sorokat szeretne elérhetővé tenni, amikor PSReadLine a kimenet megjelenítése után megjeleníti a parancssort. Például PSReadLine a befejezések listáját adja vissza.

Ez a beállítás kevesebbre van szükség, mint az PSReadLinekorábbi verzióiban, de a InvokePrompt függvény használatakor hasznos.

Paramétertulajdonságok

Típus:Int32
Alapértelmezett érték:0
Támogatja a helyettesítő karaktereket:False
DontShow:False

Paraméterkészletek

(All)
Position:Named
Kötelező:False
Folyamatból származó érték:False
Folyamatból származó érték tulajdonságnév alapján:False
Fennmaradó argumentumokból származó érték:False

-HistoryNoDuplicates

Ez a beállítás szabályozza a visszahívási viselkedést. A rendszer továbbra is ismétlődő parancsokat ad hozzá az előzményfájlhoz. Ha ez a beállítás be van állítva, csak a legutóbbi hívás jelenik meg a parancsok visszahívásakor. A rendszer ismétlődő parancsokat ad hozzá az előzményekhez, hogy megőrizze a rendezést a visszahívás során. Az előzmények visszahívása vagy keresésekor azonban általában nem szeretné többször látni a parancsot.

Alapértelmezés szerint a PSConsoleReadLineOptions objektum globális HistoryNoDuplicates tulajdonsága True. A tulajdonság értékének módosításához meg kell adnia a SwitchParameter értékét az alábbiak szerint: -HistoryNoDuplicates:$false. A True csak a SwitchParameter, -HistoryNoDuplicateshasználatával állítható vissza.

A következő paranccsal közvetlenül beállíthatja a tulajdonság értékét:

(Get-PSReadLineOption).HistoryNoDuplicates = $false

Paramétertulajdonságok

Típus:SwitchParameter
Alapértelmezett érték:False
Támogatja a helyettesítő karaktereket:False
DontShow:False

Paraméterkészletek

(All)
Position:Named
Kötelező:False
Folyamatból származó érték:False
Folyamatból származó érték tulajdonságnév alapján:False
Fennmaradó argumentumokból származó érték:False

-HistorySavePath

Megadja annak a fájlnak az elérési útját, amelyben az előzmények mentésre kerülnek. A Windows vagy nem Windows platformot futtató számítógépek különböző helyeken tárolják a fájlt. A fájlnév egy $($Host.Name)_history.txtváltozóban van tárolva, például ConsoleHost_history.txt.

Ha nem használja ezt a paramétert, az alapértelmezett elérési út a következő:

Windows

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

nemWindows

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

Paramétertulajdonságok

Típus:String
Alapértelmezett érték: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
Támogatja a helyettesítő karaktereket:False
DontShow:False

Paraméterkészletek

(All)
Position:Named
Kötelező:False
Folyamatból származó érték:False
Folyamatból származó érték tulajdonságnév alapján:False
Fennmaradó argumentumokból származó érték:False

-HistorySaveStyle

Meghatározza, hogy PSReadLine hogyan menti az előzményeket.

Az érvényes értékek a következők:

  • SaveIncrementally: Mentse az előzményeket az egyes parancsok végrehajtása után, és ossza meg őket a PowerShell több példányán.
  • SaveAtExit: Előzményfájl hozzáfűzése, amikor a PowerShell kilép.
  • SaveNothing: Ne használjon előzményfájlt.

Megjegyzés:

Ha HistorySaveStyleSaveNothing értékre állítja, majd ugyanabban a munkamenetben később SaveIncrementally értékre állítja, a PSReadLine menti a munkamenetben korábban futtatott összes parancsot.

Paramétertulajdonságok

Típus:HistorySaveStyle
Alapértelmezett érték:SaveIncrementally
Támogatja a helyettesítő karaktereket:False
DontShow:False

Paraméterkészletek

(All)
Position:Named
Kötelező:False
Folyamatból származó érték:False
Folyamatból származó érték tulajdonságnév alapján:False
Fennmaradó argumentumokból származó érték:False

-HistorySearchCaseSensitive

Azt adja meg, hogy az előzménykeresés megkülönbözteti a kis- és nagybetűket olyan függvényekben, mint ReverseSearchHistory vagy HistorySearchBackward.

Alapértelmezés szerint a PSConsoleReadLineOptions objektum globális HistorySearchCaseSensitive tulajdonsága Falseértékre van állítva. Ezzel a SwitchParameter a tulajdonság értékét Trueértékre állítja. A tulajdonság értékének visszaállításához meg kell adnia a SwitchParameter értékét az alábbiak szerint: -HistorySearchCaseSensitive:$false.

A következő paranccsal közvetlenül beállíthatja a tulajdonság értékét:

(Get-PSReadLineOption).HistorySearchCaseSensitive = $false

Paramétertulajdonságok

Típus:SwitchParameter
Alapértelmezett érték:False
Támogatja a helyettesítő karaktereket:False
DontShow:False

Paraméterkészletek

(All)
Position:Named
Kötelező:False
Folyamatból származó érték:False
Folyamatból származó érték tulajdonságnév alapján:False
Fennmaradó argumentumokból származó érték:False

-HistorySearchCursorMovesToEnd

Azt jelzi, hogy a kurzor a keresési előzményekből betöltendő parancsok végére kerül. Ha ezt a paramétert $falseértékre állítja, a kurzor a felfelé vagy lefelé mutató nyilak lenyomásakor a helyén marad.

Alapértelmezés szerint a PsConsoleReadLineOptions objektum globális HistorySearchCursorMovesToEnd tulajdonsága Falseértékre van állítva. Ezzel a SwitchParameter a tulajdonság értékét Trueértékre állítja. A tulajdonság értékének visszaállításához meg kell adnia a SwitchParameter értékét az alábbiak szerint: -HistorySearchCursorMovesToEnd:$false.

A következő paranccsal közvetlenül beállíthatja a tulajdonság értékét:

(Get-PSReadLineOption).HistorySearchCursorMovesToEnd = $false

Paramétertulajdonságok

Típus:SwitchParameter
Alapértelmezett érték:False
Támogatja a helyettesítő karaktereket:False
DontShow:False

Paraméterkészletek

(All)
Position:Named
Kötelező:False
Folyamatból származó érték:False
Folyamatból származó érték tulajdonságnév alapján:False
Fennmaradó argumentumokból származó érték:False

-MaximumHistoryCount

A PSReadLine előzményeibe menthető parancsok maximális számát adja meg.

PSReadLine előzményei eltérnek a PowerShell-előzményektől.

Paramétertulajdonságok

Típus:Int32
Alapértelmezett érték:None
Támogatja a helyettesítő karaktereket:False
DontShow:False

Paraméterkészletek

(All)
Position:Named
Kötelező:False
Folyamatból származó érték:False
Folyamatból származó érték tulajdonságnév alapján:False
Fennmaradó argumentumokból származó érték:False

-MaximumKillRingCount

A kill ringben tárolt elemek maximális számát adja meg.

Paramétertulajdonságok

Típus:Int32
Alapértelmezett érték:10
Támogatja a helyettesítő karaktereket:False
DontShow:False

Paraméterkészletek

(All)
Position:Named
Kötelező:False
Folyamatból származó érték:False
Folyamatból származó érték tulajdonságnév alapján:False
Fennmaradó argumentumokból származó érték:False

-PredictionSource

Megadja a PSReadLine forrását a prediktív javaslatok lekéréséhez.

Az érvényes értékek a következők:

  • None - tiltsa le a prediktív IntelliSense funkciót (alapértelmezett).
  • History - engedélyezze a prediktív IntelliSense funkciót, és használja a PSReadLine előzményeit egyetlen forrásként.
  • Plugin - engedélyezze a prediktív IntelliSense funkciót, és használja a beépülő modulokat (CommandPrediction) egyetlen forrásként. Ez az érték a PSReadLine 2.2.0-ban lett hozzáadva
  • HistoryAndPlugin - engedélyezze a prediktív IntelliSense funkciót, és használja az előzményeket és a beépülő modult is forrásként. Ez az érték a PSReadLine 2.2.0-ban lett hozzáadva

Paramétertulajdonságok

Típus:Microsoft.PowerShell.PredictionSource
Alapértelmezett érték:None
Támogatja a helyettesítő karaktereket:False
DontShow:False

Paraméterkészletek

(All)
Position:Named
Kötelező:False
Folyamatból származó érték:False
Folyamatból származó érték tulajdonságnév alapján:False
Fennmaradó argumentumokból származó érték:False

-PredictionViewStyle

Beállítja a prediktív szöveg megjelenítésének stílusát. Az alapértelmezett érték a InlineView.

  • InlineView - a stílus, mint a meglévő ma, hasonló, mint a halhéj és zsh. (default)
  • ListView - a javaslatok egy legördülő listában jelennek meg, a felhasználók pedig az UpArrow és a DownArrow használatával választhatnak.

Ez a paraméter a PSReadLine 2.2.0-ban lett hozzáadva

Paramétertulajdonságok

Típus:Microsoft.PowerShell.PredictionViewStyle
Alapértelmezett érték:InlineView
Támogatja a helyettesítő karaktereket:False
DontShow:False

Paraméterkészletek

(All)
Position:Named
Kötelező:False
Folyamatból származó érték:False
Folyamatból származó érték tulajdonságnév alapján:False
Fennmaradó argumentumokból származó érték:False

-PromptText

Ez a paraméter a PromptText tulajdonság értékét állítja be. Az alapértelmezett érték a "> ".

PSReadLine elemzi a parancssori függvényt, hogy meghatározza, hogyan módosíthatja csak a kérés egy részének színét. Ez az elemzés nem 100% megbízható. Akkor használja ezt a lehetőséget, ha PSReadLine váratlan módon módosítja a kérést. Adja meg a záró szóközt.

Ennek a paraméternek az értéke lehet egyetlen sztring vagy két sztringből álló tömb. Az első sztring a parancssori sztring azon része, amelyet elemzési hiba esetén pirosra szeretne módosítani. A második sztring egy másodlagos sztring, amelyet elemzési hiba esetén használhat.

Paramétertulajdonságok

Típus:

String[]

Támogatja a helyettesítő karaktereket:False
DontShow:False

Paraméterkészletek

(All)
Position:Named
Kötelező:False
Folyamatból származó érték:False
Folyamatból származó érték tulajdonságnév alapján:False
Fennmaradó argumentumokból származó érték:False

-ShowToolTips

A lehetséges befejezések megjelenítésekor az elemleírások megjelennek a befejezések listájában.

Ez a beállítás alapértelmezés szerint engedélyezve van. Ez a beállítás alapértelmezés szerint nem volt engedélyezve PSReadLinekorábbi verzióiban. A letiltáshoz állítsa be ezt a beállítást $false.

Ez a paraméter és beállítás a PSReadLine 2.3.4-ben lett hozzáadva.

Alapértelmezés szerint a PSConsoleReadLineOptions objektum globális ShowToolTips tulajdonsága True. Ezzel a SwitchParameter a tulajdonság értékét Trueértékre állítja. A tulajdonság értékének módosításához meg kell adnia a SwitchParameter értékét az alábbiak szerint: -ShowToolTips:$false.

A következő paranccsal közvetlenül beállíthatja a tulajdonság értékét:

(Get-PSReadLineOption).ShowToolTips = $false

Paramétertulajdonságok

Típus:SwitchParameter
Alapértelmezett érték:True
Támogatja a helyettesítő karaktereket:False
DontShow:False

Paraméterkészletek

(All)
Position:Named
Kötelező:False
Folyamatból származó érték:False
Folyamatból származó érték tulajdonságnév alapján:False
Fennmaradó argumentumokból származó érték:False

-TerminateOrphanedConsoleApps

Ez a paraméter a TerminateOrphanedConsoleApps beállítást állítja be $true.

A WindowsCtrl+c lenyomásakor a konzolhoz csatlakoztatott összes folyamat leállítási jelet kap, nem pedig csak az aktív rendszerhéjat. Néha, amikor egy rendszerhéj elindította a gyermekfolyamatok egy nagy fáját (például egy buildrendszert), előfordulhat, hogy egyes folyamatok kilépnek, így egyszerre több folyamat is megpróbálkozhat a konzol bemenetének felhasználásával.

Amikor a TerminateOrphanedConsoleApps beállítást $trueértékre állítja, a PSReadLine rögzíti a konzolhoz jelenleg csatolt folyamatok listáját. Ezt követően, amikor a PSReadLine fut, új listát kap a konzolhoz csatolt folyamatokról, és leállítja azokat, amelyek nem szerepelnek az eredeti listában.

Ez a paraméter és beállítás a PSReadLine 2.3.4-ben lett hozzáadva.

Paramétertulajdonságok

Típus:SwitchParameter
Alapértelmezett érték:None
Támogatja a helyettesítő karaktereket:False
DontShow:False

Paraméterkészletek

(All)
Position:Named
Kötelező:False
Folyamatból származó érték:False
Folyamatból származó érték tulajdonságnév alapján:False
Fennmaradó argumentumokból származó érték:False

-ViModeChangeHandler

A ViModeIndicator beállításakor Scripta rendszer minden alkalommal meghívja a megadott szkriptblokkot, amikor a mód megváltozik. A szkriptblokk egy típusú ViModeargumentumot ad meg.

Ez a paraméter a PowerShell 7-ben lett bevezetve.

Paramétertulajdonságok

Típus:ScriptBlock
Alapértelmezett érték:None
Támogatja a helyettesítő karaktereket:False
DontShow:False

Paraméterkészletek

(All)
Position:Named
Kötelező:False
Folyamatból származó érték:False
Folyamatból származó érték tulajdonságnév alapján:False
Fennmaradó argumentumokból származó érték:False

-ViModeIndicator

Ez a beállítás beállítja az aktuális Vi mód vizualizációjelzőjének beállítását. Beszúrási vagy parancsmód.

Az érvényes értékek a következők:

  • None: Nincs mutató.
  • Prompt: A parancssor színe megváltozik.
  • Cursor: A kurzor mérete megváltozik.
  • Script: A felhasználó által megadott szöveg lesz kinyomtatva.

Paramétertulajdonságok

Típus:ViModeStyle
Alapértelmezett érték:None
Támogatja a helyettesítő karaktereket:False
DontShow:False

Paraméterkészletek

(All)
Position:Named
Kötelező:False
Folyamatból származó érték:False
Folyamatból származó érték tulajdonságnév alapján:False
Fennmaradó argumentumokból származó érték:False

-WordDelimiters

Meghatározza azokat a karaktereket, amelyek szavakat tagoljanak olyan függvényekhez, mint ForwardWord vagy KillWord.

Paramétertulajdonságok

Típus:String
Alapértelmezett érték:;:,.[]{}()/\|^&*-=+'"---
Támogatja a helyettesítő karaktereket:False
DontShow:False

Paraméterkészletek

(All)
Position:Named
Kötelező:False
Folyamatból származó érték:False
Folyamatból származó érték tulajdonságnév alapján:False
Fennmaradó argumentumokból származó érték:False

CommonParameters

Ez a parancsmag a következő gyakori paramétereket támogatja: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction és -WarningVariable. További információért lásd about_CommonParameters.

Bevitelek

None

Ehhez a parancsmaghoz nem lehet objektumokat csövezni.

Kimenetek

None

Ez a parancsmag nem ad vissza kimenetet.