From 6679a50e00909f415f23b8e9549b177baa5d2766 Mon Sep 17 00:00:00 2001 From: DrSlony Date: Mon, 30 Jul 2012 02:12:23 +0100 Subject: [PATCH] Updated the man page. Issue 1418 --- doc/manpage/rawtherapee.1 | 103 ++++++++++++++++++++------------------ 1 file changed, 54 insertions(+), 49 deletions(-) diff --git a/doc/manpage/rawtherapee.1 b/doc/manpage/rawtherapee.1 index acfc9aa68..423c3bc47 100644 --- a/doc/manpage/rawtherapee.1 +++ b/doc/manpage/rawtherapee.1 @@ -1,60 +1,55 @@ -.TH RAWTHERAPEE 1 "June 14, 2012" +.TH RAWTHERAPEE 1 "July 31, 2012" .SH NAME -rawtherapee \- Free RAW converter and digital photo processing software +rawtherapee \- an advanced cross-platform program for developing raw photos. .SH SYNOPSIS \fBrawtherapee\fP [directory|image\-file] .br \fBrawtherapee\fP [\-o|\-O ] [\-s|\-S] [\-p ] [\-d] -[\-j<1\-100>|\-t|\-t1|\-n] [\-Y] \-c +[\-j[1\-100]|\-t|\-t1|\-n] [\-Y] \-c .SH DESCRIPTION -\fBRawTherapee\fP is used to adjust some of the most often changed parameters -when optimizing digital images. A normal user often just wants to adjust the -white balance or brightness of a photo he took. Instead of using a big and -expensive image editor you could use a small and fast (specialized) tool like -\fBRawTherapee\fP. -.br -More and more cameras also support RAW formats. RAW files usually offer higher -color depth than JPGs (JPG is limited to 8 Bit per color). So the adjustments are -done with the high color depth and then afterwards converted to or saved as JPGs. -RawTherapee supports JPG (8 bit), PNG (8 or 16 bit) and TIFF (8 or 16 bit). All -image processing is done in 16 bit/channel mode. -.br -Different to other RAW converters it can use EAHD as demosaicing algorithm. The -RAW loading engine of \fBRawTherapee\fP is based on dcraw. +\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. .SH OPTIONS .TP -\-o | -select output directory +\-o | +select output directory. .TP -\-O | - select output dir and copy pp3 file into it +\-O | + select output directory and copy the PP3 file into it. .TP \-s -include the pp3 file next to the input file (with same name) to build the image's -parameters, eg: for IMG001.NEF there should be IMG001.NEF.pp3 in the same dir if -absent use default +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 if pp3 file not found +like \-s but skip processing that image if its corresponding PP3 file is not +found. .TP -\-p -specify pp3 file to be used for all conversions. You can specify as many \-p -options as you like (see note below) +\-p +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 Image pp3 file to build the image's parameters +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) +\-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 tiff +specify output to be uncompressed 8 bit per channel TIFF. .TP \-t1 -specify output to be compressed tiff. +specify output to be zip-compressed 8 bit per channel TIFF. .TP \-n -specify output to be png. +specify output to be 8 bit per channel PNG with a compression value of 6. .TP \-Y overwrite output if present. @@ -62,20 +57,30 @@ overwrite output if present. .P .B Note: .br -Your pp3 files can be incomplete, \fBRawTherapee\fP will set the values like that: -the pp3 file is built with internal default values; then overridden by those -found in the default RAW or Image pp3 file (if \-d has been set); then overridden -by those found in the pp3 files provided by \-p, each one overriding the previous -values; then overridden by the sidecar file if \-s is set and if the file exists; -the time where the sidecar file is used depend of the position of the \-s switch -in the command line regarding to the \-p parameters -(e.g. "\-p first.pp3 \-p second.pp3 -s \-p fourth.pp3"). - -.SH SEE ALSO -the included help +You can use partial PP3 files, in which case RawTherapee will set the +missing values as follows: .br -http://www.rawtherapee.com + 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 .SH AUTHOR -\fBRawTherapee\fP was written by Gabor Horvath and others. -.PP -This manual page was written by Philip Rinn . +\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. +.br +The RawTherapee Development Team comprises of passionate people from all around +the world.