awesome

• Index

Contents

• Static module functions
• Theme variables
• Deprecated functions
• Tables
• Fields

Popups and bars

• awful.hotkeys_popup.widget
• awful.menu
• awful.popup
• awful.titlebar
• awful.tooltip
• awful.wallpaper
• awful.wibar
• awful.widget.calendar_popup
• menubar
• naughty.layout.box
• naughty.layout.legacy
• wibox

Core components

• awesome
• awful.keygrabber
• client and awful.client
• drawable
• gears.timer
• mousegrabber
• naughty.action
• naughty.notification
• root
• screen and awful.screen
• tag and awful.tag

Input handling

• awful.button
• awful.key
• awful.keyboard
• mouse

Declarative rules

• ruled.client
• ruled.notifications

Widgets

• awful.widget.button
• awful.widget.clienticon
• awful.widget.keyboardlayout
• awful.widget.launcher
• awful.widget.layoutbox
• awful.widget.layoutlist
• awful.widget.prompt
• awful.widget.taglist
• awful.widget.tasklist
• awful.widget.watch
• naughty.list.actions
• naughty.list.notifications
• naughty.widget.icon
• naughty.widget.message
• naughty.widget.title
• wibox.widget.calendar
• wibox.widget.checkbox
• wibox.widget.graph
• wibox.widget.imagebox
• wibox.widget.piechart
• wibox.widget.progressbar
• wibox.widget.separator
• wibox.widget.slider
• wibox.widget.systray
• wibox.widget.textbox
• wibox.widget.textclock

Widget containers

• awful.widget.only_on_screen
• naughty.widget.background
• wibox.container.arcchart
• wibox.container.background
• wibox.container.constraint
• wibox.container.margin
• wibox.container.mirror
• wibox.container.place
• wibox.container.radialprogressbar
• wibox.container.rotate
• wibox.container.scroll
• wibox.container.tile

Widget layouts

• wibox.layout.align
• wibox.layout.fixed
• wibox.layout.flex
• wibox.layout.grid
• wibox.layout.manual
• wibox.layout.ratio
• wibox.layout.stack

Utility libraries

• gears.debug
• gears.filesystem
• gears.geometry
• gears.math
• gears.object
• gears.protected_call
• gears.sort
• gears.string
• gears.table
• gears.wallpaper

Theme related libraries

• beautiful
• gears.color
• gears.shape

Libraries

• awful.completion
• awful.hotkeys_popup
• awful.layout
• awful.permissions
• awful.placement
• awful.prompt
• awful.rules
• awful.spawn
• awful.util
• dbus
• gears.matcher
• gears.surface
• menubar.menu_gen
• menubar.utils
• naughty
• selection
• wibox.widget

Sample files

• rc.lua
• theme.lua

Classes

• awful.screenshot
• awful.widget.common
• gears.cache
• gears.matrix
• menubar.icon_theme
• menubar.index_theme
• wibox.hierarchy
• wibox.widget.base
• xproperties

Documentation

• Authors
• Readme
• Contributing
• The Widget system
• Creating new widget
• Default configuration file documentation
• Change Awesome appearance
• My first Awesome
• The AwesomeWM client layout system
• Startup options
• Building and Testing
• Using Cairo and LGI
• Tips for upgrading your configuration
• NEWS
• FAQ

Module: menubar

Menubar module, which aims to provide a freedesktop menu alternative.

List of menubar keybindings:

Keybinding	Description
LeftC-j	select an item on the left
RightC-k	select an item on the right
Backspace	exit the current category if we are in any
Escape	exit the current directory or exit menubar
Home	select the first item
End	select the last
Return	execute the entry
C-Return	execute the command with awful.spawn
C-M-Return	execute the command in a terminal

Static module functions

menubar.refresh (scr)	Refresh menubar's cache by reloading .desktop files.
menubar.show (scr)	Show the menubar on the given screen.
menubar.hide ()	Hide the menubar.

Theme variables

