mirror of
https://gitlab.com/dwt1/dotfiles.git
synced 2026-04-23 11:30:23 +10:00
Update
This commit is contained in:
Derek Taylor
@@ -1,40 +0,0 @@
|
||||
Welcome to the Lain wiki!
|
||||
|
||||
If you spot a typo or have a suggestion, please notify me opening an [issue](https://github.com/copycat-killer/lain/issues) format. Thank you.
|
||||
|
||||
Dependency
|
||||
------------
|
||||
|
||||
Package | Requested by | Reasons of choice
|
||||
--- | --- | ---
|
||||
[curl](https://curl.haxx.se) | `imap`, `mpd`, and `weather` widgets | 1. faster and simpler to use than [LuaSocket](https://github.com/diegonehab/luasocket); 2. it's in the core of almost every distro; 3. can be called [asynchronously](https://awesomewm.org/doc/api/libraries/awful.spawn.html#easy_async)
|
||||
|
||||
Installation
|
||||
------------
|
||||
|
||||
### Arch Linux
|
||||
|
||||
[AUR package](https://aur.archlinux.org/packages/lain-git/)
|
||||
|
||||
### Other distributions
|
||||
|
||||
```shell
|
||||
git clone https://github.com/copycat-killer/lain.git ~/.config/awesome/lain
|
||||
```
|
||||
|
||||
Also available via [LuaRocks](https://luarocks.org/modules/aajjbb/lain).
|
||||
|
||||
Usage
|
||||
--------
|
||||
|
||||
First, include it into your `rc.lua`:
|
||||
|
||||
```lua
|
||||
local lain = require("lain")
|
||||
```
|
||||
|
||||
Then check out the submodules you want:
|
||||
|
||||
- [Layouts](https://github.com/copycat-killer/lain/wiki/Layouts)
|
||||
- [Widgets](https://github.com/copycat-killer/lain/wiki/Widgets)
|
||||
- [Utilities](https://github.com/copycat-killer/lain/wiki/Utilities)
|
||||
@@ -1,255 +0,0 @@
|
||||
|
||||
lain/layout
|
||||
.
|
||||
|-- termfair
|
||||
|-- termfair.center
|
||||
|-- cascade
|
||||
|-- cascade.tile
|
||||
|-- centerwork
|
||||
|-- centerwork.horizontal
|
||||
|
||||
Usage
|
||||
=====
|
||||
|
||||
As usual, specify your favourites in `awful.layout.layouts`, or set them on specific tags with [`awful.layout.set`](https://awesomewm.org/doc/api/libraries/awful.layout.html#set).
|
||||
|
||||
```lua
|
||||
awful.layout.set(lain.layout.termfair, tag)
|
||||
```
|
||||
|
||||
How do layouts work?
|
||||
====================
|
||||
|
||||
`termfair`
|
||||
--------
|
||||
|
||||
This layout restricts the size of each window. Each window will have the
|
||||
same width but is variable in height. Furthermore, windows are
|
||||
left-aligned. The basic workflow is as follows (the number above the
|
||||
screen is the number of open windows, the number in a cell is the fixed
|
||||
number of a client):
|
||||
|
||||
(1) (2) (3)
|
||||
+---+---+---+ +---+---+---+ +---+---+---+
|
||||
| | | | | | | | | | | |
|
||||
| 1 | | | -> | 2 | 1 | | -> | 3 | 2 | 1 | ->
|
||||
| | | | | | | | | | | |
|
||||
+---+---+---+ +---+---+---+ +---+---+---+
|
||||
|
||||
(4) (5) (6)
|
||||
+---+---+---+ +---+---+---+ +---+---+---+
|
||||
| 4 | | | | 5 | 4 | | | 6 | 5 | 4 |
|
||||
+---+---+---+ -> +---+---+---+ -> +---+---+---+
|
||||
| 3 | 2 | 1 | | 3 | 2 | 1 | | 3 | 2 | 1 |
|
||||
+---+---+---+ +---+---+---+ +---+---+---+
|
||||
|
||||
The first client will be located in the left column. When opening
|
||||
another window, this new window will be placed in the left column while
|
||||
moving the first window into the middle column. Once a row is full,
|
||||
another row above it will be created.
|
||||
|
||||
Default number of columns and rows are respectively taken from `nmaster`
|
||||
and `ncol` values in `awful.tag`, but you can set your own.
|
||||
|
||||
For example, this sets `termfair` to 3 columns and at least 1 row:
|
||||
|
||||
```lua
|
||||
lain.layout.termfair.nmaster = 3
|
||||
lain.layout.termfair.ncol = 1
|
||||
```
|
||||
|
||||
`termfair.center`
|
||||
----------
|
||||
|
||||
Similar to `termfair`, but with fixed number of vertical columns. Cols are centerded until there are `nmaster` columns, then windows are stacked as slaves, with possibly `ncol` clients per column at most.
|
||||
|
||||
(1) (2) (3)
|
||||
+---+---+---+ +-+---+---+-+ +---+---+---+
|
||||
| | | | | | | | | | | | |
|
||||
| | 1 | | -> | | 1 | 2 | | -> | 1 | 2 | 3 | ->
|
||||
| | | | | | | | | | | | |
|
||||
+---+---+---+ +-+---+---+-+ +---+---+---+
|
||||
|
||||
(4) (5)
|
||||
+---+---+---+ +---+---+---+
|
||||
| | | 3 | | | 2 | 4 |
|
||||
+ 1 + 2 +---+ -> + 1 +---+---+
|
||||
| | | 4 | | | 3 | 5 |
|
||||
+---+---+---+ +---+---+---+
|
||||
|
||||
Like `termfair`, default number of columns and rows are respectively taken from `nmaster`
|
||||
and `ncol` values in `awful.tag`, but you can set your own.
|
||||
|
||||
For example, this sets `termfair.center` to 3 columns and at least 1 row:
|
||||
|
||||
```lua
|
||||
lain.layout.termfair.center.nmaster = 3
|
||||
lain.layout.termfair.center.ncol = 1
|
||||
```
|
||||
|
||||
`cascade`
|
||||
-------
|
||||
|
||||
Cascade all windows of a tag.
|
||||
|
||||
You can control the offsets by setting these two variables:
|
||||
|
||||
```lua
|
||||
lain.layout.cascade.offset_x = 64
|
||||
lain.layout.cascade.offset_y = 16
|
||||
```
|
||||
|
||||
The following reserves space for 5 windows:
|
||||
|
||||
```lua
|
||||
lain.layout.cascade.nmaster = 5
|
||||
```
|
||||
|
||||
That is, no window will get resized upon the creation of a new window,
|
||||
unless there's more than 5 windows.
|
||||
|
||||
`cascade.tile`
|
||||
-----------
|
||||
|
||||
Similar to `awful.layout.suit.tile` layout, however, clients in the slave
|
||||
column are cascaded instead of tiled.
|
||||
|
||||
Left column size can be set, otherwise is controlled by `mwfact` of the
|
||||
tag. Additional windows will be opened in another column on the right.
|
||||
New windows are placed above old windows.
|
||||
|
||||
Whether the slave column is placed on top of the master window or not is
|
||||
controlled by the value of `ncol`. A value of 1 means "overlapping slave column"
|
||||
and anything else means "don't overlap windows".
|
||||
|
||||
Usage example:
|
||||
|
||||
```lua
|
||||
lain.layout.cascade.tile.offset_x = 2
|
||||
lain.layout.cascade.tile.offset_y = 32
|
||||
lain.layout.cascade.tile.extra_padding = 5
|
||||
lain.layout.cascade.tile.nmaster = 5
|
||||
lain.layout.cascade.tile.ncol = 2
|
||||
```
|
||||
|
||||
`extra_padding` reduces the size of the master window if "overlapping
|
||||
slave column" is activated. This allows you to see if there are any
|
||||
windows in your slave column.
|
||||
|
||||
Setting `offset_x` to a very small value or even 0 is recommended to avoid wasting space.
|
||||
|
||||
`centerwork`
|
||||
----------
|
||||
|
||||
You start with one window, centered horizontally:
|
||||
|
||||
+--------------------------+
|
||||
| +----------+ |
|
||||
| | | |
|
||||
| | | |
|
||||
| | | |
|
||||
| | MAIN | |
|
||||
| | | |
|
||||
| | | |
|
||||
| | | |
|
||||
| | | |
|
||||
| +----------+ |
|
||||
+--------------------------+
|
||||
|
||||
This is your main working window. You do most of the work right here.
|
||||
Sometimes, you may want to open up additional windows. They're put on left and right, alternately.
|
||||
|
||||
+--------------------------+
|
||||
| +---+ +----------+ +---+ |
|
||||
| | | | | | | |
|
||||
| | | | | | | |
|
||||
| | | | | | | |
|
||||
| +---+ | MAIN | +---+ |
|
||||
| +---+ | | +---+ |
|
||||
| | | | | | | |
|
||||
| | | | | | | |
|
||||
| | | | | | | |
|
||||
| +---+ +----------+ +---+ |
|
||||
+--------------------------+
|
||||
|
||||
*Please note:* If you use Awesome's default configuration, navigation in
|
||||
this layout may be very confusing. How do you get from the main window
|
||||
to satellite ones depends on the order in which the windows are opened.
|
||||
Thus, use of `awful.client.focus.bydirection()` is suggested.
|
||||
Here's an example:
|
||||
|
||||
```lua
|
||||
globalkeys = awful.util.table.join(
|
||||
-- [...]
|
||||
awful.key({ modkey }, "j",
|
||||
function()
|
||||
awful.client.focus.bydirection("down")
|
||||
if client.focus then client.focus:raise() end
|
||||
end),
|
||||
awful.key({ modkey }, "k",
|
||||
function()
|
||||
awful.client.focus.bydirection("up")
|
||||
if client.focus then client.focus:raise() end
|
||||
end),
|
||||
awful.key({ modkey }, "h",
|
||||
function()
|
||||
awful.client.focus.bydirection("left")
|
||||
if client.focus then client.focus:raise() end
|
||||
end),
|
||||
awful.key({ modkey }, "l",
|
||||
function()
|
||||
awful.client.focus.bydirection("right")
|
||||
if client.focus then client.focus:raise() end
|
||||
end),
|
||||
-- [...]
|
||||
)
|
||||
```
|
||||
|
||||
`centerwork.horizontal`
|
||||
-----------
|
||||
|
||||
Same as `centerwork`, except that the main
|
||||
window expands horizontally, and the additional windows
|
||||
are put ontop/below it. Useful if you have a screen turned 90°.
|
||||
|
||||
Pre 4.0 `uselesstile` patches
|
||||
=============================
|
||||
|
||||
In branch 3.5, this module provided useless gaps layouts. Since useless gaps have been implemented in Awesome 4.0, those layouts have been removed.
|
||||
|
||||
Following are a couple of `uselesstile` variants that were not part of lain. They are kept only for reference and are not supported.
|
||||
|
||||
Xmonad-like
|
||||
-----------
|
||||
|
||||
If you want to have `awful.layout.suit.tile` behave like xmonad, with internal gaps two times wider than external ones, download [this](https://gist.github.com/copycat-killer/9e56dcfbe66bfe14967c) as `lain/layout/uselesstile`.
|
||||
|
||||
Inverted master
|
||||
---------------
|
||||
|
||||
Want to invert master window position? Use [this](https://gist.github.com/copycat-killer/c59dc59c9f99d98218eb) version. You can set `single_gap` with `width` and `height` in your `theme.lua`, in order to define the window geometry when there's only one client, otherwise it goes maximized. An example:
|
||||
|
||||
theme.single_gap = { width = 600, height = 100 }
|
||||
|
||||
What about layout icons?
|
||||
========================
|
||||
|
||||
They are located in ``lain/icons/layout``.
|
||||
|
||||
To use them, define new `layout_*` variables in your ``theme.lua``. For instance:
|
||||
|
||||
```lua
|
||||
theme.lain_icons = os.getenv("HOME") ..
|
||||
"/.config/awesome/lain/icons/layout/default/"
|
||||
theme.layout_termfair = theme.lain_icons .. "termfair.png"
|
||||
theme.layout_centerfair = theme.lain_icons .. "centerfair.png" -- termfair.center
|
||||
theme.layout_cascade = theme.lain_icons .. "cascade.png"
|
||||
theme.layout_cascadetile = theme.lain_icons .. "cascadetile.png" -- cascade.tile
|
||||
theme.layout_centerwork = theme.lain_icons .. "centerwork.png"
|
||||
theme.layout_centerhwork = theme.lain_icons .. "centerworkh.png" -- centerwork.horizontal
|
||||
```
|
||||
|
||||
Credits go to [Nicolas Estibals](https://github.com/nestibal) for creating
|
||||
layout icons for default theme.
|
||||
|
||||
You can use them as a template for your custom versions.
|
||||
@@ -1,245 +0,0 @@
|
||||
Quake
|
||||
-----
|
||||
|
||||
A Quake-like dropdown container for your favourite application.
|
||||
|
||||
**Usage**
|
||||
|
||||
Define it globally to have a single instance for all screens:
|
||||
|
||||
```lua
|
||||
local quake = lain.util.quake()
|
||||
```
|
||||
|
||||
or define it in `connect_for_each_screen` to have one instance for each screen:
|
||||
|
||||
```lua
|
||||
awful.screen.connect_for_each_screen(function(s)
|
||||
-- Quake application
|
||||
s.quake = lain.util.quake()
|
||||
-- [...]
|
||||
```
|
||||
|
||||
**Keybinding example**
|
||||
|
||||
If using a global instance:
|
||||
```lua
|
||||
awful.key({ modkey, }, "z", function () quake:toggle() end),
|
||||
```
|
||||
|
||||
If using a per-screen instance:
|
||||
```lua
|
||||
awful.key({ modkey, }, "z", function () awful.screen.focused().quake:toggle() end),
|
||||
```
|
||||
|
||||
**Input table**
|
||||
|
||||
Variable | Meaning | Type | Default
|
||||
--- | --- | --- | ---
|
||||
`app` | client to spawn | string | "xterm"
|
||||
`name` | client name | string | "QuakeDD"
|
||||
`argname` | how to specify client name | string | "-name %s"
|
||||
`extra` | extra `app` arguments | string | empty string
|
||||
`border` | border width | number | 1
|
||||
`visible` | initially visible | boolean | false
|
||||
`followtag` | always spawn on currently focused screen | boolean | false
|
||||
`overlap` | Overlap the wibox or not | boolean | false
|
||||
`settings` | Additional settings to make on the client | function | nil
|
||||
`screen` | screen where to spawn the client | number | `awful.screen.focused()`
|
||||
`height` | dropdown client height | float in [0,1] or exact pixels number | 0.25
|
||||
`width` | dropdown client width | float in [0,1] or exact pixels number | 1
|
||||
`vert` | vertical position | string, possible values: "top", "bottom", "center" | "top"
|
||||
`horiz` | horizontal position | string, possible values: "left", "right", "center" | "left"
|
||||
|
||||
`height` and `width` express a fraction of the workspace.
|
||||
|
||||
`settings` is a function which takes the client as input, and can be used to customize its properties. For instance:
|
||||
|
||||
```lua
|
||||
-- set the client sticky
|
||||
s.quake = lain.util.quake { settings = function(c) c.sticky = true end }
|
||||
```
|
||||
|
||||
Read [here](https://awesomewm.org/doc/api/classes/client.html#Object_properties) for the complete list of properties.
|
||||
|
||||
**Notes**
|
||||
|
||||
* [Does not work](https://github.com/copycat-killer/lain/issues/358) with `gnome-terminal`, `konsole`, or any other terminal which is strictly designed for a Desktop Environment. Just pick a better terminal, [there's plenty](https://wiki.archlinux.org/index.php/List_of_applications#Terminal_emulators).
|
||||
* Set `followtag = true` if [experiencing issues with multiscreen setups](https://github.com/copycat-killer/lain/issues/346).
|
||||
* If you have a `awful.client.setslave` rule for your application, ensure you use an exception for `QuakeDD` (or your defined `name`). Otherwise, you may run into problems with focus.
|
||||
* If you are using a VTE-based terminal like `termite`, be sure to set [`argname = "--name %s"`](https://github.com/copycat-killer/lain/issues/211).
|
||||
|
||||
Separators
|
||||
----------
|
||||
|
||||
Adds Cairo separators.
|
||||
|
||||
```lua
|
||||
local separators = lain.util.separators
|
||||
```
|
||||
|
||||
A separator function `separators.separator` takes two color arguments, defined as strings. `"alpha"` argument is allowed. Example:
|
||||
|
||||
```lua
|
||||
arrl_dl = separators.arrow_left(beautiful.bg_focus, "alpha")
|
||||
arrl_ld = separators.arrow_left("alpha", beautiful.bg_focus)
|
||||
```
|
||||
|
||||
You can customize height and width by setting `separators_height` and `separators_width` in your `theme.lua`. Default values are 0 and 9, respectively.
|
||||
|
||||
List of functions:
|
||||
|
||||
+-- separators
|
||||
|
|
||||
|`-- arrow_right() Draw a right arrow.
|
||||
`-- arrow_left() Draw a left arrow.
|
||||
|
||||
markup
|
||||
------
|
||||
|
||||
Mades markup easier.
|
||||
|
||||
```lua
|
||||
local markup = lain.util.markup
|
||||
```
|
||||
|
||||
List of functions:
|
||||
|
||||
+-- markup
|
||||
|
|
||||
|`-- bold() Set bold.
|
||||
|`-- italic() Set italicized text.
|
||||
|`-- strike() Set strikethrough text.
|
||||
|`-- underline() Set underlined text.
|
||||
|`-- monospace() Set monospaced text.
|
||||
|`-- big() Set bigger text.
|
||||
|`-- small() Set smaller text.
|
||||
|`-- font() Set the font of the text.
|
||||
|`-- font() Set the font of the text.
|
||||
|`-- color() Set background and foreground color.
|
||||
|`-- fontfg() Set font and foreground color.
|
||||
|`-- fontbg() Set font and background color.
|
||||
`-- fontcolor() Set font, plus background and foreground colors.
|
||||
|
|
||||
|`--+ bg
|
||||
| |
|
||||
| `-- color() Set background color.
|
||||
|
|
||||
`--+ fg
|
||||
|
|
||||
`-- color() Set foreground color.
|
||||
|
||||
they all take one argument, which is the text to markup, except the following:
|
||||
|
||||
```lua
|
||||
markup.font(font, text)
|
||||
markup.color(fg, bg, text)
|
||||
markup.fontfg(font, fg, text)
|
||||
markup.fontbg(font, bg, text)
|
||||
markup.fontcolor(font, fg, bg, text)
|
||||
markup.fg.color(color, text)
|
||||
markup.bg.color(color, text)
|
||||
```
|
||||
|
||||
Dynamic tagging
|
||||
---------------
|
||||
|
||||
That is:
|
||||
|
||||
- add a new tag;
|
||||
- rename current tag;
|
||||
- move current tag;
|
||||
- delete current tag.
|
||||
|
||||
If you delete a tag, any rule set on it shall be broken, so be careful.
|
||||
|
||||
Use it with key bindings like these:
|
||||
|
||||
```lua
|
||||
awful.key({ modkey, "Shift" }, "n", function () lain.util.add_tag(mylayout) end),
|
||||
awful.key({ modkey, "Shift" }, "r", function () lain.util.rename_tag() end),
|
||||
awful.key({ modkey, "Shift" }, "Left", function () lain.util.move_tag(1) end), -- move to next tag
|
||||
awful.key({ modkey, "Shift" }, "Right", function () lain.util.move_tag(-1) end), -- move to previous tag
|
||||
awful.key({ modkey, "Shift" }, "d", function () lain.util.delete_tag() end),
|
||||
```
|
||||
|
||||
The argument in `lain.util.add_tag` represents the tag layout, and is optional: if not present, it will be defaulted to `awful.layout.suit.tile`.
|
||||
|
||||
Useless gaps resize
|
||||
---------------------
|
||||
|
||||
Changes `beautiful.useless_gaps` on the fly.
|
||||
|
||||
The function takes an integer argument, being the amount of pixel to add/remove to gaps.
|
||||
|
||||
You could use it with these keybindings:
|
||||
|
||||
```lua
|
||||
-- On the fly useless gaps change
|
||||
awful.key({ altkey, "Control" }, "+", function () lain.util.useless_gaps_resize(1) end),
|
||||
awful.key({ altkey, "Control" }, "-", function () lain.util.useless_gaps_resize(-1) end),
|
||||
```
|
||||
|
||||
where `altkey = Mod1`, or you could use it like this:
|
||||
|
||||
```lua
|
||||
mywidget:buttons(awful.util.table.join (
|
||||
awful.button({}, 4, function() lain.util.useless_gaps_resize(-1) end),
|
||||
awful.button({}, 5, function() lain.util.useless_gaps_resize(1) end)
|
||||
end)
|
||||
))
|
||||
```
|
||||
|
||||
so when hovering the mouse over `mywidget`, you can adjust useless gaps size by scrolling with the mouse wheel.
|
||||
|
||||
tag\_view\_nonempty
|
||||
-------------------
|
||||
|
||||
This function lets you jump to the next/previous non-empty tag.
|
||||
It takes two arguments:
|
||||
|
||||
* `direction`: `1` for next non-empty tag, `-1` for previous.
|
||||
* `sc`: Screen which the taglist is in. Default is `mouse.screen` or `1`. This
|
||||
argument is optional.
|
||||
|
||||
You can use it with key bindings like these:
|
||||
|
||||
```lua
|
||||
-- Non-empty tag browsing
|
||||
awful.key({ altkey }, "Left", function () lain.util.tag_view_nonempty(-1) end),
|
||||
awful.key({ altkey }, "Right", function () lain.util.tag_view_nonempty(1) end),
|
||||
```
|
||||
|
||||
where `altkey = "Mod1"`.
|
||||
|
||||
magnify\_client
|
||||
---------------
|
||||
|
||||
Set a client to floating and resize it in the same way the "magnifier"
|
||||
layout does it. Place it on the "current" screen (derived from the mouse
|
||||
position). This allows you to magnify any client you wish, regardless of
|
||||
the currently used layout. Use it with a client keybinding like this:
|
||||
|
||||
```lua
|
||||
clientkeys = awful.util.table.join(
|
||||
-- [...]
|
||||
awful.key({ modkey, "Control" }, "m", lain.util.magnify_client),
|
||||
-- [...]
|
||||
)
|
||||
```
|
||||
|
||||
If you want to "de-magnify" it, just retype the keybinding.
|
||||
|
||||
If you want magnified client to respond to `incmwfact`, read [here](https://github.com/copycat-killer/lain/issues/195).
|
||||
|
||||
menu\_clients\_current\_tags
|
||||
----------------------------
|
||||
|
||||
Similar to `awful.menu.clients`, but this menu only shows the clients
|
||||
of currently visible tags. Use it with a key binding like this:
|
||||
|
||||
```lua
|
||||
awful.key({ "Mod1" }, "Tab", function()
|
||||
lain.util.menu_clients_current_tags({ width = 350 }, { keygrabber = true })
|
||||
end),
|
||||
```
|
||||
@@ -1,56 +0,0 @@
|
||||
# Usage
|
||||
|
||||
Every lain widget is a table.
|
||||
|
||||
A lain widget is generated by a `function`.
|
||||
|
||||
The `function` signature, input and output arguments can be found in the [related wiki entry](https://github.com/copycat-killer/lain/wiki/Widgets#index).
|
||||
|
||||
Every lain widget contains a `wibox.widget`, which is updated by a timed function. To access the widget, use the field `widget`, while to access the timed function, use the field `update`. Some lain widgets may also have an `icon` field, which is a `wibox.widget.imagebox`, and/or a `timer` field, which is the `gears.timer` on `update`.
|
||||
|
||||
Every `function` may take either a table or a list of variables as input.
|
||||
|
||||
If the input is a table, you must define a function variable called `settings` in it. There you will be able to define `widget` appearance.
|
||||
|
||||
For instance, if `widget` is a textbox, to markup it call `widget:set_markup(...)` within `settings`.
|
||||
|
||||
In the scope of `settings` you can use predefined arguments, which are specified in the wiki entries.
|
||||
|
||||
Example of a lain widget:
|
||||
|
||||
```lua
|
||||
local cpu = lain.widget.cpu {
|
||||
settings = function()
|
||||
widget:set_markup("Cpu " .. cpu_now.usage)
|
||||
end
|
||||
}
|
||||
-- to access the widget: cpu.widget
|
||||
```
|
||||
|
||||
If you want to see some applications, check [awesome-copycats](https://github.com/copycat-killer/awesome-copycats).
|
||||
|
||||
# Index
|
||||
|
||||
- [alsa](https://github.com/copycat-killer/lain/wiki/alsa)
|
||||
- [alsabar](https://github.com/copycat-killer/lain/wiki/alsabar)
|
||||
- [bat](https://github.com/copycat-killer/lain/wiki/bat)
|
||||
- [calendar](https://github.com/copycat-killer/lain/wiki/calendar)
|
||||
- [cpu](https://github.com/copycat-killer/lain/wiki/cpu)
|
||||
- [fs](https://github.com/copycat-killer/lain/wiki/fs)
|
||||
- [imap](https://github.com/copycat-killer/lain/wiki/imap)
|
||||
- [mem](https://github.com/copycat-killer/lain/wiki/mem)
|
||||
- [mpd](https://github.com/copycat-killer/lain/wiki/mpd)
|
||||
- [net](https://github.com/copycat-killer/lain/wiki/net)
|
||||
- [pulse](https://github.com/copycat-killer/lain/wiki/pulse)
|
||||
- [pulsebar](https://github.com/copycat-killer/lain/wiki/pulsebar)
|
||||
- [sysload](https://github.com/copycat-killer/lain/wiki/sysload)
|
||||
- [temp](https://github.com/copycat-killer/lain/wiki/temp)
|
||||
- [weather](https://github.com/copycat-killer/lain/wiki/weather)
|
||||
|
||||
## Users contributed
|
||||
|
||||
- [kbdlayout](https://github.com/copycat-killer/lain/wiki/kbdlayout)
|
||||
- [moc](https://github.com/copycat-killer/lain/wiki/moc)
|
||||
- [redshift](https://github.com/copycat-killer/lain/wiki/redshift)
|
||||
- [task](https://github.com/copycat-killer/lain/wiki/task)
|
||||
- [tpbat](https://github.com/copycat-killer/lain/wiki/tpbat)
|
||||
@@ -1 +0,0 @@
|
||||
[Home](https://github.com/copycat-killer/lain/wiki) • [Layouts](https://github.com/copycat-killer/lain/wiki/Layouts) • [Widgets](https://github.com/copycat-killer/lain/wiki/Widgets) • [Utilities](https://github.com/copycat-killer/lain/wiki/Utilities)
|
||||
@@ -1,25 +0,0 @@
|
||||
* [Home](https://github.com/copycat-killer/lain/wiki/Home)
|
||||
* [Layouts](https://github.com/copycat-killer/lain/wiki/Layouts)
|
||||
* [Usage](https://github.com/copycat-killer/lain/wiki/Layouts#Usage)
|
||||
* [How do layouts work?](https://github.com/copycat-killer/lain/wiki/Layouts#how-do-layouts-work)
|
||||
* [termfair](https://github.com/copycat-killer/lain/wiki/Layouts#termfair)
|
||||
* [centerfair](https://github.com/copycat-killer/lain/wiki/Layouts#termfaircenter)
|
||||
* [cascade](https://github.com/copycat-killer/lain/wiki/Layouts#cascade)
|
||||
* [cascadetile](https://github.com/copycat-killer/lain/wiki/Layouts#cascadetile)
|
||||
* [centerwork](https://github.com/copycat-killer/lain/wiki/Layouts#centerwork)
|
||||
* [centerworkh](https://github.com/copycat-killer/lain/wiki/Layouts#centerworkhorizontal)
|
||||
* [Pre 4.0 uselesstile patches](https://github.com/copycat-killer/lain/wiki/Layouts#pre-40-uselesstile-patches)
|
||||
* [What about layout icons?](https://github.com/copycat-killer/lain/wiki/Layouts#what-about-layout-icons)
|
||||
* [Widgets](https://github.com/copycat-killer/lain/wiki/Widgets)
|
||||
* [Usage](https://github.com/copycat-killer/lain/wiki/Widgets#usage)
|
||||
* [Index](https://github.com/copycat-killer/lain/wiki/Widgets#index)
|
||||
* [Users contributed](https://github.com/copycat-killer/lain/wiki/Widgets#users-contributed)
|
||||
* [Utilities](https://github.com/copycat-killer/lain/wiki/Utilities)
|
||||
* [quake](https://github.com/copycat-killer/lain/wiki/Utilities#quake)
|
||||
* [separators](https://github.com/copycat-killer/lain/wiki/Utilities#separators)
|
||||
* [markup](https://github.com/copycat-killer/lain/wiki/Utilities#markup)
|
||||
* [dynamic tagging](https://github.com/copycat-killer/lain/wiki/Utilities#dynamic-tagging)
|
||||
* [useless_gaps_resize](https://github.com/copycat-killer/lain/wiki/Utilities#useless-gaps-resize)
|
||||
* [tag_view_non_empty](https://github.com/copycat-killer/lain/wiki/Utilities#tag_view_nonempty)
|
||||
* [magnify_client](https://github.com/copycat-killer/lain/wiki/Utilities#magnify_client)
|
||||
* [menu_clients_current_tags](https://github.com/copycat-killer/lain/wiki/Utilities#menu_clients_current_tags)
|
||||
@@ -1,136 +0,0 @@
|
||||
## Usage
|
||||
|
||||
[Read here.](https://github.com/copycat-killer/lain/wiki/Widgets#usage)
|
||||
|
||||
### Description
|
||||
|
||||
Shows ALSA volume.
|
||||
|
||||
```lua
|
||||
local volume = lain.widget.alsa()
|
||||
```
|
||||
|
||||
## Input table
|
||||
|
||||
Variable | Meaning | Type | Default
|
||||
--- | --- | --- | ---
|
||||
`timeout` | Refresh timeout seconds | number | 5
|
||||
`cmd` | Alsa mixer command | string | "amixer"
|
||||
`channel` | Mixer channel | string | "Master"
|
||||
`togglechannel` | Toggle channel | string | `nil`
|
||||
`settings` | User settings | function | empty function
|
||||
|
||||
`cmd` is useful if you need to pass additional arguments to amixer. For instance, you may want to define `cmd = "amixer -c X"` in order to set amixer with card `X`.
|
||||
|
||||
`settings` can use the following variables:
|
||||
|
||||
Variable | Meaning | Type | Values
|
||||
--- | --- | --- | ---
|
||||
`volume_now.level` | Volume level | number | 0-100
|
||||
`volume_now.status` | Device status | string | "on", "off"
|
||||
|
||||
## Output table
|
||||
|
||||
Variable | Meaning | Type
|
||||
--- | --- | ---
|
||||
`widget` | The widget | `wibox.widget.textbox`
|
||||
`channel` | ALSA channel | string
|
||||
`update` | Update `widget` | function
|
||||
|
||||
## Toggle channel
|
||||
|
||||
In case mute toggling can't be mapped to master channel (this happens, for instance, when you are using an HDMI output), define togglechannel as your S/PDIF device. You can get the device ID with `scontents` command.
|
||||
|
||||
For instance, if card number is 1 and S/PDIF number is 3:
|
||||
|
||||
```shell
|
||||
$ amixer -c 1 scontents
|
||||
Simple mixer control 'Master',0
|
||||
Capabilities: volume
|
||||
Playback channels: Front Left - Front Right
|
||||
Capture channels: Front Left - Front Right
|
||||
Limits: 0 - 255
|
||||
Front Left: 255 [100%]
|
||||
Front Right: 255 [100%]
|
||||
Simple mixer control 'IEC958',0
|
||||
Capabilities: pswitch pswitch-joined
|
||||
Playback channels: Mono
|
||||
Mono: Playback [on]
|
||||
Simple mixer control 'IEC958',1
|
||||
Capabilities: pswitch pswitch-joined
|
||||
Playback channels: Mono
|
||||
Mono: Playback [on]
|
||||
Simple mixer control 'IEC958',2
|
||||
Capabilities: pswitch pswitch-joined
|
||||
Playback channels: Mono
|
||||
Mono: Playback [on]
|
||||
Simple mixer control 'IEC958',3
|
||||
Capabilities: pswitch pswitch-joined
|
||||
Playback channels: Mono
|
||||
Mono: Playback [on]
|
||||
```
|
||||
|
||||
you have to set `togglechannel = "IEC958,3"`.
|
||||
|
||||
## Buttons
|
||||
|
||||
If you want buttons, just add the following after your widget in `rc.lua`.
|
||||
|
||||
```lua
|
||||
volume.widget:buttons(awful.util.table.join(
|
||||
awful.button({}, 1, function() -- left click
|
||||
awful.spawn(string.format("%s -e alsamixer", terminal))
|
||||
end),
|
||||
awful.button({}, 2, function() -- middle click
|
||||
awful.spawn(string.format("%s set %s 100%%", volume.cmd, volume.channel))
|
||||
volume.update()
|
||||
end),
|
||||
awful.button({}, 3, function() -- right click
|
||||
awful.spawn(string.format("%s set %s toggle", volume.cmd, volume.togglechannel or volume.channel))
|
||||
volume.update()
|
||||
end),
|
||||
awful.button({}, 4, function() -- scroll up
|
||||
awful.spawn(string.format("%s set %s 1%%+", volume.cmd, volume.channel))
|
||||
volume.update()
|
||||
end),
|
||||
awful.button({}, 5, function() -- scroll down
|
||||
awful.spawn(string.format("%s set %s 1%%-", volume.cmd, volume.channel))
|
||||
volume.update()
|
||||
end)
|
||||
))
|
||||
```
|
||||
|
||||
## Keybindings
|
||||
|
||||
You can control the widget with keybindings like these:
|
||||
|
||||
```lua
|
||||
-- ALSA volume control
|
||||
awful.key({ altkey }, "Up",
|
||||
function ()
|
||||
os.execute(string.format("amixer set %s 1%%+", volume.channel))
|
||||
volume.update()
|
||||
end),
|
||||
awful.key({ altkey }, "Down",
|
||||
function ()
|
||||
os.execute(string.format("amixer set %s 1%%-", volume.channel))
|
||||
volume.update()
|
||||
end),
|
||||
awful.key({ altkey }, "m",
|
||||
function ()
|
||||
os.execute(string.format("amixer set %s toggle", volume.togglechannel or volume.channel))
|
||||
volume.update()
|
||||
end),
|
||||
awful.key({ altkey, "Control" }, "m",
|
||||
function ()
|
||||
os.execute(string.format("amixer set %s 100%%", volume.channel))
|
||||
volume.update()
|
||||
end),
|
||||
awful.key({ altkey, "Control" }, "0",
|
||||
function ()
|
||||
os.execute(string.format("amixer set %s 0%%", volume.channel))
|
||||
volume.update()
|
||||
end),
|
||||
```
|
||||
|
||||
where `altkey = "Mod1"`.
|
||||
@@ -1,100 +0,0 @@
|
||||
## Usage
|
||||
|
||||
[Read here.](https://github.com/copycat-killer/lain/wiki/Widgets#usage)
|
||||
|
||||
### Description
|
||||
|
||||
Shows ALSA volume with a progressbar; provides tooltips and notifications.
|
||||
|
||||
```lua
|
||||
local volume = lain.widget.alsabar()
|
||||
```
|
||||
|
||||
## Input table
|
||||
|
||||
Variable | Meaning | Type | Default
|
||||
--- | --- | --- | ---
|
||||
`timeout` | Refresh timeout seconds | number | 5
|
||||
`settings` | User settings | function | empty function
|
||||
`width` | Bar width | number | 63
|
||||
`height` | Bar height | number | 1
|
||||
`ticks` | Set bar ticks on | boolean | false
|
||||
`ticks_size` | Ticks size | number | 7
|
||||
`cmd` | ALSA mixer command | string | "amixer"
|
||||
`channel` | Mixer channel | string | "Master"
|
||||
`togglechannel` | Toggle channel | string | `nil`
|
||||
`colors` | Bar colors | table | see [Default colors](https://github.com/copycat-killer/lain/wiki/alsabar#default-colors)
|
||||
`notification_preset` | Notification preset | table | See [default `notification_preset`](https://github.com/copycat-killer/lain/wiki/alsabar#default-notification_preset)
|
||||
`followtag` | Display the notification on currently focused screen | boolean | false
|
||||
|
||||
`cmd` is useful if you need to pass additional arguments to `amixer`. For instance, you may want to define `command = "amixer -c X"` in order to set amixer with card `X`.
|
||||
|
||||
In case mute toggling can't be mapped to master channel (this happens, for instance, when you are using an HDMI output), define `togglechannel` as your S/PDIF device. Read [`alsa`](https://github.com/copycat-killer/lain/wiki/alsa#toggle-channel) page to know how.
|
||||
|
||||
`settings` can use the following variables:
|
||||
|
||||
Variable | Meaning | Type | Values
|
||||
--- | --- | --- | ---
|
||||
`volume_now.level` | Volume level | number | 0-100
|
||||
`volume_now.status` | Device status | string | "on", "off"
|
||||
|
||||
In multiple screen setups, the default behaviour is to show a visual notification pop-up window on the first screen. By setting `followtag` to `true` it will be shown on the currently focused tag screen.
|
||||
|
||||
### Default colors
|
||||
|
||||
Variable | Meaning | Type | Default
|
||||
--- | --- | --- | ---
|
||||
`background` | Bar backgrund color | string | "#000000"
|
||||
`mute` | Bar mute color | string | "#EB8F8F"
|
||||
`unmute` | Bar unmute color | string | "#A4CE8A"
|
||||
|
||||
### Default `notification_preset`
|
||||
|
||||
```lua
|
||||
notification_preset = {
|
||||
font = "Monospace 10"
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
## Output table
|
||||
|
||||
Variable | Meaning | Type
|
||||
--- | --- | ---
|
||||
`bar` | The widget | `wibox.widget.progressbar`
|
||||
`channel` | ALSA channel | string
|
||||
`notify` | The notification | function
|
||||
`update` | Update `bar` | function
|
||||
`tooltip` | The tooltip | `awful.tooltip`
|
||||
|
||||
## Buttons
|
||||
|
||||
If you want buttons, just add the following after your widget in `rc.lua`.
|
||||
|
||||
```lua
|
||||
volume.bar:buttons(awful.util.table.join(
|
||||
awful.button({}, 1, function() -- left click
|
||||
awful.spawn(string.format("%s -e alsamixer", terminal))
|
||||
end),
|
||||
awful.button({}, 2, function() -- middle click
|
||||
awful.spawn(string.format("%s set %s 100%%", volume.cmd, volume.channel))
|
||||
volume.update()
|
||||
end),
|
||||
awful.button({}, 3, function() -- right click
|
||||
awful.spawn(string.format("%s set %s toggle", volume.cmd, volume.togglechannel or volume.channel))
|
||||
volume.update()
|
||||
end),
|
||||
awful.button({}, 4, function() -- scroll up
|
||||
awful.spawn(string.format("%s set %s 1%%+", volume.cmd, volume.channel))
|
||||
volume.update()
|
||||
end),
|
||||
awful.button({}, 5, function() -- scroll down
|
||||
awful.spawn(string.format("%s set %s 1%%-", volume.cmd, volume.channel))
|
||||
volume.update()
|
||||
end)
|
||||
))
|
||||
```
|
||||
|
||||
## Keybindings
|
||||
|
||||
Read [here](https://github.com/copycat-killer/lain/wiki/alsa#keybindings). If you want notifications, use `volume.notify()` instead of `volume.update()`.
|
||||
@@ -1,89 +0,0 @@
|
||||
## Usage
|
||||
|
||||
[Read here.](https://github.com/copycat-killer/lain/wiki/Widgets#usage)
|
||||
|
||||
### Description
|
||||
|
||||
Shows the remaining time and percentage capacity of your laptop battery, as well as
|
||||
the current wattage. Multiple batteries are supported.
|
||||
|
||||
Displays a notification when battery is low or critical.
|
||||
|
||||
```lua
|
||||
local mybattery = lain.widget.bat()
|
||||
```
|
||||
|
||||
## Input table
|
||||
|
||||
Variable | Meaning | Type | Default
|
||||
--- | --- | --- | ---
|
||||
`timeout` | Refresh timeout seconds | number | 30
|
||||
`battery` | Single battery id | string | "BAT0"
|
||||
`batteries` | Multiple batteries id table | table of strings | `{"BAT0"}`
|
||||
`ac` | AC | string | "AC0"
|
||||
`notify` | Show notification popups | string | "on"
|
||||
`n_perc` | Percentages assumed for critical and low battery levels | table of integers | `{5, 15}`
|
||||
`settings` | User settings | function | empty function
|
||||
|
||||
You only have to define one between `battery` and `batteries`.
|
||||
|
||||
If you have one battery, you can either use `args.battery = "BAT*"` or `args.batteries = {"BAT*"}`. Of course, if you have multiple batteries, you need to use the latter option.
|
||||
|
||||
To disable warning notifications, set `notify` to `"off"`.
|
||||
|
||||
`settings` can use the `bat_now` table, which contains the following strings:
|
||||
|
||||
- `status`, battery status ("N/A", "Discharging", "Charging", "Full");
|
||||
- `n_status[i]`, i-th battery status (like above);
|
||||
- `ac_status`, AC-plug flag (0 if cable is unplugged, 1 if plugged, "N/A" otherwise);
|
||||
- `perc`, total charge percentage (integer between 0 and 100 or "N/A");
|
||||
- `n_perc`, i-th battery charge percentage (like above);
|
||||
- `time`, time remaining until charge if charging, until discharge if discharging (HH:SS string or "N/A");
|
||||
- `watt`, battery watts (float with 2 decimals).
|
||||
|
||||
and can modify the following two tables, which will be the preset for the naughty notifications:
|
||||
* `bat_notification_low_preset`(used if battery charge level <= 15)
|
||||
* `bat_notification_critical_preset` (used if battery charge level <= 5)
|
||||
|
||||
Check [here](https://awesomewm.org/doc/api/libraries/naughty.html#notify) for the list of variables they can contain. Default definitions:
|
||||
|
||||
```lua
|
||||
bat_notification_low_preset = {
|
||||
title = "Battery low",
|
||||
text = "Plug the cable!",
|
||||
timeout = 15,
|
||||
fg = "#202020",
|
||||
bg = "#CDCDCD"
|
||||
}
|
||||
```
|
||||
```lua
|
||||
bat_notification_critical_preset = {
|
||||
title = "Battery exhausted",
|
||||
text = "Shutdown imminent",
|
||||
timeout = 15,
|
||||
fg = "#000000",
|
||||
bg = "#FFFFFF"
|
||||
}
|
||||
```
|
||||
|
||||
## Output table
|
||||
|
||||
Variable | Meaning | Type
|
||||
--- | --- | ---
|
||||
`widget` | The widget | `wibox.widget.textbox`
|
||||
`update` | Update `widget` | function
|
||||
|
||||
The `update` function can be used to refresh the widget before `timeout` expires.
|
||||
|
||||
## Notes
|
||||
* Another common identifier for `ac` is `ACAD`.
|
||||
* If your widget is always on "N/A" with default settings, and you have a single battery, then `BAT0` is not your battery file. Locate the right one in `/sys/class/power_supply/` and set `battery` properly. For instance, with `BAT1`:
|
||||
|
||||
```lua
|
||||
batwidget = lain.widget.bat({
|
||||
battery = "BAT1",
|
||||
-- [...]
|
||||
})
|
||||
|
||||
```
|
||||
* Alternatively, you can try the `upower` widget [here](https://awesomewm.org/recipes/watch).
|
||||
@@ -1,105 +0,0 @@
|
||||
## Usage
|
||||
|
||||
[Read here.](https://github.com/copycat-killer/lain/wiki/Widgets#usage)
|
||||
|
||||
### Description
|
||||
|
||||
Attaches a calendar notification to a widget.
|
||||
|
||||
This is a simpler but [faster](https://github.com/awesomeWM/awesome/issues/1861)
|
||||
alternative to [`awful.widget.calendar_popup](https://awesomewm.org/doc/api/classes/awful.widget.calendar_popup.html).
|
||||
|
||||
```lua
|
||||
local calendar = lain.widget.calendar()
|
||||
```
|
||||
|
||||
- Left click / scroll down: switch to previous month.
|
||||
- Right click / scroll up: switch to next month.
|
||||
|
||||
## Input table
|
||||
|
||||
Variable | Meaning | Type | Default
|
||||
--- | --- | --- | ---
|
||||
`cal` | custom call for `cal` | string | "/usr/bin/cal"
|
||||
`attach_to` | Array of widgets | array | empty array
|
||||
`followtag` | Display the notification on currently focused screen | boolean | false
|
||||
`icons` | Path to calendar icons | string | [lain/icons/cal/white](https://github.com/copycat-killer/lain/tree/master)
|
||||
`notification_preset` | Notification preset | table | See [default `notification_preset`](https://github.com/copycat-killer/lain/wiki/calendar#default-notification_preset)
|
||||
|
||||
You can reset `cal` any way you like (using `-w` to display weeks as well, for instance). If the current day is not highlighted, you can reset `cal` to also include the proper coloring flag. For instance, under Arch Linux it's `/usr/bin/cal --color=always`, while under Ubuntu it's `/usr/bin/cal -h`.
|
||||
|
||||
You can set `attach_to` as the array of widgets to which you want to attach the calendar, for instance:
|
||||
|
||||
```lua
|
||||
lain.widget.calendar({
|
||||
`attach_to = { mywidget1, mywidget2, ... }`,
|
||||
-- [...]
|
||||
})
|
||||
```
|
||||
|
||||
The notification will show an icon of the current day number, and output from ``cal`` with current day highlighted.
|
||||
|
||||
In multiple screen setups, the default behaviour is to show a visual notification pop-up window on the first screen. By setting `followtag` to `true` it will be shown on the currently focused tag screen.
|
||||
|
||||
### Default `notification_preset`
|
||||
|
||||
```lua
|
||||
notification_preset = {
|
||||
font = "Monospace 10",
|
||||
fg = "#FFFFFF",
|
||||
bg = "#000000"
|
||||
}
|
||||
```
|
||||
|
||||
## Output table
|
||||
|
||||
Variable | Meaning | Type
|
||||
--- | --- | ---
|
||||
`attach` | Attach the calendar to an input widget | function
|
||||
`show` | Show calendar | function
|
||||
`hide` | Hide calendar | function
|
||||
|
||||
`attach` takes as argument the widget you want to attach the calendar to: `calendar.attach(widget)`.
|
||||
|
||||
## Keybindings
|
||||
|
||||
You can call the notification with a key binding like this:
|
||||
|
||||
```lua
|
||||
awful.key({ altkey }, "c", function ()
|
||||
calendar:show(7)
|
||||
end),
|
||||
```
|
||||
|
||||
where ``altkey = "Mod1"`` and ``show`` argument is an optional integer, meaning timeout seconds.
|
||||
|
||||
You can also call it defining a notification screen with a third argument like this:
|
||||
|
||||
```lua
|
||||
awful.key({ altkey }, "c", function ()
|
||||
calendar:show(7, 0, my_scr_number)
|
||||
end),
|
||||
```
|
||||
|
||||
## Notes
|
||||
|
||||
* Naughty notifications require `notification_preset.font` to be **monospaced**, in order to correctly display the output.
|
||||
* In case current day is not being highlighted in notifications, try setting `cal` specifying your environment. For instance: `cal = "/usr/bin/env TERM=linux /usr/bin/cal --your-coloring-flag-here"`.
|
||||
* If you want to [disable notification icon](https://github.com/copycat-killer/lain/pull/351), set `icons = ""` in the input table.
|
||||
* In order to have [khal](https://github.com/pimutils/khal) agenda output combined with the widget you can use this script as `cal`:
|
||||
|
||||
```shell
|
||||
#!/bin/bash
|
||||
days=3 # days to show
|
||||
cal_flag="--color=always" # colorizing flag
|
||||
if [ $# -eq 0 ]; then
|
||||
awk '{max = 21}
|
||||
FNR==NR{s1[FNR]=$0; next}{s2[FNR]=$0}
|
||||
END { format = "%-" max "s\t%-" max "s\n";
|
||||
numlines=(NR-FNR)>FNR?NR-FNR:FNR;
|
||||
for (i=1; i<=numlines; i++) { printf format, s1[i]?s1[i]:"", s2[i]?s2[i]:"" }
|
||||
}' <(/usr/bin/cal $cal_flag) <(/usr/bin/khal list today $(date -d "+$days days" "+%d.%m.%Y"))
|
||||
else
|
||||
/usr/bin/cal $@
|
||||
fi
|
||||
```
|
||||
@@ -1,30 +0,0 @@
|
||||
## Usage
|
||||
|
||||
[Read here.](https://github.com/copycat-killer/lain/wiki/Widgets#usage)
|
||||
|
||||
### Description
|
||||
|
||||
Shows the current CPU usage, both in general and per core.
|
||||
|
||||
```lua
|
||||
local mycpu = lain.widget.cpu()
|
||||
```
|
||||
|
||||
## Input table
|
||||
|
||||
Variable | Meaning | Type | Default
|
||||
--- | --- | --- | ---
|
||||
`timeout` | Refresh timeout seconds | number | 2
|
||||
`settings` | User settings | function | empty function
|
||||
|
||||
`settings` can use these strings:
|
||||
|
||||
* `cpu_now.usage`, the general use percentage;
|
||||
* `cpu_now[i].usage`, the i-th core use percentage, with `i` starting from 1.
|
||||
|
||||
## Output table
|
||||
|
||||
Variable | Meaning | Type
|
||||
--- | --- | ---
|
||||
`widget` | The widget | `wibox.widget.textbox`
|
||||
`update` | Update `widget` | function
|
||||
@@ -1,96 +0,0 @@
|
||||
## Usage
|
||||
|
||||
[Read here.](https://github.com/copycat-killer/lain/wiki/Widgets#usage)
|
||||
|
||||
### Description
|
||||
|
||||
Shows disk space usage for a set partition.
|
||||
|
||||
Displays a notification when the partition is full or has low space.
|
||||
|
||||
```lua
|
||||
local mypartition = lain.widget.fs()
|
||||
```
|
||||
|
||||
## Input table
|
||||
|
||||
Variable | Meaning | Type | Default
|
||||
--- | --- | --- | ---
|
||||
`timeout` | Refresh timeout seconds -| number | 600
|
||||
`partition` | Partition to monitor | string | "/"
|
||||
`options` | Additional options to pass to [`dfs`](https://github.com/copycat-killer/lain/blob/master/scripts/dfs) | string, in the form `--type='fstype' | --exclude-type='fstype'` | nil
|
||||
`notification_preset` | Notification preset | table | See [default `notification_preset`](https://github.com/copycat-killer/lain/wiki/fs#default-notification_preset)
|
||||
`followtag` | Display the notification on currently focused screen | boolean | false
|
||||
`notify` | Display notifications | string | "on"
|
||||
`showpopup` | Display popups with mouse hovering | string, possible values: "on", "off" | "on"
|
||||
`settings` | User settings | function | empty function
|
||||
|
||||
`settings` can use the following `partition` related strings:
|
||||
|
||||
* `fs_now.size_mb`
|
||||
* `fs_now.size_gb`
|
||||
* `fs_now.used`
|
||||
* `fs_now.used_mb`
|
||||
* `fs_now.used_gb`
|
||||
* `fs_now.available`
|
||||
* `fs_now.available_mb`
|
||||
* `fs_now.available_gb`
|
||||
|
||||
Within `settings`, you can obtain other partition values from internal `fs_info` table. For each partition, the following indexes are available:
|
||||
|
||||
* `fs_info[other_partition .. " size_mb"]`
|
||||
* `fs_info[other_partition .. " size_gb"]`
|
||||
* `fs_info[other_partition .. " used_p"]`
|
||||
* `fs_info[other_partition .. " used_mb"]`
|
||||
* `fs_info[other_partition .. " used_gb"]`
|
||||
* `fs_info[other_partition .. " avail_p"]`
|
||||
* `fs_info[other_partition .. " avail_mb"]`
|
||||
* `fs_info[other_partition .. " avail_gb"]`
|
||||
|
||||
just like the variables of `fs_now`. Example:
|
||||
|
||||
```lua
|
||||
-- shows root and home partitions percentage used
|
||||
local fsroothome = lain.widget.fs({
|
||||
settings = function()
|
||||
local home_used = tonumber(fs_info["/home used_p"]) or 0
|
||||
widget:set_text("/ " .. fs_now.used .. "% | /home " .. home_used .. "% ")
|
||||
end
|
||||
})
|
||||
```
|
||||
|
||||
Also, `settings` can modify `notification_preset` table. This table will be the preset for the naughty notifications. Check [here](https://awesomewm.org/doc/api/libraries/naughty.html#notify) for the list of variables it can contain.
|
||||
|
||||
In multiple screen setups, the default behaviour is to show a visual notification pop-up window on the first screen. By setting `followtag` to `true` it will be shown on the currently focused tag screen.
|
||||
|
||||
### Default `notification_preset`
|
||||
|
||||
```lua
|
||||
notification_preset = {
|
||||
font = "Monospace 10",
|
||||
fg = "#FFFFFF",
|
||||
bg = "#000000"
|
||||
}
|
||||
```
|
||||
|
||||
## Output table
|
||||
|
||||
Variable | Meaning | Type
|
||||
--- | --- | ---
|
||||
`widget` | The widget | `wibox.widget.textbox`
|
||||
`show` | The notification | function
|
||||
|
||||
You can display the notification with a key binding like this:
|
||||
|
||||
```lua
|
||||
awful.key({ altkey }, "h", function () mypartition.show(seconds, scr) end),
|
||||
```
|
||||
|
||||
where ``altkey = "Mod1"`` and ``show`` arguments, both optionals, are:
|
||||
|
||||
* `seconds`, notification time in seconds
|
||||
* `scr`, screen which to display the notification in
|
||||
|
||||
## Note
|
||||
|
||||
Naughty notifications require `notification_preset.font` to be **monospaced**, in order to correctly display the output.
|
||||
@@ -1,94 +0,0 @@
|
||||
## Usage
|
||||
|
||||
[Read here.](https://github.com/copycat-killer/lain/wiki/Widgets#usage)
|
||||
|
||||
### Description
|
||||
|
||||
Shows mails count fetching over IMAP.
|
||||
|
||||
```lua
|
||||
local myimap = lain.widget.imap(args)
|
||||
```
|
||||
|
||||
New mails are notified like this:
|
||||
|
||||
+--------------------------------------------+
|
||||
| +---+ |
|
||||
| |\ /| donald@disney.org has 3 new messages |
|
||||
| +---+ |
|
||||
+--------------------------------------------+
|
||||
|
||||
## Input table
|
||||
|
||||
Required parameters are:
|
||||
|
||||
Variable | Meaning | Type
|
||||
--- | --- | ---
|
||||
`server` | Mail server | string
|
||||
`mail` | User mail | string
|
||||
`password` | User password | string
|
||||
|
||||
while the optional are:
|
||||
|
||||
Variable | Meaning | Type | Default
|
||||
--- | --- | --- | ---
|
||||
`port` | IMAP port | number | 993
|
||||
`timeout` | Refresh timeout seconds | number | 60
|
||||
`is_plain` | Define whether `password` is a plain password (true) or a command that retrieves it (false) | boolean | false
|
||||
`followtag` | Notification behaviour | boolean | false
|
||||
`notify` | Show notification popups | string | "on"
|
||||
`settings` | User settings | function | empty function
|
||||
|
||||
The reason why `is_plain` is false by default is to discourage the habit of storing passwords in plain.
|
||||
|
||||
So, you can set your password in plain like this:
|
||||
|
||||
```lua
|
||||
myimapcheck = lain.widget.imap({
|
||||
is_plain = true,
|
||||
password = "mymailpassword",
|
||||
-- [...]
|
||||
})
|
||||
```
|
||||
|
||||
and you'll have the same security provided by `~/.netrc`.
|
||||
|
||||
**Or you can use a password manager**, like [spm](https://notabug.org/kl3/spm) or [pass](https://www.passwordstore.org):
|
||||
|
||||
```lua
|
||||
myimapcheck = lain.widget.imap({
|
||||
password = function()
|
||||
-- return the output of "spm show mymail"
|
||||
end,
|
||||
-- [...]
|
||||
})
|
||||
```
|
||||
|
||||
When `is_plain == false` (default), `password` can be either a string, a table or a function: the widget will execute it asynchronously in the first two cases.
|
||||
|
||||
`settings` can use the value `mailcount`, an integer greater or equal to zero, and can modify `mail_notification_preset` table, which will be the preset for the naughty notifications. Check [here](https://awesomewm.org/apidoc/libraries/naughty.html#notify) for the list of variables it can contain. Default definition:
|
||||
|
||||
```lua
|
||||
mail_notification _preset = {
|
||||
icon = lain/icons/mail.png,
|
||||
position = "top_left"
|
||||
}
|
||||
```
|
||||
|
||||
Note that `mailcount` is 0 either if there are no new mails or credentials are invalid, so make sure you get the right settings.
|
||||
|
||||
In multiple screen setups, the default behaviour is to show a visual notification pop-up window on the first screen. By setting `followtag` to `true` it will be shown on the currently focused tag screen.
|
||||
|
||||
You can have multiple instances of this widget at the same time.
|
||||
|
||||
## Output table
|
||||
|
||||
Variable | Meaning | Type
|
||||
--- | --- | ---
|
||||
`widget` | The widget | `wibox.widget.textbox`
|
||||
`update` | Update `widget` | function
|
||||
`timer` | The widget timer | [`gears.timer`](https://awesomewm.org/doc/api/classes/gears.timer.html)
|
||||
|
||||
The `update` function can be used to refresh the widget before `timeout` expires.
|
||||
|
||||
You can use `timer` to start/stop the widget as you like.
|
||||
@@ -1,75 +0,0 @@
|
||||
## Usage
|
||||
|
||||
[Read here.](https://github.com/copycat-killer/lain/wiki/Widgets#usage)
|
||||
|
||||
### Description
|
||||
|
||||
Shows and controls keyboard layouts and variants using `setxkbmap`. This is a simpler but asynchronous alternative to [awful.widget.kbdlayout](https://awesomewm.org/apidoc/classes/awful.widget.keyboardlayout.html).
|
||||
|
||||
```lua
|
||||
local mykbdlayout = lain.widget.contrib.kbdlayout()
|
||||
```
|
||||
|
||||
Left/right click switches to next/previous keyboard layout.
|
||||
|
||||
## Input table
|
||||
|
||||
Variable | Meaning | Type | Default
|
||||
--- | --- | --- | ---
|
||||
`layouts` | Keyboard layouts and variants to switch between | table | **nil**
|
||||
`add_us_secondary` | Whether to add `us` as a secondary layout | boolean | true
|
||||
`timeout` | Refresh timeout (in seconds) | number | 10
|
||||
`settings` | User settings | function | empty function
|
||||
|
||||
- `layouts`
|
||||
|
||||
A table (array) which contains tables with keys indicating layout and (optionally) variant. This argument is **mandatory**.
|
||||
|
||||
- `add_us_secondary`
|
||||
|
||||
A boolean controlling whether to add `us` as a secondary layout. This is needed in order for keyboard shortcuts to work in certain applications, i.e. Firefox, while using a non-US keyboard layout.
|
||||
|
||||
- `timeout`
|
||||
|
||||
An integer which determines the interval at which the widget will be updated, in case the keyboard layout was changed by other means.
|
||||
|
||||
- `settings`
|
||||
|
||||
A "callback" function in which the user is expected to set the text widget up. The widget itself is available as the global variable `widget`, while layout information is available as `kbdlayout_now`. `kbdlayout_now` contains two keys, `layout` containing the primary layout, and `variant`, containing the variant. If there is no variant, `variant` is `nil`.
|
||||
|
||||
## Output table
|
||||
|
||||
Variable | Meaning | Type
|
||||
--- | --- | ---
|
||||
`widget` | The widget (textbox) | `wibox.widget.textbox`
|
||||
`update` | Function to update the widget and call `settings` | function
|
||||
`set` | Function taking an index as an argument to manually set the layout given by that index | function
|
||||
`next` | Change to the next layout | function
|
||||
`prev` | Change to the prev layout | function
|
||||
|
||||
The textbox can be added to the layout via standard means.
|
||||
|
||||
By default, left-clicking the textbox calls `next`, and right-clicking calls `prev`. You can set up additional key- or mouse-bindings. See the example below.
|
||||
|
||||
## Example
|
||||
|
||||
```lua
|
||||
-- Switch between US Dvorak and DE layouts.
|
||||
mykbdlayout = lain.widget.contrib.kbdlayout({
|
||||
layouts = { { layout = "us", variant = "dvorak" },
|
||||
{ layout = "de" } },
|
||||
settings = function()
|
||||
if kbdlayout_now.variant then
|
||||
widget:set_text(string.format("%s/%s", kbdlayout_now.layout,
|
||||
kbdlayout_now.variant))
|
||||
else
|
||||
widget:set_text(kbdlayout_now.layout)
|
||||
end
|
||||
end
|
||||
})
|
||||
|
||||
-- [...]
|
||||
|
||||
-- Add key binding (traditional Alt+Shift switching)
|
||||
awful.key({ "Mod1" }, "Shift_L", function () mykbdlayout.next() end),
|
||||
```
|
||||
@@ -1,33 +0,0 @@
|
||||
## Usage
|
||||
|
||||
[Read here.](https://github.com/copycat-killer/lain/wiki/Widgets#usage)
|
||||
|
||||
### Description
|
||||
|
||||
Shows memory status (in MiB).
|
||||
|
||||
```lua
|
||||
local mymem = lain.widget.mem()
|
||||
```
|
||||
|
||||
## Input table
|
||||
|
||||
Variable | Meaning | Type | Default
|
||||
--- | --- | --- | ---
|
||||
`timeout` | Refresh timeout seconds | number | 2
|
||||
`settings` | User settings | function | empty function
|
||||
|
||||
in `settings` you can use the following variables:
|
||||
|
||||
Variable | Meaning | Type
|
||||
--- | --- | ---
|
||||
`mem_now.used` | Memory used (MiB) | string
|
||||
`mem_now.swapused` | Swap memory used (MiB) | string
|
||||
`mem_now.perc` | Memory percentage | int
|
||||
|
||||
## Output table
|
||||
|
||||
Variable | Meaning | Type
|
||||
--- | --- | ---
|
||||
`widget` | The widget | `wibox.widget.textbox`
|
||||
`update` | Update `widget` | function
|
||||
@@ -1,122 +0,0 @@
|
||||
## Usage
|
||||
|
||||
[Read here.](https://github.com/copycat-killer/lain/wiki/Widgets#usage)
|
||||
|
||||
### Description
|
||||
|
||||
A widget for showing the current song track's information from MOC (Music On Console).
|
||||
|
||||
```lua
|
||||
local mymoc = lain.widget.contrib.moc()
|
||||
```
|
||||
|
||||
Now playing songs are notified like this:
|
||||
|
||||
+--------------------------------------------------------+
|
||||
| +-------+ |
|
||||
| |/^\_/^\| Now playing |
|
||||
| |\ O O /| Cannibal Corpse (Hammer Smashed Face) - 1993 |
|
||||
| | '.o.' | Hammer Smashed Face (Radio Disney Version) |
|
||||
| +-------+ |
|
||||
+--------------------------------------------------------+
|
||||
|
||||
## Input table
|
||||
|
||||
Variable | Meaning | Type | Default
|
||||
--- | --- | --- | ---
|
||||
`timeout` | Refresh timeout seconds | number | 1
|
||||
`music_dir` | Music directory | string | "~/Music"
|
||||
`cover_size` | Album art notification size | number | 100
|
||||
`cover_pattern` | Pattern for the album art file | string | `*\\.(jpg|jpeg|png|gif)`*
|
||||
`default_art` | Default art | string | ""
|
||||
`followtag` | Display the notification on currently focused screen | boolean | false
|
||||
`settings` | User settings | function | empty function
|
||||
|
||||
\* In Lua, "\\\\" means "\" escaped.
|
||||
|
||||
Default `cover_pattern` definition will made the widget set the first jpg, jpeg, png or gif file found in the directory as the album art.
|
||||
|
||||
Pay attention to case sensitivity when defining `music_dir`.
|
||||
|
||||
`settings` can use `moc_now` table, which contains the following string values:
|
||||
|
||||
- state (possible values: "PLAY", "PAUSE", "STOP")
|
||||
- file
|
||||
- artist
|
||||
- title
|
||||
- album
|
||||
- elapsed (Time elapsed for the current track)
|
||||
- total (The current track's total time)
|
||||
|
||||
and can modify `moc_notification_preset` table, which will be the preset for the naughty notifications. Check [here](https://awesomewm.org/apidoc/libraries/naughty.html#notify) for the list of variables it can contain. Default definition:
|
||||
|
||||
```lua
|
||||
moc_notification_preset = {
|
||||
title = "Now playing",
|
||||
timeout = 6,
|
||||
text = string.format("%s (%s) - %s\n%s", moc_now.artist,
|
||||
moc_now.album, moc_now.elapsed, moc_now.title)
|
||||
}
|
||||
```
|
||||
|
||||
In multiple screen setups, the default behaviour is to show a visual notification pop-up window on the first screen. By setting `followtag` to `true` it will be shown on the currently focused tag screen.
|
||||
|
||||
## Output table
|
||||
|
||||
Variable | Meaning | Type
|
||||
--- | --- | ---
|
||||
`widget` | The widget | `wibox.widget.textbox`
|
||||
`update` | Update `widget` | function
|
||||
`timer` | The widget timer | [`gears.timer`](https://awesomewm.org/doc/api/classes/gears.timer.html)
|
||||
|
||||
The `update` function can be used to refresh the widget before `timeout` expires.
|
||||
|
||||
You can use `timer` to start/stop the widget as you like.
|
||||
|
||||
## Keybindings
|
||||
|
||||
You can control the widget with key bindings like these:
|
||||
|
||||
```lua
|
||||
-- MOC control
|
||||
awful.key({ altkey, "Control" }, "Up",
|
||||
function ()
|
||||
awful.spawn.with_shell("mocp -G")
|
||||
moc.update()
|
||||
end),
|
||||
awful.key({ altkey, "Control" }, "Down",
|
||||
function ()
|
||||
awful.spawn.with_shell("mocp -s")
|
||||
moc.update()
|
||||
end),
|
||||
awful.key({ altkey, "Control" }, "Left",
|
||||
function ()
|
||||
awful.spawn.with_shell("mocp -r")
|
||||
moc.update()
|
||||
end),
|
||||
awful.key({ altkey, "Control" }, "Right",
|
||||
function ()
|
||||
awful.spawn.with_shell("mocp -f")
|
||||
moc.update()
|
||||
end),
|
||||
```
|
||||
|
||||
where `altkey = "Mod1"`.
|
||||
|
||||
If you don't use the widget for long periods and wish to spare CPU, you can toggle it with a keybinding like this:
|
||||
|
||||
```lua
|
||||
-- toggle MOC widget
|
||||
awful.key({ altkey }, "0",
|
||||
function ()
|
||||
local common = { text = "MOC widget ", position = "top_middle", timeout = 2 }
|
||||
if moc.timer.started then
|
||||
moc.timer:stop()
|
||||
common.text = common.text .. markup.bold("OFF")
|
||||
else
|
||||
moc.timer:start()
|
||||
common.text = common.text .. markup.bold("ON")
|
||||
end
|
||||
naughty.notify(common)
|
||||
end),
|
||||
```
|
||||
@@ -1,172 +0,0 @@
|
||||
## Usage
|
||||
|
||||
[Read here.](https://github.com/copycat-killer/lain/wiki/Widgets#usage)
|
||||
|
||||
### Description
|
||||
|
||||
Shows MPD status.
|
||||
|
||||
```lua
|
||||
local mympd = lain.widget.mpd()
|
||||
```
|
||||
|
||||
Now playing songs are notified like this:
|
||||
|
||||
+--------------------------------------------------------+
|
||||
| +-------+ |
|
||||
| |/^\_/^\| Now playing |
|
||||
| |\ O O /| Cannibal Corpse (Hammer Smashed Face) - 1993 |
|
||||
| | '.o.' | Hammer Smashed Face (Radio Disney Version) |
|
||||
| +-------+ |
|
||||
+--------------------------------------------------------+
|
||||
|
||||
**Note:** if MPD is turned off or not set correctly, the widget will constantly display "N/A" values.
|
||||
|
||||
## Input table
|
||||
|
||||
Variable | Meaning | Type | Default
|
||||
--- | --- | --- | ---
|
||||
`timeout` | Refresh timeout seconds | number | 2
|
||||
`password` | MPD password | string | ""
|
||||
`host` | MPD server | string | "127.0.0.1"
|
||||
`port` | MPD port | string | "6600"
|
||||
`music_dir` | Music directory | string | "~/Music"
|
||||
`cover_size` | Album art notification size | number | 100
|
||||
`cover_pattern` | Pattern for the album art file | string | `*\\.(jpg|jpeg|png|gif)`*
|
||||
`default_art` | Default art | string | `nil`
|
||||
`notify` | Show notification popups | string | "on"
|
||||
`followtag` | Notification behaviour | boolean | false
|
||||
`settings` | User settings | function | empty function
|
||||
|
||||
\* In Lua, "\\\\" means "\" escaped.
|
||||
|
||||
Default `cover_pattern` definition will made the widget set the first jpg, jpeg, png or gif file found in the directory as the album art.
|
||||
|
||||
Pay attention to case sensitivity when defining `music_dir`.
|
||||
|
||||
`settings` can use `mpd_now` table, which contains the following values:
|
||||
|
||||
(**note:** the first four are boolean [flags](https://github.com/copycat-killer/lain/pull/205), the remaining are all strings)
|
||||
|
||||
- random_mode
|
||||
- single_mode
|
||||
- repeat_mode
|
||||
- consume_mode
|
||||
- pls_pos (playlist position)
|
||||
- pls_len (playlist length)
|
||||
- state (possible values: "play", "pause", "stop")
|
||||
- file
|
||||
- artist
|
||||
- title
|
||||
- name
|
||||
- album
|
||||
- track
|
||||
- genre
|
||||
- date
|
||||
- [time](https://github.com/copycat-killer/lain/pull/90) (length of current song, in seconds)
|
||||
- [elapsed](https://github.com/copycat-killer/lain/pull/90) (elapsed time of current song, in seconds)
|
||||
|
||||
and can modify `mpd_notification_preset` table, which will be the preset for the naughty notifications. Check [here](https://awesomewm.org/doc/api/libraries/naughty.html#notify) for the list of variables it can contain. Default definition:
|
||||
|
||||
```lua
|
||||
mpd_notification_preset = {
|
||||
title = "Now playing",
|
||||
timeout = 6,
|
||||
text = string.format("%s (%s) - %s\n%s", mpd_now.artist,
|
||||
mpd_now.album, mpd_now.date, mpd_now.title)
|
||||
}
|
||||
```
|
||||
|
||||
In multiple screen setups, the default behaviour is to show a visual notification pop-up window on the first screen. By setting `followtag` to `true` it will be shown on the currently focused tag screen.
|
||||
|
||||
## Output table
|
||||
|
||||
Variable | Meaning | Type
|
||||
--- | --- | ---
|
||||
`widget` | The textbox | `wibox.widget.textbox`
|
||||
`update` | Update `widget` | function
|
||||
`timer` | The widget timer | [`gears.timer`](https://awesomewm.org/doc/api/classes/gears.timer.html)
|
||||
|
||||
The `update` function can be used to refresh the widget before `timeout` expires.
|
||||
|
||||
You can use `timer` to start/stop the widget as you like.
|
||||
|
||||
## Keybindings
|
||||
|
||||
You can control the widget with keybindings like these:
|
||||
|
||||
```lua
|
||||
-- MPD control
|
||||
awful.key({ altkey, "Control" }, "Up",
|
||||
function ()
|
||||
awful.spawn.with_shell("mpc toggle || ncmpc toggle || pms toggle")
|
||||
mympd.update()
|
||||
end),
|
||||
awful.key({ altkey, "Control" }, "Down",
|
||||
function ()
|
||||
awful.spawn.with_shell("mpc stop || ncmpc stop || pms stop")
|
||||
mympd.update()
|
||||
end),
|
||||
awful.key({ altkey, "Control" }, "Left",
|
||||
function ()
|
||||
awful.spawn.with_shell("mpc prev || ncmpc prev || pms prev")
|
||||
mympd.update()
|
||||
end),
|
||||
awful.key({ altkey, "Control" }, "Right",
|
||||
function ()
|
||||
awful.spawn.with_shell("mpc next || ncmpc next || pms next")
|
||||
mympd.update()
|
||||
end),
|
||||
```
|
||||
|
||||
where `altkey = "Mod1"`.
|
||||
|
||||
If you don't use the widget for long periods and wish to spare CPU, you can toggle it with a keybinding like this:
|
||||
|
||||
```lua
|
||||
-- disable MPD widget
|
||||
awful.key({ altkey }, "0",
|
||||
function ()
|
||||
local common = {
|
||||
text = "MPD widget ",
|
||||
position = "top_middle",
|
||||
timeout = 2
|
||||
}
|
||||
if mympd.timer.started then
|
||||
mympd.timer:stop()
|
||||
common.text = common.text .. markup.bold("OFF")
|
||||
else
|
||||
mympd.timer:start()
|
||||
common.text = common.text .. markup.bold("ON")
|
||||
end
|
||||
naughty.notify(common)
|
||||
end),
|
||||
```
|
||||
|
||||
## Notes
|
||||
|
||||
### Always use `set_markup`
|
||||
|
||||
In `settings`, if you use `widget:set_text`, [it will ignore Pango markup](https://github.com/copycat-killer/lain/issues/258), so be sure to always use `widget:set_markup`.
|
||||
|
||||
### Volume fade in toggling MPD
|
||||
|
||||
If you want a fade in/out in toggling MPD, you can put [this script](https://gist.github.com/copycat-killer/76e315bc27c6cdf7edd5021964b88df1) in your local `bin` directory:
|
||||
|
||||
```shell
|
||||
$ curl https://gist.githubusercontent.com/copycat-killer/76e315bc27c6cdf7edd5021964b88df1/raw/97f7ba586418a4e07637cfbc91d2974278dfa623/mpd-fade -o ~/bin/mpc-fade
|
||||
$ chmod +x ~/bin/mpc-fade
|
||||
```
|
||||
|
||||
Set your 1% decrease/increase commands [here](https://gist.github.com/copycat-killer/76e315bc27c6cdf7edd5021964b88df1#file-mpd-fade-L8-L9), then use a keybinding like this:
|
||||
|
||||
```lua
|
||||
-- MPD toggle with volume fading
|
||||
awful.key({ "Shift" }, "Pause",
|
||||
function()
|
||||
awful.spawn.easy_async("mpc-fade 20 4", -- mpc-fade <percentage> <length in secs>
|
||||
function(stdout, stderr, reason, exit_code)
|
||||
mympd.update()
|
||||
end)
|
||||
end),
|
||||
```
|
||||
@@ -1,69 +0,0 @@
|
||||
## Usage
|
||||
|
||||
[Read here.](https://github.com/copycat-killer/lain/wiki/Widgets#usage)
|
||||
|
||||
### Description
|
||||
|
||||
Monitors network interfaces and shows current traffic.
|
||||
|
||||
```lua
|
||||
local mynet = lain.widget.net()
|
||||
```
|
||||
|
||||
## Input table
|
||||
|
||||
Variable | Meaning | Type | Default
|
||||
--- | --- | --- | ---
|
||||
`timeout` | Refresh timeout seconds | number | 2
|
||||
`iface` | Network device(s) | string (single interface) or array of strings (multiple interfaces) | autodetected
|
||||
`units` | Units | number | 1024 (kilobytes)
|
||||
`notify` | Display "no carrier" notifications | string | "on"
|
||||
`screen` | Notifications screen | number | 1
|
||||
`settings` | User settings | function | empty function
|
||||
|
||||
`iface` can be a string or an array of the form `{ "eth0", "eth1", ... }` containing a list of the devices to collect data on.
|
||||
|
||||
If more than one device is included, `net_now.sent` and `net_now.received` will contain cumulative values over all given devices.
|
||||
Use `net_now.devices["eth0"]` to access `sent`, `received`, `state` or `carrier` per device.
|
||||
|
||||
Possible alternative values for `units` are 1 (byte) or multiple of 1024: 1024^2 (mb), 1024^3 (gb), and so on.
|
||||
|
||||
If `notify = "off"` is set, the widget won't display a notification when there's no carrier.
|
||||
|
||||
`settings` can use the following `iface` related strings:
|
||||
|
||||
- `net_now.carrier` ("0", "1");
|
||||
- `net_now.state` ("up", "down");
|
||||
- `net_now.sent` and `net_now.received` (numbers) will be the sum across all specified interfaces;
|
||||
- `net_now.devices["interface"]` contains the same attributes as the old api for each interface. More on this in the "Multiple devices" section below.
|
||||
|
||||
For compatibility reasons, if multiple devices are given, `net_now.carrier` and `net_now.state` correspond to the last interface in the iface array and should not be relied upon (deprecated).
|
||||
|
||||
## Output table
|
||||
|
||||
Variable | Meaning | Type
|
||||
--- | --- | ---
|
||||
`widget` | The widget | `wibox.widget.textbox`
|
||||
`update` | Update `widget` | function
|
||||
|
||||
## Notes
|
||||
|
||||
### Setting `iface` manually
|
||||
|
||||
If the widget [spawns a "no carrier" notification and you are sure to have an active network device](https://github.com/copycat-killer/lain/issues/102), then autodetection is probably not working. This may due to [your user privileges](https://github.com/copycat-killer/lain/issues/102#issuecomment-246470526). In this case you can set `iface` manually. You can see which device is **UP,LOWER_UP** with the following command:
|
||||
|
||||
```shell
|
||||
ip link show
|
||||
```
|
||||
|
||||
### Two widgets for upload/download rates from the same `iface`
|
||||
|
||||
```lua
|
||||
local mynetdown = wibox.widget.textbox()
|
||||
local mynetup = lain.widgets.net {
|
||||
settings = function()
|
||||
widget:set_markup(net_now.sent)
|
||||
netdowninfo:set_markup(net_now.received)
|
||||
end
|
||||
}
|
||||
```
|
||||
@@ -1,135 +0,0 @@
|
||||
## Usage
|
||||
|
||||
[Read here.](https://github.com/copycat-killer/lain/wiki/Widgets#usage)
|
||||
|
||||
### Description
|
||||
|
||||
Shows and controls PulseAudio volume.
|
||||
|
||||
```lua
|
||||
local volume = lain.widget.pulse()
|
||||
```
|
||||
|
||||
## Input table
|
||||
|
||||
Variable | Meaning | Type | Default
|
||||
--- | --- | --- | ---
|
||||
`timeout` | Refresh timeout seconds | number | 5
|
||||
`devicetype` | PulseAudio device type | string ("sink", "source") | "sink"
|
||||
`cmd` | PulseAudio command | string or function | see [here](https://github.com/copycat-killer/lain/blob/master/widget/pulse.lua#L26)
|
||||
`settings` | User settings | function | empty function
|
||||
|
||||
`cmd` is a terminal command to catch infos from current default device. You can redefine it, being sure that the ouput is something like this:
|
||||
|
||||
```shell
|
||||
* index: 0
|
||||
volume: front-left: 18340 / 28% / -33.18 dB, front-right: 18340 / 28% / -33.18 dB
|
||||
muted: no
|
||||
device.string = "front:1"
|
||||
```
|
||||
|
||||
If your devices change dinamically, you can define it as a function which returns a command string.
|
||||
|
||||
If sed doesn't work, you can try with a grep variant:
|
||||
|
||||
```lua
|
||||
cmd = "pacmd list-" .. pulse.devicetype .. "s | grep -e $(pactl info | grep -e 'ink' | cut -d' ' -f3) -e 'volume: front' -e 'muted'"
|
||||
```
|
||||
|
||||
### `settings` variables
|
||||
|
||||
`settings` can use the following variables:
|
||||
|
||||
Variable | Meaning | Type | Values
|
||||
--- | --- | --- | ---
|
||||
`volume_now.device` | Device name | string | device name or "N/A"
|
||||
`volume_now.index` | Device index | string | >= "0"
|
||||
`volume_now.muted` | Device mute status | string | "yes", "no", "N/A"
|
||||
`volume_now.channel` | Device channels | table of string integers | `volume_now.channel[i]`, where `i >= 1`
|
||||
`volume_now.left` | Front left sink level or first source | string | "0"-"100"
|
||||
`volume_now.right` | Front right sink level or second source | string | "0"-"100"
|
||||
|
||||
`volume_now.channel` is a table of your PulseAudio devices. Fetch a channel level like this: `volume_now.channel[i]`, where `i >= 1`.
|
||||
|
||||
`volume_now.{left,right}` are pointers for `volume_now.{channel[1], channel[2]}` (stereo).
|
||||
|
||||
## Output table
|
||||
|
||||
Variable | Meaning | Type
|
||||
--- | --- | ---
|
||||
`widget` | The widget | `wibox.widget.textbox`
|
||||
`update` | Update `widget` | function
|
||||
|
||||
## Buttons
|
||||
|
||||
```lua
|
||||
volume.widget:buttons(awful.util.table.join(
|
||||
awful.button({}, 1, function() -- left click
|
||||
awful.spawn("pavucontrol")
|
||||
end),
|
||||
awful.button({}, 2, function() -- middle click
|
||||
awful.spawn(string.format("pactl set-sink-volume %d 100%%", volume.sink))
|
||||
volume.update()
|
||||
end),
|
||||
awful.button({}, 3, function() -- right click
|
||||
awful.spawn(string.format("pactl set-sink-mute %d toggle", volume.sink))
|
||||
volume.update()
|
||||
end),
|
||||
awful.button({}, 4, function() -- scroll up
|
||||
awful.spawn(string.format("pactl set-sink-volume %d +1%%", volume.sink))
|
||||
volume.update()
|
||||
end),
|
||||
awful.button({}, 5, function() -- scroll down
|
||||
awful.spawn(string.format("pactl set-sink-volume %d -1%%", volume.sink))
|
||||
volume.update()
|
||||
end)
|
||||
))
|
||||
```
|
||||
|
||||
## Keybindings
|
||||
|
||||
```lua
|
||||
-- PulseAudio volume control
|
||||
awful.key({ altkey }, "Up",
|
||||
function ()
|
||||
os.execute(string.format("pactl set-sink-volume %d +1%%", volume.sink))
|
||||
volume.update()
|
||||
end),
|
||||
awful.key({ altkey }, "Down",
|
||||
function ()
|
||||
os.execute(string.format("pactl set-sink-volume %d -1%%", volume.sink))
|
||||
volume.update()
|
||||
end),
|
||||
awful.key({ altkey }, "m",
|
||||
function ()
|
||||
os.execute(string.format("pactl set-sink-mute %d toggle", volume.sink))
|
||||
volume.update()
|
||||
end),
|
||||
awful.key({ altkey, "Control" }, "m",
|
||||
function ()
|
||||
os.execute(string.format("pactl set-sink-volume %d 100%%", volume.sink))
|
||||
volume.update()
|
||||
end),
|
||||
awful.key({ altkey, "Control" }, "0",
|
||||
function ()
|
||||
os.execute(string.format("pactl set-sink-volume %d 0%%", volume.sink))
|
||||
volume.update()
|
||||
end),
|
||||
```
|
||||
|
||||
where `altkey = "Mod1"`.
|
||||
|
||||
## Example
|
||||
|
||||
```lua
|
||||
-- PulseAudio volume (based on multicolor theme)
|
||||
local volume = lain.widget.pulse {
|
||||
settings = function()
|
||||
vlevel = volume_now.left .. "-" .. volume_now.right .. "% | " .. volume_now.device
|
||||
if volume_now.muted == "yes" then
|
||||
vlevel = vlevel .. " M"
|
||||
end
|
||||
widget:set_markup(lain.util.markup("#7493d2", vlevel))
|
||||
end
|
||||
}
|
||||
```
|
||||
@@ -1,89 +0,0 @@
|
||||
## Usage
|
||||
|
||||
[Read here.](https://github.com/copycat-killer/lain/wiki/Widgets#usage)
|
||||
|
||||
### Description
|
||||
|
||||
Shows PulseAudio volume with a progressbar; provides tooltips and notifications.
|
||||
|
||||
```lua
|
||||
local volume = lain.widget.pulsebar()
|
||||
```
|
||||
|
||||
## Input table
|
||||
|
||||
Variable | Meaning | Type | Default
|
||||
--- | --- | --- | ---
|
||||
`timeout` | Refresh timeout seconds | number | 5
|
||||
`settings` | User settings | function | empty function
|
||||
`width` | Bar width | number | 63
|
||||
`height` | Bar height | number | 1
|
||||
`ticks` | Set bar ticks on | boolean | false
|
||||
`ticks_size` | Ticks size | number | 7
|
||||
`colors` | Bar colors | table | see [Default colors](https://github.com/copycat-killer/lain/wiki/pulsebar#default-colors)
|
||||
`followtag` | Display the notification on currently focused screen | boolean | false
|
||||
`notification_preset` | Notification preset | table | See [default `notification_preset`](https://github.com/copycat-killer/lain/wiki/pulsebar#default-notification_preset)
|
||||
`devicetype` | PulseAudio device type | string ("sink", "source") | "sink"
|
||||
`cmd` | PulseAudio command | string or function | see [here](https://github.com/copycat-killer/lain/blob/master/widget/pulsebar.lua#L48)
|
||||
|
||||
Read [pulse](https://github.com/copycat-killer/lain/wiki/pulse) page for `cmd` settings.
|
||||
|
||||
`settings` can use [these variables](https://github.com/copycat-killer/lain/wiki/pulse#settings-variables).
|
||||
|
||||
With multiple screens, the default behaviour is to show a visual notification pop-up window on the first screen. By setting `followtag` to `true` it will be shown on the currently focused tag screen.
|
||||
|
||||
### Default colors
|
||||
|
||||
Variable | Meaning | Type | Default
|
||||
--- | --- | --- | ---
|
||||
`background` | Bar backgrund color | string | "#000000"
|
||||
`mute` | Bar mute color | string | "#EB8F8F"
|
||||
`unmute` | Bar unmute color | string | "#A4CE8A"
|
||||
|
||||
### Default `notification_preset`
|
||||
|
||||
```lua
|
||||
notification_preset = {
|
||||
font = "Monospace 10"
|
||||
}
|
||||
```
|
||||
|
||||
## Output table
|
||||
|
||||
Variable | Meaning | Type
|
||||
--- | --- | ---
|
||||
`bar` | The widget | `wibox.widget.progressbar`
|
||||
`device` | PulseAudio device | string
|
||||
`notify` | The notification | function
|
||||
`update` | Update state | function
|
||||
`tooltip` | The tooltip | `awful.tooltip`
|
||||
|
||||
## Buttons
|
||||
|
||||
```lua
|
||||
volume.bar:buttons(awful.util.table.join(
|
||||
awful.button({}, 1, function() -- left click
|
||||
awful.spawn("pavucontrol")
|
||||
end),
|
||||
awful.button({}, 2, function() -- middle click
|
||||
awful.spawn(string.format("pactl set-sink-volume %d 100%%", volume.sink))
|
||||
volume.update()
|
||||
end),
|
||||
awful.button({}, 3, function() -- right click
|
||||
awful.spawn(string.format("pactl set-sink-mute %d toggle", volume.sink))
|
||||
volume.update()
|
||||
end),
|
||||
awful.button({}, 4, function() -- scroll up
|
||||
awful.spawn(string.format("pactl set-sink-volume %d +1%%", volume.sink))
|
||||
volume.update()
|
||||
end),
|
||||
awful.button({}, 5, function() -- scroll down
|
||||
awful.spawn(string.format("pactl set-sink-volume %d -1%%", volume.sink))
|
||||
volume.update()
|
||||
end)
|
||||
))
|
||||
```
|
||||
|
||||
## Keybindings
|
||||
|
||||
Same as [here](https://github.com/copycat-killer/lain/wiki/pulse#keybindings). If you want notifications, use `volume.notify()` instead of `volume.update()`.
|
||||
@@ -1,100 +0,0 @@
|
||||
### What is Redshift? #
|
||||
|
||||
[**Project homepage**](http://jonls.dk/redshift/)
|
||||
|
||||
>**Redshift** is an application that adjusts the computer display's color temperature based upon the Sun's apparent position in relation to the user's location on Earth.
|
||||
|
||||
>The program is free software, inspired by the proprietary f.lux, and can be used to reduce eye strain as well as insomnia and delayed sleep phase syndrome.
|
||||
|
||||
>The computer display's color temperature transitions evenly from night to daytime temperature to allow the user's eyes to slowly adapt. At night, the color temperature is low and is typically 3000–4000 K (default is 3500 K), preferably matching the room's lighting temperature. Typical color temperature during the daytime is 5500–6500 K (default is 5500 K).
|
||||
|
||||
**Source:** [Wikipedia](https://en.wikipedia.org/wiki/Redshift_%28software%29)
|
||||
|
||||
### Preparations
|
||||
|
||||
**Redshift must be installed** on your system if you want to use this widget.
|
||||
|
||||
Packages should be available for most distributions. Source code and build instructions can be found on Github [here](https://github.com/jonls/redshift).
|
||||
|
||||
You also need a valid config file. Please see the [project homepage](http://jonls.dk/redshift/) for details. An example: [`~/.config/redshift.conf`](https://github.com/jonls/redshift/blob/master/redshift.conf.sample).
|
||||
|
||||
You have to match the location settings to your personal situation: you can adjust the `lat` and `lon` variables using a [web service](https://encrypted.google.com/search?q=get+latitude+and+longitude).
|
||||
|
||||
You might also want to modify the color temperatures to fit your preferences.
|
||||
|
||||
### Using the widget
|
||||
|
||||
This widget provides the following functions:
|
||||
|
||||
| function | meaning |
|
||||
| --- | --- |
|
||||
| `redshift:toggle()` | Toggles Redshift adjustments on or off, and also restarts it if terminates. |
|
||||
| `redshift:attach(widget, update_function)` | Attach to a widget. Click on the widget to toggle redshift on or off. `update_function` is a callback function which will be triggered each time Redshift changes its status. (See the examples below.) |
|
||||
|
||||
### Usage examples
|
||||
|
||||
#### Textbox status widget
|
||||
|
||||
```lua
|
||||
myredshift = wibox.widget.textbox()
|
||||
lain.widget.contrib.redshift:attach(
|
||||
myredshift,
|
||||
function (active)
|
||||
if active then
|
||||
myredshift:set_text("RS on")
|
||||
else
|
||||
myredshift:set_text("RS off")
|
||||
end
|
||||
end
|
||||
)
|
||||
```
|
||||
|
||||
Then add `myredshift.widget` to your wibox.
|
||||
|
||||
#### Checkbox status widget
|
||||
|
||||
```lua
|
||||
local markup = lain.util.markup
|
||||
|
||||
local myredshift = wibox.widget{
|
||||
checked = false,
|
||||
check_color = "#EB8F8F",
|
||||
border_color = "#EB8F8F",
|
||||
border_width = 1,
|
||||
shape = gears.shape.square,
|
||||
widget = wibox.widget.checkbox
|
||||
}
|
||||
|
||||
local myredshift_text = wibox.widget{
|
||||
align = "center",
|
||||
widget = wibox.widget.textbox,
|
||||
}
|
||||
|
||||
local myredshift_stack = wibox.widget{
|
||||
myredshift,
|
||||
myredshift_text,
|
||||
layout = wibox.layout.stack
|
||||
}
|
||||
|
||||
lain.widget.contrib.redshift:attach(
|
||||
myredshift,
|
||||
function (active)
|
||||
if active then
|
||||
myredshift_text:set_markup(markup(beautiful.bg_normal, "<b>R</b>"))
|
||||
else
|
||||
myredshift_text:set_markup(markup(beautiful.fg_normal, "R"))
|
||||
end
|
||||
myredshift.checked = active
|
||||
end
|
||||
)
|
||||
```
|
||||
|
||||
Then add the `myredshift_stack` widget to your wibox.
|
||||
|
||||
#### Keybinding
|
||||
|
||||
Add this to the keybindings in your `rc.lua`:
|
||||
```lua
|
||||
-- Toggle redshift with Mod+Shift+t
|
||||
awful.key({ modkey, "Shift" }, "t", function () lain.widget.contrib.redshift:toggle() end),
|
||||
```
|
||||
@@ -1,27 +0,0 @@
|
||||
## Usage
|
||||
|
||||
[Read here.](https://github.com/copycat-killer/lain/wiki/Widgets#usage)
|
||||
|
||||
### Description
|
||||
|
||||
Shows the current system load.
|
||||
|
||||
```lua
|
||||
mysysload = lain.widget.sysload()
|
||||
```
|
||||
|
||||
## Input table
|
||||
|
||||
Variable | Meaning | Type | Default
|
||||
--- | --- | --- | ---
|
||||
`timeout` | Refresh timeout seconds | number | 2
|
||||
`settings` | User settings | function | empty function
|
||||
|
||||
`settings` can use strings `load_1`, `load_5` and `load_15`, which are the load averages over 1, 5, and 15 minutes.
|
||||
|
||||
## Output table
|
||||
|
||||
Variable | Meaning | Type
|
||||
--- | --- | ---
|
||||
`widget` | The widget | `wibox.widget.textbox`
|
||||
`update` | Update `widget` | function
|
||||
@@ -1,51 +0,0 @@
|
||||
## Usage
|
||||
|
||||
[Read here.](https://github.com/copycat-killer/lain/wiki/Widgets#usage)
|
||||
|
||||
### Description
|
||||
|
||||
Attaches a [taskwarrior](http://taskwarrior.org) notifications to a widget, and lets you execute `task` commands from the promptbox.
|
||||
|
||||
```lua
|
||||
lain.widget.contrib.task.attach(widget, args)
|
||||
```
|
||||
|
||||
`args` is an optional table which can contain:
|
||||
|
||||
Variable | Meaning | Type | Default
|
||||
--- | --- | --- | ---
|
||||
`show_cmd` | Taskwarrior command to show in the popup | string | "task next"
|
||||
`prompt_text` | Prompt text | string | "Enter task command: "
|
||||
`followtag` | Display the notification on currently focused screen | boolean | false
|
||||
`notification_preset` | Notification preset | table | See [default `notification_preset`](https://github.com/copycat-killer/lain/wiki/task#default-notification_preset)
|
||||
|
||||
The tasks are shown in a notification popup when the mouse is moved over the attached `widget`, and the popup is hidden when the mouse is moved away. By default, the notification will show the output of `task next`. With `show_cmd`, the `task` popup command can be customized, for example if you want to [filter the tasks](https://taskwarrior.org/docs/filter.html) or show a [custom report](https://github.com/copycat-killer/lain/pull/213).
|
||||
|
||||
In multiple screen setups, the default behaviour is to show a visual notification pop-up window on the first screen. By setting `followtag` to `true` it will be shown on the currently focused tag screen.
|
||||
|
||||
You can call the notification with a keybinding like this:
|
||||
|
||||
```lua
|
||||
awful.key({ modkey, altkey }, "t", function () lain.widget.contrib.task.show(scr) end),
|
||||
```
|
||||
|
||||
where ``altkey = "Mod1"`` and `scr` (optional) indicates the screen which you want the notification in.
|
||||
|
||||
And you can prompt to input a `task` command with a keybinding like this:
|
||||
|
||||
```lua
|
||||
awful.key({ altkey }, "t", lain.widget.contrib.task.prompt),
|
||||
```
|
||||
|
||||
### Default `notification_preset`
|
||||
|
||||
```lua
|
||||
notification_preset = {
|
||||
font = "Monospace 10",
|
||||
icon = helpers.icons_dir .. "/taskwarrior.png"
|
||||
}
|
||||
```
|
||||
|
||||
## Note
|
||||
|
||||
* If your widget does not display `task next` output, try changing Taskwarrior verbose, for instance: `show_cmd = 'task rc.verbose:label'` or `show_cmd = 'task rc.verbose:nothing'`.
|
||||
@@ -1,32 +0,0 @@
|
||||
## Usage
|
||||
|
||||
[Read here.](https://github.com/copycat-killer/lain/wiki/Widgets#usage)
|
||||
|
||||
### Description
|
||||
|
||||
Shows the current CPU temperature.
|
||||
|
||||
```lua
|
||||
local mytemp = lain.widget.temp()
|
||||
```
|
||||
|
||||
## Input table
|
||||
|
||||
Variable | Meaning | Type | Default
|
||||
--- | --- | --- | ---
|
||||
`timeout` | Refresh timeout seconds | number | 2
|
||||
`tempfile` | Path of file which stores core temperature value | string | "/sys/class/thermal/thermal_zone0/temp"
|
||||
`settings` | User settings | function | empty function
|
||||
|
||||
`settings` can use the string `coretemp_now`, which means current core temperature, expressed in Celsius (linux standard).
|
||||
|
||||
## Output table
|
||||
|
||||
Variable | Meaning | Type
|
||||
--- | --- | ---
|
||||
`widget` | The widget | `wibox.widget.textbox`
|
||||
`update` | Update `widget` | function
|
||||
|
||||
## Note
|
||||
|
||||
Depending on the architecture, note that your temp files location [might vary](https://github.com/copycat-killer/lain/issues/84#issuecomment-72751763).
|
||||
@@ -1,30 +0,0 @@
|
||||
## Usage
|
||||
|
||||
[Read here.](https://github.com/copycat-killer/lain/wiki/Widgets#usage)
|
||||
|
||||
### Description
|
||||
|
||||
A battery widget that works with Lenovo ThinkPad laptops using [tp_smapi](http://www.thinkwiki.org/wiki/Tp_smapi).
|
||||
|
||||
Includes hover notification with more details.
|
||||
|
||||
```lua
|
||||
local mytpbat = lain.widget.contrib.tpbat()
|
||||
```
|
||||
|
||||
## Input table
|
||||
|
||||
Variable | Meaning | Type | Default
|
||||
--- | --- | --- | ---
|
||||
`timeout` | Refresh timeout seconds | number | 30
|
||||
`battery` | Single battery id | string | "BAT0"
|
||||
`settings` | User settings | function | empty function
|
||||
|
||||
## Output table
|
||||
|
||||
Variable | Meaning | Type
|
||||
--- | --- | ---
|
||||
`widget` | The widget | `wibox.widget.textbox`
|
||||
`update` | Update `widget` | function
|
||||
|
||||
The `update` function can be used to refresh the widget before `timeout` expires.
|
||||
@@ -1,149 +0,0 @@
|
||||
## Usage
|
||||
|
||||
[Read here.](https://github.com/copycat-killer/lain/wiki/Widgets#usage)
|
||||
|
||||
### Description
|
||||
|
||||
Provides current weather status widgets and X-days forecast popup notifications.
|
||||
|
||||
Uses [OpenWeatherMap](http://openweathermap.org/api) API.
|
||||
|
||||
By default, it uses [current](http://openweathermap.org/current) for current weather data and [forecast16](http://openweathermap.org/forecast16) for forecasts.
|
||||
|
||||
```lua
|
||||
local myweather = lain.widget.weather()
|
||||
```
|
||||
|
||||
## Input table
|
||||
|
||||
Variable | Meaning | Type | Default
|
||||
--- | --- | --- | ---
|
||||
`timeout` | Refresh timeout seconds for current weather status | number | 900 (15 min)
|
||||
`timeout_forecast` | Refresh timeout seconds for forecast notification | number | 86400 (24 hrs)
|
||||
`current_call` | Command to fetch weather status data from the API | string | see `default_current_call`
|
||||
`forecast_call` | Command to fetch forecast data from the API | string | see `default_forecast_call`
|
||||
`city_id` | API city code | number | not set
|
||||
`units` | Temperature units system | string | "metric"
|
||||
`lang` | API data localization | string | "en"
|
||||
`cnt` | Forecast days interval | number | 5
|
||||
`date_cmd` | Forecast notification format style | string | "date -u -d @%d +'%%a %%d'"
|
||||
`icons_path` | Icons path | string | `lain/icons/openweathermap`
|
||||
`notification_preset` | Preset for notifications | table | empty table
|
||||
`notification_text_fun` | Function to format forecast notifications | function | see `notification_text_fun`
|
||||
`weather_na_markup` | Markup to be used when weather textbox is not available | text | " N/A "
|
||||
`followtag` | Display the notification on currently focused screen | boolean | false
|
||||
`showpopup` | Display popups with mouse hovering | string, possible values: "on", "off" | "on"
|
||||
`settings` | User settings | function | empty function
|
||||
|
||||
- ``default_current_call``
|
||||
|
||||
`"curl -s 'http://api.openweathermap.org/data/2.5/weather?id=%s&units=%s&lang=%s'"`
|
||||
|
||||
You can rewrite it using any fetcher solution you like, or you can modify it in order to fetch data by city name, instead of ID: just replace `id` with `q`:
|
||||
|
||||
`"curl -s 'http://api.openweathermap.org/data/2.5/weather?q=%s&units=%s&lang=%s'"`
|
||||
|
||||
and set `city_id` with your city name, for instance `city_id = "London,UK"`.
|
||||
|
||||
- ``default_forecast_call``
|
||||
|
||||
`"curl -s 'http://api.openweathermap.org/data/2.5/forecast/daily?id=%s&units=%s&lang=%s&cnt=%s'"`
|
||||
|
||||
Like above.
|
||||
If you want to use [forecast5](http://openweathermap.org/forecast5), use this API call string:
|
||||
`http://api.openweathermap.org/data/2.5/forecast?id=%s&units=%s&lang=%s&cnt=%s`
|
||||
|
||||
- ``city_id``
|
||||
|
||||
An integer that defines the OpenWeatherMap ID code of your city.
|
||||
To obtain it go to [OpenWeatherMap](http://openweathermap.org/) and query for your city in the top search bar. The link will look like this:
|
||||
|
||||
http://openweathermap.org/city/2643743
|
||||
|
||||
your `city_id` is the number at the end.
|
||||
|
||||
- ``units``
|
||||
|
||||
- For temperature in Fahrenheit use `units = "imperial"`
|
||||
- For temperature in Celsius use `units = "metric"` (Lain default)
|
||||
- For temperature in Kelvin use `units = "standard"` (OpenWeatherMap default)
|
||||
|
||||
- ``lang``
|
||||
|
||||
See *Multilingual Support* section [here](http://openweathermap.org/current).
|
||||
|
||||
- ``cnt``
|
||||
|
||||
Determines how many days to show in the forecast notification. Up to 16 if you use [forecast16](http://openweathermap.org/forecast16) (default), and up to 5 if you use [forecast5](http://openweathermap.org/forecast5).
|
||||
|
||||
- ``date_cmd``
|
||||
|
||||
OpenWeatherMap time is in UNIX format, so this variable uses `date` to determine how each line in the forecast notification is formatted. Default looks like this:
|
||||
|
||||
day #daynumber: forecast, temp_min - temp_max
|
||||
|
||||
see `man date` for your customizations.
|
||||
|
||||
- ``icons_path``
|
||||
|
||||
You can set your own icons path if you don't wish to use `lain/icons/openweathermap`. Just be sure that your icons are PNGs and named exactly like [OpenWeatherMap ones](http://openweathermap.org/weather-conditions).
|
||||
|
||||
- ``notification_preset``
|
||||
|
||||
Notifications preset table. See [here](https://awesomewm.org/doc/api/libraries/naughty.html#notify) for the details.
|
||||
|
||||
- ``notification_text_fun``
|
||||
```lua
|
||||
function (wn)
|
||||
local day = string.gsub(read_pipe(string.format(date_cmd, wn["dt"])), "\n", "")
|
||||
local tmin = math.floor(wn["temp"]["min"])
|
||||
local tmax = math.floor(wn["temp"]["max"])
|
||||
local desc = wn["weather"][1]["description"]
|
||||
|
||||
return string.format("<b>%s</b>: %s, %d - %d ", day, desc, tmin, tmax)
|
||||
end
|
||||
```
|
||||
See [here](https://github.com/copycat-killer/lain/issues/186#issuecomment-203400918) for a complete customization example.
|
||||
|
||||
- ``followtag``
|
||||
|
||||
In multiple screen setups, the default behaviour is to show a visual notification pop-up window on the first screen. By setting `followtag` to `true` it will be shown on the currently focused tag screen.
|
||||
|
||||
- ``settings``
|
||||
|
||||
In your `settings` function, you can use `widget` variable to refer to the textbox, and the dictionary `weather_now` to refer to data retrieved by `current_call`. The dictionary is built with [dkjson library](http://dkolf.de/src/dkjson-lua.fsl/home), and its structure is defined [here](http://openweathermap.org/weather-data).
|
||||
For instance, you can retrieve current weather status and temperature in this way:
|
||||
```lua
|
||||
descr = weather_now["weather"][1]["description"]:lower()
|
||||
units = math.floor(weather_now["main"]["temp"])
|
||||
```
|
||||
|
||||
## Output table
|
||||
|
||||
Variable | Meaning | Type
|
||||
--- | --- | ---
|
||||
`widget` | The widget | `wibox.widget.textbox`
|
||||
`icon` | The icon | `wibox.widget.imagebox`
|
||||
`update` | Update `widget` | function
|
||||
`timer` | The widget timer | [`gears.timer`](https://awesomewm.org/doc/api/classes/gears.timer.html)
|
||||
`timer_forecast` | The forecast notification timer | [`gears.timer`](https://awesomewm.org/doc/api/classes/gears.timer.html)
|
||||
|
||||
## Functions
|
||||
|
||||
You can attach the forecast notification to any widget like this:
|
||||
|
||||
```lua
|
||||
myweather.attach(obj)
|
||||
```
|
||||
|
||||
Hovering over ``obj`` will display the notification.
|
||||
|
||||
## Keybindings
|
||||
|
||||
You can create a keybinding for the weather popup like this:
|
||||
|
||||
```lua
|
||||
awful.key( { "Mod1" }, "w", function () myweather.show(5) end )
|
||||
```
|
||||
|
||||
where ``show`` argument is an integer defining timeout seconds.
|
||||
Reference in New Issue
Block a user