Updated Utilities (markdown)

[etc/awesome.git] / Utilities.md

diff --git a/Utilities.md b/Utilities.md
index 168d95ff2c13a773729774d942b11dc92703b41d..3f00c3513f76f42f9da726094b94bd744d3a43ed 100644 (file)
--- a/Utilities.md
+++ b/Utilities.md
@@ -1,13 +1,11 @@
-[<- home](https://github.com/copycat-killer/lain/wiki)
-

 markup
 ------
 
 markup
 ------
 

-This is a submodule which helps you markupping your text.
+Made markup easier!

 
 First, require it like this:
 
 
 First, require it like this:
 

-    local markup = require("lain.util.markup")
+    local markup = lain.util.markup

 
 then you can call its functions:
 
 
 then you can call its functions:
 


@@ -40,7 +38,7 @@ then you can call its functions:
      |`-- normal()      Set both foreground and background normal colors.
       `-- urgent()      Set both foreground and background urgent colors.
 
      |`-- normal()      Set both foreground and background normal colors.
       `-- urgent()      Set both foreground and background urgent colors.
 

-they all take one argument, which is the text to markup, except `fg.color()` and `bg.color()`:
+they all take one argument, which is the text to markup, except `fg.color` and `bg.color`:

 
     markup.fg.color(text, color)
     markup.bg.color(text, color)
 
     markup.fg.color(text, color)
     markup.bg.color(text, color)


@@ -48,10 +46,11 @@ they all take one argument, which is the text to markup, except `fg.color()` and
 menu\_clients\_current\_tags
 ----------------------------
 
 menu\_clients\_current\_tags
 ----------------------------
 

-Similar to `awful.menu.clients()`, but this menu only shows the clients
+Similar to `awful.menu.clients`, but this menu only shows the clients

 of currently visible tags. Use it with a key binding like this:
 
 of currently visible tags. Use it with a key binding like this:
 

-    awful.key({ "Mod1" }, "Tab", function()
+    awful.key({ "Mod1" }, "Tab",
+    function()

         awful.menu.menu_keys.down = { "Down", "Alt_L", "Tab", "j" }
         awful.menu.menu_keys.up = { "Up", "k" }
         lain.util.menu_clients_current_tags({ width = 350 }, { keygrabber = true })
         awful.menu.menu_keys.down = { "Down", "Alt_L", "Tab", "j" }
         awful.menu.menu_keys.up = { "Up", "k" }
         lain.util.menu_clients_current_tags({ width = 350 }, { keygrabber = true })


@@ -128,4 +127,27 @@ You can use it with a key binding like this:
 
     awful.key({ modkey, "Shift" }, "r", function () lain.util.prompt_rename_tag(mypromptbox) end)
 
 
     awful.key({ modkey, "Shift" }, "r", function () lain.util.prompt_rename_tag(mypromptbox) end)
 

-Credits goes to [minism](https://bbs.archlinux.org/viewtopic.php?pid=1315135#p1315135).
\ No newline at end of file
+Credits goes to [minism](https://bbs.archlinux.org/viewtopic.php?pid=1315135#p1315135).
+
+useless\_gaps\_resize
+---------------------
+
+Changes `beautiful.useless_gaps_width` on the fly.
+
+The function takes an integer argument, being the amount of pixel to add/remove to gaps.
+
+You could use it with these keybindings:
+
+    -- On the fly useless gaps change
+    awful.key({ altkey, "Control" }, "+", function () lain.util.useless_gaps_resize(1) end),
+    awful.key({ altkey, "Control" }, "-", function () lain.util.useless_gaps_resize(-1) end),
+
+where `altkey=Mod1`, or you could use it as a button like this:
+
+    mywidget:buttons(awful.util.table.join (
+          awful.button({}, 4, function() lain.util.useless_gaps_resize(-1) end),
+          awful.button({}, 5, function() lain.util.useless_gaps_resize(1) end)
+          end)
+    ))
+
+so when hovering the mouse over `mywidget`, you can adjust useless gaps size by scrolling with the mouse wheel.
\ No newline at end of file