@@ -120,38 +120,39 @@ instance Exception VtyConfigurationError where
120120type InputMap = [(Maybe String, String, Event)]
121121
122122-- | A Vty configuration.
123−data Config = Config
124− {
125− -- | The default is 1 character.
126− vmin :: Maybe Int
127− -- | The default is 100 milliseconds, 0.1 seconds.
128− , vtime :: Maybe Int
129− -- | The default is False.
130− , mouseMode :: Maybe Bool
131− -- | The default is False.
132− , bracketedPasteMode :: Maybe Bool
133− -- | Debug information is appended to this file if not Nothing.
134− , debugLog :: Maybe FilePath
135− -- | The (input byte, output event) pairs extend the internal input
136− -- table of VTY and the table from terminfo.
137− --
138− -- See "Graphics.Vty.Config" module documentation for documentation
139− -- of the @map@ directive.
140− , inputMap :: InputMap
141− -- | The input file descriptor to use. The default is
142− -- 'System.Posix.IO.stdInput'
143− , inputFd :: Maybe Fd
144− -- | The output file descriptor to use. The default is
145− -- 'System.Posix.IO.stdOutput'
146− , outputFd :: Maybe Fd
147− -- | The terminal name used to look up terminfo capabilities.
148− -- The default is the value of the TERM environment variable.
149− , termName :: Maybe String
150− -- | Terminal width map files.
151− , termWidthMaps :: [(String, FilePath)]
152− -- | Whether to permit custom Unicode width table loading.
153− , allowCustomUnicodeWithTables :: Bool
154− } deriving (Show, Eq)
123+data Config =
124+ Config { vmin :: Maybe Int
125+ -- ^ The default is 1 character.
126+ , vtime :: Maybe Int
127+ -- ^ The default is 100 milliseconds, 0.1 seconds.
128+ , mouseMode :: Maybe Bool
129+ -- ^ The default is False.
130+ , bracketedPasteMode :: Maybe Bool
131+ -- ^ The default is False.
132+ , debugLog :: Maybe FilePath
133+ -- ^ Debug information is appended to this file if not
134+ -- Nothing.
135+ , inputMap :: InputMap
136+ -- ^ The (input byte, output event) pairs extend the internal
137+ -- input table of VTY and the table from terminfo.
138+ --
139+ -- See "Graphics.Vty.Config" module documentation for
140+ -- documentation of the @map@ directive.
141+ , inputFd :: Maybe Fd
142+ -- ^ The input file descriptor to use. The default is
143+ -- 'System.Posix.IO.stdInput'
144+ , outputFd :: Maybe Fd
145+ -- ^ The output file descriptor to use. The default is
146+ -- 'System.Posix.IO.stdOutput'
147+ , termName :: Maybe String
148+ -- ^ The terminal name used to look up terminfo capabilities.
149+ -- The default is the value of the TERM environment variable.
150+ , termWidthMaps :: [(String, FilePath)]
151+ -- ^ Terminal width map files.
152+ , allowCustomUnicodeWithTables :: Bool
153+ -- ^ Whether to permit custom Unicode width table loading.
154+ }
155+ deriving (Show, Eq)
155156
156157defaultConfig :: Config
157158defaultConfig = mempty