Condividi tramite

Set-PSReadLineOption

Modulo:
PSReadLine Module

Personalizza il comportamento della modifica della riga di comando in PSReadLine.

Sintassi

Default (impostazione predefinita). 

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

Descrizione

Il cmdlet Set-PSReadLineOption personalizza il comportamento del modulo PSReadLine quando si modifica la riga di comando. Per visualizzare le impostazioni di PSReadLine, usare Get-PSReadLineOption.

Le opzioni impostate da questo comando si applicano solo alla sessione corrente. Per rendere persistenti tutte le opzioni, aggiungerle a uno script del profilo. Per altre informazioni, vedere about_Profiles e Personalizzazione dell'ambiente shell.

Esempio

Esempio 1: Impostare i colori di primo piano e di sfondo

Questo esempio imposta PSReadLine per visualizzare il token di commento con testo in primo piano verde su uno sfondo grigio. Nella sequenza di escape utilizzata nell'esempio, 32 rappresenta il colore di primo piano e 47 rappresenta il colore di sfondo.

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

È possibile scegliere di impostare solo un colore di testo in primo piano. Ad esempio, un colore di testo di primo piano verde brillante per il token di commento di: "Comment"="`e[92m".

Esempio 2: Impostare lo stile della campana

In questo esempio, PSReadLine risponderà a errori o condizioni che richiedono attenzione dell'utente. La BellStyle è impostata per generare un segnale acustico a 1221 Hz per 60 ms.

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

Annotazioni

Questa funzionalità potrebbe non funzionare in tutti gli host su piattaforme.

Esempio 3: Impostare più opzioni

Set-PSReadLineOption possibile impostare più opzioni con una tabella hash.

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

La tabella hash $PSReadLineOptions imposta le chiavi e i valori. Set-PSReadLineOption usa le chiavi e i valori con @PSReadLineOptions per aggiornare le opzioni di PSReadLine.

È possibile visualizzare le chiavi e i valori immettendo il nome della tabella hash, $PSReadLineOptions nella riga di comando di PowerShell.

Esempio 4: Impostare più opzioni di colore

In questo esempio viene illustrato come impostare più valori di colore in un singolo comando.

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

Esempio 5: Impostare i valori di colore per più tipi

In questo esempio vengono illustrati tre metodi diversi per impostare il colore dei token visualizzati in 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"
}

Esempio 6: Usare ViModeChangeHandler per visualizzare le modifiche alla modalità Vi

In questo esempio viene generato un escape VT di modifica del cursore in risposta a una modifica della modalità 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

La funzione OnViModeChange imposta le opzioni del cursore per le modalità Vi: insert e command. ViModeChangeHandler usa il provider di Function: per fare riferimento OnViModeChange come oggetto blocco di script.

Per altre informazioni, consultare about_Providers.

Esempio 7: Usare HistoryHandler per filtrare i comandi aggiunti alla cronologia

L'esempio seguente illustra come usare il AddToHistoryHandler per impedire il salvataggio di comandi Git nella cronologia.

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

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

Set-PSReadLineOption -AddToHistoryHandler $ScriptBlock

Lo scriptblock restituisce $false se il comando è stato avviato con git. Questo ha lo stesso effetto della restituzione dell'enumerazioneaddToHistory di SkipAdding. Se il comando non inizia con git, il gestore restituisce $true e PSReadLine salva il comando nella cronologia.

Esempio 8: Usare CommandValidationHandler per convalidare un comando prima dell'esecuzione

In questo esempio viene illustrato come usare il parametro CommandValidationHandler per eseguire un comando di convalida prima dell'esecuzione. L'esempio verifica in modo specifico la presenza del comando git con il comando secondario cmt e lo sostituisce con il nome completo commit. In questo modo è possibile creare alias abbreviati per i sottocomandi.

# 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

Esempio 9: Uso del parametro PromptText

Quando si verifica un errore di analisi, PSReadLine cambia una parte del prompt rosso. Il parametro PromptText indica PSReadLine parte della stringa di richiesta da rendere rossa.

Nell'esempio seguente, ad esempio, viene creato un prompt contenente il percorso corrente seguito dal carattere maggiore di (>) e da uno spazio.

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

La prima stringa è la parte della stringa di richiesta che si vuole impostare in rosso quando si verifica un errore di analisi. La seconda stringa è una stringa alternativa da usare per quando si verifica un errore di analisi.

Parametri

-AddToHistoryHandler

Specifica un ScriptBlock che controlla il modo in cui i comandi vengono aggiunti alla cronologia di PSReadLine.

Il ScriptBlock riceve la riga di comando come input.

Il ScripBlock deve restituire un membro dell'enumerazione AddToHistoryOption, il nome stringa di uno di questi membri o un valore booleano. L'elenco seguente descrive i valori possibili e i relativi effetti.

  • MemoryAndFile : aggiungere il comando al file di cronologia e alla sessione corrente.
  • MemoryOnly : aggiungere il comando alla cronologia solo per la sessione corrente.
  • SkipAdding: non aggiungere il comando al file di cronologia per la sessione corrente.
  • $false : uguale a se il valore fosse SkipAdding.
  • $true : uguale a se il valore fosse MemoryAndFile.

Proprietà dei parametri

Tipo:

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

Valore predefinito:None
Supporta i caratteri jolly:False
DontShow:False

Set di parametri

(All)
Posizione:Named
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False

-AnsiEscapeTimeout

Questa opzione è specifica di Windows quando l'input viene reindirizzato, ad esempio quando viene eseguito in tmux o screen.

Con l'input reindirizzato in Windows, molte chiavi vengono inviate come sequenza di caratteri a partire dal carattere di escape. È impossibile distinguere tra un singolo carattere di escape seguito da più caratteri e una sequenza di escape valida.

Il presupposto è che il terminale possa inviare i caratteri più velocemente rispetto ai tipi di utente. PSReadLine attende questo timeout prima di concludere che ha ricevuto una sequenza di escape completa.

Se durante la digitazione vengono visualizzati caratteri casuali o imprevisti, è possibile regolare questo timeout.

Proprietà dei parametri

Tipo:Int32
Valore predefinito:100
Supporta i caratteri jolly:False
DontShow:False

Set di parametri

(All)
Posizione:Named
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False

-BellStyle

Specifica il modo in cui PSReadLine risponde a diverse condizioni di errore e ambigue.

I valori validi sono i seguenti:

  • udibile: un segnale acustico breve.
  • Visual: il testo lampeggia brevemente.
  • Nessuna: nessun feedback.

Proprietà dei parametri

Tipo:BellStyle
Valore predefinito:Audible
Supporta i caratteri jolly:False
DontShow:False

Set di parametri

(All)
Posizione:Named
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False

-Colors

Il parametro Colors consente di specificare vari colori utilizzati da PSReadLine.

L'argomento è una tabella hash in cui le chiavi specificano gli elementi e i valori specificano il colore. Per altre informazioni, vedere about_Hash_Tables.

