about summary refs log tree commit diff stats
path: root/doc
diff options
context:
space:
mode:
authorPaul Spooren <mail@aparcar.org>2019-08-29 15:30:35 -1000
committerDrew DeVault <sir@cmpwn.com>2019-08-30 10:32:28 +0900
commite4104a867401e383ef2b45f4c449b8b3fa25e69b (patch)
tree74a0ec139b3630e1f9963122d3ffa2809aaf0616 /doc
parentf13f9a86849ff8b4616aa7b462ed171833e02a95 (diff)
downloadaerc-e4104a867401e383ef2b45f4c449b8b3fa25e69b.tar.gz
Allow custom spinner via config file
Allows to set `ui.spinner=` to a string which is then split by
`ui.spinner-delimiter=` (Default: comma) instead of having a hard coded
animation.

This implementation doesn't use INIs capabilities to split strings as
it trims whitespaces breaking the default animation.

Signed-off-by: Paul Spooren <mail@aparcar.org>
Diffstat (limited to 'doc')
-rw-r--r--doc/aerc-config.5.scd15
1 files changed, 15 insertions, 0 deletions
diff --git a/doc/aerc-config.5.scd b/doc/aerc-config.5.scd
index f0b9b7a..9257bde 100644
--- a/doc/aerc-config.5.scd
+++ b/doc/aerc-config.5.scd
@@ -110,6 +110,21 @@ These options are configured in the *[ui]* section of aerc.conf.
 
 	Default: true
 
+*spinner*
+	Animation shown while loading, split by spinner-delimiter (below)
+
+	Examples:
+	- spinner = "\-\_-,\_-\_"
+	- spinner = '. , .'
+	- spinner = "\,|,/,-"
+
+	Default: "[..]    , [..]   ,  [..]  ,   [..] ,    [..],   [..] ,  [..]  , [..]   "
+
+*spinner-delimiter*
+	Spinner delimiter to split string into a animation
+
+	Default: ","
+
 ## VIEWER
 
 These options are configured in the *[viewer]* section of aerc.conf.