Module awful.hotkeys_popup

Popup widget which shows current hotkeys and their descriptions.

Info:

Functions

awful.hotkeys_popup.show_help ([c[, s]]) This is the same as awful.hotkeys_popup.widget.show_help.

lib.awful.hotkeys_popup.keys.tmux Functions

add_rules_for_terminal (rule) Add rules to match tmux session.


Functions

Methods
awful.hotkeys_popup.show_help ([c[, s]])
This is the same as awful.hotkeys_popup.widget.show_help.

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

  • c client The hostkeys for the client “c”. (optional)
  • s screen The screen. (optional)

See also:

lib.awful.hotkeys_popup.keys.tmux Functions

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!

  • rule table Rules to match a window containing a tmux session.

See also:

generated by LDoc 1.4.6 Last updated 2019-02-26 10:13:58