I colori possono essere un valore di ConsoleColor, ad esempio [ConsoleColor]::Redo una sequenza di escape ANSI valida. Le sequenze di escape valide dipendono dal terminale. In PowerShell 5.0, una sequenza di escape di esempio per il testo rosso è $([char]0x1b)[91m. In PowerShell 6 e versioni successive, la stessa sequenza di escape è `e[91m. È possibile specificare altre sequenze di escape, inclusi i tipi seguenti:

Sono state aggiunte due impostazioni colore per supportare la personalizzazione del ListView in PSReadLine 2.2.0:

  • ListPredictionColor: impostare il colore per il carattere > iniziale e il nome dell'origine finale, ad esempio [History]. Per impostazione predefinita, usa DarkYellow come colore di primo piano.

  • ListPredictionSelectedColor: impostare il colore per indicare che è selezionata una voce di elenco. Per impostazione predefinita, usa DarkBlack come colore di sfondo.

  • Colore 256

  • Colore a 24 bit

  • Primo piano, sfondo o entrambi

  • Inverso, grassetto

Per altre informazioni sui codici di colore ANSI, vedere l'articolo di Wikipedia codice di escape ANSI.

Le chiavi valide includono:

  • ContinuationPrompt: colore del prompt di continuazione.
  • l'enfasi: colore dell'enfasi. Ad esempio, il testo corrispondente durante la ricerca nella cronologia.
  • Errore: colore dell'errore. Ad esempio, nel prompt.
  • selezione: colore da evidenziare la selezione del menu o il testo selezionato.
  • predefinita: colore del token predefinito.
  • commento: colore del token di commento.
  • Parola chiave: colore del token della parola chiave.
  • stringhe: colore del token stringa.
  • Operator: colore del token dell'operatore.
  • Variabile: colore del token variabile.
  • comando: colore del token del comando.
  • Parametro: colore del token del parametro.
  • Tipo: colore del token di tipo.
  • Numero: colore del token numerico.
  • Membro: colore del token del nome del membro.
  • InlinePrediction: colore per la visualizzazione inline del suggerimento predittivo.
  • ListPrediction: colore del carattere iniziale > e del nome dell'origine di stima.
  • ListPredictionSelected: colore per la stima selezionata nella visualizzazione elenco.

Proprietà dei parametri

Tipo:Hashtable
Valore predefinito:None
Supporta i caratteri jolly:False
DontShow:False

Set di parametri

(All)
Posizione:Named
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False

-CommandValidationHandler

Specifica un ScriptBlock chiamato da ValidateAndAcceptLine. Se viene generata un'eccezione, la convalida non riesce e viene segnalato l'errore.

Prima di generare un'eccezione, il gestore di convalida può posizionare il cursore al punto dell'errore per semplificare la correzione. Un gestore di convalida può anche modificare la riga di comando per correggere gli errori tipografici comuni.

validateAndAcceptLine viene usato per evitare confusione nella cronologia con i comandi che non possono funzionare.

Proprietà dei parametri

Tipo:

Action<T>[CommandAst]

Valore predefinito:None
Supporta i caratteri jolly:False
DontShow:False

Set di parametri

(All)
Posizione:Named
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False

-CompletionQueryItems

Specifica il numero massimo di elementi di completamento visualizzati senza richiedere conferma.

Se il numero di elementi da visualizzare è maggiore di questo valore, PSReadLine richiede sì/no prima di visualizzare gli elementi di completamento.

Proprietà dei parametri

Tipo:Int32
Valore predefinito:100
Supporta i caratteri jolly:False
DontShow:False

Set di parametri

(All)
Posizione:Named
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False

-ContinuationPrompt

Specifica la stringa visualizzata all'inizio delle righe successive quando viene immesso l'input su più righe. Il valore predefinito è doppio di segni (>>). Una stringa vuota è valida.

Proprietà dei parametri

Tipo:String
Valore predefinito:>>
Supporta i caratteri jolly:False
DontShow:False

Set di parametri

(All)
Posizione:Named
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False

-DingDuration

Specifica la durata del segnale acustico quando BellStyle è impostato su udibile.

Proprietà dei parametri

Tipo:Int32
Valore predefinito:50ms
Supporta i caratteri jolly:False
DontShow:False

Set di parametri

(All)
Posizione:Named
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False

-DingTone

Specifica il tono inHz (Hz) del segnale acustico quando BellStyle è impostato su Audible.

Proprietà dei parametri

Tipo:Int32
Valore predefinito:1221
Supporta i caratteri jolly:False
DontShow:False

Set di parametri

(All)
Posizione:Named
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False

-EditMode

Specifica la modalità di modifica della riga di comando. L'uso di questo parametro reimposta le associazioni di tasti impostate da Set-PSReadLineKeyHandler.

I valori validi sono i seguenti:

  • Windows: le associazioni di tasti emulano PowerShell, cmd e Visual Studio. (impostazione predefinita in Windows)
  • Emacs: le associazioni di tasti emulano Bash o Emacs. (impostazione predefinita nelle piattaforme non Windows)
  • Vi: le associazioni di tasti emulano Vi.

Usare Get-PSReadLineKeyHandler per visualizzare i tasti di scelta rapida per il EditMode attualmente configurato.

Proprietà dei parametri

Tipo:EditMode
Valore predefinito:Windows
Supporta i caratteri jolly:False
DontShow:False

Set di parametri

(All)
Posizione:Named
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False

-ExtraPromptLineCount

Specifica il numero di righe aggiuntive.

Se il prompt si estende su più righe, specificare un valore per questo parametro. Usare questa opzione quando si desidera che le righe aggiuntive siano disponibili quando PSReadLine visualizza il prompt dopo aver visualizzato un output. Ad esempio, PSReadLine restituisce un elenco di completamenti.

Questa opzione è necessaria in meno rispetto alle versioni precedenti di PSReadLine, ma è utile quando viene usata la funzione InvokePrompt.

Proprietà dei parametri

Tipo:Int32
Valore predefinito:0
Supporta i caratteri jolly:False
DontShow:False

Set di parametri

(All)
Posizione:Named
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False

-HistoryNoDuplicates

Questa opzione controlla il comportamento di richiamo. I comandi duplicati vengono comunque aggiunti al file di cronologia. Quando questa opzione è impostata, viene visualizzata solo la chiamata più recente quando si richiamano i comandi. I comandi ripetuti vengono aggiunti alla cronologia per mantenere l'ordinamento durante il richiamo. Tuttavia, in genere non si vuole visualizzare il comando più volte durante il richiamo o la ricerca nella cronologia.

Per impostazione predefinita, la proprietà HistoryNoDuplicates dell'oggetto PSConsoleReadLineOptions globale è impostata su True. Per modificare il valore della proprietà, è necessario specificare il valore del SwitchParameter come indicato di seguito: -HistoryNoDuplicates:$false. È possibile tornare a True usando solo switchparameter , -HistoryNoDuplicates.

Usando il comando seguente, è possibile impostare direttamente il valore della proprietà:

(Get-PSReadLineOption).HistoryNoDuplicates = $false

Proprietà dei parametri

Tipo:SwitchParameter
Valore predefinito:False
Supporta i caratteri jolly:False
DontShow:False

Set di parametri

(All)
Posizione:Named
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False

-HistorySavePath

Specifica il percorso del file in cui viene salvata la cronologia. I computer che eseguono piattaforme Windows o non Windows archiviano il file in posizioni diverse. Il nome file viene archiviato in una variabile $($Host.Name)_history.txt, ad esempio ConsoleHost_history.txt.

Se non si usa questo parametro, il percorso predefinito è il seguente:

Windows

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

non Windows

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

Proprietà dei parametri

Tipo:String
Valore predefinito: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
Supporta i caratteri jolly:False
DontShow:False

Set di parametri

(All)
Posizione:Named
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False

-HistorySaveStyle

Specifica il modo in cui PSReadLine salva la cronologia.

I valori validi sono i seguenti:

  • SaveIncrementally: salvare la cronologia dopo l'esecuzione di ogni comando e condividerla tra più istanze di PowerShell.
  • SaveAtExit: aggiungere il file di cronologia all'uscita da PowerShell.
  • SaveNothing: non usare un file di cronologia.

Annotazioni

Se si imposta HistorySaveStyle su SaveNothing e quindi impostarlo su SaveIncrementally più avanti nella stessa sessione, PSReadLine salva tutti i comandi eseguiti in precedenza nella sessione.

Proprietà dei parametri

Tipo:HistorySaveStyle
Valore predefinito:SaveIncrementally
Supporta i caratteri jolly:False
DontShow:False

Set di parametri

(All)
Posizione:Named
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False

-HistorySearchCaseSensitive

Specifica che la ricerca della cronologia fa distinzione tra maiuscole e minuscole nelle funzioni come ReverseSearchHistory o HistorySearchBackward.

Per impostazione predefinita, la proprietà HistorySearchCaseSensitive dell'oggetto PSConsoleReadLineOptions globale è impostata su False. L'utilizzo di questa SwitchParameter imposta il valore della proprietà su True. Per ripristinare il valore della proprietà, è necessario specificare il valore di SwitchParameter come indicato di seguito: -HistorySearchCaseSensitive:$false.

Usando il comando seguente, è possibile impostare direttamente il valore della proprietà:

(Get-PSReadLineOption).HistorySearchCaseSensitive = $false

Proprietà dei parametri

Tipo:SwitchParameter
Valore predefinito:False
Supporta i caratteri jolly:False
DontShow:False

Set di parametri

(All)
Posizione:Named
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False

-HistorySearchCursorMovesToEnd

Indica che il cursore si sposta alla fine dei comandi caricati dalla cronologia usando una ricerca. Quando questo parametro è impostato su $false, il cursore rimane nella posizione in cui è stata premuta la freccia su o giù.

Per impostazione predefinita, la proprietà HistorySearchCursorMovesToEnd dell'oggetto PSConsoleReadLineOptions globale è impostata suFalse. Usando questa SwitchParameter impostare il valore della proprietà su True. Per ripristinare il valore della proprietà, è necessario specificare il valore di SwitchParameter come indicato di seguito: -HistorySearchCursorMovesToEnd:$false.

Usando il comando seguente, è possibile impostare direttamente il valore della proprietà:

(Get-PSReadLineOption).HistorySearchCursorMovesToEnd = $false

Proprietà dei parametri

Tipo:SwitchParameter
Valore predefinito:False
Supporta i caratteri jolly:False
DontShow:False

Set di parametri

(All)
Posizione:Named
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False

-MaximumHistoryCount

Specifica il numero massimo di comandi da salvare in cronologia di PSReadLine.

cronologia di PSReadLine è separata dalla cronologia di PowerShell.

Proprietà dei parametri

Tipo:Int32
Valore predefinito:None
Supporta i caratteri jolly:False
DontShow:False

Set di parametri

(All)
Posizione:Named
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False

-MaximumKillRingCount

Specifica il numero massimo di elementi archiviati nell'anello di terminazioni.

Proprietà dei parametri

Tipo:Int32
Valore predefinito:10
Supporta i caratteri jolly:False
DontShow:False

Set di parametri

(All)
Posizione:Named
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False

-PredictionSource

Specifica l'origine per PSReadLine per ottenere suggerimenti predittivi.

I valori validi sono:

  • Nessuna: disabilitare la funzionalità IntelliSense predittiva (impostazione predefinita).
  • Cronologia: abilitare la funzionalità IntelliSense predittiva e usare la cronologia PSReadLine come unica origine.
  • plug-in: abilitare la funzionalità Predittiva IntelliSense e usare i plug-in (CommandPrediction) come unica origine. Questo valore è stato aggiunto in PSReadLine 2.2.0
  • HistoryAndPlugin: abilitare la funzionalità IntelliSense predittiva e usare sia cronologia che plug-in come origini. Questo valore è stato aggiunto in PSReadLine 2.2.0

Proprietà dei parametri

Tipo:Microsoft.PowerShell.PredictionSource
Valore predefinito:None
Supporta i caratteri jolly:False
DontShow:False

Set di parametri

(All)
Posizione:Named
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False

-PredictionViewStyle

Imposta lo stile per la visualizzazione del testo predittivo. Il valore predefinito è InlineView.

  • InlineView : lo stile attuale, simile a quello della shell di pesce e zsh. (default)
  • listView: viene eseguito il rendering dei suggerimenti in un elenco a discesa e gli utenti possono selezionare usando UpArrow e DownArrow.

Questo parametro è stato aggiunto in PSReadLine 2.2.0

Proprietà dei parametri

Tipo:Microsoft.PowerShell.PredictionViewStyle
Valore predefinito:InlineView
Supporta i caratteri jolly:False
DontShow:False

Set di parametri

(All)
Posizione:Named
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False

-PromptText

Questo parametro imposta il valore della proprietà PromptText. Il valore predefinito è "> ".

PSReadLine analizza la funzione prompt per determinare come modificare solo il colore della parte del prompt. Questa analisi non è 100% affidabile. Usare questa opzione se PSReadLine sta modificando la richiesta in modi imprevisti. Includere eventuali spazi vuoti finali.

Il valore di questo parametro può essere una singola stringa o una matrice di due stringhe. La prima stringa è la parte della stringa di richiesta da modificare in rosso quando si verifica un errore di analisi. La seconda stringa è una stringa alternativa da usare per quando si verifica un errore di analisi.

Proprietà dei parametri

Tipo:

String[]

Supporta i caratteri jolly:False
DontShow:False

Set di parametri

(All)
Posizione:Named
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False

-ShowToolTips

Quando vengono visualizzati i possibili completamenti, le descrizioni comando vengono visualizzate nell'elenco dei completamenti.

Questa opzione è abilitata per impostazione predefinita. Questa opzione non è stata abilitata per impostazione predefinita nelle versioni precedenti di PSReadLine. Per disabilitare, impostare questa opzione su $false.

Questo parametro e l'opzione sono stati aggiunti in PSReadLine 2.3.4.

Per impostazione predefinita, la proprietà ShowToolTips dell'oggetto PSConsoleReadLineOptions globale su True. L'utilizzo di questa SwitchParameter imposta il valore della proprietà su True. Per modificare il valore della proprietà, è necessario specificare il valore del SwitchParameter come indicato di seguito: -ShowToolTips:$false.

Usando il comando seguente, è possibile impostare direttamente il valore della proprietà:

(Get-PSReadLineOption).ShowToolTips = $false

Proprietà dei parametri

Tipo:SwitchParameter
Valore predefinito:True
Supporta i caratteri jolly:False
DontShow:False

Set di parametri

(All)
Posizione:Named
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False

-TerminateOrphanedConsoleApps

Questo parametro imposta l'opzione di TerminateOrphanedConsoleApps su $true.

In Windows, quando si preme CTRL+c per terminare un processo, ogni processo collegato a una console riceve un segnale di terminazione, anziché solo la shell attiva. In alcuni casi, quando una shell ha avviato un albero di grandi dimensioni di processi figlio, ad esempio un sistema di compilazione, alcuni processi possono uscire, lasciando più processi contemporaneamente cercando di usare l'input della console.

Quando si imposta l'opzione TerminateOrphanedConsoleApps su $true, PSReadLine registra l'elenco dei processi attualmente collegati alla console. Successivamente, ogni volta che PSReadLine viene eseguito, ottiene un nuovo elenco di processi collegati alla console e termina quelli che non sono nell'elenco originale.

Questo parametro e l'opzione sono stati aggiunti in PSReadLine 2.3.4.

Proprietà dei parametri

Tipo:SwitchParameter
Valore predefinito:None
Supporta i caratteri jolly:False
DontShow:False

Set di parametri

(All)
Posizione:Named
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False

-ViModeChangeHandler

Quando la ViModeIndicator è impostata su Script, il blocco di script fornito verrà richiamato ogni volta che cambia la modalità. Il blocco di script viene fornito un argomento di tipo ViMode.

Questo parametro è stato introdotto in PowerShell 7.

Proprietà dei parametri

Tipo:ScriptBlock
Valore predefinito:None
Supporta i caratteri jolly:False
DontShow:False

Set di parametri

(All)
Posizione:Named
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False

-ViModeIndicator

Questa opzione imposta l'indicatore visivo per la modalità di vi corrente. Modalità di inserimento o modalità di comando.

I valori validi sono i seguenti:

  • Nessuna: non è presente alcun indicatore.
  • prompt: il prompt cambia colore.
  • cursore: la dimensione del cursore cambia.
  • Script: viene stampato il testo specificato dall'utente.

Proprietà dei parametri

Tipo:ViModeStyle
Valore predefinito:None
Supporta i caratteri jolly:False
DontShow:False

Set di parametri

(All)
Posizione:Named
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False

-WordDelimiters

Specifica i caratteri che delimitano le parole per funzioni come ForwardWord o KillWord.

Proprietà dei parametri

Tipo:String
Valore predefinito:;:,.[]{}()/\|^&*-=+'"---
Supporta i caratteri jolly:False
DontShow:False

Set di parametri

(All)
Posizione:Named
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False

CommonParameters

Questo cmdlet supporta i parametri comuni: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Per altre informazioni, vedi about_CommonParameters.

Input

None

Gli oggetti non possono essere inviati tramite pipe a questo cmdlet.

Output

None

Questo cmdlet non restituisce alcun output.