awesome

• Index

Contents

• Static module functions

Utility libraries

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

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.clipboard
• ruled.notifications
• ruled.screen
• ruled.tag

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

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

Theme related libraries

• beautiful
• gears.color
• gears.shape

Client tiling

• dynamite
• dynamite.layout.conditional
• dynamite.layout.ratio
• dynamite.layout.stack
• dynamite.layout.tabbed
• dynamite.utils
• dynamite.widget.placeholder

Libraries

• awful.completion
• awful.hotkeys_popup
• awful.layout
• awful.permissions
• awful.placement
• awful.prompt
• awful.spawn
• awful.util
• dbus
• dynamite.widget.pager
• dynamite.widget.spawn
• gears.matcher
• gears.surface
• lib.lain.layout.centerwork
• menubar.menu_gen
• menubar.utils
• naughty
• selection
• wibox.widget

Sample files

• rc.lua
• theme.lua

Classes

• awful.widget.common
• gears.cache
• gears.connection
• gears.history
• gears.matrix
• gears.reactive
• gears.watcher
• menubar.icon_theme
• menubar.index_theme
• signals
• wibox.container.conditional
• wibox.container.scale
• wibox.container.template
• wibox.drawable
• wibox.hierarchy
• wibox.widget.base
• wibox.widget.status
• 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: gears.filesystem

Filesystem module for gears.

Static module functions

gears.filesystem.make_directories (dir) -> ()	Create a directory, including all missing parent directories.
gears.filesystem.make_parent_directories (path) -> ()	Create all parent directories for a given path.
gears.filesystem.file_readable (filename) -> boolean	Check if a file exists, is readable and not a directory.
gears.filesystem.file_executable (filename) -> boolean	Check if a file exists, is executable and not a directory.
gears.filesystem.dir_readable (path) -> boolean	Check if a path exists, is readable and a directory.
gears.filesystem.is_dir (path) -> boolean	Check if a path is a directory.
gears.filesystem.get_xdg_config_home () -> ()	Get the config home according to the XDG basedir specification.
gears.filesystem.get_xdg_cache_home () -> ()	Get the cache home according to the XDG basedir specification.
gears.filesystem.get_xdg_data_home () -> string	Get the data home according to the XDG basedir specification.
gears.filesystem.get_xdg_data_dirs () -> table	Get the data dirs according to the XDG basedir specification.
gears.filesystem.get_configuration_dir () -> ()	Get the path to the user's config dir.
gears.filesystem.get_cache_dir () -> ()	Get the path to a directory that should be used for caching data.
gears.filesystem.get_themes_dir () -> ()	Get the path to the directory where themes are installed.
gears.filesystem.get_awesome_icon_dir () -> ()	Get the path to the directory where our icons are installed.
gears.filesystem.get_dir (d) -> ()	Get the user's config or cache dir.
gears.filesystem.get_random_file_from_dir (path[, exts[, absolute_path=false]]) -> string or nil	Get the name of a random file from a given directory.

Static module functions

gears.filesystem.make_directories (dir) -> ()

Create a directory, including all missing parent directories.

Parameters:

• dir string The directory.

Returns:

(true, nil) on success, (false, err) on failure

gears.filesystem.make_parent_directories (path) -> ()

Create all parent directories for a given path.

Parameters:

• path string The path whose parents should be created.

Returns:

(true, nil) on success, (false, err) on failure.

gears.filesystem.file_readable (filename) -> boolean

Check if a file exists, is readable and not a directory.

Parameters:

• filename string The file path.

Returns:

boolean True if file exists and is readable.

gears.filesystem.file_executable (filename) -> boolean

Check if a file exists, is executable and not a directory.

Parameters:

• filename string The file path.

Returns:

boolean True if file exists and is executable.

gears.filesystem.dir_readable (path) -> boolean

Check if a path exists, is readable and a directory.

Parameters:

• path string The directory path.

Returns:

boolean True if path exists and is readable.

gears.filesystem.is_dir (path) -> boolean

Check if a path is a directory.

Parameters:

• path string The directory path

Returns:

boolean True if path exists and is a directory.

gears.filesystem.get_xdg_config_home () -> ()

Get the config home according to the XDG basedir specification.

Returns:

the config home (XDGCONFIGHOME) with a slash at the end.

gears.filesystem.get_xdg_cache_home () -> ()

Get the cache home according to the XDG basedir specification.

Returns:

the cache home (XDGCACHEHOME) with a slash at the end.

gears.filesystem.get_xdg_data_home () -> string

Get the data home according to the XDG basedir specification.

Returns:

string the data home (XDGDATAHOME) with a slash at the end.

gears.filesystem.get_xdg_data_dirs () -> table

Get the data dirs according to the XDG basedir specification.

Returns:

table the data dirs (XDGDATADIRS) with a slash at the end of each entry.

gears.filesystem.get_configuration_dir () -> ()

Get the path to the user's config dir. This is the directory containing the configuration file ("rc.lua").

Returns:

A string with the requested path with a slash at the end.

gears.filesystem.get_cache_dir () -> ()

Get the path to a directory that should be used for caching data.

Returns:

A string with the requested path with a slash at the end.

gears.filesystem.get_themes_dir () -> ()

Get the path to the directory where themes are installed.

Returns:

A string with the requested path with a slash at the end.

gears.filesystem.get_awesome_icon_dir () -> ()

Get the path to the directory where our icons are installed.

Returns:

A string with the requested path with a slash at the end.

gears.filesystem.get_dir (d) -> ()

Get the user's config or cache dir. It first checks XDGCONFIGHOME / XDGCACHEHOME, but then goes with the default paths.

Parameters:

• d The directory to get (either "config" or "cache").

Returns:

A string containing the requested path.

gears.filesystem.get_random_file_from_dir (path[, exts[, absolute_path=false]]) -> string or nil

Get the name of a random file from a given directory.

Parameters:

• path string The directory to search.
• exts table Specific extensions to limit the search to. eg:{ "jpg", "png" } If ommited, all files are considered. (optional)
• absolute_path boolean Return the absolute path instead of the filename. (default false)

Returns:

string or nil A randomly selected filename from the specified path (with a specified extension if required) or nil if no suitable file is found. If absolute_path is set, then a path is returned instead of a file name.