]> git.madduck.net Git - etc/awesome.git/blobdiff - Utilities.md

madduck's git repository

Every one of the projects in this repository is available at the canonical URL git://git.madduck.net/madduck/pub/<projectpath> — see each project's metadata for the exact URL.

All patches and comments are welcome. Please squash your changes to logical commits before using git-format-patch and git-send-email to patches@git.madduck.net. If you'd read over the Git project's submission guidelines and adhered to them, I'd be especially grateful.

SSH access, as well as push access can be individually arranged.

If you use my repositories frequently, consider adding the following snippet to ~/.gitconfig and using the third clone URL listed for each project:

[url "git://git.madduck.net/madduck/"]
  insteadOf = madduck:

Updated fs (markdown)
[etc/awesome.git] / Utilities.md
index 7bf82a0f1efd2b56df3cc7b2b48ce35f296b318d..cbf8c0ff4eba042778f4839bbd945c447418865c 100644 (file)
@@ -1 +1,130 @@
-[<- home](https://github.com/copycat-killer/lain/wiki)
\ No newline at end of file
+markup
+------
+
+This is a submodule which helps you markupping your text.
+
+First, require it like this:
+
+    local markup = require("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
+of currently visible tags. Use it with a key binding like this:
+
+    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 })
+    end),
+
+magnify\_client
+---------------
+
+Set a client to floating and resize it in the same way the "magnifier"
+layout does it. Place it on the "current" screen (derived from the mouse
+position). This allows you to magnify any client you wish, regardless of
+the currently used layout. Use it with a client keybinding like this:
+
+       clientkeys = awful.util.table.join(
+               ...
+               awful.key({ modkey, "Control" }, "m", lain.util.magnify_client),
+               ...
+       )
+
+If you want to "de-magnify" it, just reset the clients floating state to
+`false` (hit `Mod4`+`CTRL`+`Space`, for example).
+
+niceborder\_{focus, unfocus}
+----------------------------
+
+By default, your `rc.lua` contains something like this:
+
+       client.connect_signal("focus", function(c) c.border_color = beautiful.border_focus end)
+       client.connect_signal("unfocus", function(c) c.border_color = beautiful.border_normal end)
+
+You can change it to this:
+
+       client.connect_signal("focus", lain.util.niceborder_focus(c))
+       client.connect_signal("unfocus", lain.util.niceborder_unfocus(c))
+
+Now, when a client is focused or unfocused, Awesome will look up its
+nice value in `/proc/<pid>/stat`. If it's less than 0, the client is
+classified as "high priority"; if it's greater than 0, the client is
+classified as "low priority". If it's equal to 0, nothing special
+happens.
+
+This requires to define additional colors in your `theme.lua`. For example:
+
+       theme.border_focus_highprio  = "#FF0000"
+       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