1UFRAW(1) UFRAW(1)
2
6 UFRaw - Convert camera RAW images to standard image files.
7
9 ufraw [OPTIONS] <rawfile(s)>
10 ufraw-batch [OPTIONS] <rawfile(s)>
11
13 The Unidentified Flying Raw (UFRaw) is a utility to read and manipulate
14 raw images from digital cameras. It reads raw images using Dave
15 Coffin's raw conversion utility - DCRaw. UFRaw supports basic color
16 management using Little CMS, allowing the user to apply color profiles.
17 For Nikon users UFRaw has the advantage that it can read the camera's
18 tone curves. Even if you don't own a Nikon, you can still apply a
19 Nikon curve to your images.
20 By default 'ufraw' displays a preview window for each raw image
22 allowing the user to tweak the image parameters before saving. If no
23 raw images are given at the command line, UFRaw will display a file
24 chooser dialog. To process the images with no questions asked (and no
25 preview) use the command 'ufraw-batch'.
26 The input files can be either raw images or UFRaw ID-files. ID-files
28 contain a raw image filename and the parameters for handling the image.
29 UFRaw can also work as a GIMP plug-in. To activate it simply open a raw
31 image or a UFRaw ID-file in the GIMP.
32
34 The options supplied on the command-line decide the starting-values for
35 the GUI. The GUI will then allow you to tweak these values before
36 saving the final image.
37 General Options
39 --version
40 Display the version of UFRaw and exit.
41 --help
43 Display a brief description of how to use UFRaw and exit.
44 --silent
46 Do not display any messages during batch conversion.
47 --conf=<ID-filename>
49 Load all parameters from an ID-file. This feature can be used to
50 tweak the parameters for one file using the GUI and using those
51 parameters as the starting point for other images as well.
52 Image Manipulation Options
54 These command-line options override settings from the default
55 configuration of UFRaw and from any loaded ID-file. The best way to
56 learn about how these parameters work is to experiment with the GUI.
57 All parameters correspond exactly to a setting available in the GUI.
58 Not all parameters in the GUI have corresponding command-line options.
59 --wb=camera|auto
61 White balance setting. "camera" means that UFRaw tries to read the
62 color-temperature and green color component that the camera
63 recorded in the meta-information in the raw-file. This does not
64 work for all cameras. If UFRaw fails to read the white-balance
65 information from the meta-information, it falls back to "auto".
66 "auto" means that UFRaw calculates the color-temperature and green
68 color component automatically from the image data.
69 The white-balance can also be set manually with the --temperature
71 and --green options.
72 --temperature=TEMP
74 Manually set the color temperature in Kelvin (2000 - 7000).
75 --green=GREEN
77 Green color component. Range 0.20 to 2.50.
78 --gamma=GAMMA
80 Gamma adjustment of the base curve. Range 0.10 to 1.00. Default
81 0.45.
82 --linearity=LINEARITY
84 Linearity of the base curve. Range 0.00 to 1.00. Default 0.10.
85 --exposure=auto|EXPOSURE
87 Auto exposure or exposure correction in EV. Range -3.00 to 3.00.
88 Default 0.
89 --restore=clip|lch|hsv
91 Control how highlights are restored when applying negative EV.
92 'clip' restores nothing and is therefore safe from any artifacts.
93 'lch' restores in LCH space, resulting in restored highlights with
94 soft details (good for clouds). 'hsv' restores in HSV space,
95 resulting in restored highlights with sharp details. The default
96 is 'lch'.
97 --clip=digital|film
99 Control how highlights are clipped when applying positive EV.
100 'digital' corresponds to using a linear response, emulating the
101 harsh behaviour of the digital sensor. 'film' emulate the soft
102 film response. The default is 'digital'.
103 --saturation=SAT
105 Adjust the color saturation. Range 0.00 to 3.00. Default 1.0, use 0
106 for black & white output.
107 --wavelet-denoising-threshold=THRESHOLD
109 Wavelet denoising threshold (default 0.0).
110 --base-curve=manual|linear|custom|camera|CURVE
112 Type of tone curve to use. The base curve is a combination of the
113 gamma curve corrected by the curve specified here. The base curve
114 is applied to each channel of the raw data after the white balance
115 and color matrix, but before the ICC transformation.
116 "manual" means that a manual tone curve is used. This is probably
118 not very useful as a command-line option, since there is no way to
119 specify what the curve should look like.
120 "linear" means that no tone curve corrections is performed.
122 "custom" means that UFRaw shall use the curve supplied by the
124 camera in the meta-information in the raw-file.
125 "camera" means that UFRaw shall use the "custom" curve only if the
127 camera was set to use it (according to the meta-information).
128 Otherwise the "linear" curve is used.
129 CURVE can be the filename (without path) of any curve that was
131 previously loaded in the GUI.
132 The default is "camera" if such a curve exists, linear otherwise.
134 --base-curve-file=<curve-file>
136 Load the base curve from a file. The curve file format can be
137 either UFRaw's XML format or Nikon's NTC/NCV format.
138 --curve=manual|linear|CURVE
140 Type of luminosity curve to use. This curve is applied in HSV space
141 and therefore hue and saturation should not be effected by it.
142 "manual" means that a manual luminosity curve is used. This is
144 probably not very useful as a command-line option, since there is
145 no way to specify what the curve should look like.
146 "linear" means that no luminosity correction is performed.
148 CURVE can be the filename (without path) of any curve that was
150 previously loaded in the GUI.
151 The default is "linear".
153 --curve-file=<curve-file>
155 Load the luminosity curve from a file. The curve file format can
156 be either UFRaw's XML format or Nikon's NTC/NCV format.
157 --black-point=auto|BLACK
159 Black-point value. Range 0.0 to 1.0, default 0.0.
160 --interpolation=ahd|vng|four-color|ppg|bilinear
162 Interpolation algorithm to use when converting from the Bayer-
163 pattern to normal RGB values. AHD (Adaptive Homogeneity Directed)
164 interpolation is the best, but also the slowest. VNG (Variable
165 Number Gradients) is second best and a bit faster. Bilinear is the
166 simplest yet fastest interpolation.
167 "four-color" is a variation of the VNG interpolation that should
169 only be used if you see strange square patterns in the VNG
170 interpolation, See <http://www.cybercom.net/~dcoffin/dcraw/>.
171 AHD is the default interpolation. AHD interpolation is not
173 supported for cameras with four color filters, such as the Sony-828
174 RGBE filter. In such cases, VNG interpolation will be used instead.
175 --color-smoothing
177 Apply color smoothing.
178 --grayscale=none|lightness|luminance|value|mixer
180 Grayscale conversion algorithm to use (default none).
181 --darkframe=FILE
183 Use FILE for raw darkframe subtraction.
184 Output Options
186 The options which are related to the final output are:
187 --shrink=FACTOR
189 Shrink the image by FACTOR (default 1).
190 --size=SIZE
192 Downsize max(height,width) to SIZE.
193 --rotate=camera|ANGLE|no
195 Rotate image to camera's setting, by ANGLE degrees clockwise, or do
196 not rotate the image (default camera)
197 --crop-(left|right|top|bottom)=PIXELS
199 Crop the output to the given pixel range, relative to the raw image
200 after rotation but before any scaling.
201 --out-type=ppm|tiff|tif|png|jpeg|jpg|fits
203 Output file-format to use. The default output file-format is ppm.
204 --out-depth=8|16
206 Output bit depth per channel. ppm, tiff, png and fits output
207 formats can uses either 8 bits or 16 bits to encode each of the
208 Red, Green and Blue components of each pixel. The jpeg format only
209 allows for 8 bits for each color component.
210 The raw-files contain more than eight bits of information for each
212 color component. This means that by using an eight bit format, you
213 are actually discarding some of the information supplied by the
214 camera. This is not a problem if you only plan to view the image on
215 screen. For prints you should consider a 16 bits workflow.
216 --compression=VALUE
218 JPEG quality factor. Range 0-100 with a higher number giving a
219 higher quality at the cost of a larger file. Default 85. The
220 --compression parameter is only relevant if the output file-format
221 is jpeg.
222 --[no]exif
224 Embed exif in output. Default embed exif. Exif is currently
225 embedded in JPEG, PNG and TIFF output.
226 --[no]zip
228 Enable [disable] TIFF zip compression. The zip-compression is loss-
229 less. Default nozip. The --zip parameter is only relevant if the
230 output file-format if tiff8 or tiff16.
231 --out-path=PATH
233 PATH for output file. In batch mode by default, output-files are
234 placed in the same directory as the input-files. In interactive
235 mode UFRaw tries to ''guess'' if you have a favorite output
236 directory.
237 --output=FILE
239 Output file name to use. This is only relevant if a single raw-file
240 is supplied on the command-line. . Use '-' to output to stdout. The
241 default is to name the output-file the same as the input-file but
242 with the extension given by the output file-format.
243 --overwrite
245 Overwrite existing files without asking. Default is to ask before
246 deleting an existing file.
247 --create-id=no|also|only
249 Control whether UFRaw ID files are created for the output image.
250 (Default is no).
251 --embedded-image
253 Extract the preview image embedded in the raw file instead of
254 converting the raw image.
255
257 Conversion settings are applied in the following priority order:
258 1. Command-line options
260 2. Settings from the configuration file specified with --conf=<ID-file>
261 (ignoring any filenames in the ID-file).
262 3. Settings from an ID-file supplied as an input-file.
263 4. Settings from $HOME/.ufrawrc
264 5. UFRaw's default settings.
265 This means that an option supplied on the command-line always takes
267 precedence over all other options.
268 The conversion settings can be changed in the GUI before the resulting
270 image is saved.
271
273 $HOME/.ufrawrc - UFRaw resource file containing the user default
274 settings. This is an XML file that can be modified with any text
275 editor. Still, it is recommended not to edit this file. This file is
276 updated from the GUI when you save an image, or when you explicitly ask
277 to save this file in the 'Options' menu.
278 $HOME/.ufraw-gtkrc - An optional file for setting up a specific GTK
280 theme for UFRaw.
281
283 UFRaw homepage: <http://ufraw.sourceforge.net>
284 DCRaw homepage: <http://www.cybercom.net/~dcoffin/dcraw>
285
287 The GIMP homepage: <http://www.gimp.org>
288
290 Hey! The above document had some coding errors, which are explained
291 below:
292 Around line 15:
294 You forgot a '=back' before '=head1'
295 Around line 223:
297 '=item' outside of any '=over'
298UFRAW 2010-02-23 UFRAW(1)