Updated help and man page, #3369
This commit is contained in:
Morgan Hardwood
parent
a991d53bf3
commit
3d6f9407a2
@ -1,86 +1,67 @@
|
||||
.TH RAWTHERAPEE 1 "July 31, 2012"
|
||||
.TH RAWTHERAPEE 1 "July 05, 2016"
|
||||
.SH NAME
|
||||
rawtherapee \- an advanced cross-platform program for developing raw photos.
|
||||
.SH SYNOPSIS
|
||||
\fBrawtherapee\fP [directory|image\-file]
|
||||
.br
|
||||
\fBrawtherapee\fP [\-o|\-O <output>] [\-s|\-S] [\-p <file>] [\-d]
|
||||
[\-j[1\-100]|\-t|\-t1|\-n] [\-Y] \-c <input>
|
||||
RawTherapee - An advanced, cross-platform program for developing raw photos.
|
||||
.SH DESCRIPTION
|
||||
\fBRawTherapee\fP is an advanced program for developing raw photos and for
|
||||
processing non-raw photos. It is non-destructive, makes use of OpenMP, supports
|
||||
all the cameras supported by dcraw and carries out its calculations in a high
|
||||
precision 32bit floating point engine.
|
||||
\fBRawTherapee\fP is an advanced program for developing raw photos and for processing non-raw photos. It is non-destructive, makes use of OpenMP, supports all the cameras supported by dcraw and more, and carries out its calculations in a high precision 32-bit floating point engine.
|
||||
.SH LINKS
|
||||
Website: http://www.rawtherapee.com/
|
||||
Documentation: http://rawpedia.rawtherapee.com/
|
||||
Forum: https://discuss.pixls.us/c/software/rawtherapee
|
||||
Code and bug reports: https://github.com/Beep6581/RawTherapee
|
||||
.SH SYMBOLS
|
||||
<Chevrons> indicate parameters you can change.
|
||||
[Square brackets] mean the parameter is optional.
|
||||
The pipe symbol | indicates a choice of one or the other.
|
||||
The dash symbol - denotes a range of possible values from one to the other.
|
||||
.SH SYNOPSIS
|
||||
rawtherapee <folder> Start File Browser inside folder.
|
||||
rawtherapee <file> Start Image Editor with file.
|
||||
rawtherapee -c <dir>|<files> Convert files in batch with default parameters.
|
||||
rawtherapee <other options> -c <dir>|<files> Convert files in batch with your own settings.
|
||||
rawtherapee [-o <output>|-O <output>] [-s|-S] [-p <one.pp3> [-p <two.pp3> ...] ] [-d] [ -j[1-100] [-js<1-3>] | [-b<8|16>] [-t[z] | [-n]] ] [-Y] -c <input>
|
||||
.SH OPTIONS
|
||||
.TP
|
||||
\-o <output file>|<output dir>
|
||||
select output directory.
|
||||
.TP
|
||||
\-O <output file>|<output dir>
|
||||
select output directory and copy the PP3 file into it.
|
||||
.TP
|
||||
\-s
|
||||
use the PP3 processing profile located next to the input file (which shares
|
||||
same name as the input file) when building the processing parameters, e.g.: for
|
||||
IMG001.NEF there should be a IMG001.NEF.pp3 in the same directory. If such a
|
||||
file is not found, the default values are used.
|
||||
.TP
|
||||
\-S
|
||||
like \-s but skip processing that image if its corresponding PP3 file is not
|
||||
found.
|
||||
.TP
|
||||
\-p <PP3 file>
|
||||
specify a PP3 processing profile to be used for all conversions. You can
|
||||
specify as many \-p options as you like (see note below).
|
||||
.TP
|
||||
\-d
|
||||
use the default raw or non-raw PP3 file to build the image's parameters
|
||||
(specified in the options file).
|
||||
.TP
|
||||
\-j[1\-100]
|
||||
specify output to be JPEG (default). The compression value can be in the range
|
||||
1-100. If none was specified, the default compression value is 90, balanced
|
||||
subsampling (4:2:2).
|
||||
.TP
|
||||
\-t
|
||||
specify output to be uncompressed 8 bit per channel TIFF.
|
||||
.TP
|
||||
\-t1
|
||||
specify output to be zip-compressed 8 bit per channel TIFF.
|
||||
.TP
|
||||
\-n
|
||||
specify output to be 8 bit per channel PNG with a compression value of 6.
|
||||
.TP
|
||||
\-Y
|
||||
overwrite output if present.
|
||||
-c <files> Specify one or more input files.
|
||||
-c must be the last option.
|
||||
-o <file>|<dir> Set output file or folder.
|
||||
Saves output file alongside input file if -o is not specified.
|
||||
-O <file>|<dir> Set output file or folder and copy pp3 file into it.
|
||||
Saves output file alongside input file if -O is not specified.
|
||||
-s Use the existing sidecar file to build the processing parameters,
|
||||
e.g. for photo.raw there should be a photo.raw.pp3 file in the same folder.
|
||||
If the sidecar file does not exist, neutral values will be used.
|
||||
-S Like -s but skip if the sidecar file does not exist.
|
||||
-p <file.pp3> Specify processing profile to be used for all conversions.
|
||||
You can specify as many sets of "-p <file.pp3>" options as you like,
|
||||
each will be built on top of the previous one, as explained below.
|
||||
-d Use the default raw or non-raw processing profile as set in
|
||||
Preferences > Image Processing > Default Processing Profile
|
||||
-j[1-100] Specify output to be JPEG (default, if -t and -n are not set).
|
||||
Optionally, specify compression 1-100 (default value: 92).
|
||||
-js<1-3> Specify the JPEG chroma subsampling parameter, where:
|
||||
1 = Best compression: 2x2, 1x1, 1x1 (4:2:0)
|
||||
Chroma halved vertically and horizontally.
|
||||
2 = Balanced (default): 2x1, 1x1, 1x1 (4:2:2)
|
||||
Chroma halved horizontally.
|
||||
3 = Best quality: 1x1, 1x1, 1x1 (4:4:4)
|
||||
No chroma subsampling.
|
||||
-b<8|16> Specify bit depth per channel (default value: 16 for TIFF, 8 for PNG).
|
||||
Only applies to TIFF and PNG output, JPEG is always 8.
|
||||
-t[z] Specify output to be TIFF.
|
||||
Uncompressed by default, or deflate compression with 'z'.
|
||||
-n Specify output to be compressed PNG.
|
||||
Compression is hard-coded to 6.
|
||||
-Y Overwrite output if present.
|
||||
|
||||
.P
|
||||
.B Note:
|
||||
.br
|
||||
You can use partial PP3 files, in which case RawTherapee will set the
|
||||
missing values as follows:
|
||||
.br
|
||||
The PP3 file is first built with internal default values;
|
||||
.br
|
||||
then overridden by those found in the "default raw" or "default non-raw" photo
|
||||
profile (if \-d has been set);
|
||||
.br
|
||||
then overridden by those found in the PP3 files provided by \-p, each one
|
||||
overriding the previous values;
|
||||
.br
|
||||
then overridden by the sidecar file if \-s is set and if the file exists;
|
||||
.br
|
||||
the time when the sidecar file is used depends of the position of the \-s
|
||||
switch in the command line relative to the \-p parameters
|
||||
(e.g. "\-p first.pp3 \-p second.pp3 \-s \-p fourth.pp3").
|
||||
.SH SEE ALSO
|
||||
You can find the documentation, including a detailed user manual, on the
|
||||
project's website:
|
||||
http://rawtherapee.com/blog/documentation
|
||||
Your pp3 files can be incomplete, RawTherapee will build the final values as follows:
|
||||
1- A new processing profile is created using neutral values,
|
||||
2- If the "-d" option is set, the values are overridden by those found in
|
||||
the default raw or non-raw processing profile.
|
||||
3- If one or more "-p" options are set, the values are overridden by those
|
||||
found in these processing profiles.
|
||||
4- If the "-s" or "-S" options are set, the values are finally overridden by those
|
||||
found in the sidecar files.
|
||||
The processing profiles are processed in the order specified on the command line.
|
||||
.SH AUTHOR
|
||||
\fBRawTherapee\fP was originally written by Gabor Horvath of Budapest,
|
||||
Hungary, before being relicensed as free and open-source software in January
|
||||
2010 and being maintained by a team of people since.
|
||||
\fBRawTherapee\fP was originally written by Gabor Horvath of Budapest, Hungary, before being re-licensed as free and open-source software in January 2010.
|
||||
.br
|
||||
The RawTherapee Development Team comprises of passionate people from all around
|
||||
the world.
|
||||
The RawTherapee development team comprises of passionate people from all around the world.
|
||||
|
||||
@ -1082,7 +1082,7 @@ int ImageIO::saveJPEG (Glib::ustring fname, int quality, int subSamp)
|
||||
cinfo.comp_info[2].h_samp_factor = cinfo.comp_info[2].v_samp_factor = 1;
|
||||
|
||||
if (subSamp == 1) {
|
||||
// Best compression, default of the JPEG library: 2x2, 1x1, 1x1 (4:1:1)
|
||||
// Best compression, default of the JPEG library: 2x2, 1x1, 1x1 (4:2:0)
|
||||
cinfo.comp_info[0].h_samp_factor = cinfo.comp_info[0].v_samp_factor = 2;
|
||||
} else if (subSamp == 2) {
|
||||
// Widely used normal ratio 2x1, 1x1, 1x1 (4:2:2)
|
||||
|
||||
100
rtgui/main.cc
100
rtgui/main.cc
@ -581,59 +581,73 @@ int processLineParams( int argc, char **argv )
|
||||
case '?':
|
||||
default: {
|
||||
Glib::ustring pparamsExt = paramFileExtension.substr(1);
|
||||
std::cout << "<Chevrons> indicate parameters you can change." << std::endl;
|
||||
std::cout << "[Square brackets] mean the parameter is not mandatory." << std::endl;
|
||||
std::cout << "The pipe symbol | indicates a choice of one or the other." << std::endl;
|
||||
std::cout << "The dash symbol - denotes a range of possible values from one to the other." << std::endl;
|
||||
cout << std::endl;
|
||||
std::cout << " An advanced, cross-platform program for developing raw photos." << std::endl;
|
||||
std::cout << std::endl;
|
||||
std::cout << " Website: http://www.rawtherapee.com/" << std::endl;
|
||||
std::cout << " Documentation: http://rawpedia.rawtherapee.com/" << std::endl;
|
||||
std::cout << " Forum: https://discuss.pixls.us/c/software/rawtherapee" << std::endl;
|
||||
std::cout << " Code and bug reports: https://github.com/Beep6581/RawTherapee" << std::endl;
|
||||
std::cout << std::endl;
|
||||
std::cout << "Symbols:" << std::endl;
|
||||
std::cout << " <Chevrons> indicate parameters you can change." << std::endl;
|
||||
std::cout << " [Square brackets] mean the parameter is optional." << std::endl;
|
||||
std::cout << " The pipe symbol | indicates a choice of one or the other." << std::endl;
|
||||
std::cout << " The dash symbol - denotes a range of possible values from one to the other." << std::endl;
|
||||
std::cout << std::endl;
|
||||
std::cout << "Usage:" << std::endl;
|
||||
std::cout << " " << Glib::path_get_basename(argv[0]) << " <selected dir> Start File Browser inside directory." << std::endl;
|
||||
std::cout << " " << Glib::path_get_basename(argv[0]) << " <folder> Start File Browser inside folder." << std::endl;
|
||||
std::cout << " " << Glib::path_get_basename(argv[0]) << " <file> Start Image Editor with file." << std::endl;
|
||||
std::cout << " " << Glib::path_get_basename(argv[0]) << " -c <dir>|<files> Convert files in batch with default parameters." << std::endl << std::endl;
|
||||
std::cout << " " << Glib::path_get_basename(argv[0]) << " -c <dir>|<files> Convert files in batch with default parameters." << std::endl;
|
||||
std::cout << " " << Glib::path_get_basename(argv[0]) << " <other options> -c <dir>|<files> Convert files in batch with your own settings." << std::endl;
|
||||
std::cout << std::endl;
|
||||
#ifdef WIN32
|
||||
std::cout << " -w Do not open the Windows console" << std::endl;
|
||||
std::cout << std::endl;
|
||||
#endif
|
||||
std::cout << "Other options used with -c (-c must be the last option):" << std::endl;
|
||||
std::cout << Glib::path_get_basename(argv[0]) << " [-o <output>|-O <output>] [-s|-S] [-p <files>] [-d] [-j[1-100] [-js<1-3>]|[-b<8|16>] <[-t[z] | [-n]]] [-Y] -c <input>" << std::endl;
|
||||
std::cout << " -o <file>|<dir> Select output file or directory." << std::endl;
|
||||
std::cout << " -O <file>|<dir> Select output file or directory and copy " << pparamsExt << " file into it." << std::endl;
|
||||
std::cout << " -s Include the " << pparamsExt << " file next to the input file (with the same" << std::endl;
|
||||
std::cout << " name) to build the image parameters," << std::endl;
|
||||
std::cout << " e.g. for photo.raw there should be a photo.raw." << pparamsExt << " file in" << std::endl;
|
||||
std::cout << " the same directory. If the file does not exist, internal" << std::endl;
|
||||
std::cout << " default (neutral) values (not those in Default." << pparamsExt << ") will be" << std::endl;
|
||||
std::cout << " used." << std::endl;
|
||||
std::cout << " -S Like -s but skip if the " << pparamsExt << " file does not exist." << std::endl;
|
||||
std::cout << " -p <file.pp3> Specify " << pparamsExt << " file to be used for all conversions." << std::endl;
|
||||
std::cout << " You can specify as many -p options as you like (see" << std::endl;
|
||||
std::cout << " description below)." << std::endl;
|
||||
std::cout << " -d Use the default raw or non-raw " << pparamsExt << " file as set in" << std::endl;
|
||||
std::cout << "Options:" << std::endl;
|
||||
std::cout << " " << Glib::path_get_basename(argv[0]) << " [-o <output>|-O <output>] [-s|-S] [-p <one.pp3> [-p <two.pp3> ...] ] [-d] [ -j[1-100] [-js<1-3>] | [-b<8|16>] [-t[z] | [-n]] ] [-Y] -c <input>" << std::endl;
|
||||
std::cout << std::endl;
|
||||
std::cout << " -c <files> Specify one or more input files." << std::endl;
|
||||
std::cout << " -c must be the last option." << std::endl;
|
||||
std::cout << " -o <file>|<dir> Set output file or folder." << std::endl;
|
||||
std::cout << " Saves output file alongside input file if -o is not specified." << std::endl;
|
||||
std::cout << " -O <file>|<dir> Set output file or folder and copy " << pparamsExt << " file into it." << std::endl;
|
||||
std::cout << " Saves output file alongside input file if -O is not specified." << std::endl;
|
||||
std::cout << " -s Use the existing sidecar file to build the processing parameters," << std::endl;
|
||||
std::cout << " e.g. for photo.raw there should be a photo.raw." << pparamsExt << " file in the same folder." << std::endl;
|
||||
std::cout << " If the sidecar file does not exist, neutral values will be used." << std::endl;
|
||||
std::cout << " -S Like -s but skip if the sidecar file does not exist." << std::endl;
|
||||
std::cout << " -p <file.pp3> Specify processing profile to be used for all conversions." << std::endl;
|
||||
std::cout << " You can specify as many sets of \"-p <file.pp3>\" options as you like," << std::endl;
|
||||
std::cout << " each will be built on top of the previous one, as explained below." << std::endl;
|
||||
std::cout << " -d Use the default raw or non-raw processing profile as set in" << std::endl;
|
||||
std::cout << " Preferences > Image Processing > Default Processing Profile" << std::endl;
|
||||
std::cout << " -j[1-100] Specify output to be JPEG (on by default). Optionally add" << std::endl;
|
||||
std::cout << " compression 1-100 (default value: 92)." << std::endl;
|
||||
std::cout << " -j[1-100] Specify output to be JPEG (default, if -t and -n are not set)." << std::endl;
|
||||
std::cout << " Optionally, specify compression 1-100 (default value: 92)." << std::endl;
|
||||
std::cout << " -js<1-3> Specify the JPEG chroma subsampling parameter, where:" << std::endl;
|
||||
std::cout << " 1 = Best compression: 2x2, 1x1, 1x1 (4:2:0)" << std::endl;
|
||||
std::cout << " 1 = Best compression: 2x2, 1x1, 1x1 (4:2:0)" << std::endl;
|
||||
std::cout << " Chroma halved vertically and horizontally." << std::endl;
|
||||
std::cout << " 2 = Balanced: 2x1, 1x1, 1x1 (4:2:2)" << std::endl;
|
||||
std::cout << " 2 = Balanced (default): 2x1, 1x1, 1x1 (4:2:2)" << std::endl;
|
||||
std::cout << " Chroma halved horizontally." << std::endl;
|
||||
std::cout << " 3 = Best quality: 1x1, 1x1, 1x1 (4:4:4)" << std::endl;
|
||||
std::cout << " 3 = Best quality: 1x1, 1x1, 1x1 (4:4:4)" << std::endl;
|
||||
std::cout << " No chroma subsampling." << std::endl;
|
||||
std::cout << " -b<8|16> Specify bit depth per channel (only applies to TIFF and PNG output)." << std::endl;
|
||||
std::cout << " -t[z] Specify output to be TIFF (16-bit if -b8 is not set)." << std::endl;
|
||||
std::cout << " Uncompressed by default, or ZIP compression with 'z'" << std::endl;
|
||||
std::cout << " -n Specify output to be compressed PNG (16-bit if -b8 is not set)." << std::endl;
|
||||
std::cout << " -Y Overwrite output if present." << std::endl << std::endl;
|
||||
std::cout << "Your " << pparamsExt << " files can be incomplete, RawTherapee will set the values as follows:" << std::endl;
|
||||
std::cout << " 1- A new profile is created using internal default (neutral) values" << std::endl;
|
||||
std::cout << " (hard-coded into RawTherapee)," << std::endl;
|
||||
std::cout << " 2- then overridden by those found in the default raw or non-raw " << pparamsExt << " file" << std::endl;
|
||||
std::cout << " (if -d has been set)," << std::endl;
|
||||
std::cout << " 3- then overridden by those found in the " << pparamsExt << " files provided by -p, each one" << std::endl;
|
||||
std::cout << " overriding the previous values," << std::endl;
|
||||
std::cout << " 4- then overridden by the sidecar file if -s is set and if the file exists;" << std::endl;
|
||||
std::cout << " the time where the sidecar file is used depends on the position of the -s" << std::endl;
|
||||
std::cout << " switch in the command line relative to the -p parameters," << std::endl;
|
||||
std::cout << " e.g. -p first." << pparamsExt << " -p second." << pparamsExt << " -s -p fourth." << pparamsExt << std::endl;
|
||||
std::cout << " -b<8|16> Specify bit depth per channel (default value: 16 for TIFF, 8 for PNG)." << std::endl;
|
||||
std::cout << " Only applies to TIFF and PNG output, JPEG is always 8." << std::endl;
|
||||
std::cout << " -t[z] Specify output to be TIFF." << std::endl;
|
||||
std::cout << " Uncompressed by default, or deflate compression with 'z'." << std::endl;
|
||||
std::cout << " -n Specify output to be compressed PNG." << std::endl;
|
||||
std::cout << " Compression is hard-coded to 6." << std::endl;
|
||||
std::cout << " -Y Overwrite output if present." << std::endl;
|
||||
std::cout << std::endl;
|
||||
std::cout << "Your " << pparamsExt << " files can be incomplete, RawTherapee will build the final values as follows:" << std::endl;
|
||||
std::cout << " 1- A new processing profile is created using neutral values," << std::endl;
|
||||
std::cout << " 2- If the \"-d\" option is set, the values are overridden by those found in" << std::endl;
|
||||
std::cout << " the default raw or non-raw processing profile." << std::endl;
|
||||
std::cout << " 3- If one or more \"-p\" options are set, the values are overridden by those" << std::endl;
|
||||
std::cout << " found in these processing profiles." << std::endl;
|
||||
std::cout << " 4- If the \"-s\" or \"-S\" options are set, the values are finally overridden by those" << std::endl;
|
||||
std::cout << " found in the sidecar files." << std::endl;
|
||||
std::cout << " The processing profiles are processed in the order specified on the command line." << std::endl;
|
||||
return -1;
|
||||
}
|
||||
}
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user