Updated borderbox (markdown)

[etc/awesome.git] / Utilities.md

diff --git a/Utilities.md b/Utilities.md
index d9790dadc5aa024b9a58a80538a99717eea32a9a..3797f3c5584b8a2c416c3b1b6f968a3c808e51c5 100644 (file)
--- a/Utilities.md
+++ b/Utilities.md
@@ -1,12 +1,56 @@
-[<- home](https://github.com/copycat-killer/lain/wiki)
+markup
+------
+
+Made markup easier!
+
+First, require it like this:
+
+    local markup = lain.util.markup
+
+then you can call its functions:
+
+     +-- markup
+     |
+     |`-- bold()        Set bold.
+     |`-- italic()      Set italicized text.
+     |`-- strike()      Set strikethrough text.
+     |`-- underline()   Set underlined text.
+     |`-- monospace()   Set monospaced text.
+     |`-- big()         Set bigger text.
+     |`-- small()       Set smaller text.
+     |`-- font()        Set the font of the text.
+     |
+     |`--+ bg
+     |   |
+     |   |`-- color()   Set background color.
+     |   |`-- focus()   Set focus  background color.
+     |   |`-- normal()  Set normal background color.
+     |    `-- urgent()  Set urgent background color.
+     |
+     |`--+ fg
+     |   |
+     |   |`-- color()   Set foreground color.
+     |   |`-- focus()   Set focus  foreground color.
+     |   |`-- normal()  Set normal foreground color.
+     |    `-- urgent()  Set urgent foreground color.
+     |
+     |`-- focus()       Set both foreground and background focus  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`:
+
+    markup.fg.color(text, color)
+    markup.bg.color(text, color)
 
 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:
 
-    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 })
@@ -26,8 +70,7 @@ the currently used layout. Use it with a client keybinding like this:
                ...
        )
 
-If you want to "de-magnify" it, just reset the clients floating state to
-`false` (hit `Mod4`+`CTRL`+`Space`, for example).
+If you want to "de-magnify" it, just retype the keybinding.
 
 niceborder\_{focus, unfocus}
 ----------------------------
@@ -83,4 +126,27 @@ You can use it with a key binding like this:
 
     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 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