Set-PSReadlineOption

Module:: PSReadline Module

Personnalise le comportement de l’édition de ligne de commande dans PSReadline.

Syntaxe

OptionsSet

Set-PSReadlineOption
    [-EditMode <EditMode>]
    [-ContinuationPrompt <String>]
    [-ContinuationPromptForegroundColor <ConsoleColor>]
    [-ContinuationPromptBackgroundColor <ConsoleColor>]
    [-EmphasisForegroundColor <ConsoleColor>]
    [-EmphasisBackgroundColor <ConsoleColor>]
    [-ErrorForegroundColor <ConsoleColor>]
    [-ErrorBackgroundColor <ConsoleColor>]
    [-HistoryNoDuplicates]
    [-AddToHistoryHandler <Func[string,bool]>]
    [-CommandValidationHandler <Action[CommandAst]>]
    [-HistorySearchCursorMovesToEnd]
    [-MaximumHistoryCount <Int32>]
    [-MaximumKillRingCount <Int32>]
    [-ResetTokenColors]
    [-ShowToolTips]
    [-ExtraPromptLineCount <Int32>]
    [-DingTone <Int32>]
    [-DingDuration <Int32>]
    [-BellStyle <BellStyle>]
    [-CompletionQueryItems <Int32>]
    [-WordDelimiters <String>]
    [-HistorySearchCaseSensitive]
    [-HistorySaveStyle <HistorySaveStyle>]
    [-HistorySavePath <String>]
    [<CommonParameters>]

ColorSet

Set-PSReadlineOption
    [-TokenKind] <TokenClassification>
    [[-ForegroundColor] <ConsoleColor>]
    [[-BackgroundColor] <ConsoleColor>]
    [<CommonParameters>]

Description

L’applet Set-PSReadlineOption de commande personnalise le comportement du module PSReadline lorsque vous modifiez la ligne de commande. Pour afficher les paramètres PSReadline , utilisez Get-PSReadlineOption.

Exemples

Exemple 1 : Définir les couleurs de premier plan et d’arrière-plan

Cet exemple définit PSReadline pour afficher le jeton de commentaire avec du texte de premier plan vert sur un arrière-plan gris.

Set-PSReadlineOption -TokenKind Comment -ForegroundColor Green -BackgroundColor Gray

Exemple 2 : Définir le style de cloche

Dans cet exemple, PSReadline répondra aux erreurs ou aux conditions qui nécessitent l’attention de l’utilisateur. Le BellStyle est configuré pour émettre un bip sonore à 1221 Hz pendant 60 ms.

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

Paramètres

-AddToHistoryHandler

Spécifie un ScriptBlock qui contrôle les commandes ajoutées à l’historique PSReadline .

Le ScriptBlock reçoit la ligne de commande en entrée. Si le ScriptBlock renvoie $True, la ligne de commande est ajoutée à l’historique.

Propriétés du paramètre

Type:	Func[String, Boolean]
Valeur par défaut:	None
Prend en charge les caractères génériques:	False
DontShow:	False

Jeux de paramètres

(All)

Position:	Named
Obligatoire:	False
Valeur du pipeline:	False
Valeur du pipeline par nom de propriété:	False
Valeur des arguments restants:	False

-BackgroundColor

Spécifie la couleur d’arrière-plan du jeton spécifié par le paramètre TokenKind .

Les valeurs acceptables pour ce paramètre sont les suivantes :

Noir
Bleu foncé
Vert foncé
DarkCyan (en)
Rouge foncé
Magenta foncé
Jaune foncé
Gris
Gris foncé
Bleu
Vert
Cyan
Rouge
Magenta
Jaune
Blanc

Propriétés du paramètre

Type:	ConsoleColor
Valeur par défaut:	None
Valeurs acceptées:	Black, DarkBlue, DarkGreen, DarkCyan, DarkRed, DarkMagenta, DarkYellow, Gray, DarkGray, Blue, Green, Cyan, Red, Magenta, Yellow, White
Prend en charge les caractères génériques:	False
DontShow:	False

Jeux de paramètres

ColorSet

Position:	2
Obligatoire:	False
Valeur du pipeline:	False
Valeur du pipeline par nom de propriété:	False
Valeur des arguments restants:	False

-BellStyle

Spécifie comment PSReadline répond à diverses erreurs et conditions ambiguës.

Les valeurs valides sont les suivantes :

Audible : Un bip court.
Visuel : Le texte clignote brièvement.
Aucun : Aucun retour.

Propriétés du paramètre

