aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorDaniel Eklöf <daniel@ekloef.se>2021-05-22 12:49:42 +0000
committerDaniel Eklöf <daniel@ekloef.se>2021-05-22 12:49:42 +0000
commit28d27f49bfbaa799fed8c7a97aa9d91204ac62b8 (patch)
tree6db4a63df5736a1d144b208a846dc27cdff4a1b3 /doc
parentMerge branch 'fdm-always-check-for-signals' (diff)
parentconfig: add cursor.underline-thickness (diff)
Merge branch 'underline-cursor-thickness'
Closes #524
Diffstat (limited to 'doc')
-rw-r--r--doc/foot.ini.5.scd18
1 files changed, 15 insertions, 3 deletions
diff --git a/doc/foot.ini.5.scd b/doc/foot.ini.5.scd
index cb4b4f08..eb55ba80 100644
--- a/doc/foot.ini.5.scd
+++ b/doc/foot.ini.5.scd
@@ -344,9 +344,21 @@ applications can change these at runtime.
*beam-thickness*
Thickness (width) of the beam styled cursor. The value is in
- _points_, and its exact value thus depends on the monitor's
- DPI. To instead specify a thickness in _pixels_, use the *px*
- suffix: e.g. *beam-thickness=2px*. Default: _1.5_
+ points, and its exact value thus depends on the monitor's DPI. To
+ instead specify a thickness in pixels, use the *px* suffix:
+ e.g. *beam-thickness=2px*. Default: _1.5_
+
+*underline-thickness*
+ Thickness (height) of the underline styled cursor. The value is in
+ points, and its exact value thus depends on the monitor's DPI.
+
+ To instead specify a thickness in pixels, use the *px* suffix:
+ e.g. *underline-thickness=2px*.
+
+ Note that if left unset, the cursor's thickness will scale with
+ the font size, while if set, the size is fixed.
+
+ Default: _font underline thickness_.
# SECTION: mouse