diff --git a/awesomerc.lua b/awesomerc.lua index 4073796f..6d085b52 100644 --- a/awesomerc.lua +++ b/awesomerc.lua @@ -14,7 +14,7 @@ local beautiful = require("beautiful") -- Notification library local naughty = require("naughty") local menubar = require("menubar") -local hotkeys_popup = require("awful.hotkeys_popup").widget +local hotkeys_popup = require("awful.hotkeys_popup") -- Enable hotkeys help widget for VIM and other apps -- when client with a matching name is opened: require("awful.hotkeys_popup.keys") @@ -104,11 +104,11 @@ end -- @DOC_MENU@ -- Create a launcher widget and a main menu myawesomemenu = { - { "hotkeys", function() return false, hotkeys_popup.show_help end}, + { "hotkeys", function() hotkeys_popup.show_help(nil, awful.screen.focused()) end }, { "manual", terminal .. " -e man awesome" }, { "edit config", editor_cmd .. " " .. awesome.conffile }, { "restart", awesome.restart }, - { "quit", function() awesome.quit() end} + { "quit", function() awesome.quit() end }, } mymainmenu = awful.menu({ items = { { "awesome", myawesomemenu, beautiful.awesome_icon }, diff --git a/lib/awful/hotkeys_popup/init.lua b/lib/awful/hotkeys_popup/init.lua index 359149a7..182fe5ab 100644 --- a/lib/awful/hotkeys_popup/init.lua +++ b/lib/awful/hotkeys_popup/init.lua @@ -6,10 +6,27 @@ -- @module awful.hotkeys_popup --------------------------------------------------------------------------- - local hotkeys_popup = { widget = require("awful.hotkeys_popup.widget"), } + +--- 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 }, +-- -- +-- } +-- +-- see `awful.hotkeys_popup.widget.show_help` for more information +-- @tparam[opt] client c The hostkeys for the client "c". +-- @tparam[opt] screen s The screen. +-- @tparam[opt=true] boolean show_args.show_awesome_keys Show AwesomeWM hotkeys. +-- When set to `false` only app-specific hotkeys will be shown. +-- @function awful.hotkeys_popup.show_help +-- @see awful.hotkeys_popup.widget.show_help + hotkeys_popup.show_help = hotkeys_popup.widget.show_help return hotkeys_popup