Utilities.md

   1 [<- home](https://github.com/copycat-killer/lain/wiki)
   2
   3 markup
   4 ------
   5
   6 This is a submodule which helps you markupping your text.
   7
   8 First, call it like this:
   9
  10     local markup = require("lain.util.markup")
  11
  12 then you can call its functions:
  13
  14      +-- markup
  15      |
  16      |`-- bold()        Set bold.
  17      |`-- italic()      Set italicized text.
  18      |`-- strike()      Set strikethrough text.
  19      |`-- underline()   Set underlined text.
  20      |`-- monospace()   Set monospaced text.
  21      |`-- big()         Set bigger text.
  22      |`-- small()       Set smaller text.
  23      |`-- font()        Set the font of the text.
  24      |
  25      |`--+ bg
  26      |   |
  27      |   |`-- color()   Set background color.
  28      |   |`-- focus()   Set focus  background color.
  29      |   |`-- normal()  Set normal background color.
  30      |    `-- urgent()  Set urgent background color.
  31      |
  32      |`--+ fg
  33      |   |
  34      |   |`-- color()   Set foreground color.
  35      |   |`-- focus()   Set focus  foreground color.
  36      |   |`-- normal()  Set normal foreground color.
  37      |    `-- urgent()  Set urgent foreground color.
  38      |
  39      |`-- focus()       Set both foreground and background focus  colors.
  40      |`-- normal()      Set both foreground and background normal colors.
  41       `-- urgent()      Set both foreground and background urgent colors.
  42
  43 menu\_clients\_current\_tags
  44 ----------------------------
  45
  46 Similar to `awful.menu.clients()`, but this menu only shows the clients
  47 of currently visible tags. Use it with a key binding like this:
  48
  49     awful.key({ "Mod1" }, "Tab", function()
  50         awful.menu.menu_keys.down = { "Down", "Alt_L", "Tab", "j" }
  51         awful.menu.menu_keys.up = { "Up", "k" }
  52         lain.util.menu_clients_current_tags({ width = 350 }, { keygrabber = true })
  53     end),
  54
  55 magnify\_client
  56 ---------------
  57
  58 Set a client to floating and resize it in the same way the "magnifier"
  59 layout does it. Place it on the "current" screen (derived from the mouse
  60 position). This allows you to magnify any client you wish, regardless of
  61 the currently used layout. Use it with a client keybinding like this:
  62
  63         clientkeys = awful.util.table.join(
  64                 ...
  65                 awful.key({ modkey, "Control" }, "m", lain.util.magnify_client),
  66                 ...
  67         )
  68
  69 If you want to "de-magnify" it, just reset the clients floating state to
  70 `false` (hit `Mod4`+`CTRL`+`Space`, for example).
  71
  72 niceborder\_{focus, unfocus}
  73 ----------------------------
  74
  75 By default, your `rc.lua` contains something like this:
  76
  77         client.connect_signal("focus", function(c) c.border_color = beautiful.border_focus end)
  78         client.connect_signal("unfocus", function(c) c.border_color = beautiful.border_normal end)
  79
  80 You can change it to this:
  81
  82         client.connect_signal("focus", lain.util.niceborder_focus(c))
  83         client.connect_signal("unfocus", lain.util.niceborder_unfocus(c))
  84
  85 Now, when a client is focused or unfocused, Awesome will look up its
  86 nice value in `/proc/<pid>/stat`. If it's less than 0, the client is
  87 classified as "high priority"; if it's greater than 0, the client is
  88 classified as "low priority". If it's equal to 0, nothing special
  89 happens.
  90
  91 This requires to define additional colors in your `theme.lua`. For example:
  92
  93         theme.border_focus_highprio  = "#FF0000"
  94         theme.border_normal_highprio = "#A03333"
  95
  96         theme.border_focus_lowprio   = "#3333FF"
  97         theme.border_normal_lowprio  = "#333366"
  98
  99 tag\_view\_nonempty
 100 -------------------
 101
 102 This function lets you jump to the next/previous non-empty tag.
 103 It takes two arguments:
 104
 105 * `direction`: `1` for next non-empty tag, `-1` for previous.
 106 * `sc`: Screen which the taglist is in. Default is `mouse.screen` or `1`. This
 107   argument is optional.
 108
 109 You can use it with key bindings like these:
 110
 111     -- Non-empty tag browsing
 112     awful.key({ altkey }, "Left", function () lain.util.tag_view_nonempty(-1) end),
 113     awful.key({ altkey }, "Right", function () lain.util.tag_view_nonempty(1) end),
 114
 115 where `altkey = "Mod1"`.
 116
 117 prompt\_rename\_tag
 118 -------------------
 119
 120 This function enables you to dynamically rename the current tag you have focused.
 121
 122 You can use it with a key binding like this:
 123
 124     awful.key({ modkey, "Shift" }, "r", function () lain.util.prompt_rename_tag(mypromptbox) end)
 125
 126 Credits goes to [minism](https://bbs.archlinux.org/viewtopic.php?pid=1315135#p1315135).