liz/rawTherapee
liz/rawTherapee
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Updated help and man page, #3369

Browse Source
This commit is contained in:
Morgan Hardwood 2016-07-05 23:07:58 +02:00
parent a991d53bf3
commit 3d6f9407a2
3 changed files with 119 additions and 124 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

141
doc/manpage/rawtherapee.1
View File

@ -1,86 +1,67 @@
.TH RAWTHERAPEE 1 "July 31, 2012" .TH RAWTHERAPEE 1 "July 05, 2016"
.SH NAME .SH NAME
rawtherapee \- an advanced cross-platform program for developing raw photos. 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>
.SH DESCRIPTION .SH DESCRIPTION
\fBRawTherapee\fP is an advanced program for developing raw photos and for \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.
processing non-raw photos. It is non-destructive, makes use of OpenMP, supports .SH LINKS
all the cameras supported by dcraw and carries out its calculations in a high Website: http://www.rawtherapee.com/
precision 32bit floating point engine. 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 .SH OPTIONS
.TP -c <files> Specify one or more input files.
\-o <output file>|<output dir> -c must be the last option.
select output directory. -o <file>|<dir> Set output file or folder.
.TP Saves output file alongside input file if -o is not specified.
\-O <output file>|<output dir> -O <file>|<dir> Set output file or folder and copy pp3 file into it.
select output directory and copy the PP3 file into it. Saves output file alongside input file if -O is not specified.
.TP -s Use the existing sidecar file to build the processing parameters,
\-s e.g. for photo.raw there should be a photo.raw.pp3 file in the same folder.
use the PP3 processing profile located next to the input file (which shares If the sidecar file does not exist, neutral values will be used.
same name as the input file) when building the processing parameters, e.g.: for -S Like -s but skip if the sidecar file does not exist.
IMG001.NEF there should be a IMG001.NEF.pp3 in the same directory. If such a -p <file.pp3> Specify processing profile to be used for all conversions.
file is not found, the default values are used. You can specify as many sets of "-p <file.pp3>" options as you like,
.TP each will be built on top of the previous one, as explained below.
\-S -d Use the default raw or non-raw processing profile as set in
like \-s but skip processing that image if its corresponding PP3 file is not Preferences > Image Processing > Default Processing Profile
found. -j[1-100] Specify output to be JPEG (default, if -t and -n are not set).
.TP Optionally, specify compression 1-100 (default value: 92).
\-p <PP3 file> -js<1-3> Specify the JPEG chroma subsampling parameter, where:
specify a PP3 processing profile to be used for all conversions. You can 1 = Best compression: 2x2, 1x1, 1x1 (4:2:0)
specify as many \-p options as you like (see note below). Chroma halved vertically and horizontally.
.TP 2 = Balanced (default): 2x1, 1x1, 1x1 (4:2:2)
\-d Chroma halved horizontally.
use the default raw or non-raw PP3 file to build the image's parameters 3 = Best quality: 1x1, 1x1, 1x1 (4:4:4)
(specified in the options file). No chroma subsampling.
.TP -b<8|16> Specify bit depth per channel (default value: 16 for TIFF, 8 for PNG).
\-j[1\-100] Only applies to TIFF and PNG output, JPEG is always 8.
specify output to be JPEG (default). The compression value can be in the range -t[z] Specify output to be TIFF.
1-100. If none was specified, the default compression value is 90, balanced Uncompressed by default, or deflate compression with 'z'.
subsampling (4:2:2). -n Specify output to be compressed PNG.
.TP Compression is hard-coded to 6.
\-t -Y Overwrite output if present.
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.
.P Your pp3 files can be incomplete, RawTherapee will build the final values as follows:
.B Note: 1- A new processing profile is created using neutral values,
.br 2- If the "-d" option is set, the values are overridden by those found in
You can use partial PP3 files, in which case RawTherapee will set the the default raw or non-raw processing profile.
missing values as follows: 3- If one or more "-p" options are set, the values are overridden by those
.br found in these processing profiles.
The PP3 file is first built with internal default values; 4- If the "-s" or "-S" options are set, the values are finally overridden by those
.br found in the sidecar files.
then overridden by those found in the "default raw" or "default non-raw" photo The processing profiles are processed in the order specified on the command line.
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
.SH AUTHOR .SH AUTHOR
\fBRawTherapee\fP was originally written by Gabor Horvath of Budapest, \fBRawTherapee\fP was originally written by Gabor Horvath of Budapest, Hungary, before being re-licensed as free and open-source software in January 2010.
Hungary, before being relicensed as free and open-source software in January
2010 and being maintained by a team of people since.
.br .br
The RawTherapee Development Team comprises of passionate people from all around The RawTherapee development team comprises of passionate people from all around the world.
the world.

2
rtengine/imageio.cc
View File

