Updated bat (markdown)

[etc/awesome.git] / Utilities.md

diff --git a/Utilities.md b/Utilities.md
index 3cf188e4226b34195b31fff3b5007c8f90ead778..99588b9d709d70c11585091bb8095f5a09d790c2 100644 (file)
--- a/Utilities.md
+++ b/Utilities.md
@@ -1,11 +1,11 @@
 markup
 ------
 
-This is a submodule which helps you markupping your text.
+Made markup easier!
 
 First, require it like this:
 
-    local markup = require("lain.util.markup")
+    local markup = lain.util.markup
 
 then you can call its functions:
 
@@ -43,13 +43,77 @@ they all take one argument, which is the text to markup, except `fg.color` and `
     markup.fg.color(text, color)
     markup.bg.color(text, color)
 
+dynamic tagging
+---------------
+
+That is:
+
+- add a new tag;
+- rename current tag;
+- move current tag;
+- remove current tag.
+
+If you delete a tag, any rule set on it shall be broken, so be careful.
+
+Use it with key bindings like these:
+
+    awful.key({ modkey, "Shift" }, "n", function () lain.util.add_tag(mypromptbox) end),
+    awful.key({ modkey, "Shift" }, "r", function () lain.util.rename_tag(mypromptbox) end),
+    awful.key({ modkey, "Shift" }, "Left", function () lain.util.move_tag(1) end),  -- move to next tag
+    awful.key({ modkey, "Shift" }, "Right", function () lain.util.move_tag(-1) end), -- move to previous tag
+    awful.key({ modkey, "Shift" }, "d", function () lain.util.remove_tag() end),
+
+**Note** that these function won't work properly with [Copland theme](https://github.com/copycat-killer/awesome-copycats) or any other configuration that already uses a dynamic tagging module like [Eminent](https://github.com/copycat-killer/awesome-copycats/tree/master/eminent).
+
+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.
+
+tag\_view\_nonempty
+-------------------
+
+This function lets you jump to the next/previous non-empty tag.
+It takes two arguments:
+
+* `direction`: `1` for next non-empty tag, `-1` for previous.
+* `sc`: Screen which the taglist is in. Default is `mouse.screen` or `1`. This
+  argument is optional.
+
+You can use it with key bindings like these:
+
+    -- Non-empty tag browsing
+    awful.key({ altkey }, "Left", function () lain.util.tag_view_nonempty(-1) end),
+    awful.key({ altkey }, "Right", function () lain.util.tag_view_nonempty(1) end),
+
+where `altkey = "Mod1"`.
+
 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 })
@@ -69,8 +133,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}
 ----------------------------
@@ -97,33 +160,4 @@ This requires to define additional colors in your `theme.lua`. For example:
        theme.border_normal_highprio = "#A03333"
 
        theme.border_focus_lowprio   = "#3333FF"
-       theme.border_normal_lowprio  = "#333366"
-
-tag\_view\_nonempty
--------------------
-
-This function lets you jump to the next/previous non-empty tag.
-It takes two arguments:
-
-* `direction`: `1` for next non-empty tag, `-1` for previous.
-* `sc`: Screen which the taglist is in. Default is `mouse.screen` or `1`. This
-  argument is optional.
-
-You can use it with key bindings like these:
-
-    -- Non-empty tag browsing
-    awful.key({ altkey }, "Left", function () lain.util.tag_view_nonempty(-1) end),
-    awful.key({ altkey }, "Right", function () lain.util.tag_view_nonempty(1) end),
-
-where `altkey = "Mod1"`.
-
-prompt\_rename\_tag
--------------------
-
-This function enables you to dynamically rename the current tag you have focused.
-
-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
+       theme.border_normal_lowprio  = "#333366"
\ No newline at end of file