2022-11-04 22:17:45 -07:00
|
|
|
## Modules
|
2022-07-16 18:00:58 -07:00
|
|
|
|
|
|
|
|
Modules are parts of this configuration that can be disabled. Nearly all features in this config are defined by a module.
|
|
|
|
|
|
2022-11-04 22:17:45 -07:00
|
|
|
### Enable / Disable Modules
|
|
|
|
|
|
|
|
|
|
See `config-template.lua`
|
|
|
|
|
|
|
|
|
|
### Organization
|
2022-07-16 18:00:58 -07:00
|
|
|
|
|
|
|
|
Every directory in `modules/` is a module. Modules cannot be in subdirectories. \
|
|
|
|
|
Each module directory MUST have an ``init.lua``, which returns a table. That table can contain anything, but a few keys are special:
|
|
|
|
|
|
|
|
|
|
``keybinds`` \
|
2022-11-05 08:08:15 -07:00
|
|
|
Defines keybinds the module provides. It is automatically loaded *if* the module is enabled. \
|
2022-07-16 18:00:58 -07:00
|
|
|
This MUST be a table formed by ``awful.key()``. See `ibus` or `screenshot` for examples.
|
|
|
|
|
|
|
|
|
|
``init`` \
|
2022-11-05 08:08:15 -07:00
|
|
|
Called once when awesome starts if defined. Takes no arguments.
|
|
|
|
|
|
|
|
|
|
``for_each_screen(s)`` \
|
|
|
|
|
Called for each screen at start if defined. Takes one argument, `s`, the screen.
|
