2020-12-14 23:54:59 +00:00
<!doctype html>
< html lang = "en" >
< head >
< meta charset = "utf-8" >
< meta http-equiv = "x-ua-compatible" content = "ie=edge" >
< title > darktable lua documentation - installation< / 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" >
2020-12-14 23:57:48 +00:00
< link rel = "stylesheet" href = "https://darktable-org.github.io/luadocs/css/style.min.6f8fcc9b0ebcd3ac477a507f922faefdf963732422cd88933d1d4783ebccb952.css" >
2020-12-14 23:54:59 +00:00
2020-12-14 23:57:48 +00:00
< script src = "https://darktable-org.github.io/luadocs/js/jquery.js" > < / script >
< script src = "https://darktable-org.github.io/luadocs/js/popper.js" type = "module" > < / script >
< script src = "https://darktable-org.github.io/luadocs/js/bootstrap.js" > < / script >
< script src = "https://darktable-org.github.io/luadocs/js/lunr.js" > < / script >
< script src = "https://darktable-org.github.io/luadocs/js/app.js" > < / script >
2020-12-14 23:54:59 +00:00
< / head >
< body >
< header class = "navbar navbar-expand-lg sticky-top navbar-dark bg-dark" >
2020-12-14 23:57:48 +00:00
< a class = "navbar-brand" href = "https://darktable-org.github.io/luadocs/" rel = "home" title = ".Site.Title" >
2020-12-14 23:54:59 +00:00
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 >
2020-12-14 23:57:48 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/" class = "" >
2020-12-14 23:54:59 +00:00
Lua Scripts Manual
< / a >
< ul >
< li >
< i class = "no-toggle" > < / i >
2020-12-14 23:57:48 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/overview/" class = "" >
2020-12-14 23:54:59 +00:00
overview
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
2020-12-14 23:57:48 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/installation/" class = " active" >
2020-12-14 23:54:59 +00:00
installation
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
2020-12-14 23:57:48 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/troubleshooting/" class = "" >
2020-12-14 23:54:59 +00:00
troubleshooting
< / a >
< / li >
< li class = "parent" >
< i class = "fa fa-plus-square toggle" > < / i >
2020-12-14 23:57:48 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/" class = "" >
2020-12-14 23:54:59 +00:00
scripts
< / a >
< ul >
< li >
< i class = "no-toggle" > < / i >
2020-12-14 23:57:48 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/overview/" class = "" >
2020-12-14 23:54:59 +00:00
overview
< / a >
< / li >
< li class = "parent" >
< i class = "fa fa-plus-square toggle" > < / i >
2020-12-14 23:57:48 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/contrib/" class = "" >
2020-12-14 23:54:59 +00:00
contrib
< / a >
< ul >
< li >
< i class = "no-toggle" > < / i >
2020-12-14 23:57:48 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/contrib/autogrouper/" class = "" >
2020-12-18 21:50:11 +00:00
AutoGrouper
2020-12-14 23:54:59 +00:00
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
2020-12-14 23:57:48 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/contrib/autostyle/" class = "" >
2020-12-14 23:54:59 +00:00
autostyle
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
2020-12-14 23:57:48 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/contrib/clear_gps/" class = "" >
2020-12-14 23:54:59 +00:00
clear_GPS
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
2020-12-14 23:57:48 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/contrib/collecthelper/" class = "" >
2020-12-14 23:54:59 +00:00
CollectHelper
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
2020-12-14 23:57:48 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/contrib/copy_attach_detach_tags/" class = "" >
2020-12-14 23:54:59 +00:00
copy_attach_detach_tags
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
2020-12-14 23:57:48 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/contrib/cr2hdr/" class = "" >
2020-12-14 23:54:59 +00:00
cr2hdr
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
2020-12-14 23:57:48 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/contrib/enfuseadvanced/" class = "" >
2020-12-14 23:54:59 +00:00
enfuseAdvanced
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
2020-12-14 23:57:48 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/contrib/exportlut/" class = "" >
2020-12-14 23:54:59 +00:00
exportLUT
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
2020-12-14 23:57:48 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/contrib/ext_editor/" class = "" >
2020-12-14 23:54:59 +00:00
ext_editor
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
2020-12-14 23:57:48 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/contrib/face_recognition/" class = "" >
2020-12-14 23:54:59 +00:00
face_recognition
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
2020-12-14 23:57:48 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/contrib/fujifilm_ratings/" class = "" >
2020-12-14 23:54:59 +00:00
fujifilm_ratings
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
2020-12-14 23:57:48 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/contrib/geojson_export/" class = "" >
2020-12-14 23:54:59 +00:00
geoJSON_export
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
2020-12-14 23:57:48 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/contrib/geotoolbox/" class = "" >
2020-12-14 23:54:59 +00:00
geoToolbox
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
2020-12-14 23:57:48 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/contrib/gimp/" class = "" >
2020-12-14 23:54:59 +00:00
gimp
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
2020-12-14 23:57:48 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/contrib/gpx_export/" class = "" >
2020-12-14 23:54:59 +00:00
gpx_export
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
2020-12-14 23:57:48 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/contrib/hdrmerge/" class = "" >
2020-12-14 23:54:59 +00:00
HDRMerge
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
2020-12-14 23:57:48 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/contrib/hugin/" class = "" >
2020-12-14 23:54:59 +00:00
hugin
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
2020-12-14 23:57:48 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/contrib/image_stack/" class = "" >
2020-12-14 23:54:59 +00:00
image_stack
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
2020-12-14 23:57:48 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/contrib/image_time/" class = "" >
2020-12-14 23:54:59 +00:00
image_time
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
2020-12-14 23:57:48 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/contrib/kml_export/" class = "" >
2020-12-14 23:54:59 +00:00
kml_export
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
2020-12-14 23:57:48 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/contrib/labelstotags/" class = "" >
2020-12-14 23:54:59 +00:00
LabelsToTags
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
2020-12-14 23:57:48 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/contrib/openinexplorer/" class = "" >
2020-12-14 23:54:59 +00:00
OpenInExplorer
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
2020-12-14 23:57:48 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/contrib/passport_guide/" class = "" >
2020-12-14 23:54:59 +00:00
passport_guide
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
2020-12-14 23:57:48 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/contrib/pdf_slideshow/" class = "" >
2020-12-14 23:54:59 +00:00
pdf_slideshow
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
2020-12-14 23:57:48 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/contrib/photils/" class = "" >
2020-12-14 23:54:59 +00:00
photils
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
2020-12-14 23:57:48 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/contrib/quicktag/" class = "" >
2020-12-14 23:54:59 +00:00
quicktag
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
2020-12-14 23:57:48 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/contrib/rate_group/" class = "" >
2020-12-14 23:54:59 +00:00
rate_group
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
2020-12-14 23:57:48 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/contrib/rename-tags/" class = "" >
2020-12-14 23:54:59 +00:00
rename_tags
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
2020-12-14 23:57:48 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/contrib/rl_out_sharp/" class = "" >
2020-12-14 23:54:59 +00:00
RL_out_sharp
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
2020-12-14 23:57:48 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/contrib/slideshowmusic/" class = "" >
2020-12-14 23:54:59 +00:00
slideshowMusic
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
2020-12-14 23:57:48 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/contrib/transfer_hierarchy/" class = "" >
2020-12-14 23:54:59 +00:00
transfer_hierarchy
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
2020-12-14 23:57:48 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/contrib/video_ffmpeg/" class = "" >
2020-12-14 23:54:59 +00:00
video_ffmpeg
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
2020-12-14 23:57:48 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/contrib/select_untagged/" class = "" >
2020-12-14 23:54:59 +00:00
select_untagged
< / a >
< / li >
< / ul >
< / li >
< li class = "parent" >
< i class = "fa fa-plus-square toggle" > < / i >
2020-12-14 23:57:48 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/examples/" class = "" >
2020-12-14 23:54:59 +00:00
examples
< / a >
< ul >
< li >
< i class = "no-toggle" > < / i >
2020-12-14 23:57:48 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/examples/api_version/" class = "" >
2020-12-14 23:54:59 +00:00
api_version
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
2020-12-14 23:57:48 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/examples/darkroom_demo/" class = "" >
2020-12-14 23:54:59 +00:00
darkroom_demo
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
2020-12-14 23:57:48 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/examples/gettextexample/" class = "" >
2020-12-14 23:54:59 +00:00
gettextExample
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
2020-12-14 23:57:48 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/examples/hello_world/" class = "" >
2020-12-14 23:54:59 +00:00
hello_world
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
2020-12-14 23:57:48 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/examples/lighttable_demo/" class = "" >
2020-12-14 23:54:59 +00:00
lighttable_demo
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
2020-12-14 23:57:48 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/examples/moduleexample/" class = "" >
2020-12-14 23:54:59 +00:00
moduleExample
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
2020-12-14 23:57:48 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/examples/multi_os/" class = "" >
2020-12-14 23:54:59 +00:00
name
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
2020-12-14 23:57:48 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/examples/panels_demo/" class = "" >
2020-12-14 23:54:59 +00:00
panels_demo
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
2020-12-14 23:57:48 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/examples/preferenceexamples/" class = "" >
2020-12-14 23:54:59 +00:00
preferenceExample
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
2020-12-14 23:57:48 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/examples/printexamples/" class = "" >
2020-12-14 23:54:59 +00:00
printExamples
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
2020-12-14 23:57:48 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/examples/running_os/" class = "" >
2020-12-14 23:54:59 +00:00
running_os
< / a >
< / li >
< / ul >
< / li >
< li class = "parent" >
< i class = "fa fa-plus-square toggle" > < / i >
2020-12-18 21:50:11 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/official/" class = "" >
official
< / a >
< ul >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.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://darktable-org.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://darktable-org.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://darktable-org.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://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/official/enfuse/" class = "" >
enfuse
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.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://darktable-org.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://darktable-org.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://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/official/import_filters/" class = "" >
import_filters
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/official/save_selection/" class = "" >
save_selection
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
< a href = "https://darktable-org.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 >
2020-12-14 23:57:48 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/tools/" class = "" >
2020-12-14 23:54:59 +00:00
tools
< / a >
< ul >
< li >
< i class = "no-toggle" > < / i >
2020-12-14 23:57:48 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/tools/executable_manager/" class = "" >
2020-12-14 23:54:59 +00:00
executable_manager
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
2020-12-14 23:57:48 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/tools/gen_i18n_mo/" class = "" >
2020-12-14 23:54:59 +00:00
gen_i18n_mo
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
2020-12-14 23:57:48 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/tools/get_lib_manpages/" class = "" >
2020-12-14 23:54:59 +00:00
get_lib_manpages
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
2020-12-14 23:57:48 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/tools/get_libdoc/" class = "" >
2020-12-14 23:54:59 +00:00
get_libdoc
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
2020-12-14 23:57:48 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/scripts/tools/script_manager/" class = "" >
2020-12-14 23:54:59 +00:00
script_manager
< / a >
< / li >
< / ul >
< / li >
< / ul >
< / li >
< / ul >
< / li >
< li class = "parent" >
< i class = "fa fa-plus-square toggle" > < / i >
2020-12-14 23:57:48 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.api.manual/" class = "" >
2020-12-14 23:54:59 +00:00
Lua Scripts Libraries API Manual
< / a >
< ul >
< li class = "parent" >
< i class = "fa fa-plus-square toggle" > < / i >
2020-12-14 23:57:48 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils/" class = "" >
2020-12-14 23:54:59 +00:00
dtutils
< / a >
< ul >
< li >
< i class = "no-toggle" > < / i >
2020-12-14 23:57:48 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils/details/" class = "" >
2020-12-14 23:54:59 +00:00
details
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
2020-12-14 23:57:48 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils/check_min_api_version/" class = "" >
2020-12-14 23:54:59 +00:00
check_min_api_version
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
2020-12-14 23:57:48 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils/check_os/" class = "" >
2020-12-14 23:54:59 +00:00
check_os
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
2020-12-14 23:57:48 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils/join/" class = "" >
2020-12-14 23:54:59 +00:00
join
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
2020-12-14 23:57:48 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils/prequire/" class = "" >
2020-12-14 23:54:59 +00:00
prequire
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
2020-12-14 23:57:48 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils/spairs/" class = "" >
2020-12-14 23:54:59 +00:00
spairs
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
2020-12-14 23:57:48 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils/split/" class = "" >
2020-12-14 23:54:59 +00:00
split
< / a >
< / li >
< / ul >
< / li >
< li class = "parent" >
< i class = "fa fa-plus-square toggle" > < / i >
2020-12-14 23:57:48 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils.debug/" class = "" >
2020-12-14 23:54:59 +00:00
dtutils.debug
< / a >
< ul >
< li >
< i class = "no-toggle" > < / i >
2020-12-14 23:57:48 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils.debug/details/" class = "" >
2020-12-14 23:54:59 +00:00
details
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
2020-12-14 23:57:48 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils.debug/dprint/" class = "" >
2020-12-14 23:54:59 +00:00
dprint
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
2020-12-14 23:57:48 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils.debug/new_tracepoint/" class = "" >
2020-12-14 23:54:59 +00:00
new_tracepoint
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
2020-12-14 23:57:48 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils.debug/terse_dump/" class = "" >
2020-12-14 23:54:59 +00:00
terse_dump
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
2020-12-14 23:57:48 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils.debug/tracepoint/" class = "" >
2020-12-14 23:54:59 +00:00
tracepoint
< / a >
< / li >
< / ul >
< / li >
< li class = "parent" >
< i class = "fa fa-plus-square toggle" > < / i >
2020-12-14 23:57:48 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils.file/" class = "" >
2020-12-14 23:54:59 +00:00
dtutils.file
< / a >
< ul >
< li >
< i class = "no-toggle" > < / i >
2020-12-14 23:57:48 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils.file/details/" class = "" >
2020-12-14 23:54:59 +00:00
details
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
2020-12-14 23:57:48 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils.file/check_if_bin_exists/" class = "" >
2020-12-14 23:54:59 +00:00
check_if_bin_exists
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
2020-12-14 23:57:48 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils.file/check_if_file_exists/" class = "" >
2020-12-14 23:54:59 +00:00
check_if_file_exists
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
2020-12-14 23:57:48 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils.file/chop_filetype/" class = "" >
2020-12-14 23:54:59 +00:00
chop_filetype
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
2020-12-14 23:57:48 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils.file/create_unique_filename/" class = "" >
2020-12-14 23:54:59 +00:00
create_unique_filename
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
2020-12-14 23:57:48 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils.file/executable_path_widget/" class = "" >
2020-12-14 23:54:59 +00:00
executable_path_widget
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
2020-12-14 23:57:48 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils.file/file_copy/" class = "" >
2020-12-14 23:54:59 +00:00
file_copy
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
2020-12-14 23:57:48 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils.file/file_move/" class = "" >
2020-12-14 23:54:59 +00:00
file_move
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
2020-12-14 23:57:48 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils.file/filename_increment/" class = "" >
2020-12-14 23:54:59 +00:00
filename_increment
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
2020-12-14 23:57:48 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils.file/get_basename/" class = "" >
2020-12-14 23:54:59 +00:00
get_basename
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
2020-12-14 23:57:48 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils.file/get_executable_path_preference/" class = "" >
2020-12-14 23:54:59 +00:00
get_executable_path_preference
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
2020-12-14 23:57:48 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils.file/get_filename/" class = "" >
2020-12-14 23:54:59 +00:00
get_filename
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
2020-12-14 23:57:48 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils.file/get_filetype/" class = "" >
2020-12-14 23:54:59 +00:00
get_filetype
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
2020-12-14 23:57:48 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils.file/get_path/" class = "" >
2020-12-14 23:54:59 +00:00
get_path
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
2020-12-14 23:57:48 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils.file/mkdir/" class = "" >
2020-12-14 23:54:59 +00:00
mkdir
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
2020-12-14 23:57:48 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils.file/rmdir/" class = "" >
2020-12-14 23:54:59 +00:00
rmdir
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
2020-12-14 23:57:48 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils.file/sanitize_filename/" class = "" >
2020-12-14 23:54:59 +00:00
sanitize_filename
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
2020-12-14 23:57:48 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils.file/set_executable_path_preference/" class = "" >
2020-12-14 23:54:59 +00:00
set_executable_path_preference
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
2020-12-14 23:57:48 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils.file/split_filepath/" class = "" >
2020-12-14 23:54:59 +00:00
split_filepath
< / a >
< / li >
< / ul >
< / li >
< li class = "parent" >
< i class = "fa fa-plus-square toggle" > < / i >
2020-12-14 23:57:48 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils.log/" class = "" >
2020-12-14 23:54:59 +00:00
dtutils.log
< / a >
< ul >
< li >
< i class = "no-toggle" > < / i >
2020-12-14 23:57:48 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils.log/details/" class = "" >
2020-12-14 23:54:59 +00:00
details
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
2020-12-14 23:57:48 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils.log/caller/" class = "" >
2020-12-14 23:54:59 +00:00
caller
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
2020-12-14 23:57:48 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils.log/engine/" class = "" >
2020-12-14 23:54:59 +00:00
engine
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
2020-12-14 23:57:48 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils.log/log_level/" class = "" >
2020-12-14 23:54:59 +00:00
log_level
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
2020-12-14 23:57:48 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils.log/msg/" class = "" >
2020-12-14 23:54:59 +00:00
msg
< / a >
< / li >
< / ul >
< / li >
< li class = "parent" >
< i class = "fa fa-plus-square toggle" > < / i >
2020-12-14 23:57:48 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils.string/" class = "" >
2020-12-14 23:54:59 +00:00
dtutils.string
< / a >
< ul >
< li >
< i class = "no-toggle" > < / i >
2020-12-14 23:57:48 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils.string/details/" class = "" >
2020-12-14 23:54:59 +00:00
details
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
2020-12-14 23:57:48 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils.string/escape_xml_characters/" class = "" >
2020-12-14 23:54:59 +00:00
escape_xml_characters
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
2020-12-14 23:57:48 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils.string/is_not_sanitized/" class = "" >
2020-12-14 23:54:59 +00:00
is_not_sanitized
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
2020-12-14 23:57:48 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils.string/sanitize/" class = "" >
2020-12-14 23:54:59 +00:00
sanitize
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
2020-12-14 23:57:48 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils.string/sanitize_lua/" class = "" >
2020-12-14 23:54:59 +00:00
sanitize_lua
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
2020-12-14 23:57:48 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils.string/strip_accents/" class = "" >
2020-12-14 23:54:59 +00:00
strip_accents
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
2020-12-14 23:57:48 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils.string/urlencode/" class = "" >
2020-12-14 23:54:59 +00:00
urlencode
< / a >
< / li >
< / ul >
< / li >
< li class = "parent" >
< i class = "fa fa-plus-square toggle" > < / i >
2020-12-14 23:57:48 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils.system/" class = "" >
2020-12-14 23:54:59 +00:00
dtutils.system
< / a >
< ul >
< li >
< i class = "no-toggle" > < / i >
2020-12-14 23:57:48 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils.system/details/" class = "" >
2020-12-14 23:54:59 +00:00
details
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
2020-12-14 23:57:48 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils.system/external_command/" class = "" >
2020-12-14 23:54:59 +00:00
external_command
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
2020-12-14 23:57:48 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils.system/launch_default_app/" class = "" >
2020-12-14 23:54:59 +00:00
launch_default_app
< / a >
< / li >
< li >
< i class = "no-toggle" > < / i >
2020-12-14 23:57:48 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils.system/windows_command/" class = "" >
2020-12-14 23:54:59 +00:00
windows_command
< / a >
< / li >
< / ul >
< / li >
< / ul >
< / li >
< li class = "parent" >
< i class = "fa fa-plus-square toggle" > < / i >
2020-12-19 03:09:45 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.api.manual/" class = "" >
2020-12-14 23:54:59 +00:00
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" >
2020-12-14 23:57:48 +00:00
< a href = 'https://darktable-org.github.io/luadocs/' > Home< / a > / < a href = 'https://darktable-org.github.io/luadocs/lua.scripts.manual/' > Lua Scripts Manual< / a > / installation
2020-12-14 23:54:59 +00:00
< / span >
< / div >
< div class = "prev-next row" >
< div class = "col-6" >
2020-12-14 23:57:48 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/overview/" class = "next" > < overview< / a >
2020-12-14 23:54:59 +00:00
< / div >
< div class = "col-6" >
2020-12-14 23:57:48 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/troubleshooting/" class = "prev" > troubleshooting > < / a >
2020-12-14 23:54:59 +00:00
< / div >
< / div >
< article role = "main" >
< h1 class = "title" >
installation
< / h1 >
< h2 id = "download-and-install" > < a href = "#download-and-install" > 🔗< / a > Download and Install< / h2 >
< p > The recommended method of installation is using git to clone the repository. This ensures that all dependencies on other scripts
are met as well as providing an easy update path.< / p >
< h3 id = "snap-packages" > < a href = "#snap-packages" > 🔗< / a > snap packages< / h3 >
< p > The snap version of darktable comes with lua included starting with version 2.4.3snap2.< / p >
< p > Ensure git is installed on your system. If it isn’ t, use the package manager to install it. Then open a terminal and:< / p >
< pre > < code > cd ~/snap/darktable/current
git clone https://github.com/darktable-org/lua-scripts.git lua
< / code > < / pre >
< h3 id = "flatpak-packages" > < a href = "#flatpak-packages" > 🔗< / a > flatpak packages< / h3 >
< p > Flatpak packages now use the internal lua interpreter.< / p >
< p > Ensure git is installed on your system. If it isn’ t, use the package manager to install it. Then open a terminal and:< / p >
< pre > < code > cd ~/.var/app/org.darktable.Darktable/config/darktable
git clone https://github.com/darktable-org/lua-scripts.git lua
< / code > < / pre >
< h3 id = "appimage-packages" > < a href = "#appimage-packages" > 🔗< / a > appimage packages< / h3 >
< p > These packages run in their own environment and don’ t have access to a lua interpreter, therefore the scripts can’ t run. The packagers could enable the internal interpreter, or allow the package to link the interpreter from the operating system, or bundle a copy of lua with the package. If you use one of these packages and wish to use the lua scripts, please contact the package maintainer and suggest the above fixes.< / p >
< h3 id = "linux-and-macos" > < a href = "#linux-and-macos" > 🔗< / a > Linux and MacOS< / h3 >
< p > Ensure git is installed on your system. If it isn’ t, use the package manager to install it. Then open a terminal and:< / p >
< pre > < code > cd ~/.config/darktable/
git clone https://github.com/darktable-org/lua-scripts.git lua
< / code > < / pre >
< h3 id = "windows" > < a href = "#windows" > 🔗< / a > Windows< / h3 >
< p > Ensure git is installed on your system. Git can be obtained from < a href = "https://gitforwindows.org/," > https://gitforwindows.org/,< / a > as well as other places. If you use the gitforwindows.org distribution, install the Git Bash Shell also as it will aid in debugging the scripts if necessary. Then open a command prompt and run:< / p >
< pre > < code > cd %LOCALAPPDATA%\darktable
git clone https://github.com/darktable-org/lua-scripts.git lua
< / code > < / pre >
< p > If you don’ t have %LOCALAPPDATA%\darktable you have to start dartable at least once, because the directory is created at the first start of darktable.< / p >
< h2 id = "enabling" > < a href = "#enabling" > 🔗< / a > Enabling< / h2 >
< p > When darktable starts it looks for a file name < code > ~/.config/darktable/luarc< / code > (< code > %LOCALAPPDATA%\darktable\luarc< / code > for windows) and reads it to see which scripts to include. The file is a plain text file with entries of the form < code > require " < directory> /< name> " < / code > where directory is the directory containing the scripts, from the above list, and name is the name from the above list. To include GIMP the line would be < code > require " contrib/gimp" < / code > .< / p >
< p > The recommended way to enable and disable specific scripts is using the script manager module. To use script manager do the following:< / p >
< h3 id = "linux-or-macos" > < a href = "#linux-or-macos" > 🔗< / a > Linux or MacOS< / h3 >
< pre > < code > echo 'require " tools/script_manager" ' > ~/.config/darktable/luarc
< / code > < / pre >
< h3 id = "windows-1" > < a href = "#windows-1" > 🔗< / a > Windows< / h3 >
< pre > < code > echo " require 'tools/script_manager'" > %LOCALAPPDATA%\darktable\luarc
< / code > < / pre >
< h3 id = "snap" > < a href = "#snap" > 🔗< / a > Snap< / h3 >
< pre > < code > echo 'require " tools/script_manager" ' > ~/snap/darktable/current/luarc
< / code > < / pre >
< h3 id = "flatpak" > < a href = "#flatpak" > 🔗< / a > Flatpak< / h3 >
< pre > < code > echo require " tools/script_manager" ' > ~/.var/app/org.darktable.Darktable/config/darktable/luarc
< / code > < / pre >
< p > You can also create or add lines to the luarc file from the command line:< / p >
< p > < code > echo 'require " contrib/gimp" ' > ~/.config/darktable/luarc< / code > to create the file with a gimp entry< br >
or < code > echo 'require " contrib/hugin" ' > > ~/.config/darktable/luarc< / code > to add an entry for hugin.< / p >
< p > On windows from a command prompt:< / p >
< p > < code > echo require " contrib/gimp" > %LOCALAPPDATA%\darktable\luarc< / code > to create the file with a gimp entry< br >
or < code > echo require " contrib/hugin" > > %LOCALAPPDATA%\darktable\luarc< / code > to add an entry for hugin.< / p >
< h2 id = "disabling" > < a href = "#disabling" > 🔗< / a > Disabling< / h2 >
< p > To disable a script open the luarc file in your text editor and insert < code > --< / code > at the start of the line containing the script you wish to disable, then save the file.< / p >
< h2 id = "updating" > < a href = "#updating" > 🔗< / a > Updating< / h2 >
< p > To update the script repository, open a terminal or command prompt and do the following:< / p >
< h3 id = "snap-1" > < a href = "#snap-1" > 🔗< / a > Snap< / h3 >
< pre > < code > cd ~/snap/darktable/current/lua
git pull
< / code > < / pre >
< h3 id = "flatpak-1" > < a href = "#flatpak-1" > 🔗< / a > Flatpak< / h3 >
< pre > < code > cd ~/.var/app/org.darktable.Darktable/config/darktable/lua
git pull
< / code > < / pre >
< h3 id = "linux-and-macos-1" > < a href = "#linux-and-macos-1" > 🔗< / a > Linux and MacOS< / h3 >
< pre > < code > cd ~/.config/darktable/lua/
git pull
< / code > < / pre >
< h3 id = "windows-2" > < a href = "#windows-2" > 🔗< / a > Windows< / h3 >
< pre > < code > cd %LOCALAPPDATA%\darktable\lua
git pull
< / code > < / pre >
< / article >
< div class = "prev-next row" >
< div class = "col-6" >
2020-12-14 23:57:48 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/overview/" class = "next" > < overview< / a >
2020-12-14 23:54:59 +00:00
< / div >
< div class = "col-6" >
2020-12-14 23:57:48 +00:00
< a href = "https://darktable-org.github.io/luadocs/lua.scripts.manual/troubleshooting/" class = "prev" > troubleshooting > < / a >
2020-12-14 23:54:59 +00:00
< / 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 >
