luadocs/lua.scripts.manual/scripts/overview/index.html
2020-12-14 23:54:59 +00:00

1861 lines
46 KiB
HTML

<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="x-ua-compatible" content="ie=edge">
<title>darktable lua documentation - overview</title>
<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="manifest" href="site.webmanifest">
<link rel="apple-touch-icon" href="icon.png">
<link rel="stylesheet" href="https://elstoc.github.io/luadocs/css/style.min.6f8fcc9b0ebcd3ac477a507f922faefdf963732422cd88933d1d4783ebccb952.css">
<script src="https://elstoc.github.io/luadocs/js/jquery.js"></script>
<script src="https://elstoc.github.io/luadocs/js/popper.js" type="module"></script>
<script src="https://elstoc.github.io/luadocs/js/bootstrap.js"></script>
<script src="https://elstoc.github.io/luadocs/js/lunr.js"></script>
<script src="https://elstoc.github.io/luadocs/js/app.js"></script>
</head>
<body>
<header class="navbar navbar-expand-lg sticky-top navbar-dark bg-dark">
<a class="navbar-brand" href="https://elstoc.github.io/luadocs/" rel="home" title=".Site.Title">
darktable lua documentation
</a>
<button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarSupportedContent" aria-controls="navbarSupportedContent" aria-expanded="false" aria-label="Toggle navigation">
<span class="navbar-toggler-icon"></span>
</button>
<div class="collapse navbar-collapse" id="navbarSupportedContent">
<ul class="navbar-nav ml-auto">
<form class="form-inline my-2 my-lg-0">
<input id="search-input" class="form-control mr-sm-2" type="search" placeholder="Search" autocomplete="off" aria-label="Search">
</form>
</ul>
</div>
</header>
<div id="search-results" class="search-results">
</div>
<div class="container-fluid">
<div class="row">
<nav class="navigation col-sm-12 order-sm-12 col-md-3 order-md-1">
<ul>
<li class="parent">
<i class="fa fa-plus-square toggle"></i>
<a href="https://elstoc.github.io/luadocs/lua.scripts.manual/" class="">
Lua Scripts Manual
</a>
<ul>
<li>
<i class="no-toggle"></i>
<a href="https://elstoc.github.io/luadocs/lua.scripts.manual/overview/" class="">
overview
</a>
</li>
<li>
<i class="no-toggle"></i>
<a href="https://elstoc.github.io/luadocs/lua.scripts.manual/installation/" class="">
installation
</a>
</li>
<li>
<i class="no-toggle"></i>
<a href="https://elstoc.github.io/luadocs/lua.scripts.manual/troubleshooting/" class="">
troubleshooting
</a>
</li>
<li class="parent">
<i class="fa fa-plus-square toggle"></i>
<a href="https://elstoc.github.io/luadocs/lua.scripts.manual/scripts/" class="">
scripts
</a>
<ul>
<li>
<i class="no-toggle"></i>
<a href="https://elstoc.github.io/luadocs/lua.scripts.manual/scripts/overview/" class=" active">
overview
</a>
</li>
<li class="parent">
<i class="fa fa-plus-square toggle"></i>
<a href="https://elstoc.github.io/luadocs/lua.scripts.manual/scripts/official/" class="">
official
</a>
<ul>
<li>
<i class="no-toggle"></i>
<a href="https://elstoc.github.io/luadocs/lua.scripts.manual/scripts/official/check_for_updates/" class="">
check_for_updates
</a>
</li>
<li>
<i class="no-toggle"></i>
<a href="https://elstoc.github.io/luadocs/lua.scripts.manual/scripts/official/copy_paste_metadata/" class="">
copy_paste_metadata
</a>
</li>
<li>
<i class="no-toggle"></i>
<a href="https://elstoc.github.io/luadocs/lua.scripts.manual/scripts/official/delete_long_tags/" class="">
delete_long_tags
</a>
</li>
<li>
<i class="no-toggle"></i>
<a href="https://elstoc.github.io/luadocs/lua.scripts.manual/scripts/official/delete_unused_tags/" class="">
delete_unused_tags
</a>
</li>
<li>
<i class="no-toggle"></i>
<a href="https://elstoc.github.io/luadocs/lua.scripts.manual/scripts/official/enfuse/" class="">
enfuse
</a>
</li>
<li>
<i class="no-toggle"></i>
<a href="https://elstoc.github.io/luadocs/lua.scripts.manual/scripts/official/generate_image_txt/" class="">
generate_image_txt
</a>
</li>
<li>
<i class="no-toggle"></i>
<a href="https://elstoc.github.io/luadocs/lua.scripts.manual/scripts/official/image_path_in_ui/" class="">
image_path_in_ui
</a>
</li>
<li>
<i class="no-toggle"></i>
<a href="https://elstoc.github.io/luadocs/lua.scripts.manual/scripts/official/import_filter_manager/" class="">
import_filter_manager
</a>
</li>
<li>
<i class="no-toggle"></i>
<a href="https://elstoc.github.io/luadocs/lua.scripts.manual/scripts/official/import_filters/" class="">
import_filters
</a>
</li>
<li>
<i class="no-toggle"></i>
<a href="https://elstoc.github.io/luadocs/lua.scripts.manual/scripts/official/save_selection/" class="">
save_selection
</a>
</li>
<li>
<i class="no-toggle"></i>
<a href="https://elstoc.github.io/luadocs/lua.scripts.manual/scripts/official/selection_to_pdf/" class="">
selection_to_pdf
</a>
</li>
</ul>
</li>
<li class="parent">
<i class="fa fa-plus-square toggle"></i>
<a href="https://elstoc.github.io/luadocs/lua.scripts.manual/scripts/contrib/" class="">
contrib
</a>
<ul>
<li>
<i class="no-toggle"></i>
<a href="https://elstoc.github.io/luadocs/lua.scripts.manual/scripts/contrib/autogrouper/" class="">
AugoGrouper
</a>
</li>
<li>
<i class="no-toggle"></i>
<a href="https://elstoc.github.io/luadocs/lua.scripts.manual/scripts/contrib/autostyle/" class="">
autostyle
</a>
</li>
<li>
<i class="no-toggle"></i>
<a href="https://elstoc.github.io/luadocs/lua.scripts.manual/scripts/contrib/clear_gps/" class="">
clear_GPS
</a>
</li>
<li>
<i class="no-toggle"></i>
<a href="https://elstoc.github.io/luadocs/lua.scripts.manual/scripts/contrib/collecthelper/" class="">
CollectHelper
</a>
</li>
<li>
<i class="no-toggle"></i>
<a href="https://elstoc.github.io/luadocs/lua.scripts.manual/scripts/contrib/copy_attach_detach_tags/" class="">
copy_attach_detach_tags
</a>
</li>
<li>
<i class="no-toggle"></i>
<a href="https://elstoc.github.io/luadocs/lua.scripts.manual/scripts/contrib/cr2hdr/" class="">
cr2hdr
</a>
</li>
<li>
<i class="no-toggle"></i>
<a href="https://elstoc.github.io/luadocs/lua.scripts.manual/scripts/contrib/enfuseadvanced/" class="">
enfuseAdvanced
</a>
</li>
<li>
<i class="no-toggle"></i>
<a href="https://elstoc.github.io/luadocs/lua.scripts.manual/scripts/contrib/exportlut/" class="">
exportLUT
</a>
</li>
<li>
<i class="no-toggle"></i>
<a href="https://elstoc.github.io/luadocs/lua.scripts.manual/scripts/contrib/ext_editor/" class="">
ext_editor
</a>
</li>
<li>
<i class="no-toggle"></i>
<a href="https://elstoc.github.io/luadocs/lua.scripts.manual/scripts/contrib/face_recognition/" class="">
face_recognition
</a>
</li>
<li>
<i class="no-toggle"></i>
<a href="https://elstoc.github.io/luadocs/lua.scripts.manual/scripts/contrib/fujifilm_ratings/" class="">
fujifilm_ratings
</a>
</li>
<li>
<i class="no-toggle"></i>
<a href="https://elstoc.github.io/luadocs/lua.scripts.manual/scripts/contrib/geojson_export/" class="">
geoJSON_export
</a>
</li>
<li>
<i class="no-toggle"></i>
<a href="https://elstoc.github.io/luadocs/lua.scripts.manual/scripts/contrib/geotoolbox/" class="">
geoToolbox
</a>
</li>
<li>
<i class="no-toggle"></i>
<a href="https://elstoc.github.io/luadocs/lua.scripts.manual/scripts/contrib/gimp/" class="">
gimp
</a>
</li>
<li>
<i class="no-toggle"></i>
<a href="https://elstoc.github.io/luadocs/lua.scripts.manual/scripts/contrib/gpx_export/" class="">
gpx_export
</a>
</li>
<li>
<i class="no-toggle"></i>
<a href="https://elstoc.github.io/luadocs/lua.scripts.manual/scripts/contrib/hdrmerge/" class="">
HDRMerge
</a>
</li>
<li>
<i class="no-toggle"></i>
<a href="https://elstoc.github.io/luadocs/lua.scripts.manual/scripts/contrib/hugin/" class="">
hugin
</a>
</li>
<li>
<i class="no-toggle"></i>
<a href="https://elstoc.github.io/luadocs/lua.scripts.manual/scripts/contrib/image_stack/" class="">
image_stack
</a>
</li>
<li>
<i class="no-toggle"></i>
<a href="https://elstoc.github.io/luadocs/lua.scripts.manual/scripts/contrib/image_time/" class="">
image_time
</a>
</li>
<li>
<i class="no-toggle"></i>
<a href="https://elstoc.github.io/luadocs/lua.scripts.manual/scripts/contrib/kml_export/" class="">
kml_export
</a>
</li>
<li>
<i class="no-toggle"></i>
<a href="https://elstoc.github.io/luadocs/lua.scripts.manual/scripts/contrib/labelstotags/" class="">
LabelsToTags
</a>
</li>
<li>
<i class="no-toggle"></i>
<a href="https://elstoc.github.io/luadocs/lua.scripts.manual/scripts/contrib/openinexplorer/" class="">
OpenInExplorer
</a>
</li>
<li>
<i class="no-toggle"></i>
<a href="https://elstoc.github.io/luadocs/lua.scripts.manual/scripts/contrib/passport_guide/" class="">
passport_guide
</a>
</li>
<li>
<i class="no-toggle"></i>
<a href="https://elstoc.github.io/luadocs/lua.scripts.manual/scripts/contrib/pdf_slideshow/" class="">
pdf_slideshow
</a>
</li>
<li>
<i class="no-toggle"></i>
<a href="https://elstoc.github.io/luadocs/lua.scripts.manual/scripts/contrib/photils/" class="">
photils
</a>
</li>
<li>
<i class="no-toggle"></i>
<a href="https://elstoc.github.io/luadocs/lua.scripts.manual/scripts/contrib/quicktag/" class="">
quicktag
</a>
</li>
<li>
<i class="no-toggle"></i>
<a href="https://elstoc.github.io/luadocs/lua.scripts.manual/scripts/contrib/rate_group/" class="">
rate_group
</a>
</li>
<li>
<i class="no-toggle"></i>
<a href="https://elstoc.github.io/luadocs/lua.scripts.manual/scripts/contrib/rename-tags/" class="">
rename_tags
</a>
</li>
<li>
<i class="no-toggle"></i>
<a href="https://elstoc.github.io/luadocs/lua.scripts.manual/scripts/contrib/rl_out_sharp/" class="">
RL_out_sharp
</a>
</li>
<li>
<i class="no-toggle"></i>
<a href="https://elstoc.github.io/luadocs/lua.scripts.manual/scripts/contrib/slideshowmusic/" class="">
slideshowMusic
</a>
</li>
<li>
<i class="no-toggle"></i>
<a href="https://elstoc.github.io/luadocs/lua.scripts.manual/scripts/contrib/transfer_hierarchy/" class="">
transfer_hierarchy
</a>
</li>
<li>
<i class="no-toggle"></i>
<a href="https://elstoc.github.io/luadocs/lua.scripts.manual/scripts/contrib/video_ffmpeg/" class="">
video_ffmpeg
</a>
</li>
<li>
<i class="no-toggle"></i>
<a href="https://elstoc.github.io/luadocs/lua.scripts.manual/scripts/contrib/select_untagged/" class="">
select_untagged
</a>
</li>
</ul>
</li>
<li class="parent">
<i class="fa fa-plus-square toggle"></i>
<a href="https://elstoc.github.io/luadocs/lua.scripts.manual/scripts/examples/" class="">
examples
</a>
<ul>
<li>
<i class="no-toggle"></i>
<a href="https://elstoc.github.io/luadocs/lua.scripts.manual/scripts/examples/api_version/" class="">
api_version
</a>
</li>
<li>
<i class="no-toggle"></i>
<a href="https://elstoc.github.io/luadocs/lua.scripts.manual/scripts/examples/darkroom_demo/" class="">
darkroom_demo
</a>
</li>
<li>
<i class="no-toggle"></i>
<a href="https://elstoc.github.io/luadocs/lua.scripts.manual/scripts/examples/gettextexample/" class="">
gettextExample
</a>
</li>
<li>
<i class="no-toggle"></i>
<a href="https://elstoc.github.io/luadocs/lua.scripts.manual/scripts/examples/hello_world/" class="">
hello_world
</a>
</li>
<li>
<i class="no-toggle"></i>
<a href="https://elstoc.github.io/luadocs/lua.scripts.manual/scripts/examples/lighttable_demo/" class="">
lighttable_demo
</a>
</li>
<li>
<i class="no-toggle"></i>
<a href="https://elstoc.github.io/luadocs/lua.scripts.manual/scripts/examples/moduleexample/" class="">
moduleExample
</a>
</li>
<li>
<i class="no-toggle"></i>
<a href="https://elstoc.github.io/luadocs/lua.scripts.manual/scripts/examples/multi_os/" class="">
name
</a>
</li>
<li>
<i class="no-toggle"></i>
<a href="https://elstoc.github.io/luadocs/lua.scripts.manual/scripts/examples/panels_demo/" class="">
panels_demo
</a>
</li>
<li>
<i class="no-toggle"></i>
<a href="https://elstoc.github.io/luadocs/lua.scripts.manual/scripts/examples/preferenceexamples/" class="">
preferenceExample
</a>
</li>
<li>
<i class="no-toggle"></i>
<a href="https://elstoc.github.io/luadocs/lua.scripts.manual/scripts/examples/printexamples/" class="">
printExamples
</a>
</li>
<li>
<i class="no-toggle"></i>
<a href="https://elstoc.github.io/luadocs/lua.scripts.manual/scripts/examples/running_os/" class="">
running_os
</a>
</li>
</ul>
</li>
<li class="parent">
<i class="fa fa-plus-square toggle"></i>
<a href="https://elstoc.github.io/luadocs/lua.scripts.manual/scripts/tools/" class="">
tools
</a>
<ul>
<li>
<i class="no-toggle"></i>
<a href="https://elstoc.github.io/luadocs/lua.scripts.manual/scripts/tools/executable_manager/" class="">
executable_manager
</a>
</li>
<li>
<i class="no-toggle"></i>
<a href="https://elstoc.github.io/luadocs/lua.scripts.manual/scripts/tools/gen_i18n_mo/" class="">
gen_i18n_mo
</a>
</li>
<li>
<i class="no-toggle"></i>
<a href="https://elstoc.github.io/luadocs/lua.scripts.manual/scripts/tools/get_lib_manpages/" class="">
get_lib_manpages
</a>
</li>
<li>
<i class="no-toggle"></i>
<a href="https://elstoc.github.io/luadocs/lua.scripts.manual/scripts/tools/get_libdoc/" class="">
get_libdoc
</a>
</li>
<li>
<i class="no-toggle"></i>
<a href="https://elstoc.github.io/luadocs/lua.scripts.manual/scripts/tools/script_manager/" class="">
script_manager
</a>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li class="parent">
<i class="fa fa-plus-square toggle"></i>
<a href="https://elstoc.github.io/luadocs/lua.scripts.api.manual/" class="">
Lua Scripts Libraries API Manual
</a>
<ul>
<li class="parent">
<i class="fa fa-plus-square toggle"></i>
<a href="https://elstoc.github.io/luadocs/lua.scripts.api.manual/dtutils/" class="">
dtutils
</a>
<ul>
<li>
<i class="no-toggle"></i>
<a href="https://elstoc.github.io/luadocs/lua.scripts.api.manual/dtutils/details/" class="">
details
</a>
</li>
<li>
<i class="no-toggle"></i>
<a href="https://elstoc.github.io/luadocs/lua.scripts.api.manual/dtutils/check_min_api_version/" class="">
check_min_api_version
</a>
</li>
<li>
<i class="no-toggle"></i>
<a href="https://elstoc.github.io/luadocs/lua.scripts.api.manual/dtutils/check_os/" class="">
check_os
</a>
</li>
<li>
<i class="no-toggle"></i>
<a href="https://elstoc.github.io/luadocs/lua.scripts.api.manual/dtutils/join/" class="">
join
</a>
</li>
<li>
<i class="no-toggle"></i>
<a href="https://elstoc.github.io/luadocs/lua.scripts.api.manual/dtutils/prequire/" class="">
prequire
</a>
</li>
<li>
<i class="no-toggle"></i>
<a href="https://elstoc.github.io/luadocs/lua.scripts.api.manual/dtutils/spairs/" class="">
spairs
</a>
</li>
<li>
<i class="no-toggle"></i>
<a href="https://elstoc.github.io/luadocs/lua.scripts.api.manual/dtutils/split/" class="">
split
</a>
</li>
</ul>
</li>
<li class="parent">
<i class="fa fa-plus-square toggle"></i>
<a href="https://elstoc.github.io/luadocs/lua.scripts.api.manual/dtutils.debug/" class="">
dtutils.debug
</a>
<ul>
<li>
<i class="no-toggle"></i>
<a href="https://elstoc.github.io/luadocs/lua.scripts.api.manual/dtutils.debug/details/" class="">
details
</a>
</li>
<li>
<i class="no-toggle"></i>
<a href="https://elstoc.github.io/luadocs/lua.scripts.api.manual/dtutils.debug/dprint/" class="">
dprint
</a>
</li>
<li>
<i class="no-toggle"></i>
<a href="https://elstoc.github.io/luadocs/lua.scripts.api.manual/dtutils.debug/new_tracepoint/" class="">
new_tracepoint
</a>
</li>
<li>
<i class="no-toggle"></i>
<a href="https://elstoc.github.io/luadocs/lua.scripts.api.manual/dtutils.debug/terse_dump/" class="">
terse_dump
</a>
</li>
<li>
<i class="no-toggle"></i>
<a href="https://elstoc.github.io/luadocs/lua.scripts.api.manual/dtutils.debug/tracepoint/" class="">
tracepoint
</a>
</li>
</ul>
</li>
<li class="parent">
<i class="fa fa-plus-square toggle"></i>
<a href="https://elstoc.github.io/luadocs/lua.scripts.api.manual/dtutils.file/" class="">
dtutils.file
</a>
<ul>
<li>
<i class="no-toggle"></i>
<a href="https://elstoc.github.io/luadocs/lua.scripts.api.manual/dtutils.file/details/" class="">
details
</a>
</li>
<li>
<i class="no-toggle"></i>
<a href="https://elstoc.github.io/luadocs/lua.scripts.api.manual/dtutils.file/check_if_bin_exists/" class="">
check_if_bin_exists
</a>
</li>
<li>
<i class="no-toggle"></i>
<a href="https://elstoc.github.io/luadocs/lua.scripts.api.manual/dtutils.file/check_if_file_exists/" class="">
check_if_file_exists
</a>
</li>
<li>
<i class="no-toggle"></i>
<a href="https://elstoc.github.io/luadocs/lua.scripts.api.manual/dtutils.file/chop_filetype/" class="">
chop_filetype
</a>
</li>
<li>
<i class="no-toggle"></i>
<a href="https://elstoc.github.io/luadocs/lua.scripts.api.manual/dtutils.file/create_unique_filename/" class="">
create_unique_filename
</a>
</li>
<li>
<i class="no-toggle"></i>
<a href="https://elstoc.github.io/luadocs/lua.scripts.api.manual/dtutils.file/executable_path_widget/" class="">
executable_path_widget
</a>
</li>
<li>
<i class="no-toggle"></i>
<a href="https://elstoc.github.io/luadocs/lua.scripts.api.manual/dtutils.file/file_copy/" class="">
file_copy
</a>
</li>
<li>
<i class="no-toggle"></i>
<a href="https://elstoc.github.io/luadocs/lua.scripts.api.manual/dtutils.file/file_move/" class="">
file_move
</a>
</li>
<li>
<i class="no-toggle"></i>
<a href="https://elstoc.github.io/luadocs/lua.scripts.api.manual/dtutils.file/filename_increment/" class="">
filename_increment
</a>
</li>
<li>
<i class="no-toggle"></i>
<a href="https://elstoc.github.io/luadocs/lua.scripts.api.manual/dtutils.file/get_basename/" class="">
get_basename
</a>
</li>
<li>
<i class="no-toggle"></i>
<a href="https://elstoc.github.io/luadocs/lua.scripts.api.manual/dtutils.file/get_executable_path_preference/" class="">
get_executable_path_preference
</a>
</li>
<li>
<i class="no-toggle"></i>
<a href="https://elstoc.github.io/luadocs/lua.scripts.api.manual/dtutils.file/get_filename/" class="">
get_filename
</a>
</li>
<li>
<i class="no-toggle"></i>
<a href="https://elstoc.github.io/luadocs/lua.scripts.api.manual/dtutils.file/get_filetype/" class="">
get_filetype
</a>
</li>
<li>
<i class="no-toggle"></i>
<a href="https://elstoc.github.io/luadocs/lua.scripts.api.manual/dtutils.file/get_path/" class="">
get_path
</a>
</li>
<li>
<i class="no-toggle"></i>
<a href="https://elstoc.github.io/luadocs/lua.scripts.api.manual/dtutils.file/mkdir/" class="">
mkdir
</a>
</li>
<li>
<i class="no-toggle"></i>
<a href="https://elstoc.github.io/luadocs/lua.scripts.api.manual/dtutils.file/rmdir/" class="">
rmdir
</a>
</li>
<li>
<i class="no-toggle"></i>
<a href="https://elstoc.github.io/luadocs/lua.scripts.api.manual/dtutils.file/sanitize_filename/" class="">
sanitize_filename
</a>
</li>
<li>
<i class="no-toggle"></i>
<a href="https://elstoc.github.io/luadocs/lua.scripts.api.manual/dtutils.file/set_executable_path_preference/" class="">
set_executable_path_preference
</a>
</li>
<li>
<i class="no-toggle"></i>
<a href="https://elstoc.github.io/luadocs/lua.scripts.api.manual/dtutils.file/split_filepath/" class="">
split_filepath
</a>
</li>
</ul>
</li>
<li class="parent">
<i class="fa fa-plus-square toggle"></i>
<a href="https://elstoc.github.io/luadocs/lua.scripts.api.manual/dtutils.log/" class="">
dtutils.log
</a>
<ul>
<li>
<i class="no-toggle"></i>
<a href="https://elstoc.github.io/luadocs/lua.scripts.api.manual/dtutils.log/details/" class="">
details
</a>
</li>
<li>
<i class="no-toggle"></i>
<a href="https://elstoc.github.io/luadocs/lua.scripts.api.manual/dtutils.log/caller/" class="">
caller
</a>
</li>
<li>
<i class="no-toggle"></i>
<a href="https://elstoc.github.io/luadocs/lua.scripts.api.manual/dtutils.log/engine/" class="">
engine
</a>
</li>
<li>
<i class="no-toggle"></i>
<a href="https://elstoc.github.io/luadocs/lua.scripts.api.manual/dtutils.log/log_level/" class="">
log_level
</a>
</li>
<li>
<i class="no-toggle"></i>
<a href="https://elstoc.github.io/luadocs/lua.scripts.api.manual/dtutils.log/msg/" class="">
msg
</a>
</li>
</ul>
</li>
<li class="parent">
<i class="fa fa-plus-square toggle"></i>
<a href="https://elstoc.github.io/luadocs/lua.scripts.api.manual/dtutils.string/" class="">
dtutils.string
</a>
<ul>
<li>
<i class="no-toggle"></i>
<a href="https://elstoc.github.io/luadocs/lua.scripts.api.manual/dtutils.string/details/" class="">
details
</a>
</li>
<li>
<i class="no-toggle"></i>
<a href="https://elstoc.github.io/luadocs/lua.scripts.api.manual/dtutils.string/escape_xml_characters/" class="">
escape_xml_characters
</a>
</li>
<li>
<i class="no-toggle"></i>
<a href="https://elstoc.github.io/luadocs/lua.scripts.api.manual/dtutils.string/is_not_sanitized/" class="">
is_not_sanitized
</a>
</li>
<li>
<i class="no-toggle"></i>
<a href="https://elstoc.github.io/luadocs/lua.scripts.api.manual/dtutils.string/sanitize/" class="">
sanitize
</a>
</li>
<li>
<i class="no-toggle"></i>
<a href="https://elstoc.github.io/luadocs/lua.scripts.api.manual/dtutils.string/sanitize_lua/" class="">
sanitize_lua
</a>
</li>
<li>
<i class="no-toggle"></i>
<a href="https://elstoc.github.io/luadocs/lua.scripts.api.manual/dtutils.string/strip_accents/" class="">
strip_accents
</a>
</li>
<li>
<i class="no-toggle"></i>
<a href="https://elstoc.github.io/luadocs/lua.scripts.api.manual/dtutils.string/urlencode/" class="">
urlencode
</a>
</li>
</ul>
</li>
<li class="parent">
<i class="fa fa-plus-square toggle"></i>
<a href="https://elstoc.github.io/luadocs/lua.scripts.api.manual/dtutils.system/" class="">
dtutils.system
</a>
<ul>
<li>
<i class="no-toggle"></i>
<a href="https://elstoc.github.io/luadocs/lua.scripts.api.manual/dtutils.system/details/" class="">
details
</a>
</li>
<li>
<i class="no-toggle"></i>
<a href="https://elstoc.github.io/luadocs/lua.scripts.api.manual/dtutils.system/external_command/" class="">
external_command
</a>
</li>
<li>
<i class="no-toggle"></i>
<a href="https://elstoc.github.io/luadocs/lua.scripts.api.manual/dtutils.system/launch_default_app/" class="">
launch_default_app
</a>
</li>
<li>
<i class="no-toggle"></i>
<a href="https://elstoc.github.io/luadocs/lua.scripts.api.manual/dtutils.system/windows_command/" class="">
windows_command
</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="parent">
<i class="fa fa-plus-square toggle"></i>
<a href="https://elstoc.github.io/luadocs/lua.api/" class="">
Lua API Manual
</a>
<ul></ul>
</li>
</ul>
</nav>
<div class="content col-sm-12 order-sm-1 col-md-9 mx-md-auto order-md-12">
<div class="crumbs">
<span class="crumb">
<a href='https://elstoc.github.io/luadocs/'>Home</a> / <a href='https://elstoc.github.io/luadocs/lua.scripts.manual/'>Lua Scripts Manual</a> / <a href='https://elstoc.github.io/luadocs/lua.scripts.manual/scripts/'>scripts</a> / overview
</span>
</div>
<div class="prev-next row">
<div class="col-6">
<a href="https://elstoc.github.io/luadocs/lua.scripts.manual/scripts/" class="next">&lt; scripts</a>
</div>
<div class="col-6">
<a href="https://elstoc.github.io/luadocs/lua.scripts.manual/scripts/official/" class="prev">official &gt;</a>
</div>
</div>
<article role="main">
<h1 class="title">
overview
</h1>
<p>darktable can be customized and extended using the Lua programming language. The <a href="https://github.com/darktable-org/lua-scripts" target="_blank">lua-scripts repository</a>
contains the collected
efforts of the darktable developers, maintainers, contributors and community. The following sections list the scripts
contained in the repository, whether they can be run by themselves (Standalone - Yes) or depend on other
scripts (Standalone - No), what operating systems they are known to work on (L - Linux, M - MacOS, W - Windows), and their purpose.</p>
<h3 id="official-scripts"><a href="#official-scripts">🔗</a>Official Scripts</h3>
<p>These scripts are written primarily by the darktable developers and maintained by the authors and/or repository maintainers. They are located in the official/ directory.</p>
<table>
<thead>
<tr>
<th>Name</th>
<th style="text-align:center">Standalone</th>
<th style="text-align:center">Op/Sys</th>
<th>Purpose</th>
</tr>
</thead>
<tbody>
<tr>
<td><a href="/luadocs/lua.scripts.manual/scripts/official/check_for_updates/">check_for_updates</a></td>
<td style="text-align:center">Yes</td>
<td style="text-align:center">LMW</td>
<td>Check for updates to darktable</td>
</tr>
<tr>
<td><a href="/luadocs/lua.scripts.manual/scripts/official/copy_paste_metadata/">copy_paste_metadata</a></td>
<td style="text-align:center">Yes</td>
<td style="text-align:center">LMW</td>
<td>Copy and paste metadata, tags, ratings, and color labels between images</td>
</tr>
<tr>
<td><a href="/luadocs/lua.scripts.manual/scripts/official/delete_long_tags/">delete_long_tags</a></td>
<td style="text-align:center">Yes</td>
<td style="text-align:center">LMW</td>
<td>Delete all tags longer than a specified length</td>
</tr>
<tr>
<td><a href="/luadocs/lua.scripts.manual/scripts/official/delete_unused_tags/">delete_unused_tags</a></td>
<td style="text-align:center">Yes</td>
<td style="text-align:center">LMW</td>
<td>Delete tags that have no associated images</td>
</tr>
<tr>
<td><a href="/luadocs/lua.scripts.manual/scripts/official/enfuse/">enfuse</a></td>
<td style="text-align:center">No</td>
<td style="text-align:center">L</td>
<td>Exposure blend several images (HDR)</td>
</tr>
<tr>
<td><a href="/luadocs/lua.scripts.manual/scripts/official/generate_image_txt/">generate_image_txt</a></td>
<td style="text-align:center">No</td>
<td style="text-align:center">L</td>
<td>Generate txt sidecar files to be overlaid on zoomed images</td>
</tr>
<tr>
<td><a href="/luadocs/lua.scripts.manual/scripts/official/image_path_in_ui/">image_path_in_ui</a></td>
<td style="text-align:center">Yes</td>
<td style="text-align:center">LMW</td>
<td>Plugin to display selected image path</td>
</tr>
<tr>
<td><a href="/luadocs/lua.scripts.manual/scripts/official/import_filter_manager/">import_filter_manager</a></td>
<td style="text-align:center">Yes</td>
<td style="text-align:center">LMW</td>
<td>Manager for import filters</td>
</tr>
<tr>
<td><a href="/luadocs/lua.scripts.manual/scripts/official/import_filters/">import_filters</a></td>
<td style="text-align:center">No</td>
<td style="text-align:center">LMW</td>
<td>Two import filters for use with import_filter_manager</td>
</tr>
<tr>
<td><a href="/luadocs/lua.scripts.manual/scripts/official/save_selection/">save_selection</a></td>
<td style="text-align:center">Yes</td>
<td style="text-align:center">LMW</td>
<td>Provide save and restore from multiple selection buffers</td>
</tr>
<tr>
<td><a href="/luadocs/lua.scripts.manual/scripts/official/selection_to_pdf/">selection_to_pdf</a></td>
<td style="text-align:center">No</td>
<td style="text-align:center">L</td>
<td>Generate a PDF file from the selected images</td>
</tr>
</tbody>
</table>
<h3 id="contributed-scripts"><a href="#contributed-scripts">🔗</a>Contributed Scripts</h3>
<p>These scripts are contributed by users. They are meant to have an &ldquo;owner&rdquo;, i.e. the author, who maintains them. Over time the community has helped maintain these scripts, as well as the authors. They are located in the contrib/ directory.</p>
<table>
<thead>
<tr>
<th>Name</th>
<th style="text-align:center">Standalone</th>
<th style="text-align:center">Op/Sys</th>
<th>Purpose</th>
</tr>
</thead>
<tbody>
<tr>
<td><a href="/luadocs/lua.scripts.manual/scripts/contrib/autogrouper/">AutoGrouper</a></td>
<td style="text-align:center">Yes</td>
<td style="text-align:center">LMW</td>
<td>Group images together by time</td>
</tr>
<tr>
<td><a href="/luadocs/lua.scripts.manual/scripts/contrib/autostyle/">autostyle</a></td>
<td style="text-align:center">Yes</td>
<td style="text-align:center">LMW</td>
<td>Automatically apply styles on import</td>
</tr>
<tr>
<td><a href="/luadocs/lua.scripts.manual/scripts/contrib/clear_gps/">clear_GPS</a></td>
<td style="text-align:center">Yes</td>
<td style="text-align:center">LMW</td>
<td>Reset GPS information for selected images</td>
</tr>
<tr>
<td><a href="/luadocs/lua.scripts.manual/scripts/contrib/collecthelper/">CollectHelper</a></td>
<td style="text-align:center">Yes</td>
<td style="text-align:center">LMW</td>
<td>Add buttons to selected images module to manipulate the collection</td>
</tr>
<tr>
<td><a href="/luadocs/lua.scripts.manual/scripts/contrib/copy_attach_detach_tags/">copy_attach_detach_tags</a></td>
<td style="text-align:center">Yes</td>
<td style="text-align:center">LMW</td>
<td>Copy and paste tags from/to images</td>
</tr>
<tr>
<td><a href="/luadocs/lua.scripts.manual/scripts/contrib/cr2hdr/">cr2hdr</a></td>
<td style="text-align:center">Yes</td>
<td style="text-align:center">L</td>
<td>Process image created with Magic Lantern Dual ISO</td>
</tr>
<tr>
<td><a href="/luadocs/lua.scripts.manual/scripts/contrib/enfuseadvanced/">enfuseAdvanced</a></td>
<td style="text-align:center">No</td>
<td style="text-align:center">LMW</td>
<td>Merge multiple images into Dynamic Range Increase (DRI) or Depth From Focus (DFF) images</td>
</tr>
<tr>
<td><a href="/luadocs/lua.scripts.manual/scripts/contrib/exportlut/">exportLUT</a></td>
<td style="text-align:center">Yes</td>
<td style="text-align:center">LMW</td>
<td>Create a LUT from a style and export it</td>
</tr>
<tr>
<td><a href="/luadocs/lua.scripts.manual/scripts/contrib/ext_editor/">ext_editor</a></td>
<td style="text-align:center">No</td>
<td style="text-align:center">LW</td>
<td>Export pictures to collection and edit them with up to nine user-defined external editors</td>
</tr>
<tr>
<td><a href="/luadocs/lua.scripts.manual/scripts/contrib/face_recognition/">face_recognition</a></td>
<td style="text-align:center">No</td>
<td style="text-align:center">LM</td>
<td>Identify and tag images using facial recognition</td>
</tr>
<tr>
<td><a href="/luadocs/lua.scripts.manual/scripts/contrib/fujifilm_ratings/">fujifilm_ratings</a></td>
<td style="text-align:center">No</td>
<td style="text-align:center">LM</td>
<td>Support importing Fujifilm ratings</td>
</tr>
<tr>
<td><a href="/luadocs/lua.scripts.manual/scripts/contrib/geojson_export/">geoJSON_export</a></td>
<td style="text-align:center">No</td>
<td style="text-align:center">L</td>
<td>Create a geo JSON script with thumbnails for use in &hellip;</td>
</tr>
<tr>
<td><a href="/luadocs/lua.scripts.manual/scripts/contrib/geotoolbox/">geoToolbox</a></td>
<td style="text-align:center">No</td>
<td style="text-align:center">LMW</td>
<td>A toolbox of geo functions</td>
</tr>
<tr>
<td><a href="/luadocs/lua.scripts.manual/scripts/contrib/gimp/">gimp</a></td>
<td style="text-align:center">No</td>
<td style="text-align:center">LMW</td>
<td>Open an image in GIMP for editing and return the result</td>
</tr>
<tr>
<td><a href="/luadocs/lua.scripts.manual/scripts/contrib/gpx_export/">gpx_export</a></td>
<td style="text-align:center">No</td>
<td style="text-align:center">LMW</td>
<td>Export a GPX track file from selected images GPS data</td>
</tr>
<tr>
<td><a href="/luadocs/lua.scripts.manual/scripts/contrib/hdrmerge/">HDRMerge</a></td>
<td style="text-align:center">No</td>
<td style="text-align:center">LMW</td>
<td>Combine the selected images into an HDR DNG and return the result</td>
</tr>
<tr>
<td><a href="/luadocs/lua.scripts.manual/scripts/contrib/hugin/">hugin</a></td>
<td style="text-align:center">No</td>
<td style="text-align:center">LMW</td>
<td>Combine selected images into a panorama and return the result</td>
</tr>
<tr>
<td><a href="/luadocs/lua.scripts.manual/scripts/contrib/image_stack/">image_stack</a></td>
<td style="text-align:center">No</td>
<td style="text-align:center">LMW</td>
<td>Combine a stack of images to remove noise or transient objects</td>
</tr>
<tr>
<td><a href="/luadocs/lua.scripts.manual/scripts/contrib/image_time/">image_time</a></td>
<td style="text-align:center">Yes</td>
<td style="text-align:center">LMW</td>
<td>Adjust the EXIF image time</td>
</tr>
<tr>
<td><a href="/luadocs/lua.scripts.manual/scripts/contrib/kml_export/">kml_export</a></td>
<td style="text-align:center">No</td>
<td style="text-align:center">L</td>
<td>Export photos with a KML file for usage in Google Earth</td>
</tr>
<tr>
<td><a href="/luadocs/lua.scripts.manual/scripts/contrib/labelstotags/">LabelsToTags</a></td>
<td style="text-align:center">Yes</td>
<td style="text-align:center">LMW</td>
<td>Apply tags based on color labels and ratings</td>
</tr>
<tr>
<td><a href="/luadocs/lua.scripts.manual/scripts/contrib/openinexplorer/">OpenInExplorer</a></td>
<td style="text-align:center">No</td>
<td style="text-align:center">LMW</td>
<td>Open the selected images in the system file manager</td>
</tr>
<tr>
<td><a href="/luadocs/lua.scripts.manual/scripts/contrib/passport_guide/">passport_guide</a></td>
<td style="text-align:center">Yes</td>
<td style="text-align:center">LMW</td>
<td>Add passport cropping guide to darkroom crop tool</td>
</tr>
<tr>
<td><a href="/luadocs/lua.scripts.manual/scripts/contrib/pdf_slideshow/">pdf_slideshow</a></td>
<td style="text-align:center">No</td>
<td style="text-align:center">LM</td>
<td>Export images to a PDF slideshow</td>
</tr>
<tr>
<td><a href="/luadocs/lua.scripts.manual/scripts/contrib/photils/">photils</a></td>
<td style="text-align:center">No</td>
<td style="text-align:center">LM</td>
<td>Automatic tag suggestions for your images</td>
</tr>
<tr>
<td><a href="/luadocs/lua.scripts.manual/scripts/contrib/quicktag/">quicktag</a>.md</td>
<td style="text-align:center">Yes</td>
<td style="text-align:center">LMW</td>
<td>Create shortcuts for quickly applying tags</td>
</tr>
<tr>
<td><a href="/luadocs/lua.scripts.manual/scripts/contrib/rate_group/">rate_group</a></td>
<td style="text-align:center">Yes</td>
<td style="text-align:center">LMW</td>
<td>Apply or remove a star rating from grouped images</td>
</tr>
<tr>
<td><a href="/luadocs/lua.scripts.manual/scripts/contrib/rename-tags/">rename-tags</a></td>
<td style="text-align:center">Yes</td>
<td style="text-align:center">LMW</td>
<td>Change a tag name</td>
</tr>
<tr>
<td><a href="/luadocs/lua.scripts.manual/scripts/contrib/rl_out_sharp/">RL_out_sharp</a></td>
<td style="text-align:center">No</td>
<td style="text-align:center">LW</td>
<td>Output sharpening using GMic (Richardson-Lucy algorithm)</td>
</tr>
<tr>
<td><a href="/luadocs/lua.scripts.manual/scripts/contrib/select_untagged/">select_untagged</a></td>
<td style="text-align:center">Yes</td>
<td style="text-align:center">LMW</td>
<td>Enable selection of untagged images</td>
</tr>
<tr>
<td><a href="/luadocs/lua.scripts.manual/scripts/contrib/slideshowmusic/">slideshowMusic</a></td>
<td style="text-align:center">No</td>
<td style="text-align:center">L</td>
<td>Play music during a slideshow</td>
</tr>
<tr>
<td><a href="/luadocs/lua.scripts.manual/scripts/contrib/transfer_hierarchy/">transfer_hierarchy</a></td>
<td style="text-align:center">Yes</td>
<td style="text-align:center">LMW</td>
<td>Image move/copy preserving directory hierarchy</td>
</tr>
<tr>
<td><a href="/luadocs/lua.scripts.manual/scripts/contrib/video_ffmpeg/">video_ffmpeg</a></td>
<td style="text-align:center">No</td>
<td style="text-align:center">LMW</td>
<td>Export video from darktable</td>
</tr>
</tbody>
</table>
<h3 id="example-scripts"><a href="#example-scripts">🔗</a>Example Scripts</h3>
<p>These scripts provide examples of how to use specific portions of the API. They run, but are meant for demonstration purposes only. They are located in the examples/ directory.</p>
<table>
<thead>
<tr>
<th>Name</th>
<th style="text-align:center">Standalone</th>
<th style="text-align:center">Op/Sys</th>
<th>Purpose</th>
</tr>
</thead>
<tbody>
<tr>
<td><a href="/luadocs/lua.scripts.manual/scripts/examples/api_version/">api_version</a></td>
<td style="text-align:center">Yes</td>
<td style="text-align:center">LMW</td>
<td>Print the current API version</td>
</tr>
<tr>
<td><a href="/luadocs/lua.scripts.manual/scripts/examples/darkroom_demo/">darkroom_demo</a></td>
<td style="text-align:center">Yes</td>
<td style="text-align:center">LMW</td>
<td>Demonstrate changing images in darkoom</td>
</tr>
<tr>
<td><a href="/luadocs/lua.scripts.manual/scripts/examples/gettextexample/">gettextExample</a></td>
<td style="text-align:center">Yes</td>
<td style="text-align:center">LM</td>
<td>How to use translation</td>
</tr>
<tr>
<td><a href="/luadocs/lua.scripts.manual/scripts/examples/hello_world/">hello_world</a></td>
<td style="text-align:center">Yes</td>
<td style="text-align:center">LMW</td>
<td>Prints hello world when darktable starts</td>
</tr>
<tr>
<td><a href="/luadocs/lua.scripts.manual/scripts/examples/lighttable_demo/">lighttable_demo</a></td>
<td style="text-align:center">Yes</td>
<td style="text-align:center">LMW</td>
<td>Demonstrate controlling lighttable mode, zoom, sorting and filtering</td>
</tr>
<tr>
<td><a href="/luadocs/lua.scripts.manual/scripts/examples/moduleexample/">moduleExample</a></td>
<td style="text-align:center">Yes</td>
<td style="text-align:center">LMW</td>
<td>How to create a lighttable module</td>
</tr>
<tr>
<td><a href="/luadocs/lua.scripts.manual/scripts/examples/multi_os/">multi_os</a></td>
<td style="text-align:center">No</td>
<td style="text-align:center">LMW</td>
<td>How to create a cross platform script that calls an external executable</td>
</tr>
<tr>
<td><a href="/luadocs/lua.scripts.manual/scripts/examples/panels_demo/">panels_demo</a></td>
<td style="text-align:center">Yes</td>
<td style="text-align:center">LMW</td>
<td>Demonstrate hiding and showing darktable panels</td>
</tr>
<tr>
<td><a href="/luadocs/lua.scripts.manual/scripts/examples/preferenceexamples/">preferenceExamples</a></td>
<td style="text-align:center">Yes</td>
<td style="text-align:center">LMW</td>
<td>How to use preferences in a script</td>
</tr>
<tr>
<td><a href="/luadocs/lua.scripts.manual/scripts/examples/printexamples/">printExamples</a></td>
<td style="text-align:center">Yes</td>
<td style="text-align:center">LMW</td>
<td>How to use various print functions from a script</td>
</tr>
<tr>
<td><a href="/luadocs/lua.scripts.manual/scripts/examples/running_os/">running_os</a></td>
<td style="text-align:center">Yes</td>
<td style="text-align:center">LMW</td>
<td>Print out the running operating system</td>
</tr>
</tbody>
</table>
<h3 id="tools"><a href="#tools">🔗</a>Tools</h3>
<p>Tool scripts perform functions relating to the repository, such as generating documentation. They are located in the tools/ directory.</p>
<table>
<thead>
<tr>
<th>Name</th>
<th style="text-align:center">Standalone</th>
<th style="text-align:center">Op/Sys</th>
<th>Purpose</th>
</tr>
</thead>
<tbody>
<tr>
<td><a href="/luadocs/lua.scripts.manual/scripts/tools/executable_manager/">executable_manager</a></td>
<td style="text-align:center">Yes</td>
<td style="text-align:center">LMW</td>
<td>Manage the external executables used by the lua scripts</td>
</tr>
<tr>
<td><a href="/luadocs/lua.scripts.manual/scripts/tools/gen_i18n_mo/">gen_i18n_mo</a></td>
<td style="text-align:center">No</td>
<td style="text-align:center">LMW</td>
<td>Generate compiled translation files (.mo) from source files (.po)</td>
</tr>
<tr>
<td><a href="/luadocs/lua.scripts.manual/scripts/tools/get_lib_manpages/">get_lib_manpages</a></td>
<td style="text-align:center">No</td>
<td style="text-align:center">LM</td>
<td>Retrieve the library documentation and output it in man page and PDF format</td>
</tr>
<tr>
<td><a href="/luadocs/lua.scripts.manual/scripts/tools/get_libdoc/">get_libdoc</a></td>
<td style="text-align:center">No</td>
<td style="text-align:center">LMW</td>
<td>Retrieve the library documentation and output it as text</td>
</tr>
<tr>
<td><a href="/luadocs/lua.scripts.manual/scripts/tools/script_manager/">script_manager</a></td>
<td style="text-align:center">No</td>
<td style="text-align:center">LMW</td>
<td>Manage (install, update, enable, disable) the lua scripts</td>
</tr>
</tbody>
</table>
</article>
<div class="prev-next row">
<div class="col-6">
<a href="https://elstoc.github.io/luadocs/lua.scripts.manual/scripts/" class="next">&lt; scripts</a>
</div>
<div class="col-6">
<a href="https://elstoc.github.io/luadocs/lua.scripts.manual/scripts/official/" class="prev">official &gt;</a>
</div>
</div>
</div>
</div>
</div>
</body>
</html>
<script>
(function($) {
$.fn.scrollToMiddle = function(options) {
var settings = $.extend({
duration: 0
}, options );
return this.each(function() {
var $el = $(this);
var elOffset = $el.offset().top;
var elHeight = $el.height();
var windowHeight = $(window).height();
var offset;
if (elHeight < windowHeight) {
offset = elOffset - ((windowHeight / 2) - (elHeight / 2));
}
else {
offset = elOffset;
}
$('.navigation').scrollTop(offset);
});
};
}(jQuery));
$('.navigation').css('opacity', '0');
$(document).ready(function(){
$('.parent ul').hide();
$('.navigation').css('opacity', 1.0);
$('.active').parents('ul').show();
$('.active').siblings('ul').show();
$('.active').children('i.toggle').removeClass("fa-plus-squre").addClass("fa-minus-square-o");
$('.active').parents('li').children('.toggle').removeClass("fa-plus-square").addClass("fa-minus-square-o");
$('.active').scrollToMiddle();
$('.toggle').on('click', function (e) {
e.stopPropagation();
$(this).siblings('ul').slideToggle();
if($(this).hasClass("fa-plus-square")) {
$(this).addClass("fa-minus-square-o");
$(this).removeClass("fa-plus-square");
}
else {
$(this).addClass("fa-plus-square");
$(this).removeClass("fa-minus-square-o");
}
});
});
</script>