Type:	BellStyle
Valeur par défaut:	Audible
Valeurs acceptées:	None, Visual, Audible
Prend en charge les caractères génériques:	False
DontShow:	False

Jeux de paramètres

(All)

Position:	Named
Obligatoire:	False
Valeur du pipeline:	False
Valeur du pipeline par nom de propriété:	False
Valeur des arguments restants:	False

-CommandValidationHandler

Spécifie un ScriptBlock appelé à partir de ValidateAndAcceptLine. Si une exception est levée, la validation échoue et l’erreur est signalée.

Avant de lever une exception, le gestionnaire de validation peut placer le curseur au point de l’erreur pour faciliter sa correction. Un gestionnaire de validation peut également modifier la ligne de commande, par exemple pour corriger les erreurs typographiques courantes.

ValidateAndAcceptLine est utilisé pour éviter d’encombrer votre historique avec des commandes qui ne peuvent pas fonctionner.

Propriétés du paramètre

Type:	Action[CommandAst]
Valeur par défaut:	None
Prend en charge les caractères génériques:	False
DontShow:	False

Jeux de paramètres

(All)

Position:	Named
Obligatoire:	False
Valeur du pipeline:	False
Valeur du pipeline par nom de propriété:	False
Valeur des arguments restants:	False

-CompletionQueryItems

Spécifie le nombre maximal d’éléments d’achèvement affichés sans invite.

Si le nombre d’éléments à afficher est supérieur à cette valeur, PSReadline demande oui/non avant d’afficher les éléments d’achèvement.

Propriétés du paramètre

Type:	Int32
Valeur par défaut:	100
Prend en charge les caractères génériques:	False
DontShow:	False

Jeux de paramètres

(All)

Position:	Named
Obligatoire:	False
Valeur du pipeline:	False
Valeur du pipeline par nom de propriété:	False
Valeur des arguments restants:	False

-ContinuationPrompt

Spécifie la chaîne affichée au début des lignes suivantes lors de la saisie de plusieurs lignes. La valeur par défaut est le signe double supérieur à (>>). Une chaîne vide est valide.

Propriétés du paramètre

Type:	String
Valeur par défaut:	>>
Prend en charge les caractères génériques:	False
DontShow:	False

Jeux de paramètres

(All)

Position:	Named
Obligatoire:	False
Valeur du pipeline:	False
Valeur du pipeline par nom de propriété:	False
Valeur des arguments restants:	False

-ContinuationPromptBackgroundColor

Spécifie la couleur d’arrière-plan de l’invite de continuation.

Les valeurs acceptables sont les mêmes que pour le paramètre BackgroundColor .

Propriétés du paramètre

Type:	ConsoleColor
Valeur par défaut:	None
Valeurs acceptées:	Black, DarkBlue, DarkGreen, DarkCyan, DarkRed, DarkMagenta, DarkYellow, Gray, DarkGray, Blue, Green, Cyan, Red, Magenta, Yellow, White
Prend en charge les caractères génériques:	False
DontShow:	False

Jeux de paramètres

OptionsSet

Position:	Named
Obligatoire:	False
Valeur du pipeline:	False
Valeur du pipeline par nom de propriété:	False
Valeur des arguments restants:	False

-ContinuationPromptForegroundColor

Spécifie la couleur de premier plan de l’invite de continuation.

Les valeurs acceptables sont les mêmes que pour le paramètre BackgroundColor .

Propriétés du paramètre

Type:	ConsoleColor
Valeur par défaut:	None
Valeurs acceptées:	Black, DarkBlue, DarkGreen, DarkCyan, DarkRed, DarkMagenta, DarkYellow, Gray, DarkGray, Blue, Green, Cyan, Red, Magenta, Yellow, White
Prend en charge les caractères génériques:	False
DontShow:	False

Jeux de paramètres

OptionsSet

Position:	Named
Obligatoire:	False
Valeur du pipeline:	False
Valeur du pipeline par nom de propriété:	False
Valeur des arguments restants:	False

-DingDuration

Spécifie la durée du bip lorsque BellStyle est défini sur Audible.

Propriétés du paramètre

Type:	Int32
Valeur par défaut:	50ms
Prend en charge les caractères génériques:	False
DontShow:	False

Jeux de paramètres

(All)

Position:	Named
Obligatoire:	False
Valeur du pipeline:	False
Valeur du pipeline par nom de propriété:	False
Valeur des arguments restants:	False

-DingTone

Spécifie la tonalité en Hertz (Hz) du bip lorsque BellStyle est réglé sur Audible.

Propriétés du paramètre

Type:	Int32
Valeur par défaut:	1221
Prend en charge les caractères génériques:	False
DontShow:	False

