.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "DARKTABLE-CLI 1"
.TH DARKTABLE-CLI 1 "2019-11-27" "darktable 3.0" "darktable"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
darktable\-cli \- a command line darktable variant
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    darktable\-cli IMG_1234.{RAW,...} [<xmp file>] <output file> [options] [\-\-core <darktable options>]
.Ve
.PP
Options:
.PP
.Vb 12
\&    \-\-width <max width>
\&    \-\-height <max height>
\&    \-\-bpp <bpp>
\&    \-\-hq <0|1|false|true>
\&    \-\-upscale <0|1|false|true>
\&    \-\-export_masks <0|1|false|true>
\&    \-\-style <style name>
\&    \-\-style\-overwrite
\&    \-\-apply\-custom\-presets <0|1|false|true>
\&    \-\-verbose
\&    \-\-help
\&    \-\-version
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\fBdarktable\fR is a digital photography workflow application for \fBLinux\fR, \fBMac \s-1OS X\s0\fR and several other \fBUnices\fR.
It's described further in \fBdarktable\fR\|(1).
.PP
\&\fBdarktable-cli\fR is a command line variant to be used to export images
given the raw file and the accompanying xmp file.
.SH "OPTIONS"
.IX Header "OPTIONS"
The user needs to supply an input filename and an output filename.
All other parameters are optional.
.IP "\fB<input file>\fR" 4
.IX Item "<input file>"
The name of the input file to export.
.IP "\fB<xmp file>\fR" 4
.IX Item "<xmp file>"
The optional name of an \s-1XMP\s0 sidecar file containing the history stack
data to be applied during export.
If this option is not given darktable will search for an \s-1XMP\s0 file that
belongs to the given input file.
.IP "\fB<output file>\fR" 4
.IX Item "<output file>"
The name of the output file.
darktable derives the export file format from the file extension.
You can also use all the variables available in \fBdarktable\fR's export module in the output filename.
.IP "\fB\-\-width <max width>\fR" 4
.IX Item "--width <max width>"
This optional parameter allows one to limit the width of the exported
image to that number of pixels.
.IP "\fB\-\-height <max height>\fR" 4
.IX Item "--height <max height>"
This optional parameter allows one to limit the height of the exported
image to that number of pixels.
.IP "\fB\-\-bpp <bpp>\fR" 4
.IX Item "--bpp <bpp>"
An optional parameter to define the bit depth of the exported image;
allowed values depend on the file format.
Currently this option is not yet functional.
If you need to define the bit depth you need to use the following workaround:
.Sp
.Vb 1
\&    \-\-core \-\-conf plugins/imageio/format/<FORMAT>/bpp=<VALUE>
.Ve
.Sp
where \fB\s-1FORMAT\s0\fR is the name of the selected output format, for example \fBpng\fR.
.IP "\fB\-\-hq <0|1|true|false>\fR" 4
.IX Item "--hq <0|1|true|false>"
A flag that defines whether to use high quality resampling during export.
Defaults to true.
.IP "\fB\-\-upscale <0|1|true|false>\fR" 4
.IX Item "--upscale <0|1|true|false>"
A flag that defines whether to allow upscaling during export.
Defaults to false.
.IP "\fB\-\-export_masks <0|1|true|false>\fR" 4
.IX Item "--export_masks <0|1|true|false>"
A flag that defines whether masks used in the image will be stored as layers in the
exported image (provided the format supports it).
Defaults to false.
.IP "\fB\-\-style <style name>\fR" 4
.IX Item "--style <style name>"
Specify the name of a style to be applied during export.  If a style
is specified, the path to the darktable configuration directory must
also be specified (i.e. \-\-core \-\-configdir ~/.config/darktable).
Defaults to no style specified.
.IP "\fB\-\-style\-overwrite\fR" 4
.IX Item "--style-overwrite"
The specified style overwrites the history stack instead of being
appended to it.
.IP "\fB\-\-apply\-custom\-presets\fR" 4
.IX Item "--apply-custom-presets"
With this option you can decide if darktable loads its set of default parameters from
\&\fBdata.db\fR and applies them. Otherwise the defaults that ship with darktable are used.
.Sp
Set this flag to false in order to run multiple instances.
.IP "\fB\-\-verbose\fR" 4
.IX Item "--verbose"
Enables verbose output.
.IP "\fB\-\-core <darktable options>\fR" 4
.IX Item "--core <darktable options>"
All command line parameters following \fB\-\-core\fR are passed
to the darktable core and handled as standard parameters.
See \fBdarktable\fR\|(1) for a detailed description of the options.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBdarktable\fR\|(1)
.SH "AUTHORS"
.IX Header "AUTHORS"
The principal developer of darktable is Johannes Hanika.
The (hopefully) complete list of contributors to the project is:
.PP
* developers:
Pascal Obry
Aldric Renaudin
Roman Lebedev
parafin
Edouard Gomez

* translators:
Pascal Obry
Victor Forsiuk
Jeronimo Pellegrini
Martin Straeten
Kang-Wei Hsu
EdgarLux
Besmir Godolja
Ryo Shinozaki
Serkan ÖNDER
mmardegan
Luca Cignoni
Marko Vertainen
Maurizio Paglia
Marcus Gama
Nicolas Auffray
Báthory Péter
Matjaž Jeran
Matt Maguire
Petr Stasiak
Stephan Hoek
bajdero
Matteo Mardegan
alex
alexbora
Яна Тунгушпаева

* contributors (at least 4 commits):
Hanno Schwalm
Victor Forsiuk
Diederik ter Rahe
Miloš Komarčević
jandren
Jeronimo Pellegrini
Nicolas Auffray
Martin Straeten
Kang-Wei Hsu
Simone Gotti
Sakari Kapanen
EdgarLux
rawfiner
Besmir Godolja
cyruscook
quovadit
Ryo Shinozaki
Philippe Weyland
Ralf Brown
Chris Elston
Serkan ÖNDER
mmardegan
Luca Cignoni
Apfelkraut
Marcus Gama
Marko Vertainen
Maurizio Paglia
Simon Raffeiner

* Sub-module rawspeed contributors (at least 1 commit):
Roman Lebedev
Miloš Komarčević
Daniel Vogelbacher
maruncz
Alex Tutubalin
Artemis Tosini
Georg Lukas
Georg Niedrist
LibRaw LLC
Marko Toplak
Milos Komarcevic
Pascal Obry
PeterWem
Simon Raffeiner
Sprite
luz paz
squid-f
ubergeek801

* Sub-module integration contributors (at least 1 commit):
Pascal Obry

And all those of you that made previous releases possible
.PP
This man page was written by Richard Levitte <richard@levitte.org>.
Additions were made by Tobias Ellinghaus <me@houz.org>.
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
\&\fBCopyright (C)\fR 2009\-2019 by Authors.
.PP
\&\fBdarktable\fR is free software; you can redistribute it and/or modify it
under the terms of the \s-1GPL\s0 v3 or (at your option) any later version.