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

[doc] update module documentation

Browse source
This commit is contained in:
tobi-wan-kenobi 2021-05-10 17:48:23 +00:00
parent 9e20b48cee
commit 7f03c9ce2d
1 changed files with 11 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
docs/modules.rst
View file

@ -85,6 +85,14 @@ Requires:
.. image:: ../screenshots/git.png .. image:: ../screenshots/git.png
keys
~~~~
Shows when a key is pressed
Parameters:
* keys.keys: Comma-separated list of keys to monitor (defaults to "")
layout-xkb layout-xkb
~~~~~~~~~~ ~~~~~~~~~~
@ -1238,7 +1246,7 @@ a delimiter (; semicolon by default).
For example in order to create two shortcuts labeled A and B with commands For example in order to create two shortcuts labeled A and B with commands
cmdA and cmdB you could do: cmdA and cmdB you could do:
./bumblebee-status -m shortcut -p shortcut.cmd='ls;ps' shortcut.label='A;B' ./bumblebee-status -m shortcut -p shortcut.cmd='firefox https://www.google.com;google-chrome https://google.com' shortcut.label='Google (Firefox);Google (Chrome)'
Parameters: Parameters:
* shortcut.cmds : List of commands to execute * shortcut.cmds : List of commands to execute
@ -1321,9 +1329,6 @@ stock
Display a stock quote from finance.yahoo.com Display a stock quote from finance.yahoo.com
Requires the following python packages:
* requests
Parameters: Parameters:
* stock.symbols : Comma-separated list of symbols to fetch * stock.symbols : Comma-separated list of symbols to fetch
* stock.change : Should we fetch change in stock value (defaults to True) * stock.change : Should we fetch change in stock value (defaults to True)
@ -1344,8 +1349,8 @@ Requires the following python packages:
* python-dateutil * python-dateutil
Parameters: Parameters:
* cpu.lat : Latitude of your location * sun.lat : Latitude of your location
* cpu.lon : Longitude of your location * sun.lon : Longitude of your location
(if none of those are set, location is determined automatically via location APIs) (if none of those are set, location is determined automatically via location APIs)