Jeux de paramètres

(All)

Position:	Named
Obligatoire:	False
Valeur du pipeline:	False
Valeur du pipeline par nom de propriété:	False
Valeur des arguments restants:	False

-EditMode

Spécifie le mode d’édition de la ligne de commande. L’utilisation de ce paramètre réinitialise toutes les combinaisons de touches définies par Set-PSReadlineKeyHandler.

Les valeurs valides sont les suivantes :

Windows : les raccourcis clavier émulent PowerShell, cmd et Visual Studio.
Emacs : Les raccourcis clavier émulent Bash ou Emacs.
Vi : Les raccourcis clavier émulent Vi.

Propriétés du paramètre

Type:	EditMode
Valeur par défaut:	Windows
Valeurs acceptées:	Windows, Emacs, Vi
Prend en charge les caractères génériques:	False
DontShow:	False

Jeux de paramètres

(All)

Position:	Named
Obligatoire:	False
Valeur du pipeline:	False
Valeur du pipeline par nom de propriété:	False
Valeur des arguments restants:	False

-EmphasisBackgroundColor

Spécifie la couleur d’arrière-plan utilisée pour mettre l’accent, par exemple pour mettre en surbrillance le texte de recherche.

Les valeurs acceptables sont les mêmes que pour le paramètre BackgroundColor .

Propriétés du paramètre

Type:	ConsoleColor
Valeur par défaut:	None
Valeurs acceptées:	Black, DarkBlue, DarkGreen, DarkCyan, DarkRed, DarkMagenta, DarkYellow, Gray, DarkGray, Blue, Green, Cyan, Red, Magenta, Yellow, White
Prend en charge les caractères génériques:	False
DontShow:	False

Jeux de paramètres

OptionsSet

Position:	Named
Obligatoire:	False
Valeur du pipeline:	False
Valeur du pipeline par nom de propriété:	False
Valeur des arguments restants:	False

-EmphasisForegroundColor

Spécifie la couleur de premier plan utilisée pour mettre l’accent, par exemple pour mettre en surbrillance le texte de recherche.

Les valeurs acceptables sont les mêmes que pour le paramètre BackgroundColor .

Propriétés du paramètre

Type:	ConsoleColor
Valeur par défaut:	None
Valeurs acceptées:	Black, DarkBlue, DarkGreen, DarkCyan, DarkRed, DarkMagenta, DarkYellow, Gray, DarkGray, Blue, Green, Cyan, Red, Magenta, Yellow, White
Prend en charge les caractères génériques:	False
DontShow:	False

Jeux de paramètres

OptionsSet

Position:	Named
Obligatoire:	False
Valeur du pipeline:	False
Valeur du pipeline par nom de propriété:	False
Valeur des arguments restants:	False

-ErrorBackgroundColor

Spécifie la couleur d’arrière-plan utilisée pour les erreurs.

Les valeurs acceptables sont les mêmes que pour le paramètre BackgroundColor .

Propriétés du paramètre

Type:	ConsoleColor
Valeur par défaut:	None
Valeurs acceptées:	Black, DarkBlue, DarkGreen, DarkCyan, DarkRed, DarkMagenta, DarkYellow, Gray, DarkGray, Blue, Green, Cyan, Red, Magenta, Yellow, White
Prend en charge les caractères génériques:	False
DontShow:	False

Jeux de paramètres

OptionsSet

Position:	Named
Obligatoire:	False
Valeur du pipeline:	False
Valeur du pipeline par nom de propriété:	False
Valeur des arguments restants:	False

-ErrorForegroundColor

Spécifie la couleur de premier plan utilisée pour les erreurs.

Les valeurs acceptables sont les mêmes que pour le paramètre BackgroundColor .

Propriétés du paramètre

Type:	ConsoleColor
Valeur par défaut:	None
Valeurs acceptées:	Black, DarkBlue, DarkGreen, DarkCyan, DarkRed, DarkMagenta, DarkYellow, Gray, DarkGray, Blue, Green, Cyan, Red, Magenta, Yellow, White
Prend en charge les caractères génériques:	False
DontShow:	False

Jeux de paramètres

OptionsSet

Position:	Named
Obligatoire:	False
Valeur du pipeline:	False
Valeur du pipeline par nom de propriété:	False
Valeur des arguments restants:	False

-ExtraPromptLineCount

Spécifie le nombre de lignes supplémentaires.