beautiful.menubar_fg_normal	color	Menubar normal text color.
beautiful.menubar_bg_normal	color	Menubar normal background color.
beautiful.menubar_border_width	number	Menubar border width.
beautiful.menubar_border_color	color	Menubar border color.
beautiful.menubar_fg_focus	color	Menubar selected item text color.
beautiful.menubar_bg_focus	color	Menubar selected item background color.
beautiful.menubar_font	font	Menubar font.

Deprecated functions

menubar.get (scr)

Get a menubar wibox.

Deprecated

Tables

menubar.geometry	Specifies the geometry of the menubar.
menubar.prompt_args	Allows user to specify custom parameters for prompt.run function (like colors).

Fields

menubar.cache_entries	boolean	When true the .desktop files will be reparsed only when the extension is initialized.
menubar.show_categories	boolean	When true the categories will be shown alongside application entries.
menubar.match_empty	boolean	When false will hide results if the current query is empty
menubar.right_margin	number	Width of blank space left in the right side.
menubar.right_label	string	Label used for "Next page", default "▶▶".
menubar.left_label	string	Label used for "Previous page", default "◀◀".

Static module functions

🔗 menubar.refresh (scr)

Refresh menubar's cache by reloading .desktop files.

Parameters:

Name		Type(s)	Description	Default value
scr	Optional	screen	Screen.	awful.screen.focused()

🔗 menubar.show (scr) · 7 theme variables

Show the menubar on the given screen.

Parameters:

Name		Type(s)	Description	Default value
scr	Optional	screen	Screen.	awful.screen.focused()

Click to display more

Consumed theme variables:

Theme variable	Usage
beautiful.menubar_fg_normal
beautiful.menubar_bg_normal
beautiful.menubar_border_width
beautiful.menubar_border_color
beautiful.menubar_fg_focus
beautiful.menubar_bg_focus
beautiful.menubar_font

🔗 menubar.hide ()

Hide the menubar.

Theme variables

🔗 beautiful.menubar_fg_normal color

Menubar normal text color.
Click to display more

Used by:

• show Show the menubar on the given screen.

🔗 beautiful.menubar_bg_normal color

Menubar normal background color.
Click to display more

Used by:

• show Show the menubar on the given screen.

🔗 beautiful.menubar_border_width number

Menubar border width.
Click to display more

Used by:

• show Show the menubar on the given screen.

🔗 beautiful.menubar_border_color color

Menubar border color.
Click to display more

Used by:

• show Show the menubar on the given screen.

🔗 beautiful.menubar_fg_focus color

Menubar selected item text color.
Click to display more

Used by:

• show Show the menubar on the given screen.

🔗 beautiful.menubar_bg_focus color

Menubar selected item background color.
Click to display more

Used by:

• show Show the menubar on the given screen.

🔗 beautiful.menubar_font font

Menubar font.
Click to display more

Used by:

• show Show the menubar on the given screen.

Deprecated functions

🔗 menubar.get (scr)

Get a menubar wibox.

Parameters:

Name		Type(s)	Description
scr	Optional	screen	Screen.

Returns:

menubar wibox.

Tables

🔗 menubar.geometry

Specifies the geometry of the menubar. This is a table with the keys x, y, width and height. Missing values are replaced via the screen's geometry. However, missing height is replaced by the font size.

🔗 menubar.prompt_args

Allows user to specify custom parameters for prompt.run function (like colors). This will merge with the default parameters, overriding affected values.

See also:

awful.prompt	Convert a wibox.widget.textbox into an input prompt.	module

Fields

🔗 menubar.cache_entries boolean

When true the .desktop files will be reparsed only when the extension is initialized. Use this if menubar takes much time to open.

🔗 menubar.show_categories boolean

When true the categories will be shown alongside application entries.

🔗 menubar.match_empty boolean

When false will hide results if the current query is empty

🔗 menubar.right_margin number

Width of blank space left in the right side.

🔗 menubar.right_label string

Label used for "Next page", default "▶▶".

🔗 menubar.left_label string

Label used for "Previous page", default "◀◀".