diff --git a/Modules.md b/Modules.md index 228014e..7d39865 100644 --- a/Modules.md +++ b/Modules.md @@ -32,11 +32,12 @@ |indicator |Displays the indicator status, for numlock, scrolllock and capslock

Parameters:
* indicator.include: Comma-separated list of interface prefixes to include (defaults to "numlock,capslock")
* indicator.signalstype: If you want the signali type color to be "critical" or "warning" (defaults to "warning")
| |kernel |Shows Linux kernel version information | |layout-xkb |Displays the current keyboard layout using libX11

Requires the following library:
* libX11.so.6
and python module:
* xkbgroup

Parameters:
* layout-xkb.showname: Boolean that indicate whether the full name should be displayed. Defaults to false (only the symbol will be displayed)
* layout-xkb.show_variant: Boolean that indecates whether the variant name should be displayed. Defaults to true.
| +|layout-xkbswitch |Displays and changes the current keyboard layout

Requires the following executable:
* xkb-switch
| |layout |Displays and changes the current keyboard layout

Requires the following executable:
* setxkbmap
| |load |Displays system load.

Parameters:
* load.warning : Warning threshold for the one-minute load average (defaults to 70% of the number of CPUs)
* load.critical: Critical threshold for the one-minute load average (defaults to 80% of the number of CPUs)
| |memory |Displays available RAM, total amount of RAM and percentage available.

Parameters:
* memory.warning : Warning threshold in % of memory used (defaults to 80%)
* memory.critical: Critical threshold in % of memory used (defaults to 90%)
* memory.format: Format string (defaults to "{used}/{total} ({percent:05.02f}%)")
* memory.usedonly: Only show the amount of RAM in use (defaults to False). Same as memory.format="{used}"
| |mocp |Displays information about the current song in mocp. Left click toggles play/pause. Right click toggles shuffle.

Requires the following executable:
* mocp

Parameters:
* mocp.format: Format string for the song information. Replace string sequences with the actual information:
%state State
%file File
%title Title, includes track, artist, song title and album
%artist Artist
%song SongTitle
%album Album
%tt TotalTime
%tl TimeLeft
%ts TotalSec
%ct CurrentTime
%cs CurrentSec
%b Bitrate
%r Sample rate
| -|mpd |Displays information about the current song in mpd.

Requires the following executable:
* mpc

Parameters:
* mpd.format: Format string for the song information. Tag values can be put in curly brackets (i.e. {artist})
* mpd.host: MPD host to connect to. (mpc behaviour by default)
| +|mpd |Displays information about the current song in mpd.

Requires the following executable:
* mpc

Parameters:
* mpd.format: Format string for the song information.
Supported tags (see `man mpc` for additional information)
* {name}
* {artist}
* {album}
* {albumartist}
* {comment}
* {composer}
* {date}
* {originaldate}
* {disc}
* {genre}
* {performer}
* {title}
* {track}
* {time}
* {file}
* {id}
* {prio}
* {mtime}
* {mdate}
Additional tags:
* {position} - position of currently playing song
not to be confused with %position% mpc tag
* {duration} - duration of currently playing song
* {file1} - song file name without path prefix
if {file} = '/foo/bar.baz', then {file1} = 'bar.baz'
* {file2} - song file name without path prefix and extension suffix
if {file} = '/foo/bar.baz', then {file2} = 'bar'
* mpd.host: MPD host to connect to. (mpc behaviour by default)
| |network_traffic |Displays network traffic
* No extra configuration needed
| |nic |Displays the name, IP address(es) and status of each available network interface.

Requires the following python module:
* netifaces

Parameters:
* nic.exclude: Comma-separated list of interface prefixes to exclude (defaults to "lo,virbr,docker,vboxnet,veth,br")
* nic.include: Comma-separated list of interfaces to include
* nic.states: Comma-separated list of states to show (prefix with "^" to invert - i.e. ^down -> show all devices that are not in state down)
* nic.format: Format string (defaults to "{intf} {state} {ip} {ssid}")
| |notmuch_count |Displays the result of a notmuch count query
default : unread emails which path do not contained "Trash" (notmuch count "tag:unread AND NOT path:/.*Trash.*/")

Parameters:
* notmuch_count.query: notmuch count query to show result

Errors:
if the notmuch query failed, the shown value is -1

Dependencies:
notmuch (https://notmuchmail.org/)
|