@ -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; cinfo.comp_info[2].h_samp_factor = cinfo.comp_info[2].v_samp_factor = 1;
if (subSamp == 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; cinfo.comp_info[0].h_samp_factor = cinfo.comp_info[0].v_samp_factor = 2;
} else if (subSamp == 2) { } else if (subSamp == 2) {
// Widely used normal ratio 2x1, 1x1, 1x1 (4:2:2) // Widely used normal ratio 2x1, 1x1, 1x1 (4:2:2)

90
rtgui/main.cc
View File

@ -581,59 +581,73 @@ int processLineParams( int argc, char **argv )
case '?': case '?':
default: { default: {
Glib::ustring pparamsExt = paramFileExtension.substr(1); Glib::ustring pparamsExt = paramFileExtension.substr(1);
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 << " <Chevrons> indicate parameters you can change." << std::endl;
std::cout << "[Square brackets] mean the parameter is not mandatory." << 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 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 << " The dash symbol - denotes a range of possible values from one to the other." << std::endl;
cout << std::endl; std::cout << std::endl;
std::cout << "Usage:" << 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]) << " <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 #ifdef WIN32
std::cout << " -w Do not open the Windows console" << std::endl; std::cout << " -w Do not open the Windows console" << std::endl;
std::cout << std::endl;
#endif #endif
std::cout << "Other options used with -c (-c must be the last option):" << std::endl; std::cout << "Options:" << 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 << " " << 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 << " -o <file>|<dir> Select output file or directory." << std::endl; std::cout << std::endl;
std::cout << " -O <file>|<dir> Select output file or directory and copy " << pparamsExt << " file into it." << std::endl; std::cout << " -c <files> Specify one or more input files." << std::endl;
std::cout << " -s Include the " << pparamsExt << " file next to the input file (with the same" << std::endl; std::cout << " -c must be the last option." << std::endl;
std::cout << " name) to build the image parameters," << std::endl; std::cout << " -o <file>|<dir> Set output file or folder." << std::endl;
std::cout << " e.g. for photo.raw there should be a photo.raw." << pparamsExt << " file in" << std::endl; std::cout << " Saves output file alongside input file if -o is not specified." << std::endl;
std::cout << " the same directory. If the file does not exist, internal" << std::endl; std::cout << " -O <file>|<dir> Set output file or folder and copy " << pparamsExt << " file into it." << std::endl;
std::cout << " default (neutral) values (not those in Default." << pparamsExt << ") will be" << std::endl; std::cout << " Saves output file alongside input file if -O is not specified." << std::endl;
std::cout << " used." << std::endl; std::cout << " -s Use the existing sidecar file to build the processing parameters," << std::endl;
std::cout << " -S Like -s but skip if the " << pparamsExt << " file does not exist." << 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 << " -p <file.pp3> Specify " << pparamsExt << " file to be used for all conversions." << std::endl; std::cout << " If the sidecar file does not exist, neutral values will be used." << std::endl;
std::cout << " You can specify as many -p options as you like (see" << std::endl; std::cout << " -S Like -s but skip if the sidecar file does not exist." << std::endl;
std::cout << " description below)." << std::endl; std::cout << " -p <file.pp3> Specify processing profile to be used for all conversions." << std::endl;
std::cout << " -d Use the default raw or non-raw " << pparamsExt << " file as set in" << 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 << " 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 << " -j[1-100] Specify output to be JPEG (default, if -t and -n are not set)." << std::endl;
std::cout << " compression 1-100 (default value: 92)." << 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 << " -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 << " 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 << " 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 << " 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 << " -b<8|16> Specify bit depth per channel (default value: 16 for TIFF, 8 for PNG)." << std::endl;
std::cout << " -t[z] Specify output to be TIFF (16-bit if -b8 is not set)." << std::endl; std::cout << " Only applies to TIFF and PNG output, JPEG is always 8." << std::endl;
std::cout << " Uncompressed by default, or ZIP compression with 'z'" << std::endl; std::cout << " -t[z] Specify output to be TIFF." << std::endl;
std::cout << " -n Specify output to be compressed PNG (16-bit if -b8 is not set)." << std::endl; std::cout << " Uncompressed by default, or deflate compression with 'z'." << std::endl;
std::cout << " -Y Overwrite output if present." << std::endl << std::endl; std::cout << " -n Specify output to be compressed PNG." << std::endl;
std::cout << "Your " << pparamsExt << " files can be incomplete, RawTherapee will set the values as follows:" << std::endl; std::cout << " Compression is hard-coded to 6." << std::endl;
std::cout << " 1- A new profile is created using internal default (neutral) values" << std::endl; std::cout << " -Y Overwrite output if present." << std::endl;
std::cout << " (hard-coded into RawTherapee)," << std::endl; std::cout << std::endl;
std::cout << " 2- then overridden by those found in the default raw or non-raw " << pparamsExt << " file" << std::endl; std::cout << "Your " << pparamsExt << " files can be incomplete, RawTherapee will build the final values as follows:" << std::endl;
std::cout << " (if -d has been set)," << std::endl; std::cout << " 1- A new processing profile is created using neutral values," << std::endl;
std::cout << " 3- then overridden by those found in the " << pparamsExt << " files provided by -p, each one" << std::endl; std::cout << " 2- If the \"-d\" option is set, the values are overridden by those found in" << std::endl;
std::cout << " overriding the previous values," << std::endl; std::cout << " the default raw or non-raw processing profile." << std::endl;
std::cout << " 4- then overridden by the sidecar file if -s is set and if the file exists;" << std::endl; std::cout << " 3- If one or more \"-p\" options are set, the values are overridden by those" << std::endl;
std::cout << " the time where the sidecar file is used depends on the position of the -s" << std::endl; std::cout << " found in these processing profiles." << std::endl;
std::cout << " switch in the command line relative to the -p parameters," << std::endl; std::cout << " 4- If the \"-s\" or \"-S\" options are set, the values are finally overridden by those" << std::endl;
std::cout << " e.g. -p first." << pparamsExt << " -p second." << pparamsExt << " -s -p fourth." << pparamsExt << 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; return -1;
} }
} }