vty-5.11.2: A simple terminal UI library

Safe HaskellNone



A Config can be provided to mkVty to customize the applications use of vty. A config file can be used to customize vty for a user's system.

The Config provided is mappend'd to Configs loaded from getAppUserDataDirectory/config and $VTY_CONFIG_FILE. The $VTY_CONFIG_FILE takes precedence over the config file or the application provided Config.

Lines in config files that fail to parse are ignored. Later entries take precedence over earlier.

For all directives:

 string := "\"" chars+ "\""




 "debugLog" string

The value of the environment variable VTY_DEBUG_LOG is equivalent to a debugLog entry at the end of the last config file.

Input Processing



 "map" term string key modifier_list
     key := KEsc | KChar Char | KBS ... (same as Key)
     modifier_list := "[" modifier+ "]"
     modifier := MShift | MCtrl | MMeta | MAlt
     term := "_" | string

EG: If the contents are

 map _       "\ESC[B"    KUp   []
 map _       "\ESC[1;3B" KDown [MAlt]
 map "xterm" "\ESC[D"    KLeft []

Then the bytes "\ESC[B" will result in the KUp event on all terminals. The bytes "\ESC[1;3B" will result in the event KDown with the MAlt modifier on all terminals. The bytes "\ESC[D" will result in the KLeft event when TERM is xterm.

If a debug log is requested then vty will output the current input table to the log in the above format.

Set VTY_DEBUG_LOG. Run vty. Check debug log for incorrect mappings. Add corrected mappings to .vty/config



type InputMap = [(Maybe String, String, Event)] Source #

Mappings from input bytes to event in the order specified. Later entries take precedence over earlier in the case multiple entries have the same byte string.

data Config Source #




userConfig :: IO Config Source #

Config from getAppUserDataDirectory/config and $VTY_CONFIG_FILE

standardIOConfig :: IO Config Source #

Configures VTY using defaults suitable for terminals. This action can raise VtyConfigurationError.