Utilities.md

   1 markup
   2 ------
   3
   4 Made markup easier!
   5
   6 First, require it like this:
   7
   8     local markup = lain.util.markup
   9
  10 then you can call its functions:
  11
  12      +-- markup
  13      |
  14      |`-- bold()        Set bold.
  15      |`-- italic()      Set italicized text.
  16      |`-- strike()      Set strikethrough text.
  17      |`-- underline()   Set underlined text.
  18      |`-- monospace()   Set monospaced text.
  19      |`-- big()         Set bigger text.
  20      |`-- small()       Set smaller text.
  21      |`-- font()        Set the font of the text.
  22      |
  23      |`--+ bg
  24      |   |
  25      |   |`-- color()   Set background color.
  26      |   |`-- focus()   Set focus  background color.
  27      |   |`-- normal()  Set normal background color.
  28      |    `-- urgent()  Set urgent background color.
  29      |
  30      |`--+ fg
  31      |   |
  32      |   |`-- color()   Set foreground color.
  33      |   |`-- focus()   Set focus  foreground color.
  34      |   |`-- normal()  Set normal foreground color.
  35      |    `-- urgent()  Set urgent foreground color.
  36      |
  37      |`-- focus()       Set both foreground and background focus  colors.
  38      |`-- normal()      Set both foreground and background normal colors.
  39       `-- urgent()      Set both foreground and background urgent colors.
  40
  41 they all take one argument, which is the text to markup, except `fg.color` and `bg.color`:
  42
  43     markup.fg.color(text, color)
  44     markup.bg.color(text, color)
  45
  46 dynamic tagging
  47 ---------------
  48
  49 That is:
  50
  51 - add a new tag;
  52 - rename current tag;
  53 - move current tag;
  54 - remove current tag.
  55
  56 If you delete a tag, any rule set on it shall be broken, so be careful.
  57
  58 Use it with key bindings like these:
  59
  60     awful.key({ modkey, "Shift" }, "n", function () lain.util.add_tag(mypromptbox) end),
  61     awful.key({ modkey, "Shift" }, "r", function () lain.util.rename_tag(mypromptbox) end),
  62     awful.key({ modkey, "Shift" }, "Left", function () lain.util.move_tag(1) end),  -- move to next tag
  63     awful.key({ modkey, "Shift" }, "Right", function () lain.util.move_tag(-1) end), -- move to previous tag
  64     awful.key({ modkey, "Shift" }, "d", function () lain.util.remove_tag() end),
  65
  66 **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).
  67
  68 useless\_gaps\_resize
  69 ---------------------
  70
  71 Changes `beautiful.useless_gaps_width` on the fly.
  72
  73 The function takes an integer argument, being the amount of pixel to add/remove to gaps.
  74
  75 You could use it with these keybindings:
  76
  77     -- On the fly useless gaps change
  78     awful.key({ altkey, "Control" }, "+", function () lain.util.useless_gaps_resize(1) end),
  79     awful.key({ altkey, "Control" }, "-", function () lain.util.useless_gaps_resize(-1) end),
  80
  81 where `altkey=Mod1`, or you could use it like this:
  82
  83     mywidget:buttons(awful.util.table.join (
  84           awful.button({}, 4, function() lain.util.useless_gaps_resize(-1) end),
  85           awful.button({}, 5, function() lain.util.useless_gaps_resize(1) end)
  86           end)
  87     ))
  88
  89 so when hovering the mouse over `mywidget`, you can adjust useless gaps size by scrolling with the mouse wheel.
  90
  91 tag\_view\_nonempty
  92 -------------------
  93
  94 This function lets you jump to the next/previous non-empty tag.
  95 It takes two arguments:
  96
  97 * `direction`: `1` for next non-empty tag, `-1` for previous.
  98 * `sc`: Screen which the taglist is in. Default is `mouse.screen` or `1`. This
  99   argument is optional.
 100
 101 You can use it with key bindings like these:
 102
 103     -- Non-empty tag browsing
 104     awful.key({ altkey }, "Left", function () lain.util.tag_view_nonempty(-1) end),
 105     awful.key({ altkey }, "Right", function () lain.util.tag_view_nonempty(1) end),
 106
 107 where `altkey = "Mod1"`.
 108
 109 menu\_clients\_current\_tags
 110 ----------------------------
 111
 112 Similar to `awful.menu.clients`, but this menu only shows the clients
 113 of currently visible tags. Use it with a key binding like this:
 114
 115     awful.key({ "Mod1" }, "Tab",
 116     function()
 117         awful.menu.menu_keys.down = { "Down", "Alt_L", "Tab", "j" }
 118         awful.menu.menu_keys.up = { "Up", "k" }
 119         lain.util.menu_clients_current_tags({ width = 350 }, { keygrabber = true })
 120     end),
 121
 122 magnify\_client
 123 ---------------
 124
 125 Set a client to floating and resize it in the same way the "magnifier"
 126 layout does it. Place it on the "current" screen (derived from the mouse
 127 position). This allows you to magnify any client you wish, regardless of
 128 the currently used layout. Use it with a client keybinding like this:
 129
 130         clientkeys = awful.util.table.join(
 131                 ...
 132                 awful.key({ modkey, "Control" }, "m", lain.util.magnify_client),
 133                 ...
 134         )
 135
 136 If you want to "de-magnify" it, just retype the keybinding.
 137
 138 niceborder\_{focus, unfocus}
 139 ----------------------------
 140
 141 By default, your `rc.lua` contains something like this:
 142
 143         client.connect_signal("focus", function(c) c.border_color = beautiful.border_focus end)
 144         client.connect_signal("unfocus", function(c) c.border_color = beautiful.border_normal end)
 145
 146 You can change it to this:
 147
 148         client.connect_signal("focus", lain.util.niceborder_focus(c))
 149         client.connect_signal("unfocus", lain.util.niceborder_unfocus(c))
 150
 151 Now, when a client is focused or unfocused, Awesome will look up its
 152 nice value in `/proc/<pid>/stat`. If it's less than 0, the client is
 153 classified as "high priority"; if it's greater than 0, the client is
 154 classified as "low priority". If it's equal to 0, nothing special
 155 happens.
 156
 157 This requires to define additional colors in your `theme.lua`. For example:
 158
 159         theme.border_focus_highprio  = "#FF0000"
 160         theme.border_normal_highprio = "#A03333"
 161
 162         theme.border_focus_lowprio   = "#3333FF"
 163         theme.border_normal_lowprio  = "#333366"