awesome

• Index

Contents

• Static module functions
• Fields

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

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.border
• 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

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

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

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.utils

Utility functions for the menubar module.

Static module functions

menubar.utils.rtrim (s) -> string	Remove CR newline from the end of the string.
menubar.utils.lookup_icon_uncached (icon_file) -> string or boolean	Lookup an icon in different folders of the filesystem.
menubar.utils.lookup_icon (icon) -> ()	Lookup an icon in different folders of the filesystem (cached).
menubar.utils.parse_desktop_file (file) -> ()	Parse a .desktop file.
menubar.utils.parse_dir (dir_path, callback)	Parse a directory with .desktop files recursively.

Fields

menubar.utils.terminal	string	Terminal which applications that need terminal would open in.
menubar.utils.wm_name	string	Name of the WM for the OnlyShowIn entry in the .desktop file.

Static module functions

🔗 menubar.utils.rtrim (s) -> string

Remove CR newline from the end of the string.

Parameters:

Name		Type(s)	Description
s		string	The string to trim

Returns:

string The trimmed string.

🔗 menubar.utils.lookup_icon_uncached (icon_file) -> string or boolean

Lookup an icon in different folders of the filesystem.

Parameters:

Name		Type(s)	Description
icon_file		string	Short or full name of the icon.

Returns:

string or boolean Full name of the icon, or false on failure.

🔗 menubar.utils.lookup_icon (icon) -> ()

Lookup an icon in different folders of the filesystem (cached).

Parameters:

Name		Type(s)	Description
icon			Short or full name of the icon.

Returns:

full name of the icon.

🔗 menubar.utils.parse_desktop_file (file) -> ()

Parse a .desktop file.

Parameters:

Name		Type(s)	Description
file			The .desktop file.

Returns:

A table with file entries.

🔗 menubar.utils.parse_dir (dir_path, callback)

Parse a directory with .desktop files recursively.

Parameters:

Name		Type(s)	Description
dir_path		string	The directory path.
callback		table	Will be fired when all the files were parsed with the resulting list of menu entries as argument.
programs		table	Paths of found .desktop files.

Fields

🔗 menubar.utils.terminal string

Terminal which applications that need terminal would open in.

🔗 menubar.utils.wm_name string

Name of the WM for the OnlyShowIn entry in the .desktop file.