Contents
1 Introduction
2 Preliminaries: Key concepts and relations
2.1 Modules
2.2 Class and object hierarchies
2.2.1 Class hierarchy
2.2.2 Object hierarchies: WRegion parents and managers
Parent–child relations
Manager–managed relations
2.2.3 Summary
3 Basic configuration
3.1 The configuration files
3.2 A walk through
cfg_ion.lua
3.3 Keys and rodents
3.3.1 Binding handlers and special variables
3.3.2 Guards
3.3.3 Defining the bindings
3.3.4 Examples
3.3.5 Key specifications
3.3.6 Button specifications
3.3.7 A further note on the default binding configuration
3.3.8 Client window bindings
3.4 Menus
3.4.1 Defining menus
3.4.2 Special menus
3.4.3 Defining context menus
3.4.4 Displaying menus
3.5 Winprops
3.5.1 Classes, roles and instances
3.5.2 Finding window identification with
xprop
3.5.3 Some common examples
Acrobat Reader
Fixing a Mozilla Firebird transient
Forcing newly created windows in named frames
4 Graphical styles
4.1 Drawing engines, style specifications and sub-styles
4.1.1 Known styles and substyles
Frames
Tabs and menu entries
The rest
4.2 Defining styles for the default drawing engine
4.2.1 The structure of the configuration files
4.2.2 Defining the styles
Colours
Borders and widths
Text
Miscellaneous
Substyles
4.2.3 An example
4.3 Miscellaneous settings
4.3.1 Extra fields for style
frame-ionframe
4.3.2 Extra fields for style
frame-floatframe
4.3.3 Extra fields for style
dock
5 Scripting
5.1 Hooks
5.2 Referring to regions
5.2.1 Direct object references
5.2.2 Name-based lookups
5.3 Alternative winprop selection criteria
5.4 Layers
5.5 Writing
ion-statusd
monitors
6 Function reference
6.1 Functions defined in
ioncore
6.1.1 WClientWin functions
6.1.2 WFrame functions
6.1.3 WInfoWin functions
6.1.4 WMPlex functions
6.1.5 WMoveresMode functions
6.1.6 WRegion functions
6.1.7 WRootWin functions
6.1.8 WScreen functions
6.1.9 WWindow functions
6.1.10 global functions
6.1.11 gr functions
6.1.12 string functions
6.1.13 table functions
6.2 Functions defined in
mod_ionws
6.2.1 WIonWS functions
6.2.2 WSplit functions
6.2.3 WSplitInner functions
6.2.4 WSplitRegion functions
6.2.5 WSplitSplit functions
6.3 Functions defined in
mod_floatws
6.3.1 WFloatFrame functions
6.3.2 WFloatWS functions
6.4 Functions defined in
mod_panews
6.4.1 WSplitPane functions
6.5 Functions defined in
mod_query
6.5.1 WComplProxy functions
6.5.2 WEdln functions
6.5.3 WInput functions
6.6 Functions defined in
mod_menu
6.6.1 WMenu functions
6.7 Functions defined in
mod_dock
6.7.1 WDock functions
6.8 Functions defined in
mod_sp
6.9 Functions defined in
de
6.10 Hooks
A The GNU General Public License
B Full class hierarchy visible to Lua-side