l.behm/bumblebee-status
1
1
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

[doc] update docs as per #606

Browse source
This commit is contained in:
tobi-wan-kenobi 2020-05-06 12:57:38 +02:00
parent 806258c2ed
commit f49300e568
22 changed files with 164 additions and 191 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
docs/development/theme.rst
View file

@ -8,9 +8,12 @@ Introduction
attributes (foreground color, background color, etc.) of the blocks that attributes (foreground color, background color, etc.) of the blocks that
make up a status bar. make up a status bar.
It is possible to specify each attribute at various levels: - For a It is possible to specify each attribute at various levels:
specific state of a specific module - For a specific module - A cycle of
attributes (those are cycled through widget-by-widget) - Default values - For a specific state of a specific module
- For a specific module
- A cycle of attributes (those are cycled through widget-by-widget)
- Default values
Looking up a value follows the “more specific rather than more generic” Looking up a value follows the “more specific rather than more generic”
approach. In other words, if a foreground color exists for the “warning” approach. In other words, if a foreground color exists for the “warning”

10
docs/features.rst
View file

@ -21,8 +21,10 @@ You can provide your own handlers to any module by using the following
- right-click - right-click
- middle-click - middle-click
- wheel-up - wheel-up
- wheel-down For example, to execute “pavucontrol” whenever you - wheel-down
left-click on the nic module, you could write:
For example, to execute “pavucontrol” whenever you
left-click on the nic module, you could write:
``$ bumblebee-status -p nic.left-click="pavucontrol"`` ``$ bumblebee-status -p nic.left-click="pavucontrol"``
@ -85,8 +87,8 @@ 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 *in addition* to ``-m`` (i.e. to autohide the CPU module, you would use
``bumblebee-status -m cpu memory traffic -a cpu``). ``bumblebee-status -m cpu memory traffic -a cpu``).
Additional widget themeing Additional widget theme settings
-------------------------- --------------------------------
There are a few parameters you can tweak directly from the commandline There are a few parameters you can tweak directly from the commandline
via ``-p`` or ``--parameters``: - ``<modulename>.theme.minwidth`` sets via ``-p`` or ``--parameters``: - ``<modulename>.theme.minwidth`` sets

142
docs/modules.rst
View file

