Module: awful.hotkeys_popup
Popup widget which shows current hotkeys and their descriptions.
Info:
- Copyright: 2014-2015 Yauheni Kirylau
-
Originally authored by: Yauheni Kirylau <yawghen@gmail.com>
(Full contributors list available on our github project)
Static module functions
awful.hotkeys_popup.show_help ([c[, s]]) | This is the same as awful.hotkeyspopup.widget.showhelp. |
lib.awful.hotkeys_popup.keys.tmux Functions
awful.hotkeys_popup.add_rules_for_terminal (rule) | Add rules to match tmux session. |
Static module functions
- awful.hotkeys_popup.show_help ([c[, s]])
-
This is the same as awful.hotkeyspopup.widget.showhelp.
example usage:
local hotkeys_popup = require("awful.hotkeys_popup") myawesomemenu = {{ "hotkeys", function() hotkeys_popup.show_help() end }, -- <more entries> }
see awful.hotkeys_popup.widget.show_help for more information
Parameters:
- c client The hostkeys for the client "c". (optional)
- s screen The screen. (optional)
See also:
lib.awful.hotkeys_popup.keys.tmux Functions
- awful.hotkeys_popup.add_rules_for_terminal (rule)
-
Add rules to match tmux session.
For example:
tmux.add_rules_for_terminal({ rule = { name = { "tmux" }}})
will show tmux hotkeys for any window that has 'tmux' in its title. If no rules are provided then tmux hotkeys will be shown always!
Parameters:
- rule table Rules to match a window containing a tmux session.
See also: