aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorDaniel Eklöf <daniel@ekloef.se>2021-04-30 18:31:47 +0000
committerDaniel Eklöf <daniel@ekloef.se>2021-04-30 18:36:16 +0000
commit7ce767ab87ca915b2ac4023cc95dbda81fe87abd (patch)
tree517f2e52ff5d626429b0f478b927bfb27028348e /doc
parentMerge branch 'bsu-esu-logging' (diff)
config: add ‘beam-thickness’ option
* Rename cursor.style value ‘bar’ to ‘beam’. ‘bar’ remains recognized, but should eventually be deprecated and then removed. * Add ‘cursor.beam-thickness’ option, a pt-or-px value specifying the thickness of the beam cursor. Defaults to 1.5pt. * Rename (and export) pt_or_px_as_pixels() to term_pt_or_px_as_pixels() * Change term_pt_or_px_as_pixels() to round point values instead of truncating them.
Diffstat (limited to 'doc')
-rw-r--r--doc/foot.ini.5.scd15
1 files changed, 10 insertions, 5 deletions
diff --git a/doc/foot.ini.5.scd b/doc/foot.ini.5.scd
index 4af48307..f32be208 100644
--- a/doc/foot.ini.5.scd
+++ b/doc/foot.ini.5.scd
@@ -68,7 +68,7 @@ in this order:
An absolute value, in _points_, that override line height from the
font metrics.
- You can specify a height in _pixels_ by using the _px_ suffix:
+ You can specify a height in _pixels_ by using the *px* suffix:
e.g. *line-height=12px*.
See also: *vertical-letter-offset*.
@@ -79,7 +79,7 @@ in this order:
Spacing between letters, in _points_. A positive value will
increase the cell size, and a negative value shrinks it.
- You can specify a letter spacing in _pixels_ by using the _px_
+ You can specify a letter spacing in _pixels_ by using the *px*
suffix: e.g. *letter-spacing=2px*.
See also: *horizontal-letter-offset*.
@@ -91,7 +91,7 @@ in this order:
positioning glyphs within cells, in _points_, relative to the top
left corner.
- To specify an offset in _pixels_, append _px_:
+ To specify an offset in _pixels_, append *px*:
e.g. *horizontal-letter-offset=2px*.
Default: _0_.
@@ -320,8 +320,8 @@ This section controls the cursor style and color. Note that
applications can change these at runtime.
*style*
- Configures the default cursor style, and is one of: _block_, _bar_
- or _underline_. Note that this can be overridden by
+ Configures the default cursor style, and is one of: *block*,
+ *beam* or *underline*. Note that this can be overridden by
applications. Default: _block_.
*blink*
@@ -335,6 +335,11 @@ applications can change these at runtime.
cursor. The other cursor styles are always rendered with the
foreground color.
+*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_
# SECTION: mouse