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 - create a new tag;
  52 - rename current tag;
  53 - delete current tag.
  54
  55 If you delete a tag, any rule set on it shall be broken, so be careful.
  56
  57 Use it with key bindings like these:
  58
  59     awful.key({ modkey, "Shift" }, "n", function () lain.util.create_tag(mypromptbox) end),
  60     awful.key({ modkey, "Shift" }, "r", function () lain.util.rename_tag(mypromptbox) end),
  61     awful.key({ modkey, "Shift" }, "d", function () lain.util.delete_tag() end),
  62
  63 useless\_gaps\_resize
  64 ---------------------
  65
  66 Changes `beautiful.useless_gaps_width` on the fly.
  67
  68 The function takes an integer argument, being the amount of pixel to add/remove to gaps.
  69
  70 You could use it with these keybindings:
  71
  72     -- On the fly useless gaps change
  73     awful.key({ altkey, "Control" }, "+", function () lain.util.useless_gaps_resize(1) end),
  74     awful.key({ altkey, "Control" }, "-", function () lain.util.useless_gaps_resize(-1) end),
  75
  76 where `altkey=Mod1`, or you could use it like this:
  77
  78     mywidget:buttons(awful.util.table.join (
  79           awful.button({}, 4, function() lain.util.useless_gaps_resize(-1) end),
  80           awful.button({}, 5, function() lain.util.useless_gaps_resize(1) end)
  81           end)
  82     ))
  83
  84 so when hovering the mouse over `mywidget`, you can adjust useless gaps size by scrolling with the mouse wheel.
  85
  86 tag\_view\_nonempty
  87 -------------------
  88
  89 This function lets you jump to the next/previous non-empty tag.
  90 It takes two arguments:
  91
  92 * `direction`: `1` for next non-empty tag, `-1` for previous.
  93 * `sc`: Screen which the taglist is in. Default is `mouse.screen` or `1`. This
  94   argument is optional.
  95
  96 You can use it with key bindings like these:
  97
  98     -- Non-empty tag browsing
  99     awful.key({ altkey }, "Left", function () lain.util.tag_view_nonempty(-1) end),
 100     awful.key({ altkey }, "Right", function () lain.util.tag_view_nonempty(1) end),
 101
 102 where `altkey = "Mod1"`.
 103
 104 menu\_clients\_current\_tags
 105 ----------------------------
 106
 107 Similar to `awful.menu.clients`, but this menu only shows the clients
 108 of currently visible tags. Use it with a key binding like this:
 109
 110     awful.key({ "Mod1" }, "Tab",
 111     function()
 112         awful.menu.menu_keys.down = { "Down", "Alt_L", "Tab", "j" }
 113         awful.menu.menu_keys.up = { "Up", "k" }
 114         lain.util.menu_clients_current_tags({ width = 350 }, { keygrabber = true })
 115     end),
 116
 117 magnify\_client
 118 ---------------
 119
 120 Set a client to floating and resize it in the same way the "magnifier"
 121 layout does it. Place it on the "current" screen (derived from the mouse
 122 position). This allows you to magnify any client you wish, regardless of
 123 the currently used layout. Use it with a client keybinding like this:
 124
 125         clientkeys = awful.util.table.join(
 126                 ...
 127                 awful.key({ modkey, "Control" }, "m", lain.util.magnify_client),
 128                 ...
 129         )
 130
 131 If you want to "de-magnify" it, just retype the keybinding.
 132
 133 niceborder\_{focus, unfocus}
 134 ----------------------------
 135
 136 By default, your `rc.lua` contains something like this:
 137
 138         client.connect_signal("focus", function(c) c.border_color = beautiful.border_focus end)
 139         client.connect_signal("unfocus", function(c) c.border_color = beautiful.border_normal end)
 140
 141 You can change it to this:
 142
 143         client.connect_signal("focus", lain.util.niceborder_focus(c))
 144         client.connect_signal("unfocus", lain.util.niceborder_unfocus(c))
 145
 146 Now, when a client is focused or unfocused, Awesome will look up its
 147 nice value in `/proc/<pid>/stat`. If it's less than 0, the client is
 148 classified as "high priority"; if it's greater than 0, the client is
 149 classified as "low priority". If it's equal to 0, nothing special
 150 happens.
 151
 152 This requires to define additional colors in your `theme.lua`. For example:
 153
 154         theme.border_focus_highprio  = "#FF0000"
 155         theme.border_normal_highprio = "#A03333"
 156
 157         theme.border_focus_lowprio   = "#3333FF"
 158         theme.border_normal_lowprio  = "#333366"