luadocs/content/lua.scripts.api.manual/dtutils/details.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

2 KiB

title id weight draft author
details details 10 false people

NAME

dtutils

SYNOPSIS

A Darktable lua utilities library

USAGE

local du = require "lib/dtutils"

DESCRIPTION

dtutils provides a common library of functions used to build lua scripts.

RETURN VALUE

du- library - the library of functions

FUNCTIONS

check_min_api_version

check the minimum required api version against the current api version

check_os

check that the operating system is supported

join

join a table of strings with a specified separator

prequire

a protected lua require

spairs

an iterator that provides sorted pairs from a table

split

split a string on a specified separator

SEE ALSO

dtutils.debug, dtutils.file, dtutils.log, dtutils.string, dtutils.system

LICENSE

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.

Copyright (C) 2016 Bill Ferguson wpferguson@gmail.com.
Copyright (C) 2016 Tobias Jakobs