Updated help and man page, #3369
This commit is contained in:
Morgan Hardwood
@@ -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.
|
||||
|
||||
Reference in New Issue
Block a user