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) Check if a file exists, is readable and not a directory.
gears.filesystem.file_executable (filename) Check if a file exists, is executable and not a directory.
gears.filesystem.dir_readable (path) Check if a path exists, is readable and a directory.
gears.filesystem.is_dir (path) 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 () Get the data home according to the XDG basedir specification.
gears.filesystem.get_xdg_data_dirs () 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]) 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:

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)
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)
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)
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)
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 (XDG_CONFIG_HOME) 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 (XDG_CACHE_HOME) with a slash at the end.
gears.filesystem.get_xdg_data_home ()
Get the data home according to the XDG basedir specification.

Returns:

    string the data home (XDG_DATA_HOME) with a slash at the end.
gears.filesystem.get_xdg_data_dirs ()
Get the data dirs according to the XDG basedir specification.

Returns:

    table the data dirs (XDG_DATA_DIRS) 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 XDG_CONFIG_HOME / XDG_CACHE_HOME, 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])
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)

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.
generated by LDoc 1.4.6 Last updated 2030-01-01 00:00:00