luadocs/content/lua.scripts.api.manual/dtutils.file/get_executable_path_preference.md
Bill Ferguson b69d752221 [lua scripts] created manual from script comments
[lua scripts api] created manual from embedded library documentation

[lua api] created stub to contain lua api manual
2020-12-12 15:14:19 -05:00

35 lines
683 B
Markdown

---
title: get_executable_path_preference
id: get_executable_path_preference
weight: 110
draft: false
author: "people"
---
## NAME
get_executable_path_preference
## SYNOPSIS
return the path to an executable from a preference
## USAGE
```
local df = require "lib/dtutils.file"
local result = df.get_executable_path_preference(executable)
```
**executable** - _string_ - the name of the executable to get the path for
## DESCRIPTION
**get_executable_path_preference** returns the path preference to
the requested executable.
## RETURN VALUE
**result** - _string_ - path to the executable
## LIMITATIONS
executable should be the basename of the executable without extensions