Miroirs/awesome
1
0
Fork 0
mirror of https://github.com/awesomeWM/awesome synced 2024-11-17 07:47:41 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

doc: Document the basic variables.

Browse source
This commit is contained in:
Emmanuel Lepage Vallee 2016-08-12 02:34:03 -04:00
parent abd2a271af
commit be8f0c376b
1 changed files with 60 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

60
lib/beautiful/init.lua
View file

@ -30,6 +30,66 @@ local descs = setmetatable({}, { __mode = 'k' })
local fonts = setmetatable({}, { __mode = 'v' })
local active_font
--- The default font.
-- @beautiful beautiful.font
-- The default background color.
-- @beautiful beautiful.bg_normal
-- The default focused element background color.
-- @beautiful beautiful.bg_focus
-- The default urgent element background color.
-- @beautiful beautiful.bg_urgent
-- The default minimized element background color.
-- @beautiful beautiful.bg_minimize
-- The system tray background color.
-- Please note that only solid colors are currently supported.
-- @beautiful beautiful.bg_systray
-- The default focused element foreground (text) color.
-- @beautiful beautiful.fg_normal
-- The default focused element foreground (text) color.
-- @beautiful beautiful.fg_focus
-- The default urgent element foreground (text) color.
-- @beautiful beautiful.fg_urgent
-- The default minimized element foreground (text) color.
-- @beautiful beautiful.fg_minimize
--- The gap between clients.
-- @beautiful beautiful.useless_gap
-- @param[opt=0] number
--- The client border width.
-- @beautiful beautiful.border_width
--- The default clients border width.
-- Note that only solid colors are supported.
-- @beautiful beautiful.border_normal
--- The focused client border width.
-- Note that only solid colors are supported.
-- @beautiful beautiful.border_focus
--- The marked clients border width.
-- Note that only solid colors are supported.
-- @beautiful beautiful.border_marked
--- The wallpaper path.
-- @beautiful beautiful.wallpaper
-- The icon theme name.
-- It has to be a directory in `/usr/share/icons` or an XDG icon folder.
-- @beautiful beautiful.icon_theme
--- The Awesome icon path.
-- @beautiful beautiful.awesome_icon
--- Load a font from a string or a font description.
--
-- @see https://developer.gnome.org/pango/stable/pango-Fonts.html#pango-font-description-from-string