Utilities.md

   1 markup
   2 ------
   3
   4 This is a submodule which helps you markupping your text.
   5
   6 First, require it like this:
   7
   8     local markup = require("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", function()
  53         awful.menu.menu_keys.down = { "Down", "Alt_L", "Tab", "j" }
  54         awful.menu.menu_keys.up = { "Up", "k" }
  55         lain.util.menu_clients_current_tags({ width = 350 }, { keygrabber = true })
  56     end),
  57
  58 magnify\_client
  59 ---------------
  60
  61 Set a client to floating and resize it in the same way the "magnifier"
  62 layout does it. Place it on the "current" screen (derived from the mouse
  63 position). This allows you to magnify any client you wish, regardless of
  64 the currently used layout. Use it with a client keybinding like this:
  65
  66         clientkeys = awful.util.table.join(
  67                 ...
  68                 awful.key({ modkey, "Control" }, "m", lain.util.magnify_client),
  69                 ...
  70         )
  71
  72 If you want to "de-magnify" it, just reset the clients floating state to
  73 `false` (hit `Mod4`+`CTRL`+`Space`, for example).
  74
  75 niceborder\_{focus, unfocus}
  76 ----------------------------
  77
  78 By default, your `rc.lua` contains something like this:
  79
  80         client.connect_signal("focus", function(c) c.border_color = beautiful.border_focus end)
  81         client.connect_signal("unfocus", function(c) c.border_color = beautiful.border_normal end)
  82
  83 You can change it to this:
  84
  85         client.connect_signal("focus", lain.util.niceborder_focus(c))
  86         client.connect_signal("unfocus", lain.util.niceborder_unfocus(c))
  87
  88 Now, when a client is focused or unfocused, Awesome will look up its
  89 nice value in `/proc/<pid>/stat`. If it's less than 0, the client is
  90 classified as "high priority"; if it's greater than 0, the client is
  91 classified as "low priority". If it's equal to 0, nothing special
  92 happens.
  93
  94 This requires to define additional colors in your `theme.lua`. For example:
  95
  96         theme.border_focus_highprio  = "#FF0000"
  97         theme.border_normal_highprio = "#A03333"
  98
  99         theme.border_focus_lowprio   = "#3333FF"
 100         theme.border_normal_lowprio  = "#333366"
 101
 102 tag\_view\_nonempty
 103 -------------------
 104
 105 This function lets you jump to the next/previous non-empty tag.
 106 It takes two arguments:
 107
 108 * `direction`: `1` for next non-empty tag, `-1` for previous.
 109 * `sc`: Screen which the taglist is in. Default is `mouse.screen` or `1`. This
 110   argument is optional.
 111
 112 You can use it with key bindings like these:
 113
 114     -- Non-empty tag browsing
 115     awful.key({ altkey }, "Left", function () lain.util.tag_view_nonempty(-1) end),
 116     awful.key({ altkey }, "Right", function () lain.util.tag_view_nonempty(1) end),
 117
 118 where `altkey = "Mod1"`.
 119
 120 prompt\_rename\_tag
 121 -------------------
 122
 123 This function enables you to dynamically rename the current tag you have focused.
 124
 125 You can use it with a key binding like this:
 126
 127     awful.key({ modkey, "Shift" }, "r", function () lain.util.prompt_rename_tag(mypromptbox) end)
 128
 129 Credits goes to [minism](https://bbs.archlinux.org/viewtopic.php?pid=1315135#p1315135).