@@ -55,6 +55,32 @@
5555-- table to the log in the above format. A workflow for using this is
5656-- to set @VTY_DEBUG_LOG@. Run the application. Check the debug log for
5757-- incorrect mappings. Add corrected mappings to @$HOME/.vty/config@.
58+--
59+-- = Unicode Character Width Maps
60+--
61+-- == @widthMap@
62+--
63+-- Format:
64+--
65+-- @
66+-- \"widthMap\" string string
67+-- @
68+--
69+-- E.g.,
70+--
71+-- @
72+-- widthMap \"xterm\" \"\/home\/user\/.vty\/xterm\_map.dat\"
73+-- @
74+--
75+-- This directive specifies the path to a Unicode character width
76+-- map (the second argument) that should be loaded and used when
77+-- the value of TERM matches the first argument. Unicode character
78+-- width maps can be produced either by running the provided binary
79+-- @vty-build-width-table@ or by calling the library routine
80+-- 'Graphics.Vty.UnicodeWidthTable.Query.buildUnicodeWidthTable'. The
81+-- 'Graphics.Vty.mkVty' function will use these configuration settings
82+-- to attempt to load and install the specified width map. See the
83+-- documentation for 'Graphics.Vty.mkVty' for details.
5884module Graphics.Vty.Config
5985 ( InputMap
6086 , Config(..)