awesomewm-mirrors
/
awesome
mirror of https://github.com/awesomeWM/awesome.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Make description of awful.mouse.finder readable. 

Signed-off-by: Julian Wollrath <jwollrath@web.de>
This commit is contained in:
Julian Wollrath 2015-02-22 22:26:25 +01:00 committed by Daniel Hahler
parent b16944a654
commit 6de9d1e1d5
1 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
lib/awful/mouse/finder.lua.in
View File

@ -5,19 +5,31 @@
-- Mouse finder highlights the mouse cursor on the screen -- Mouse finder highlights the mouse cursor on the screen
-- To enable this feature, a `awful.mouse.finder` object needs to be bound to a -- To enable this feature, a `awful.mouse.finder` object needs to be bound to a
-- key: -- key:
--
-- mymousefinder = awful.mouse.finder() -- mymousefinder = awful.mouse.finder()
--
-- Then bind the `find` function a key binding. -- Then bind the `find` function a key binding.
-- --
-- Some configuration variable can be set in the theme: -- Some configuration variable can be set in the theme:
--
-- The mouse_finder display duration -- The mouse_finder display duration
--
-- theme.mouse_finder_timeout = 3 -- theme.mouse_finder_timeout = 3
--
-- The animation speed -- The animation speed
--
-- theme.mouse_finder_animate_timeout = 0.05 -- theme.mouse_finder_animate_timeout = 0.05
--
-- The mouse_finder radius -- The mouse_finder radius
--
-- theme.mouse_finder_radius = 20 -- theme.mouse_finder_radius = 20
--
-- The growth factor -- The growth factor
--
-- theme.mouse_finder_factor = 2 -- theme.mouse_finder_factor = 2
--
-- The mouse_finder color -- The mouse_finder color
--
-- theme.mouse_finder_color = "#ff0000" -- theme.mouse_finder_color = "#ff0000"
-- --
-- @author Sébastien Gross &lt;seb•ɱɩɲʋʃ•awesome•ɑƬ•chezwam•ɖɵʈ•org&gt -- @author Sébastien Gross &lt;seb•ɱɩɲʋʃ•awesome•ɑƬ•chezwam•ɖɵʈ•org&gt