From f2153b95a535445f520d94c29b9eca3ae6906633 Mon Sep 17 00:00:00 2001 From: tobi-wan-kenobi Date: Fri, 2 Oct 2020 09:34:53 +0200 Subject: [PATCH] [doc] add scrolling parameters see #710 --- docs/features.rst | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/docs/features.rst b/docs/features.rst index f050a2b..f48ebf0 100644 --- a/docs/features.rst +++ b/docs/features.rst @@ -87,6 +87,19 @@ attention, it will remain hidden. Note that this parameter is specified *in addition* to ``-m`` (i.e. to autohide the CPU module, you would use ``bumblebee-status -m cpu memory traffic -a cpu``). +Scrolling widget text +----------------------- +Some widgets support scrolling for long text (e.g. most music player +widgets, rss, etc.). Those have some additional settings for customizing +the scrolling behaviour, in particular: + + - ``scrolling.width``: Desired width of the scrolling panel + - ``scrolling.makewide``: If set to true, extends texts shorter than + ``scrolling.width`` to that width + - ``scrolling.bounce``: If set to true, bounces the text when it reaches + the end, otherwise, it behaves like marquee (scroll-through) text + - ``scrolling.speed``: Defines the scroll speed, in characters per update + Additional widget theme settings --------------------------------