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
Download Patch File Download Diff File Expand all files Collapse all files

100
rtgui/main.cc
View File

@@ -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;
}
}