1DARKTABLE-CLI(1)                   darktable                  DARKTABLE-CLI(1)
2
3
4

NAME

6       darktable-cli - a command line darktable variant
7

SYNOPSIS

9           darktable-cli IMG_1234.{RAW,...} [<xmp file>] <output file> [options] [--core <darktable options>]
10
11       Options:
12
13           --width <max width>
14           --height <max height>
15           --bpp <bpp>
16           --hq <0|1|false|true>
17           --upscale <0|1|false|true>
18           --export_masks <0|1|false|true>
19           --style <style name>
20           --style-overwrite
21           --apply-custom-presets <0|1|false|true>
22           --verbose
23           --help
24           --version
25

DESCRIPTION

27       darktable is a digital photography workflow application for Linux, Mac
28       OS X and several other Unices.  It's described further in darktable(1).
29
30       darktable-cli is a command line variant to be used to export images
31       given the raw file and the accompanying xmp file.
32

OPTIONS

34       The user needs to supply an input filename and an output filename.  All
35       other parameters are optional.
36
37       <input file>
38           The name of the input file to export.
39
40       <xmp file>
41           The optional name of an XMP sidecar file containing the history
42           stack data to be applied during export.  If this option is not
43           given darktable will search for an XMP file that belongs to the
44           given input file.
45
46       <output file>
47           The name of the output file.  darktable derives the export file
48           format from the file extension.  You can also use all the variables
49           available in darktable's export module in the output filename.
50
51       --width <max width>
52           This optional parameter allows one to limit the width of the
53           exported image to that number of pixels.
54
55       --height <max height>
56           This optional parameter allows one to limit the height of the
57           exported image to that number of pixels.
58
59       --bpp <bpp>
60           An optional parameter to define the bit depth of the exported
61           image; allowed values depend on the file format.  Currently this
62           option is not yet functional.  If you need to define the bit depth
63           you need to use the following workaround:
64
65               --core --conf plugins/imageio/format/<FORMAT>/bpp=<VALUE>
66
67           where FORMAT is the name of the selected output format, for example
68           png.
69
70       --hq <0|1|true|false>
71           A flag that defines whether to use high quality resampling during
72           export.  Defaults to true.
73
74       --upscale <0|1|true|false>
75           A flag that defines whether to allow upscaling during export.
76           Defaults to false.
77
78       --export_masks <0|1|true|false>
79           A flag that defines whether masks used in the image will be stored
80           as layers in the exported image (provided the format supports it).
81           Defaults to false.
82
83       --style <style name>
84           Specify the name of a style to be applied during export.  If a
85           style is specified, the path to the darktable configuration
86           directory must also be specified (i.e. --core --configdir
87           ~/.config/darktable).  Defaults to no style specified.
88
89       --style-overwrite
90           The specified style overwrites the history stack instead of being
91           appended to it.
92
93       --apply-custom-presets
94           With this option you can decide if darktable loads its set of
95           default parameters from data.db and applies them. Otherwise the
96           defaults that ship with darktable are used.
97
98           Set this flag to false in order to run multiple instances.
99
100       --verbose
101           Enables verbose output.
102
103       --core <darktable options>
104           All command line parameters following --core are passed to the
105           darktable core and handled as standard parameters.  See
106           darktable(1) for a detailed description of the options.
107

SEE ALSO

109       darktable(1)
110

AUTHORS

112       The principal developer of darktable is Johannes Hanika.  The
113       (hopefully) complete list of contributors to the project is:
114
115       * developers: Pascal Obry Aldric Renaudin Aurélien PIERRE parafin Roman
116       Lebedev
117
118       * translators: Pascal Obry Jeronimo Pellegrini Martin Straeten EdgarLux
119       Marcus Gama Matt Maguire Victor Forsiuk 篠崎亮 Ryo Shinozaki Philippe
120       Weyland vertama Matjaž Jeran Aurélien PIERRE Matteo Mardegan Michel
121       Leblond Nicolas Auffray Tianhao Chai Bogusław Ciastek Báthory Péter Jan
122       Friedrich Tomasz Golinski Wiktor Nowak cotacot sbraitbart
123
124       * contributors (at least 4 commits): Diederik ter Rahe ralfbrown Dan
125       Torop Hubert Kowalski Philippe Weyland Hanno Schwalm Miloš Komarčević
126       Bill Ferguson Jeronimo Pellegrini Marco Carrarini Martin Straeten
127       Daniel Vogelbacher Chris Elston rawfiner Mark-64 EdgarLux Victor
128       Forsiuk Nicolas Auffray Chris.Elston Marcus Gama Sakari Kapanen Arnaud
129       TANGUY wpferguson Matt Maguire David-Tillmann Schaefer Marco Paolo
130       DePetrillo quovadit 篠崎亮 Ryo Shinozaki vertama Matjaž Jeran
131       darkelectron piratenpanda
132
133       * Sub-module rawspeed contributors (at least 1 commit): Roman Lebedev
134       Jordan Neumeyer Miloš Komarčević Andreas Schneider Marko Toplak Hanno
135       Schwalm helloqiu
136
137       * Sub-module integration contributors (at least 1 commit): Pascal Obry
138       Sakari Kapanen ralfbrown Aurélien PIERRE
139
140       And all those of you that made previous releases possible
141
142       This man page was written by Richard Levitte <richard@levitte.org>.
143       Additions were made by Tobias Ellinghaus <me@houz.org>.
144
146       Copyright (C) 2009-2019 by Authors.
147
148       darktable is free software; you can redistribute it and/or modify it
149       under the terms of the GPL v3 or (at your option) any later version.
150
151
152
153darktable 3.0                     2019-11-27                  DARKTABLE-CLI(1)
Impressum