Graphics.Vty.Platform.Unix.Settings

Runtime settings for vty-unix. Most applications will not need to change any of these settings.

Documentation

data VtyUnixConfigurationError

Type of exceptions that can be raised when configuring Vty on a Unix system.

Constructors

MissingTermEnvVar

The TERM environment variable is not set.

Instances

Exception VtyUnixConfigurationError

Defined in Graphics.Vty.Platform.Unix.Settings

Methods

toException :: VtyUnixConfigurationError -> SomeException

fromException :: SomeException -> Maybe VtyUnixConfigurationError

displayException :: VtyUnixConfigurationError -> String

Show VtyUnixConfigurationError

Defined in Graphics.Vty.Platform.Unix.Settings

Methods

showsPrec :: Int -> VtyUnixConfigurationError -> ShowS

show :: VtyUnixConfigurationError -> String

showList :: [VtyUnixConfigurationError] -> ShowS

Eq VtyUnixConfigurationError

Defined in Graphics.Vty.Platform.Unix.Settings

Methods

(==) :: VtyUnixConfigurationError -> VtyUnixConfigurationError -> Bool

(/=) :: VtyUnixConfigurationError -> VtyUnixConfigurationError -> Bool

data UnixSettings

Runtime library settings for interacting with Unix terminals.

See this page for details on VTIME and VMIN:

http://unixwiz.net/techtips/termios-vmin-vtime.html

Constructors

UnixSettings

Fields

• settingVmin :: Int

  VMIN character count.

• settingVtime :: Int

  VTIME setting in tenths of a second.

• settingInputFd :: Fd

  The input file descriptor to use.

• settingOutputFd :: Fd

  The output file descriptor to use.

• settingTermName :: String

  The terminal name used to look up terminfo capabilities.

Instances

Show UnixSettings

Defined in Graphics.Vty.Platform.Unix.Settings

Methods

showsPrec :: Int -> UnixSettings -> ShowS

show :: UnixSettings -> String

showList :: [UnixSettings] -> ShowS

Eq UnixSettings

Defined in Graphics.Vty.Platform.Unix.Settings

Methods

(==) :: UnixSettings -> UnixSettings -> Bool

(/=) :: UnixSettings -> UnixSettings -> Bool

currentTerminalName :: IO (Maybe String)

defaultSettings :: IO UnixSettings

Default runtime settings used by the library.