Si votre invite s’étend sur plusieurs lignes, spécifiez une valeur pour ce paramètre. Utilisez cette option lorsque vous souhaitez que des lignes supplémentaires soient disponibles lorsque PSReadline affiche l’invite après avoir affiché une sortie. Par exemple, PSReadline renvoie une liste de saisies semi-automatiques.

Cette option est moins nécessaire que dans les versions précédentes de PSReadline, mais elle est utile lorsque la InvokePrompt fonction est utilisée.

Propriétés du paramètre

Type:	Int32
Valeur par défaut:	0
Prend en charge les caractères génériques:	False
DontShow:	False

Jeux de paramètres

(All)

Position:	Named
Obligatoire:	False
Valeur du pipeline:	False
Valeur du pipeline par nom de propriété:	False
Valeur des arguments restants:	False

-ForegroundColor

Spécifie la couleur de premier plan du jeton spécifié par le paramètre TokenKind .

Les valeurs acceptables sont les mêmes que pour le paramètre BackgroundColor .

Propriétés du paramètre

Type:	ConsoleColor
Valeur par défaut:	None
Valeurs acceptées:	Black, DarkBlue, DarkGreen, DarkCyan, DarkRed, DarkMagenta, DarkYellow, Gray, DarkGray, Blue, Green, Cyan, Red, Magenta, Yellow, White
Prend en charge les caractères génériques:	False
DontShow:	False

Jeux de paramètres

ColorSet

Position:	1
Obligatoire:	False
Valeur du pipeline:	False
Valeur du pipeline par nom de propriété:	False
Valeur des arguments restants:	False

-HistoryNoDuplicates

Cette option contrôle le comportement de rappel. Les commandes en double sont toujours ajoutées au fichier d’historique. Lorsque cette option est activée, seul l’appel le plus récent s’affiche lors du rappel des commandes.

Des commandes répétées sont ajoutées à l’historique pour préserver l’ordre lors du rappel. Toutefois, vous ne souhaitez généralement pas voir la commande plusieurs fois lors du rappel ou de la recherche dans l’historique.

Propriétés du paramètre

Type:	SwitchParameter
Valeur par défaut:	False
Prend en charge les caractères génériques:	False
DontShow:	False

Jeux de paramètres

(All)

Position:	Named
Obligatoire:	False
Valeur du pipeline:	False
Valeur du pipeline par nom de propriété:	False
Valeur des arguments restants:	False

-HistorySavePath

Spécifie le chemin d’accès au fichier dans lequel l’historique est enregistré. Le nom du fichier est stocké dans une variable $($host.Name)_history.txt, par exemple ConsoleHost_history.txt.

Si vous n’utilisez pas ce paramètre, le chemin d’accès par défaut est le suivant :

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

Propriétés du paramètre

Type:	String
Valeur par défaut:	$env:APPDATA\Microsoft\Windows\PowerShell\PSReadline\$($host.Name)_history.txt
Prend en charge les caractères génériques:	False
DontShow:	False

Jeux de paramètres

(All)

Position:	Named
Obligatoire:	False
Valeur du pipeline:	False
Valeur du pipeline par nom de propriété:	False
Valeur des arguments restants:	False

-HistorySaveStyle

Spécifie comment PSReadline enregistre l’historique.

Les valeurs valides sont les suivantes :

SaveIncrementally : enregistrez l’historique après l’exécution de chaque commande et partagez-le sur plusieurs instances de PowerShell.
SaveAtExit : ajoutez le fichier d’historique à la fermeture de PowerShell.
SaveNothing : n’utilisez pas de fichier d’historique.

Propriétés du paramètre

Type:	HistorySaveStyle
Valeur par défaut:	SaveIncrementally
Valeurs acceptées:	SaveIncrementally, SaveAtExit, SaveNothing
Prend en charge les caractères génériques:	False
DontShow:	False

Jeux de paramètres

(All)

Position:	Named
Obligatoire:	False
Valeur du pipeline:	False
Valeur du pipeline par nom de propriété:	False
Valeur des arguments restants:	False

-HistorySearchCaseSensitive

Spécifie que la recherche dans l’historique est sensible à la casse dans des fonctions telles que ReverseSearchHistory ou HistorySearchBackward.

Propriétés du paramètre

Type:	SwitchParameter
Valeur par défaut:	False
Prend en charge les caractères génériques:	False
DontShow:	False

Jeux de paramètres

(All)

Position:	Named
Obligatoire:	False
Valeur du pipeline:	False
Valeur du pipeline par nom de propriété:	False
Valeur des arguments restants:	False

-HistorySearchCursorMovesToEnd

