Hi,
I was curious if documentation patches are welcome here. Attached
patch updates keygrabber API docs, by providing a usage example.
--8--
From df9ca3e42c9f3da57654e4bae123f1c16c78e424 Mon Sep 17 00:00:00 2001
From: Anurag Priyam anurag08pri...@gmail.com
Date: Sun, 16 Jan 2011 23:14:59 +0530
Subject: [PATCH] add usage example for keygrabber API
To demonstrate keygrabber API usage, I added a small function to the
docs that can be bound to a key and used to resize clients using
keyboard.
Signed-off-by: Anurag Priyam anurag08pri...@gmail.com
---
luadoc/keygrabber.lua | 17 +
1 files changed, 17 insertions(+), 0 deletions(-)
diff --git a/luadoc/keygrabber.lua b/luadoc/keygrabber.lua
index eb041f0..f7ae788 100644
--- a/luadoc/keygrabber.lua
+++ b/luadoc/keygrabber.lua
@@ -12,6 +12,23 @@ module(keygrabber)
-- @param func A callback function as described above.
-- @name run
-- @class function
+-- @usage Following function can be bound to a key, and used to resize a client
+-- using keyboard.
+-- pcode
+-- function resize(c) br/
+-- keygrabber.run(function(mod, key, event) /br
+-- if event == release then return true end /brbr/
+--
+-- if key == 'Up' then awful.client.moveresize(0, 0, 0, 5, c) br/
+-- elseif key == 'Down' then awful.client.moveresize(0, 0, 0, -5, c) br/
+-- elseif key == 'Right' then awful.client.moveresize(0, 0, 5, 0, c) br/
+-- elseif key == 'Left' then awful.client.moveresize(0, 0, -5, 0, c) br/
+-- else keygrabber.stop() br/
+-- end br/br/
+--
+-- return true br/
+-- end br/
+-- /code/p
--- Stop grabbing the keyboard.
-- @param -
--
1.7.2.3
--
Anurag Priyam
http://about.me/yeban/
From df9ca3e42c9f3da57654e4bae123f1c16c78e424 Mon Sep 17 00:00:00 2001
From: Anurag Priyam anurag08pri...@gmail.com
Date: Sun, 16 Jan 2011 23:14:59 +0530
Subject: [PATCH] add usage example for keygrabber API
To demonstrate keygrabber API usage, I added a small function to the
docs that can be bound to a key and used to resize clients using
keyboard.
Signed-off-by: Anurag Priyam anurag08pri...@gmail.com
---
luadoc/keygrabber.lua | 17 +
1 files changed, 17 insertions(+), 0 deletions(-)
diff --git a/luadoc/keygrabber.lua b/luadoc/keygrabber.lua
index eb041f0..f7ae788 100644
--- a/luadoc/keygrabber.lua
+++ b/luadoc/keygrabber.lua
@@ -12,6 +12,23 @@ module(keygrabber)
-- @param func A callback function as described above.
-- @name run
-- @class function
+-- @usage Following function can be bound to a key, and used to resize a client
+-- using keyboard.
+-- pcode
+-- function resize(c) br/
+-- keygrabber.run(function(mod, key, event) /br
+-- if event == release then return true end /brbr/
+--
+-- if key == 'Up' then awful.client.moveresize(0, 0, 0, 5, c) br/
+-- elseif key == 'Down' then awful.client.moveresize(0, 0, 0, -5, c) br/
+-- elseif key == 'Right' then awful.client.moveresize(0, 0, 5, 0, c) br/
+-- elseif key == 'Left' then awful.client.moveresize(0, 0, -5, 0, c) br/
+-- else keygrabber.stop() br/
+-- end br/br/
+--
+-- return true br/
+-- end br/
+-- /code/p
--- Stop grabbing the keyboard.
-- @param -
--
1.7.2.3
