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 --maximize-window
46 Force window to be maximized.
47 --silent
49 Do not display any messages during conversion. This option is only
50 valid with 'ufraw-batch'.
51 --conf=<ID-filename>
53 Load all parameters from an ID-file. This feature can be used to
54 tweak the parameters for one file using the GUI and using those
55 parameters as the starting point for other images as well.
56 Image Manipulation Options
58 These command-line options override settings from the default
59 configuration of UFRaw and from any loaded ID-file. The best way to
60 learn about how these parameters work is to experiment with the GUI.
61 All parameters correspond exactly to a setting available in the GUI.
62 Not all parameters in the GUI have corresponding command-line options.
63 --wb=camera|auto
65 White balance setting. "camera" means that UFRaw tries to read the
66 color-temperature and green color component that the camera
67 recorded in the meta-information in the raw-file. This does not
68 work for all cameras. If UFRaw fails to read the white-balance
69 information from the meta-information, it falls back to "auto".
70 "auto" means that UFRaw calculates the color-temperature and green
72 color component automatically from the image data.
73 The white-balance can also be set manually with the --temperature
75 and --green options.
76 --temperature=TEMP
78 Manually set the color temperature in Kelvin.
79 --green=GREEN
81 Green color component. Range 0.20 to 2.50.
82 --gamma=GAMMA
84 Gamma adjustment of the base curve. Range 0.10 to 1.00. Default
85 0.45.
86 --linearity=LINEARITY
88 Linearity of the base curve. Range 0.00 to 1.00. Default 0.10.
89 --exposure=auto|EXPOSURE
91 Auto exposure or exposure correction in EV. Range -3.00 to 3.00.
92 Default 0.
93 --restore=clip|lch|hsv
95 Control how highlights are restored when applying negative EV.
96 'clip' restores nothing and is therefore safe from any artifacts.
97 'lch' restores in LCH space, resulting in restored highlights with
98 soft details (good for clouds). 'hsv' restores in HSV space,
99 resulting in restored highlights with sharp details. The default
100 is 'lch'.
101 --clip=digital|film
103 Control how highlights are clipped when applying positive EV.
104 'digital' corresponds to using a linear response, emulating the
105 harsh behaviour of the digital sensor. 'film' emulate the soft
106 film response. The default is 'digital'.
107 --saturation=SAT
109 Adjust the color saturation. Range 0.00 to 8.00. Default 1.0, use 0
110 for black & white output.
111 --wavelet-denoising-threshold=THRESHOLD
113 Wavelet denoising threshold (default 0.0).
114 --hotpixel-sensitivity=VALUE
116 Sensitivity for detecting and shaving hot pixels (default 0.0).
117 --base-curve=manual|linear|custom|camera|CURVE
119 Type of tone curve to use. The base curve is a combination of the
120 gamma curve corrected by the curve specified here. The base curve
121 is applied to each channel of the raw data after the white balance
122 and color matrix, but before the ICC transformation.
123 "manual" means that a manual tone curve is used. This is probably
125 not very useful as a command-line option, since there is no way to
126 specify what the curve should look like.
127 "linear" means that no tone curve corrections is performed.
129 "custom" means that UFRaw shall use the curve supplied by the
131 camera in the meta-information in the raw-file.
132 "camera" means that UFRaw shall use the "custom" curve only if the
134 camera was set to use it (according to the meta-information).
135 Otherwise the "linear" curve is used.
136 CURVE can be the filename (without path) of any curve that was
138 previously loaded in the GUI.
139 The default is "camera" if such a curve exists, linear otherwise.
141 --base-curve-file=<curve-file>
143 Load the base curve from a file. The curve file format can be
144 either UFRaw's XML format or Nikon's NTC/NCV format.
145 --curve=manual|linear|CURVE
147 Type of luminosity curve to use. This curve is applied in HSV space
148 and therefore hue and saturation should not be effected by it.
149 "manual" means that a manual luminosity curve is used. This is
151 probably not very useful as a command-line option, since there is
152 no way to specify what the curve should look like.
153 "linear" means that no luminosity correction is performed.
155 CURVE can be the filename (without path) of any curve that was
157 previously loaded in the GUI.
158 The default is "linear".
160 --curve-file=<curve-file>
162 Load the luminosity curve from a file. The curve file format can
163 be either UFRaw's XML format or Nikon's NTC/NCV format.
164 --black-point=auto|BLACK
166 Black-point value. Range 0.0 to 1.0, default 0.0.
167 --interpolation=ahd|vng|four-color|ppg|bilinear
169 Interpolation algorithm to use when converting from the color
170 filter array to normal RGB values. AHD (Adaptive Homogeneity
171 Directed) interpolation is the best, but also the slowest. VNG
172 (Variable Number Gradients) is second best and a bit faster.
173 Bilinear is the simplest yet fastest interpolation.
174 "four-color" is a variation of the VNG interpolation that should
176 only be used if you see strange square patterns in the VNG
177 interpolation, See <http://www.cybercom.net/~dcoffin/dcraw/>.
178 AHD is the default interpolation. AHD interpolation is not
180 supported for cameras with four color filters, such as the Sony-828
181 RGBE filter. In such cases, VNG interpolation will be used instead.
182 --color-smoothing
184 Apply color smoothing.
185 --grayscale=none|lightness|luminance|value|mixer
187 Grayscale conversion algorithm to use (default none).
188 --grayscale-mixer=RED,GREEN,BLUE
190 Grayscale mixer values to use (default 1,1,1).
191 --darkframe=FILE
193 Use FILE for raw darkframe subtraction.
194 Output Options
196 The options which are related to the final output are:
197 --shrink=FACTOR
199 Shrink the image by FACTOR (default 1).
200 --size=SIZE
202 Downsize max(height,width) to SIZE.
203 --rotate=camera|ANGLE|no
205 Rotate image to camera's setting, by ANGLE degrees clockwise, or do
206 not rotate the image (default camera)
207 --crop-(left|right|top|bottom)=PIXELS
209 Crop the output to the given pixel range, relative to the raw image
210 after rotation but before any scaling.
211 --auto-crop
213 Crop the output automatically.
214 --aspect-ratio X:Y
216 Set crop area aspect ratio.
217 --lensfun=none|auto
219 Do not apply lens correction or try to apply correction by auto-
220 detecting the lens (default auto).
221 --out-type=ppm|tiff|tif|png|jpeg|jpg|fits
223 Output file-format to use. The default output file-format is ppm.
224 --out-depth=8|16
226 Output bit depth per channel. ppm, tiff, png and fits output
227 formats can uses either 8 bits or 16 bits to encode each of the
228 Red, Green and Blue components of each pixel. The jpeg format only
229 allows for 8 bits for each color component.
230 The raw-files contain more than eight bits of information for each
232 color component. This means that by using an eight bit format, you
233 are actually discarding some of the information supplied by the
234 camera. This is not a problem if you only plan to view the image on
235 screen. For prints you should consider a 16 bits workflow.
236 --compression=VALUE
238 JPEG quality factor. Range 0-100 with a higher number giving a
239 higher quality at the cost of a larger file. Default 85. The
240 --compression parameter is only relevant if the output file-format
241 is jpeg.
242 --[no]exif
244 Embed exif in output. Default embed exif. Exif is currently
245 embedded in JPEG, PNG and TIFF output.
246 --[no]zip
248 Enable [disable] TIFF zip compression. The zip-compression is loss-
249 less. Default nozip. The --zip parameter is only relevant if the
250 output file-format if tiff8 or tiff16.
251 --out-path=PATH
253 PATH for output file. In batch mode by default, output-files are
254 placed in the same directory as the input-files. In interactive
255 mode UFRaw tries to ''guess'' if you have a favorite output
256 directory.
257 --output=FILE
259 Output file name to use. This is only relevant if a single raw-file
260 is supplied on the command-line. . Use '-' to output to stdout. The
261 default is to name the output-file the same as the input-file but
262 with the extension given by the output file-format.
263 --overwrite
265 Overwrite existing files without asking. Default is to ask before
266 deleting an existing file.
267 --create-id=no|also|only
269 Control whether UFRaw ID files are created for the output image.
270 (Default is no).
271 --embedded-image
273 Extract the preview image embedded in the raw file instead of
274 converting the raw image. This option is only valid with
275 'ufraw-batch'.
276
278 Conversion settings are applied in the following priority order:
279 1. Command-line options
281 2. Settings from the configuration file specified with --conf=<ID-file>
282 (ignoring any filenames in the ID-file).
283 3. Settings from an ID-file supplied as an input-file.
284 4. Settings from $HOME/.ufrawrc
285 5. UFRaw's default settings.
286 This means that an option supplied on the command-line always takes
288 precedence over all other options.
289 The conversion settings can be changed in the GUI before the resulting
291 image is saved.
292
294 $HOME/.ufrawrc or $HOME/.config/ufrawrc (depending on the system) -
295 UFRaw resource file containing the user default settings. This is an
296 XML file that can be modified with any text editor. Still, it is
297 recommended not to edit this file. This file is updated from the GUI
298 when you save an image, or when you explicitly ask to save this file in
299 the 'Options' menu.
300 $HOME/.ufraw-gtkrc - An optional file for setting up a specific GTK
302 theme for UFRaw.
303
305 UFRaw homepage: <http://ufraw.sourceforge.net>
306 DCRaw homepage: <http://www.cybercom.net/~dcoffin/dcraw>
307
309 The GIMP homepage: <http://www.gimp.org>
310UFRAW 2015-06-15 UFRAW(1)