|
This is list of all options available in the program. Examples of possible values are written in maroon color.
If you experience any problems with command line, if you get large or corrupted or low quality images, please, feel free to ask us, and we'll try to find solution for your case.
ICPCL.exe
-script key specifies the script used when converting images. A script is a file containing a set of conversion parameters: operation list, target format parameters, destination folder and operations with file names. The general appearance of the key is as follows:
-script [Script name]
Script name is a string specifying the needed script. It can contain the link to a preset or user-defined script created with the help of ImageConveter Plus. If the script is located in the same folder with the program, this parameter can contain script name only.
Example:
ICPCL.exe -source "c:\my fotos\*.*" -script "convert to bmp.icp"
Otherwise the parameter should contain file name with its full path.
Example:
ICPCL.exe -source "c:\my fotos\*.*" -script "c:\convert\scripts\convert to bmp.icp"
makebat key is used to create a bat-file containing a command line with the list of parameters needed for conversion. This line is ready for immediate execution. Launch this bat-file in future to start conversion process. To create a bat-file it is necessary to use -makebat together with -script and -source keys when launching the program. The generated command line will contain all parameters from the specified script.
The general appearance of the key is as follows:
-makebat [File]
File - this character string contains the name of and path to the output bat-file. If you want to create this file in the folder with the program, you can specify its name only.
Example:
ICPCL.exe -script "c:\convert\scripts\convert to bmp.icp" -source "c:\my fotos\*.*" -makebat "convert to bmp.bat"
If you want to create the file in any other folder, you should specify its full path in the parameter.
Example:
ICPCL.exe -script "c:\convert\scripts\convert to bmp.icp" -source "c:\my fotos\*.*" -makebat "c:\convert\tobmp.bat"
–source key is used to specify source graphics files to be converted. Several masks can be used to specify groups of files. The general appearance of the key is as follows:
–source [Files]
Files - the string specifying the list of files and/or folders. The simplest case is specifying one file. If it is located in the same folder with the program, it is not necessary to specify the path.
You can use the following masks:
<folder path>\*.* - converts all graphic files from folder;
<folder path>\*.bmp - converts all JPEG files from folder;
<folder path>\MyImage.* - converts all files with name MyImage
from folder;
<folder path>\MyImage.bmp - converts only MyImage.bmp
from folder.
Example:
ICPCL.exe -dest "{My Documents}" -convertto bmp -source "foto.bmp"
ICPCL.exe -dest "{My Documents}" -convertto bmp -source " C:\My Fotos\*.*"
-dest key is used to specify the destination folder for resulting files. Besides specifying folders directly, you can use special macros in it. Macros are used to refer to default Windows folders. The general appearance of the key is as follows:
-dest [Folder]
Folder is a line specifying the name of the destination folder for resulting files. In simpler cases you can specify a folder directly.
Example:
ICPCL.exe -convertto bmp -source "C:\Original files" -dest "C:\Converted files"
-template key is used to specify a template for generation of resulting file names. Templates can be specified either manually or with the help of various macros used for batch file conversion. The general structure of the key is as follows:
-template [Name]
Name is a line with the template used to generate names of resulting files. The simplest way is to specify file name manually. This way is suitable if you convert single files.
Example:
ICPCL.exe -convertto bmp -source "C:\Original files" -dest "C:\Converted files"
To assign names to files during batch conversion you can use macros which specify values to be contained in file names. A template can contain both macros and permanent lines. The following macros are available in the program:
| Macro | Description |
|---|---|
| {Title} | Adds corresponding source file name to the resulting file name (corresponding source file name is used to name each resulting file) |
| {Type} | Adds standard extension of the selected graphics format to the resulting file name |
| {Counter} | Adds a counter to the resulting file name. Counter value is increased by 1 when a file is processed (1 digit). |
| {Counter2-7} | Adds a counter to the resulting file name. Counter value is increased by 1 when a file is processed (from 2 to 7 digits). |
| {Page} | Source Image Page Number |
| {Date} | Adds conversion date to the resulting file name. The date is added in month-day-year format. |
| {Year} | Adds conversion year to the resulting file name. |
| {Month} | Adds conversion month to the resulting file name. |
| {Day} | Adds conversion day to the resulting file name. |
| {Time} | Adds conversion time to the resulting file name. Time is added in hour-minute-second format. |
| {Hour} | Adds conversion hour to the resulting file name. |
| {Minute} | Adds conversion minute to the resulting file name. |
| {Second} | Adds conversion second to the resulting file name. |
| {Bytes} | Adds the size of resulting file in bytes to the resulting file name. |
| {Kb} | Adds the size of resulting file in kilobytes to the resulting file name. |
| {Mb} | Adds the size of resulting file in megabytes to the resulting file name. |
| {Size} | Adds the size of resulting image (width and height) to the resulting file name. |
| {Width} | Adds the width of resulting image to the resulting file name. |
| {Height} | adds the height of resulting image to the resulting file name. |
| {Depth} | Adds color depth of resulting image to the resulting file name. Color depth is number of bits used to display one pixel of an image. |
-target_opt parameter is used to set additional parameters when creating names for resulting files. Today the program has only one parameter of the kind: the action to be taken if the destination folder already contains a file with the name assigned to the converted file. The general appearance of the key is as follows:
-target_opt [Parameter]:[Value]
Parameter - additional parameter name. Today, the only allowed value is: if_exists.
Value - additional parameter value. If_exists parameter can accept the following values:
Example:
ICPCL.exe -source "C:\Original files" -dest "C:\Converted files" -target_opt if_exist:rename
-sort parameter is used to sort the list of source files, that is, to specify the order of their conversion. Files can be ordered by file name, file type, file properties and file size. Ordering can be ascending or descending. The general appearance of the key is as follows:
-sort [Field][Direction]
Field - the field used to sort files. Its allowed values are:
Direction - order direction. Its allowed values are.
Example:
ICPCL.exe -dest "{My Documents}" -convetto bmp multipage:multipage -source "c:\my fotos" -sort name ascending
This function is a full-scale instrument for changing image size with a large variety of settings. The following parameters are used to adjust settings of this operation.
Size parameter is used to directly specify resulting image size.
size:<X Y>
X - horizontal size (whole positive number).
Y - vertical size (whole negative number).
Example:
-oper Resize size:640 480
Units parameter specifies units of sizes specified in size parameter. Its allowed values are:
The default value is: pixels.
Example:
-oper Resize units:percents
Hdpi parameter specifies horizontal resolution of the resulting image. It can accept a positive number from 1 to 4096.
Example:
-oper Resize hdpi:72.000000
Vdpi parameter specifies horizontal resolution of the resulting image. It can accept a positive number from 1 to 4096.
Example:
-oper Resize vdpi:72.000000
Res_units parameter specifies units of resolution specifies in hdpi and vdpi parameters. Its allowed values are:
The default value is: inches.
Example:
-oper Resize res_units:cm
Use keep_prop parameter to tell the program whether image proportions should be kept when conveting it. Its allowed values are:
The default value is: yes.
Example:
-oper Resize keep_prop:no
Method parameter specifies the interpolation algorithm used when increasing image size. Its allowed values are:
The default value is: bilinear.
Example:
-oper Resize method:nearest
Nozoom parameter specifies whether it is necessary to increase image size if it is smaller than that specified in image settings. Its allowed values are:
The default value is: no.
Example:
-oper Resize nozoom:yes
This operation is used to rotate images at an arbitrary angle. The following parameters are used to adjust its settings:
Angle parameter specifies rotation angle (in degrees). It can accept whole numbers from 0 to 360. The default value is: 0.
Example:
-oper Rotate angle:90
Orient parameter specifies the direction of image rotation. Its allowed values are:
The default value is: ccw.
Example:
-oper Rotate orient:cw
Color parameter specifies the color to fill empty spaces after rotation. The color is specified in RGBA mode color:"r:X1,g:X2,b:X3,a:X4" where X1, X2, X3, X4 are whole positive numbers from 0 to 255. The default value is: "r:255,g:255,b:255,a:255" (transparent).
Example:
-oper Rotate color:"r:255,g:255,b:0,a:100"
Use this operation to flip the source image horizontally or vertically. This operation has one parameter:
flip - flip axis (default - verticaly)
Flip parameter specifies direction of flipping the source image. Its allowed values are:
The default value is: verticaly.
Example:
-oper Mirror flip:horizontaly
Bitmap is a home Windows raster format, which is used practically for all possible raster data storage. The following parameters are used to adjust settings of this format.
Bpp parameters specifies the number of bits used to transfer the color of one pixel. Its allowed values are.
The default value is: 24.
-convertto bmp bpp:16
Rows parameter specifies the order of saving rows in the resulting file. Its allowed values are:
The default value is: top_bottom.
-convertto bmp rows:top_bottom
Quant parameter reduces the number of distinct colors used in an image while preserving visual image quality. Its value is any whole number from 0 to 8.
The default value is: 8.
-convertto bmp quant:4
Dither is a form of noise, or 'erroneous' signal or data which is added to sample data to minimize quantization error. Dither parameter can accept two values: yes and no.
The default value is: yes.
-convertto bmp dither:no
Use "exists:overwrite" option to use original file names for converted files.
Example*:
*ImageConverter Plus command line can not overwrite files if they have "System" or "Read Only" status. Please check status of your files if you can't overwrite them.
-save_opt key is used to specify additional conversion parameters:
The general appearance of the keys is as follows:
-save_opt [Parameter 1]:[Value 1]…[Parameter 4]:[Value 4]
Parameter is additional parameter name. Can accept one of four possible values:
Value the value of the specified parameter. The value can be either yes (the parameter is switched on) or no (the parameter is switched off).
Example:
ICPCL.exe -source "C:\Original files" -dest "C:\Converted files" -save_opt convert_subfolders:yes restore_subfolders:yes open_target:no log:no
This operation crops image borders and leaves the selected part of the image. Image size is reduced without changing image resolution, so that images are not distorted. Settings of this poeration are adjusted with the help of the following parameters:
Method parameter specifies the mode of Crop image operation. This parameter specifies whether other parameters should be set. Its allowed values are:
Example:
-oper Crop method:margins
Example:
-oper Crop method:rect_2p
Example:
-oper Crop method:rect_pwh
The default value is: margins.
Example:
-oper Crop method:autocrop
Size parameter value depends on method parameter value.
size:<X1 X2 X3 X4>
Where X1, X2, X3, X4 are whole positive numbers including 0.
Example:
-oper Crop size:100 50 100 50
Example:
-oper Crop size:0 0 400 300
Example:
-oper Crop size:0 0 300 200
The default value is: 0 0 0 0.
Color parameter specifies the color of the margins to be cropped in autocrop mode. The color is specified in RGB mode.
color:"r:X1,g:X2,b:X3,a:X4"
Where X1, X2, X3, X4 are whole positive numbers from 0 to 255.
The default value is: "r:255,g:255,b:255,a:255" (transparent).
Example:
-oper Crop color:"r:255,g:255,b:255,a:100"
Tolerance parameter specifies the allowed deviation from the color specified in color parameter. Its values are whole numbers from 0 to 100.
The default value is: 0.
Example:
-oper Crop tolerance:5
This operation is used to change image size without scaling. Image size can be reduced by cropping its edges according to the selected algorithm, or increased by adding a border of the specified color. The operation settings are adjusted with the help of the following parameters.
Width parameter specifies resulting image width, or width of the added border (in pixels) regarding the value of relative size option parameter. Its allowed values are whole positive numbers from 1 to 20000.
The default value is: 0.
Example:
-oper Canvas width:200
Height parameter specifies resulting image height, or height of the added border (in pixels) regarding the value of relative size option parameter. Its allowed values are whole positive numbers from 1 to 20000.
The default value is: 0.
Example:
-oper Canvas heigth:100
Relative parameter specifies operation mode. Its allowed values are:
The default value is: no.
Example:
-oper Canvas relative:yes
Anchor parameter specifies sides of image cropping/bordering. Its allowed values are:
The default value is: center.
Example:
-oper Canvas anchor:bottom
Color parameter specifies border color. The color is specified in RGBA mode.
color:"r:X1,g:X2,b:X3,a:X4"
where X1, X2, X3, X4, are whole positive numbers from 0 to 255.
The default value is: "r:255,g:255,b:255,a:255" (transparent).
Example:
-oper Canvas color:"r:0,g:255,b:0,a:100"
This operation is used to apply a watermark (a signature, a trademark, etc.) to source images. The following parameters are used to adjust its settings.
Image parameter specifies the image to be applied to source images. It contains the full path to the needed file and is a required parameter for this operation.
Example:
-oper Watermark image:"c:\mark.bmp"
Halign parameter specifies horizontal alignment of the image applied as watermark. This parameter can have the following values.
The default value is: left.
Example:
-oper Watermark halign:right
Valign specifies vertical alignment of the image applied as watermark. This parameter can have the following values.
The default value is: top.
Example:
-oper Watermark halign:right
Offset_xt parameter specifies horizontal offset (in pixels) of the applied image regarding the alignment point specified in horizontal alignment parameter. It can be a whole positive or negative number.
The default value is: 0.
Example:
-oper Watermark offset_x:20
Offset_y parameter specifies vertical offset (in pixels) of the applied image regarding the alignment point specified in vertical alignment parameter. It can be a whole positive or negative number.
The default value is: 0.
Example:
-oper Watermark offset_y:-10
Method parameter specifies a method of applying watermark to the source image. This parameter can have the following values.
The default value is: alpha_blend.
Example:
-oper Watermark method:overdraw
This operation is used to apply one of the effects listed below to the processed image. To use several effects in one script, you should add several operations. Each of these operations will be responsible for one effect. The operation is adjusted with the help of one parameter:
effect - color effect to apply (default - blur)
Effect parameter specifies the effect to be applied to source images. Its allowed values are:
The default value is: blur.
Example:
-oper Effect effect:sepia
This operation is used if it is necessary to replace a color of the source image with another color, including transparency (alpha component). The following parameters are used to adjust settings of this operation:
Src_color parameter specifies the color to be replaced with another color. The color is specified in RGBA mode.
color:"r:X1,g:X2,b:X3,a:X4"
where X1, X2, X3, X4 are whole positive numbers from 0 to 255.
The default value is: "r:255,g:255,b:255,a:255" (transparent).
Example:
-oper ReplaceColor src_color:"r:255,g:255,b:0,a:100"
Dest_color parameter specifies the color which will replace the source color. The color is specified in RGBA mode.
color:"r:X1,g:X2,b:X3,a:X4"
where X1, X2, X3, X4 are whole positive numbers from 0 to 255.
The default value is: "r:255,g:255,b:255,a:255" (transparent).
Example:
-oper ReplaceColor dest_color:"r:0,g:255,b:0,a:100"
Tolerance parameter specifies the percentage of allowed deviation from the color specified in src_color parameter. Its allowed values are whole numbers from 0 to 100.
The default value is: 0.
Example:
-oper ReplaceColor tolerance:5
Smooth parameter tells the program to smooth color transitions in modified areas of the image. Its allowed values are:
The default value is: yes.
Example:
-oper ReplaceColor smooth:no
Color profiles are data sets used to transform values of color range. They include information on color, hue, saturation and brightness. Color profiles are used to describe compliance of colors of input and output devices in color model terms. Use color profile operation to make sure that graphics files received from a device are correctly displayed or printed on other devices in full compliance with source images. This operation is used to apply internal or external color profiles to images. Adjust its settings with the help of the following parameters:
Mode parameter specifies operation mode. Its allowed values are:
Mode default value is: ignore.
-oper ColorProfile mode:builtin
Profile_path parameter specifies the path to an external color profile. It is a string containing full path to the file with the needed profile.
-oper ColorProfile profile_path:"c:\WideGamutRGB.icc"
This operation is used to convert separate pages of multipage files. Its settings are adjusted with the help of the following parameters.
Pages_mode parameter specifies pages to be converted. Its allowed values are:
The default value is: all
Example:
-oper PageFilter pages_mode:even
Use pages parameter to specify numbers of pages to be converted or their intervals. Its value is a character string containing page numbers separated with commas. Intervals are specified with the help of hyphens. The syntax of this parameter corresponds with the syntax of print dialog boxes in Microsoft Office applications.
The default value is: none.
Example:
-oper PageFilter pages:"1,3,7-9"
Skip_first parameter specifies whether the program will convert the first page of the source file. The following values are allowed.
The default value is: no.
Example:
-oper PageFilter skip_first:yes
Skip_last parameter specifies whether the program will convert the last page of the source file. The following values are allowed.
The default value is: no.
Example:
-oper PageFilter skip_last:yes
Multipage_only parameter specifies whether this operation will be applied to source one-page files. The following values are allowed.
The default value is: yes
Example:
-oper PageFilter multipage_only:no
-sort parameter is used to sort the list of source files, that is, to specify the order of their conversion. Files can be ordered by file name, file type, file properties and file size. Ordering can be ascending or descending. The general appearance of the key is as follows:
-sort [Field][Direction]
Field - the field used to sort files. Its allowed values are:
Direction - order direction. Its allowed values are.