aboutsummaryrefslogtreecommitdiffstats
path: root/doc/aerc-config.5.scd
diff options
context:
space:
mode:
authorKoni Marti <koni.marti@gmail.com>2022-04-18 16:06:27 +0200
committerRobin Jarry <robin@jarry.cc>2022-04-25 11:21:07 +0200
commitce18e928813526e59462e391c09e868c62facb42 (patch)
tree9898097ca19e9aea7792f08ec8694a25432b83b1 /doc/aerc-config.5.scd
parenteb7e45d43be883c4be0e635875846f0d7ddca485 (diff)
downloadaerc-ce18e928813526e59462e391c09e868c62facb42.tar.gz
statusline: refactor to make it more customizable
Refactor statusline by clearly separating the rendering part from the text display. Use printf-like format string for statusline customization. Document printf-like format string to customize the statusline. Allow to completely mute the statusline (except for push notifications) with a format specifier. Provide a display mode with unicode icons for the status elements. Implements: https://todo.sr.ht/~rjarry/aerc/34 Signed-off-by: Koni Marti <koni.marti@gmail.com> Acked-by: Robin Jarry <robin@jarry.cc>
Diffstat (limited to 'doc/aerc-config.5.scd')
-rw-r--r--doc/aerc-config.5.scd46
1 files changed, 46 insertions, 0 deletions
diff --git a/doc/aerc-config.5.scd b/doc/aerc-config.5.scd
index 493fd715..b615629b 100644
--- a/doc/aerc-config.5.scd
+++ b/doc/aerc-config.5.scd
@@ -295,6 +295,52 @@ index-format=...
index-format=...
```
+## STATUSLINE
+
+These options are configured in the *[statusline]* section of aerc.conf.
+
+*render-format*
+ Describes the format string for the statusline format.
+
+ For a minimal statusline that only shows the current account and
+ the connection information, use [%a] %c.
+
+ To completely mute the statusline (except for push notficiations), use
+ %m only.
+
+ Default: [%a] %S %>%T
+
+[- *Format specifier*
+:[ *Description*
+| %%
+: literal %
+| %a
+: active account name
+| %d
+: active directory name
+| %c
+: connection state
+| %m
+: mute statusline and show only push notifications
+| %S
+: general status information (e.g. connection state, filter, search)
+| %T
+: general on/off information (e.g. passthrough, threading, sorting)
+| %>
+: does not print anything but all format specifier that follow will be right justified.
+
+*separator*
+ Specifies the separator between grouped statusline elements (e.g. for
+ the %S and %T specifiers in *render-format*).
+
+ Default: " | "
+
+*display-mode*
+ Defines the mode for displaying the status elements.
+ Options: text, icon
+
+ Default: text
+
## VIEWER