Indique que le curseur se déplace à la fin des commandes que vous chargez à partir de l’historique à l’aide d’une recherche. Lorsque ce paramètre est défini sur $False, le curseur reste à la position où il se trouvait lorsque vous avez appuyé sur les flèches vers le haut ou vers le bas.

Pour désactiver cette option, vous pouvez exécuter l’une des commandes suivantes :

Set-PSReadlineOption -HistorySearchCursorMovesToEnd:$False

(Get-PSReadlineOption).HistorySearchCursorMovesToEnd = $False

Propriétés du paramètre

Type:	SwitchParameter
Valeur par défaut:	False
Prend en charge les caractères génériques:	False
DontShow:	False

Jeux de paramètres

(All)

Position:	Named
Obligatoire:	False
Valeur du pipeline:	False
Valeur du pipeline par nom de propriété:	False
Valeur des arguments restants:	False

-MaximumHistoryCount

Spécifie le nombre maximal de commandes à enregistrer dans l’historique PSReadline .

L’historique PSReadline est distinct de l’historique PowerShell.

Propriétés du paramètre

Type:	Int32
Valeur par défaut:	None
Prend en charge les caractères génériques:	False
DontShow:	False

Jeux de paramètres

(All)

Position:	Named
Obligatoire:	False
Valeur du pipeline:	False
Valeur du pipeline par nom de propriété:	False
Valeur des arguments restants:	False

-MaximumKillRingCount

Spécifie le nombre maximal d’éléments stockés dans l’anneau d’élimination.

Propriétés du paramètre

Type:	Int32
Valeur par défaut:	10
Prend en charge les caractères génériques:	False
DontShow:	False

Jeux de paramètres

(All)

Position:	Named
Obligatoire:	False
Valeur du pipeline:	False
Valeur du pipeline par nom de propriété:	False
Valeur des arguments restants:	False

-ResetTokenColors

Indique que cette applet de commande restaure les couleurs du jeton aux paramètres par défaut.

Propriétés du paramètre

Type:	SwitchParameter
Valeur par défaut:	None
Prend en charge les caractères génériques:	False
DontShow:	False

Jeux de paramètres

OptionsSet

Position:	Named
Obligatoire:	False
Valeur du pipeline:	False
Valeur du pipeline par nom de propriété:	False
Valeur des arguments restants:	False

-ShowToolTips

Lors de l’affichage des achèvements possibles, les infobulles sont affichées dans la liste des achèvements.

Cette option est activée par défaut. Cette option n’était pas activée par défaut dans les versions précédentes de PSReadline. Pour la désactiver, définissez cette option sur $False.

Propriétés du paramètre

Type:	SwitchParameter
Valeur par défaut:	True
Prend en charge les caractères génériques:	False
DontShow:	False

Jeux de paramètres

(All)

Position:	Named
Obligatoire:	False
Valeur du pipeline:	False
Valeur du pipeline par nom de propriété:	False
Valeur des arguments restants:	False

-TokenKind

Spécifie le jeton lorsque vous définissez les options de couleur du jeton avec les paramètres ForegroundColor et BackgroundColor .

Les valeurs acceptables pour ce paramètre sont les suivantes :

Aucun
Commentaire
Mot-clé
Chaîne
Opérateur
Variable
Commande
Paramètre
Catégorie
Numéro
Membre

Propriétés du paramètre

Type:	TokenClassification
Valeur par défaut:	None
Valeurs acceptées:	None, Comment, Keyword, String, Operator, Variable, Command, Parameter, Type, Number, Member
Prend en charge les caractères génériques:	False
DontShow:	False

Jeux de paramètres

ColorSet

Position:	0
Obligatoire:	True
Valeur du pipeline:	False
Valeur du pipeline par nom de propriété:	False
Valeur des arguments restants:	False

-WordDelimiters

Spécifie les caractères qui délimitent les mots pour des fonctions telles que ForwardWord ou KillWord.

Propriétés du paramètre

Type:	String
Valeur par défaut:	;:,.[]{}()/\\|^&*-=+–—―
Prend en charge les caractères génériques:	False
DontShow:	False

Jeux de paramètres

(All)

Position:	Named
Obligatoire:	False
Valeur du pipeline:	False
Valeur du pipeline par nom de propriété:	False
Valeur des arguments restants:	False

CommonParameters

Cette applet de commande prend en charge les paramètres courants : -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction et -WarningVariable. Pour plus d’informations, consultez about_CommonParameters.

Entrées

None

Vous ne pouvez pas envoyer d’objets vers le bas du pipeline pour Set-PSReadlineOption.

Sorties

None

Set-PSReadlineOption ne génère pas de sortie.