g.findetc

Searches for GRASS support files.

Command linePython (grass.script)Python (grass.tools)

g.findetc file=string [--verbose] [--quiet] [--qq] [--ui]

Example:

g.findetc file=string

grass.script.run_command("g.findetc", file, verbose=None, quiet=None, superquiet=None)

Example:

gs.run_command("g.findetc", file="string")

grass.tools.Tools.g_findetc(file, verbose=None, quiet=None, superquiet=None)

Example:

tools = Tools()
tools.g_findetc(file="string")

This grass.tools API is experimental in version 8.5 and expected to be stable in version 8.6.

Parameters

Command linePython (grass.script)Python (grass.tools)

file=string [required]
    Name of an file or directory
--help
    Print usage summary
--verbose
    Verbose module output
--quiet
    Quiet module output
--qq
    Very quiet module output
--ui
    Force launching GUI dialog

file : str, required
    Name of an file or directory
verbose : bool, optional
    Verbose module output
    Default: None
quiet : bool, optional
    Quiet module output
    Default: None
superquiet : bool, optional
    Very quiet module output
    Default: None

file : str, required
    Name of an file or directory
verbose : bool, optional
    Verbose module output
    Default: None
quiet : bool, optional
    Quiet module output
    Default: None
superquiet : bool, optional
    Very quiet module output
    Default: None

Returns:

result : grass.tools.support.ToolResult | None
If the tool produces text as standard output, a ToolResult object will be returned. Otherwise, None will be returned.

Raises:

grass.tools.ToolError: When the tool ended with an error.

DESCRIPTION

g.findetc is designed for Bourne shell scripts that need to search for support data, programs and subfoldrs in any number of directories as specified in GRASS_ADDON_ETC, plus the GRASS application etc/ directory. This is designed for addon scripts that are installed outside the GRASS application directory, such as a user's home or a system addon directory.

OUTPUT

g.findetc writes the full path to the file or directory to standard output

SEE ALSO

g.filename, g.findfile, g.gisenv, g.mapsets

AUTHOR

William Kyngesburye

SOURCE CODE

Available at: g.findetc source code (history)
Latest change: Friday Feb 07 19:16:09 2025 in commit a82a39f