@ -5,26 +5,6 @@ core
---- ----
__pulseaudio
~~~~~~~~~~~~
Displays volume and mute status and controls for PulseAudio devices. Use wheel up and down to change volume, left click mutes, right click opens pavucontrol.
Aliases: pasink (use this to control output instead of input), pasource
Parameters:
* pulseaudio.autostart: If set to 'true' (default is 'false'), automatically starts the pulseaudio daemon if it is not running
* pulseaudio.percent_change: How much to change volume by when scrolling on the module (default is 2%)
* pulseaudio.limit: Upper limit for setting the volume (default is 0%, which means 'no limit')
Note: If the left and right channels have different volumes, the limit might not be reached exactly.
* pulseaudio.showbars: 1 for showing volume bars, requires --markup=pango;
0 for not showing volume bars (default)
Requires the following executable:
* pulseaudio
* pactl
* pavucontrol
battery battery
~~~~~~~ ~~~~~~~
@ -232,6 +212,28 @@ Parameters:
.. image:: ../screenshots/ping.png .. image:: ../screenshots/ping.png
pulseaudio
~~~~~~~~~~
Displays volume and mute status and controls for PulseAudio devices. Use wheel up and down to change volume, left click mutes, right click opens pavucontrol.
Aliases: pasink (use this to control output instead of input), pasource
Parameters:
* pulseaudio.autostart: If set to 'true' (default is 'false'), automatically starts the pulseaudio daemon if it is not running
* pulseaudio.percent_change: How much to change volume by when scrolling on the module (default is 2%)
* pulseaudio.limit: Upper limit for setting the volume (default is 0%, which means 'no limit')
Note: If the left and right channels have different volumes, the limit might not be reached exactly.
* pulseaudio.showbars: 1 for showing volume bars, requires --markup=pango;
0 for not showing volume bars (default)
Requires the following executable:
* pulseaudio
* pactl
* pavucontrol
.. image:: ../screenshots/pulseaudio.png
redshift redshift
~~~~~~~~ ~~~~~~~~
@ -242,8 +244,8 @@ Requires the following executable:
Parameters: Parameters:
* redshift.location : location provider, either of 'auto' (default), 'geoclue2', * redshift.location : location provider, either of 'auto' (default), 'geoclue2',
'ipinfo' or 'manual' 'ipinfo' or 'manual'
'auto' uses whatever redshift is configured to do 'auto' uses whatever redshift is configured to do
* redshift.lat : latitude if location is set to 'manual' * redshift.lat : latitude if location is set to 'manual'
* redshift.lon : longitude if location is set to 'manual' * redshift.lon : longitude if location is set to 'manual'
@ -319,10 +321,10 @@ Shows a widget for each connected screen and allows the user to enable/disable s
Parameters: Parameters:
* xrandr.overwrite_i3config: If set to 'true', this module assembles a new i3 config * xrandr.overwrite_i3config: If set to 'true', this module assembles a new i3 config
every time a screen is enabled or disabled by taking the file '~/.config/i3/config.template' every time a screen is enabled or disabled by taking the file '~/.config/i3/config.template'
and appending a file '~/.config/i3/config.<screen name>' for every screen. and appending a file '~/.config/i3/config.<screen name>' for every screen.
* xrandr.autoupdate: If set to 'false', does *not* invoke xrandr automatically. Instead, the * xrandr.autoupdate: If set to 'false', does *not* invoke xrandr automatically. Instead, the
module will only refresh when displays are enabled or disabled (defaults to true) module will only refresh when displays are enabled or disabled (defaults to true)
Requires the following python module: Requires the following python module:
* (optional) i3 - if present, the need for updating the widget list is auto-detected * (optional) i3 - if present, the need for updating the widget list is auto-detected
@ -420,15 +422,14 @@ Requirements:
Parameters: Parameters:
* cpu2.layout: Space-separated list of widgets to add. * cpu2.layout: Space-separated list of widgets to add.
Possible widgets are: Possible widgets are:
* cpu2.maxfreq * cpu2.maxfreq
* cpu2.cpuload * cpu2.cpuload
* cpu2.coresload * cpu2.coresload
* cpu2.temp * cpu2.temp
* cpu2.fanspeed * cpu2.fanspeed
* cpu2.colored: 1 for colored per core load graph, 0 for mono (default) * cpu2.colored: 1 for colored per core load graph, 0 for mono (default)
if this is set to 1, use --markup=pango
* cpu2.temp_pattern: pattern to look for in the output of 'sensors -u'; * cpu2.temp_pattern: pattern to look for in the output of 'sensors -u';
required if cpu2.temp widged is used required if cpu2.temp widged is used
* cpu2.fan_pattern: pattern to look for in the output of 'sensors -u'; * cpu2.fan_pattern: pattern to look for in the output of 'sensors -u';
@ -450,7 +451,7 @@ Parameters:
* currency.source: Source currency (ex. 'GBP', 'EUR'). Defaults to 'auto', which infers the local one from IP address. * currency.source: Source currency (ex. 'GBP', 'EUR'). Defaults to 'auto', which infers the local one from IP address.
* currency.destination: Comma-separated list of destination currencies (defaults to 'USD,EUR') * currency.destination: Comma-separated list of destination currencies (defaults to 'USD,EUR')
* currency.sourceformat: String format for source formatting; Defaults to '{}: {}' and has two variables, * currency.sourceformat: String format for source formatting; Defaults to '{}: {}' and has two variables,
the base symbol and the rate list the base symbol and the rate list
* currency.destinationdelimiter: Delimiter used for separating individual rates (defaults to '|') * currency.destinationdelimiter: Delimiter used for separating individual rates (defaults to '|')
Note: source and destination names right now must correspond to the names used by the API of https://markets.ft.com Note: source and destination names right now must correspond to the names used by the API of https://markets.ft.com
@ -672,19 +673,20 @@ Requires the following executable:
Parameters: Parameters:
* mocp.format: Format string for the song information. Replace string sequences with the actual information: * mocp.format: Format string for the song information. Replace string sequences with the actual information:
%state State
%file File * %state State
%title Title, includes track, artist, song title and album * %file File
%artist Artist * %title Title, includes track, artist, song title and album
%song SongTitle * %artist Artist
%album Album * %song SongTitle
%tt TotalTime * %album Album
%tl TimeLeft * %tt TotalTime
%ts TotalSec * %tl TimeLeft
%ct CurrentTime * %ts TotalSec
%cs CurrentSec * %ct CurrentTime
%b Bitrate * %cs CurrentSec
%r Sample rate * %b Bitrate
* %r Sample rate
mpd mpd
~~~ ~~~
@ -698,6 +700,7 @@ Parameters:
* mpd.format: Format string for the song information. * mpd.format: Format string for the song information.
Supported tags (see `man mpc` for additional information) Supported tags (see `man mpc` for additional information)
* {name} * {name}
* {artist} * {artist}
* {album} * {album}
@ -719,6 +722,7 @@ Parameters:
* {mdate} * {mdate}
Additional tags: Additional tags:
* {position} - position of currently playing song * {position} - position of currently playing song
not to be confused with %position% mpc tag not to be confused with %position% mpc tag
* {duration} - duration of currently playing song * {duration} - duration of currently playing song
@ -760,7 +764,7 @@ Displays GPU name, temperature and memory usage.
Parameters: Parameters:
* nvidiagpu.format: Format string (defaults to '{name}: {temp}°C %{usedmem}/{totalmem} MiB') * nvidiagpu.format: Format string (defaults to '{name}: {temp}°C %{usedmem}/{totalmem} MiB')
Available values are: {name} {temp} {mem_used} {mem_total} {fanspeed} {clock_gpu} {clock_mem} Available values are: {name} {temp} {mem_used} {mem_total} {fanspeed} {clock_gpu} {clock_mem}
Requires nvidia-smi Requires nvidia-smi
@ -810,12 +814,12 @@ Parameters:
* pomodoro.work: The work duration of timer in minutes (defaults to 25) * pomodoro.work: The work duration of timer in minutes (defaults to 25)
* pomodoro.break: The break duration of timer in minutes (defaults to 5) * pomodoro.break: The break duration of timer in minutes (defaults to 5)
* pomodoro.format: Timer display format with '%m' and '%s' for minutes and seconds (defaults to '%m:%s') * pomodoro.format: Timer display format with '%m' and '%s' for minutes and seconds (defaults to '%m:%s')
Examples: '%m min %s sec', '%mm', '', 'timer' Examples: '%m min %s sec', '%mm', '', 'timer'
* pomodoro.notify: Notification command to run when timer ends/starts (defaults to nothing) * pomodoro.notify: Notification command to run when timer ends/starts (defaults to nothing)
Example: 'notify-send 'Time up!''. If you want to chain multiple commands, Example: 'notify-send 'Time up!''. If you want to chain multiple commands,
please use an external wrapper script and invoke that. The module itself does please use an external wrapper script and invoke that. The module itself does
not support command chaining (see https://github.com/tobi-wan-kenobi/bumblebee-status/issues/532 not support command chaining (see https://github.com/tobi-wan-kenobi/bumblebee-status/issues/532
for a detailled explanation) for a detailled explanation)
prime prime
~~~~~ ~~~~~
@ -852,7 +856,7 @@ Parameters:
* progress.placeholder: Text to display while no process is running (defaults to 'n/a') * progress.placeholder: Text to display while no process is running (defaults to 'n/a')
* progress.barwidth: Width of the progressbar if it is used (defaults to 8) * progress.barwidth: Width of the progressbar if it is used (defaults to 8)
* progress.format: Format string (defaults to '{bar} {cmd} {arg}') * progress.format: Format string (defaults to '{bar} {cmd} {arg}')
Available values are: {bar} {pid} {cmd} {arg} {percentage} {quantity} {speed} {time} Available values are: {bar} {pid} {cmd} {arg} {percentage} {quantity} {speed} {time}
* progress.barfilledchar: Character used to draw the filled part of the bar (defaults to '#'), notice that it can be a string * progress.barfilledchar: Character used to draw the filled part of the bar (defaults to '#'), notice that it can be a string
* progress.baremptychar: Character used to draw the empty part of the bar (defaults to '-'), notice that it can be a string * progress.baremptychar: Character used to draw the empty part of the bar (defaults to '-'), notice that it can be a string
@ -916,16 +920,16 @@ Few command examples:
Parameters: Parameters:
* shell.command: Command to execute * shell.command: Command to execute
Use single parentheses if evaluating anything inside (sh-style) Use single parentheses if evaluating anything inside (sh-style)
For example shell.command='echo $(date +'%H:%M:%S')' For example shell.command='echo $(date +'%H:%M:%S')'
But NOT shell.command='echo $(date +'%H:%M:%S')' But NOT shell.command='echo $(date +'%H:%M:%S')'
Second one will be evaluated only once at startup Second one will be evaluated only once at startup
* shell.interval: Update interval in seconds * shell.interval: Update interval in seconds
(defaults to 1s == every bumblebee-status update) (defaults to 1s == every bumblebee-status update)
* shell.async: Run update in async mode. Won't run next thread if * shell.async: Run update in async mode. Won't run next thread if
previous one didn't finished yet. Useful for long previous one didn't finished yet. Useful for long
running scripts to avoid bumblebee-status freezes running scripts to avoid bumblebee-status freezes
(defaults to False) (defaults to False)
shortcut shortcut
~~~~~~~~ ~~~~~~~~
@ -978,9 +982,9 @@ Format Strings:
* Boolean values can be overwritten by appending '%true%false' * Boolean values can be overwritten by appending '%true%false'
in the format string in the format string
* Example: to reference 'open' in '{'state':{'open': true}}' * Example: to reference 'open' in '{'state':{'open': true}}'
you would write '%%state.open%%', if you also want you would write '%%state.open%%', if you also want
to say 'Open/Closed' depending on the boolean you to say 'Open/Closed' depending on the boolean you
would write '%%state.open%Open%Closed%%' would write '%%state.open%Open%Closed%%'
spotify spotify
~~~~~~~ ~~~~~~~
@ -1109,10 +1113,10 @@ Parameters:
* traffic.states: Comma-separated list of states to show (prefix with '^' to invert - i.e. ^down -> show all devices that are not in state down) * traffic.states: Comma-separated list of states to show (prefix with '^' to invert - i.e. ^down -> show all devices that are not in state down)
* traffic.showname: If set to False, hide network interface name (defaults to True) * traffic.showname: If set to False, hide network interface name (defaults to True)
* traffic.format: Format string for download/upload speeds. * traffic.format: Format string for download/upload speeds.
Defaults to '{:.2f}' Defaults to '{:.2f}'
* traffic.graphlen: Graph lenth in seconds. Positive even integer. Each * traffic.graphlen: Graph lenth in seconds. Positive even integer. Each
char shows 2 seconds. If set, enables up/down traffic char shows 2 seconds. If set, enables up/down traffic
graphs graphs
.. image:: ../screenshots/traffic.png .. image:: ../screenshots/traffic.png
@ -1143,7 +1147,7 @@ Prerequisites:
lists all the connection profiles that are configured. Make sure that your VPN profile is in that list! lists all the connection profiles that are configured. Make sure that your VPN profile is in that list!
e.g: to import a openvpn profile via nmcli: e.g: to import a openvpn profile via nmcli:
sudo nmcli connection import type openvpn file </path/to/your/openvpn/profile.ovpn> `sudo nmcli connection import type openvpn file </path/to/your/openvpn/profile.ovpn>`
watson watson
~~~~~~ ~~~~~~
@ -1163,8 +1167,8 @@ Requires the following python packages:
Parameters: Parameters:
* weather.location: Set location, defaults to 'auto' for getting location automatically from a web service * weather.location: Set location, defaults to 'auto' for getting location automatically from a web service
If set to a comma-separated list, left-click and right-click can be used to rotate the locations. If set to a comma-separated list, left-click and right-click can be used to rotate the locations.
Locations should be city names or city ids. Locations should be city names or city ids.
* weather.unit: metric (default), kelvin, imperial * weather.unit: metric (default), kelvin, imperial
* weather.showcity: If set to true, show location information, otherwise hide it (defaults to true) * weather.showcity: If set to true, show location information, otherwise hide it (defaults to true)
* weather.showminmax: If set to true, show the minimum and maximum temperature, otherwise hide it (defaults to false) * weather.showminmax: If set to true, show the minimum and maximum temperature, otherwise hide it (defaults to false)
@ -1194,13 +1198,13 @@ Displays info about zpools present on the system
Parameters: Parameters:
* zpool.list: Comma-separated list of zpools to display info for. If empty, info for all zpools * zpool.list: Comma-separated list of zpools to display info for. If empty, info for all zpools
is displayed. (Default: '') is displayed. (Default: '')
* zpool.format: Format string, tags {name}, {used}, {left}, {size}, {percentfree}, {percentuse}, * zpool.format: Format string, tags {name}, {used}, {left}, {size}, {percentfree}, {percentuse},
{status}, {shortstatus}, {fragpercent}, {deduppercent} are supported. {status}, {shortstatus}, {fragpercent}, {deduppercent} are supported.
(Default: '{name} {used}/{size} ({percentfree}%)') (Default: '{name} {used}/{size} ({percentfree}%)')
* zpool.showio: Show also widgets detailing current read and write I/O (Default: true) * zpool.showio: Show also widgets detailing current read and write I/O (Default: true)
* zpool.ioformat: Format string for I/O widget, tags {ops} (operations per seconds) and {band} * zpool.ioformat: Format string for I/O widget, tags {ops} (operations per seconds) and {band}
(bandwidth) are supported. (Default: '{band}') (bandwidth) are supported. (Default: '{band}')
* zpool.warnfree: Warn if free space is below this percentage (Default: 10) * zpool.warnfree: Warn if free space is below this percentage (Default: 10)
* zpool.sudo: Use sudo when calling the `zpool` binary. (Default: false) * zpool.sudo: Use sudo when calling the `zpool` binary. (Default: false)

