diff options
| author | Daniel Eklöf <daniel@ekloef.se> | 2021-06-24 15:50:55 +0000 |
|---|---|---|
| committer | Daniel Eklöf <daniel@ekloef.se> | 2021-06-24 15:50:55 +0000 |
| commit | 80c2d9d89df11c5830de900f98b5d9f3f406a1c1 (patch) | |
| tree | a27132ebbd0940872c16afd3f48f4ee791820a0a /doc | |
| parent | Merge branch 'sixel-heap-user-after-free-after-blending' (diff) | |
| parent | client: add +/-graphemes to version output (diff) | |
Merge branch 'harfbuzz'
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/foot.ini.5.scd | 24 |
1 files changed, 24 insertions, 0 deletions
diff --git a/doc/foot.ini.5.scd b/doc/foot.ini.5.scd index 58134060..2e408b3a 100644 --- a/doc/foot.ini.5.scd +++ b/doc/foot.ini.5.scd @@ -975,6 +975,30 @@ 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. It might also improve rendering of + composed characters, depending on font. + + 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 |
