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