aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorDaniel Eklöf <daniel@ekloef.se>2020-08-20 17:25:35 +0000
committerDaniel Eklöf <daniel@ekloef.se>2021-06-24 15:30:45 +0000
commitb9ef703eb14ba2357b847b62a715b4e97f690209 (patch)
treec6e65e05499e292a4f51d09453f44d1bdf0f93ad /doc
parentMerge branch 'sixel-heap-user-after-free-after-blending' (diff)
wip: grapheme shaping
Diffstat (limited to 'doc')
-rw-r--r--doc/foot.ini.5.scd22
1 files changed, 22 insertions, 0 deletions
diff --git a/doc/foot.ini.5.scd b/doc/foot.ini.5.scd
index 58134060..94ad42f6 100644
--- a/doc/foot.ini.5.scd
+++ b/doc/foot.ini.5.scd
@@ -975,6 +975,28 @@ any of these options.
Default: _no_.
+*grapheme-shaping*
+ Boolean. When enabled, foot will use _utf8proc_ to do grapheme
+ cluster segmentation while parsing "printed" text. Then, when
+ rendering, it will use _fcft_ (if compiled with _HarfBuzz_
+ support) to shape the grapheme clusters.
+
+ This is required to render e.g. flag (emoji) sequences, keycap
+ sequences, modifier sequences, zero-width-joiner (ZWJ) sequences
+ andn emoji tag sequences.
+
+ This is an experimental feature with the following requirements and limitations:
+
+ - foot must have been compiled with utf8proc support
+ - fcft must have been compiled with HarfBuzz support
+ - This option must be set to true
+ - Foot will use *wcswidth*(3) to calculate a cluster's display
+ width. This will typically _not_ match the shaped glyph's width,
+ but is necessary to not break cursor synchronization with the
+ application running in foot.
+
+ Default: _no_
+
*max-shm-pool-size-mb*
This option controls the amount of virtual address space used by
the pixmap memory to which the terminal screen content is