86
docs/themes.rst
View file

@ -1,132 +1,94 @@
List of available themes List of available themes
======================== ========================
.. warning:: Some themes (e.g. all ‘powerline’ themes) require `Font .. warning:: Some themes (e.g. all ‘powerline’ themes) require Font
Awesome <http://fontawesome.io/>`__ and a powerline-compatible font Awesome <http://fontawesome.io/>__ and a powerline-compatible font
(`powerline-fonts <https://github.com/powerline/fonts>`__. (powerline-fonts <https://github.com/powerline/fonts>__.
.. note:: If you want to add your own theme, just drop it into .. note:: If you want to add your own theme, just drop it into
`~/.config/bumblebee-status/themes/` ~/.config/bumblebee-status/themes/
Gruvbox Powerline (``-t gruvbox-powerline``) (contributed by
`TheEdgeOfRage <https://github.com/TheEdgeOfRage>`__):
.. figure:: ../screenshots/themes/powerline-gruvbox.png .. figure:: ../screenshots/themes/powerline-gruvbox.png
:alt: Gruvbox Powerline :alt: Gruvbox Powerline
Gruvbox Powerline Gruvbox Powerline (-t gruvbox-powerline) (contributed by `TheEdgeOfRage <https://github.com/TheEdgeOfRage>`__)
Gruvbox Powerline Light (``-t gruvbox-powerline-light``) (contributed by
`freed00m <https://github.com/freed00m>`__):
.. figure:: ../screenshots/themes/gruvbox-powerline-light.png .. figure:: ../screenshots/themes/gruvbox-powerline-light.png
:alt: Gruvbox Powerline Light :alt: Gruvbox Powerline Light
Gruvbox Powerline Light Gruvbox Powerline Light (-t gruvbox-powerline-light) (contributed by `freed00m <https://github.com/freed00m>`__)
Solarized Powerline (``-t solarized-powerline``):
.. figure:: ../screenshots/themes/powerline-solarized.png .. figure:: ../screenshots/themes/powerline-solarized.png
:alt: Solarized Powerline :alt: Solarized Powerline
Solarized Powerline Solarized Powerline (-t solarized-powerline)
Gruvbox (``-t gruvbox``):
.. figure:: ../screenshots/themes/gruvbox.png .. figure:: ../screenshots/themes/gruvbox.png
:alt: Gruvbox :alt: Gruvbox
Gruvbox Gruvbox (-t gruvbox)
Gruvbox Light (``-t gruvbox-light``) (contributed by
`freed00m <https://github.com/freed00m>`__):
.. figure:: ../screenshots/themes/gruvbox-light.png .. figure:: ../screenshots/themes/gruvbox-light.png
:alt: Gruvbox Light :alt: Gruvbox Light
Gruvbox Light Gruvbox Light (-t gruvbox-light) (contributed by `freed00m <https://github.com/freed00m>`__)
Solarized (``-t solarized``):
.. figure:: ../screenshots/themes/solarized.png .. figure:: ../screenshots/themes/solarized.png
:alt: Solarized :alt: Solarized
Solarized Solarized (-t solarized)
Powerline (``-t powerline``):
.. figure:: ../screenshots/themes/powerline.png .. figure:: ../screenshots/themes/powerline.png
:alt: Powerline :alt: Powerline
Powerline Powerline (-t powerline)
Greyish Powerline (``-t greyish-powerline``) (contributed by Joshua
Bark):
.. figure:: ../screenshots/themes/powerline-greyish.png .. figure:: ../screenshots/themes/powerline-greyish.png
:alt: Greyish Powerline :alt: Greyish Powerline
Greyish Powerline Greyish Powerline (-t greyish-powerline) (contributed by Joshua Bark)
Iceberg (``-t iceberg``) (contributed by
`whzup <https://github.com/whzup>`__):
.. figure:: ../screenshots/themes/iceberg.png .. figure:: ../screenshots/themes/iceberg.png
:alt: Iceberg :alt: Iceberg
Iceberg Iceberg (-t iceberg) (contributed by `whzup <https://github.com/whzup>`__)
Iceberg Powerline (``-t iceberg-powerline``) (contributed by
`whzup <https://github.com/whzup>`__):
.. figure:: ../screenshots/themes/iceberg-powerline.png .. figure:: ../screenshots/themes/iceberg-powerline.png
:alt: Iceberg Powerline :alt: Iceberg Powerline
Iceberg Powerline Iceberg Powerline (-t iceberg-powerline) (contributed by `whzup <https://github.com/whzup>`__)
Iceberg Dark Powerline (``-t iceberg-dark-powerline``) (contributed by
`gkeep <https://github.com/gkeep>`__):
.. figure:: ../screenshots/themes/iceberg-dark-powerline.png .. figure:: ../screenshots/themes/iceberg-dark-powerline.png
:alt: Iceberg Dark Powerline :alt: Iceberg Dark Powerline
Iceberg Dark Powerline Iceberg Dark Powerline (-t iceberg-dark-powerline) (contributed by `gkeep <https://github.com/gkeep>`__)
Iceberg Rainbow (``-t iceberg-rainbow``) (contributed by
`whzup <https://github.com/whzup>`__):
.. figure:: ../screenshots/themes/iceberg-rainbow.png .. figure:: ../screenshots/themes/iceberg-rainbow.png
:alt: Iceberg Rainbow :alt: Iceberg Rainbow
Iceberg Rainbow Iceberg Rainbow (-t iceberg-rainbow) (contributed by `whzup <https://github.com/whzup>`__)
Iceberg Contrast (``-t iceberg-contrast``) (contributed by
`martindoublem <https://github.com/martindoublem>`__):
.. figure:: ../screenshots/themes/iceberg-contrast.png .. figure:: ../screenshots/themes/iceberg-contrast.png
:alt: Iceberg Contrast :alt: Iceberg Contrast
Iceberg Contrast Iceberg Contrast (-t iceberg-contrast) (contributed by `martindoublem <https://github.com/martindoublem>`__)
One Dark Powerline (``-t onedark-powerline``) (contributed by
`dillasyx <https://github.com/dillasyx>`__):
.. figure:: ../screenshots/themes/onedark-powerline.png .. figure:: ../screenshots/themes/onedark-powerline.png
:alt: One Dark Powerline :alt: One Dark Powerline
One Dark Powerline One Dark Powerline (-t onedark-powerline) (contributed by `dillasyx <https://github.com/dillasyx>`__)
Dracula Powerline (-t dracula-powerline) (contributed by
`xsteadfastx <https://github.com/xsteadfastx>`__):
.. figure:: ../screenshots/themes/dracula-powerline.png .. figure:: ../screenshots/themes/dracula-powerline.png
:alt: Dracula Powerline :alt: Dracula Powerline
Dracula Powerline Dracula Powerline (-t dracula-powerline) (contributed by `xsteadfastx <https://github.com/xsteadfastx>`__)
Default (nothing or ``-t default``): .. figure:: ../screenshots/themes/nord-powerline.png
:alt: Nord Powerline
Nord Powerline (-t nord-powerline) (contributed by `uselessthird <https://github.com/uselessthird>`__)
.. figure:: ../screenshots/themes/default.png .. figure:: ../screenshots/themes/default.png
:alt: Default :alt: Default
Default Default (nothing or -t default)

3
modules/contrib/cpu2.py
View file

@ -15,15 +15,14 @@ Requirements:
Parameters: Parameters:
* cpu2.layout: Space-separated list of widgets to add. * cpu2.layout: Space-separated list of widgets to add.
Possible widgets are: Possible widgets are:
* cpu2.maxfreq * cpu2.maxfreq
* cpu2.cpuload * cpu2.cpuload
* cpu2.coresload * cpu2.coresload
* cpu2.temp * cpu2.temp
* cpu2.fanspeed * cpu2.fanspeed
* cpu2.colored: 1 for colored per core load graph, 0 for mono (default) * cpu2.colored: 1 for colored per core load graph, 0 for mono (default)
if this is set to 1, use --markup=pango
* cpu2.temp_pattern: pattern to look for in the output of 'sensors -u'; * cpu2.temp_pattern: pattern to look for in the output of 'sensors -u';
required if cpu2.temp widged is used required if cpu2.temp widged is used
* cpu2.fan_pattern: pattern to look for in the output of 'sensors -u'; * cpu2.fan_pattern: pattern to look for in the output of 'sensors -u';

2
modules/contrib/currency.py
View file

@ -11,7 +11,7 @@ Parameters:
* currency.source: Source currency (ex. 'GBP', 'EUR'). Defaults to 'auto', which infers the local one from IP address. * currency.source: Source currency (ex. 'GBP', 'EUR'). Defaults to 'auto', which infers the local one from IP address.
* currency.destination: Comma-separated list of destination currencies (defaults to 'USD,EUR') * currency.destination: Comma-separated list of destination currencies (defaults to 'USD,EUR')
* currency.sourceformat: String format for source formatting; Defaults to '{}: {}' and has two variables, * currency.sourceformat: String format for source formatting; Defaults to '{}: {}' and has two variables,
the base symbol and the rate list the base symbol and the rate list
* currency.destinationdelimiter: Delimiter used for separating individual rates (defaults to '|') * currency.destinationdelimiter: Delimiter used for separating individual rates (defaults to '|')
Note: source and destination names right now must correspond to the names used by the API of https://markets.ft.com Note: source and destination names right now must correspond to the names used by the API of https://markets.ft.com

27
modules/contrib/mocp.py
View file

@ -8,19 +8,20 @@ Requires the following executable:
Parameters: Parameters:
* mocp.format: Format string for the song information. Replace string sequences with the actual information: * mocp.format: Format string for the song information. Replace string sequences with the actual information:
%state State
%file File * %state State
%title Title, includes track, artist, song title and album * %file File
%artist Artist * %title Title, includes track, artist, song title and album
%song SongTitle * %artist Artist
%album Album * %song SongTitle
%tt TotalTime * %album Album
%tl TimeLeft * %tt TotalTime
%ts TotalSec * %tl TimeLeft
%ct CurrentTime * %ts TotalSec
%cs CurrentSec * %ct CurrentTime
%b Bitrate * %cs CurrentSec
%r Sample rate * %b Bitrate
* %r Sample rate
""" """
import core.module import core.module

2
modules/contrib/mpd.py
View file

@ -10,6 +10,7 @@ Parameters:
* mpd.format: Format string for the song information. * mpd.format: Format string for the song information.
Supported tags (see `man mpc` for additional information) Supported tags (see `man mpc` for additional information)
* {name} * {name}
* {artist} * {artist}
* {album} * {album}
@ -31,6 +32,7 @@ Parameters:
* {mdate} * {mdate}
Additional tags: Additional tags:
* {position} - position of currently playing song * {position} - position of currently playing song
not to be confused with %position% mpc tag not to be confused with %position% mpc tag
* {duration} - duration of currently playing song * {duration} - duration of currently playing song

2
modules/contrib/nvidiagpu.py
View file

@ -4,7 +4,7 @@
Parameters: Parameters:
* nvidiagpu.format: Format string (defaults to '{name}: {temp}°C %{usedmem}/{totalmem} MiB') * nvidiagpu.format: Format string (defaults to '{name}: {temp}°C %{usedmem}/{totalmem} MiB')
Available values are: {name} {temp} {mem_used} {mem_total} {fanspeed} {clock_gpu} {clock_mem} Available values are: {name} {temp} {mem_used} {mem_total} {fanspeed} {clock_gpu} {clock_mem}
Requires nvidia-smi Requires nvidia-smi
""" """

10
modules/contrib/pomodoro.py
View file

@ -8,12 +8,12 @@ Parameters:
* pomodoro.work: The work duration of timer in minutes (defaults to 25) * pomodoro.work: The work duration of timer in minutes (defaults to 25)
* pomodoro.break: The break duration of timer in minutes (defaults to 5) * pomodoro.break: The break duration of timer in minutes (defaults to 5)
* pomodoro.format: Timer display format with '%m' and '%s' for minutes and seconds (defaults to '%m:%s') * pomodoro.format: Timer display format with '%m' and '%s' for minutes and seconds (defaults to '%m:%s')
Examples: '%m min %s sec', '%mm', '', 'timer' Examples: '%m min %s sec', '%mm', '', 'timer'
* pomodoro.notify: Notification command to run when timer ends/starts (defaults to nothing) * pomodoro.notify: Notification command to run when timer ends/starts (defaults to nothing)
Example: 'notify-send 'Time up!''. If you want to chain multiple commands, Example: 'notify-send 'Time up!''. If you want to chain multiple commands,
please use an external wrapper script and invoke that. The module itself does please use an external wrapper script and invoke that. The module itself does
not support command chaining (see https://github.com/tobi-wan-kenobi/bumblebee-status/issues/532 not support command chaining (see https://github.com/tobi-wan-kenobi/bumblebee-status/issues/532
for a detailled explanation) for a detailled explanation)
""" """
from __future__ import absolute_import from __future__ import absolute_import

2
modules/contrib/progress.py
View file

@ -5,7 +5,7 @@ Parameters:
* progress.placeholder: Text to display while no process is running (defaults to 'n/a') * progress.placeholder: Text to display while no process is running (defaults to 'n/a')
* progress.barwidth: Width of the progressbar if it is used (defaults to 8) * progress.barwidth: Width of the progressbar if it is used (defaults to 8)
* progress.format: Format string (defaults to '{bar} {cmd} {arg}') * progress.format: Format string (defaults to '{bar} {cmd} {arg}')
Available values are: {bar} {pid} {cmd} {arg} {percentage} {quantity} {speed} {time} Available values are: {bar} {pid} {cmd} {arg} {percentage} {quantity} {speed} {time}
* progress.barfilledchar: Character used to draw the filled part of the bar (defaults to '#'), notice that it can be a string * progress.barfilledchar: Character used to draw the filled part of the bar (defaults to '#'), notice that it can be a string
* progress.baremptychar: Character used to draw the empty part of the bar (defaults to '-'), notice that it can be a string * progress.baremptychar: Character used to draw the empty part of the bar (defaults to '-'), notice that it can be a string

16
modules/contrib/shell.py
View file

@ -11,16 +11,16 @@ Few command examples:
Parameters: Parameters:
* shell.command: Command to execute * shell.command: Command to execute
Use single parentheses if evaluating anything inside (sh-style) Use single parentheses if evaluating anything inside (sh-style)
For example shell.command='echo $(date +'%H:%M:%S')' For example shell.command='echo $(date +'%H:%M:%S')'
But NOT shell.command='echo $(date +'%H:%M:%S')' But NOT shell.command='echo $(date +'%H:%M:%S')'
Second one will be evaluated only once at startup Second one will be evaluated only once at startup
* shell.interval: Update interval in seconds * shell.interval: Update interval in seconds
(defaults to 1s == every bumblebee-status update) (defaults to 1s == every bumblebee-status update)
* shell.async: Run update in async mode. Won't run next thread if * shell.async: Run update in async mode. Won't run next thread if
previous one didn't finished yet. Useful for long previous one didn't finished yet. Useful for long
running scripts to avoid bumblebee-status freezes running scripts to avoid bumblebee-status freezes
(defaults to False) (defaults to False)
""" """
import os import os

6
modules/contrib/spaceapi.py
View file

@ -21,9 +21,9 @@ Format Strings:
* Boolean values can be overwritten by appending '%true%false' * Boolean values can be overwritten by appending '%true%false'
in the format string in the format string
* Example: to reference 'open' in '{'state':{'open': true}}' * Example: to reference 'open' in '{'state':{'open': true}}'
you would write '%%state.open%%', if you also want you would write '%%state.open%%', if you also want
to say 'Open/Closed' depending on the boolean you to say 'Open/Closed' depending on the boolean you
would write '%%state.open%Open%Closed%%' would write '%%state.open%Open%Closed%%'
""" """
import requests import requests

6
modules/contrib/traffic.py
View file

@ -7,10 +7,10 @@ Parameters:
* traffic.states: Comma-separated list of states to show (prefix with '^' to invert - i.e. ^down -> show all devices that are not in state down) * traffic.states: Comma-separated list of states to show (prefix with '^' to invert - i.e. ^down -> show all devices that are not in state down)
* traffic.showname: If set to False, hide network interface name (defaults to True) * traffic.showname: If set to False, hide network interface name (defaults to True)
* traffic.format: Format string for download/upload speeds. * traffic.format: Format string for download/upload speeds.
Defaults to '{:.2f}' Defaults to '{:.2f}'
* traffic.graphlen: Graph lenth in seconds. Positive even integer. Each * traffic.graphlen: Graph lenth in seconds. Positive even integer. Each
char shows 2 seconds. If set, enables up/down traffic char shows 2 seconds. If set, enables up/down traffic
graphs graphs
""" """
import re import re

2
modules/contrib/vpn.py
View file

@ -12,7 +12,7 @@
lists all the connection profiles that are configured. Make sure that your VPN profile is in that list! lists all the connection profiles that are configured. Make sure that your VPN profile is in that list!
e.g: to import a openvpn profile via nmcli: e.g: to import a openvpn profile via nmcli:
sudo nmcli connection import type openvpn file </path/to/your/openvpn/profile.ovpn> `sudo nmcli connection import type openvpn file </path/to/your/openvpn/profile.ovpn>`
""" """
import logging import logging

4
modules/contrib/weather.py
View file

@ -8,8 +8,8 @@ Requires the following python packages:
Parameters: Parameters:
* weather.location: Set location, defaults to 'auto' for getting location automatically from a web service * weather.location: Set location, defaults to 'auto' for getting location automatically from a web service
If set to a comma-separated list, left-click and right-click can be used to rotate the locations. If set to a comma-separated list, left-click and right-click can be used to rotate the locations.
Locations should be city names or city ids. Locations should be city names or city ids.
* weather.unit: metric (default), kelvin, imperial * weather.unit: metric (default), kelvin, imperial
* weather.showcity: If set to true, show location information, otherwise hide it (defaults to true) * weather.showcity: If set to true, show location information, otherwise hide it (defaults to true)
* weather.showminmax: If set to true, show the minimum and maximum temperature, otherwise hide it (defaults to false) * weather.showminmax: If set to true, show the minimum and maximum temperature, otherwise hide it (defaults to false)

8
modules/contrib/zpool.py
View file

@ -2,13 +2,13 @@
Parameters: Parameters:
* zpool.list: Comma-separated list of zpools to display info for. If empty, info for all zpools * zpool.list: Comma-separated list of zpools to display info for. If empty, info for all zpools
is displayed. (Default: '') is displayed. (Default: '')
* zpool.format: Format string, tags {name}, {used}, {left}, {size}, {percentfree}, {percentuse}, * zpool.format: Format string, tags {name}, {used}, {left}, {size}, {percentfree}, {percentuse},
{status}, {shortstatus}, {fragpercent}, {deduppercent} are supported. {status}, {shortstatus}, {fragpercent}, {deduppercent} are supported.
(Default: '{name} {used}/{size} ({percentfree}%)') (Default: '{name} {used}/{size} ({percentfree}%)')
* zpool.showio: Show also widgets detailing current read and write I/O (Default: true) * zpool.showio: Show also widgets detailing current read and write I/O (Default: true)
* zpool.ioformat: Format string for I/O widget, tags {ops} (operations per seconds) and {band} * zpool.ioformat: Format string for I/O widget, tags {ops} (operations per seconds) and {band}
(bandwidth) are supported. (Default: '{band}') (bandwidth) are supported. (Default: '{band}')
* zpool.warnfree: Warn if free space is below this percentage (Default: 10) * zpool.warnfree: Warn if free space is below this percentage (Default: 10)
* zpool.sudo: Use sudo when calling the `zpool` binary. (Default: false) * zpool.sudo: Use sudo when calling the `zpool` binary. (Default: false)

2
modules/core/pasink.py
View file

@ -1,4 +1,4 @@
from .__pulseaudio import Module from .pulseaudio import Module
class Module(Module): class Module(Module):

2
modules/core/pasource.py
View file

@ -1,4 +1,4 @@
from .__pulseaudio import Module from .pulseaudio import Module
class Module(Module): class Module(Module):

4
modules/core/pulseaudio.py
View file

@ -8,9 +8,9 @@ Parameters:
* pulseaudio.autostart: If set to 'true' (default is 'false'), automatically starts the pulseaudio daemon if it is not running * pulseaudio.autostart: If set to 'true' (default is 'false'), automatically starts the pulseaudio daemon if it is not running
* pulseaudio.percent_change: How much to change volume by when scrolling on the module (default is 2%) * pulseaudio.percent_change: How much to change volume by when scrolling on the module (default is 2%)
* pulseaudio.limit: Upper limit for setting the volume (default is 0%, which means 'no limit') * pulseaudio.limit: Upper limit for setting the volume (default is 0%, which means 'no limit')
Note: If the left and right channels have different volumes, the limit might not be reached exactly. Note: If the left and right channels have different volumes, the limit might not be reached exactly.
* pulseaudio.showbars: 1 for showing volume bars, requires --markup=pango; * pulseaudio.showbars: 1 for showing volume bars, requires --markup=pango;
0 for not showing volume bars (default) 0 for not showing volume bars (default)
Requires the following executable: Requires the following executable:
* pulseaudio * pulseaudio

4
modules/core/redshift.py
View file

@ -7,8 +7,8 @@ Requires the following executable:
Parameters: Parameters:
* redshift.location : location provider, either of 'auto' (default), 'geoclue2', * redshift.location : location provider, either of 'auto' (default), 'geoclue2',
'ipinfo' or 'manual' 'ipinfo' or 'manual'
'auto' uses whatever redshift is configured to do 'auto' uses whatever redshift is configured to do
* redshift.lat : latitude if location is set to 'manual' * redshift.lat : latitude if location is set to 'manual'
* redshift.lon : longitude if location is set to 'manual' * redshift.lon : longitude if location is set to 'manual'
""" """

6
modules/core/xrandr.py
View file

@ -4,10 +4,10 @@
Parameters: Parameters:
* xrandr.overwrite_i3config: If set to 'true', this module assembles a new i3 config * xrandr.overwrite_i3config: If set to 'true', this module assembles a new i3 config
every time a screen is enabled or disabled by taking the file '~/.config/i3/config.template' every time a screen is enabled or disabled by taking the file '~/.config/i3/config.template'
and appending a file '~/.config/i3/config.<screen name>' for every screen. and appending a file '~/.config/i3/config.<screen name>' for every screen.
* xrandr.autoupdate: If set to 'false', does *not* invoke xrandr automatically. Instead, the * xrandr.autoupdate: If set to 'false', does *not* invoke xrandr automatically. Instead, the
module will only refresh when displays are enabled or disabled (defaults to true) module will only refresh when displays are enabled or disabled (defaults to true)
Requires the following python module: Requires the following python module:
* (optional) i3 - if present, the need for updating the widget list is auto-detected * (optional) i3 - if present, the need for updating the widget list is auto-detected