Skip to main content
Skip table of contents

Using the clrip application

This page applies to Harlequin v13.1r0 and later; and to Harlequin Core but not Harlequin MultiRIP

The clrip application is command-line driven. You will find it in the bin directory of the distribution.

You can use the following arguments (only the most important options are listed here; for other options, use clrip -h for the definitive information):

clrip or clrip -h or clrip -help

Displays the usage information and the available options. Append a switch for more detailed information. For example: -h P .

clrip -H

Supports the hotfolder. For more information see clrip hotfolder support

clrip -l

Lists all the configurations that the RIP has installed along with the PagebufferType values and memory settings. For more information see Override pagebuffer type and Memory allowance .

clrip filename

Processes the named file (or files) specifying no configuration file. That is, the RIP uses the default PostScript language state.

To run jobnames containing spaces, enclosing the jobname within double-quotes.

The clrip also accepts wildcard characters supported by the operating system. For example, on Windows you can use:

* Match zero or more characters.

? Match one character.

For example, specifying *.pdf, as a file name will process all files in the directory that match this pattern. Specifying wrong patterns will cause RIP errors.

In general it is recommended that the input file name is the last item specified on the command line.

clrip -c configuration filename

Processes the listed file(s) using the specified configuration. The configuration files are PostScript language files.

The chosen configuration file is consumed by the RIP just before the job file is interpreted. If you specify multiple job files, the configuration file is consumed before each job. For advice on configuration files, see Moving on with RIP configuration (Linux, macOS, and Windows).

For details on specifying the location, see Configuration location .

If you are running the clrip with an in-memory SW folder, the TestConfig folder containing the configurations you wish to use must be included in the compiled-in SW folder. If you attempt to use a configuration which has not been compiled-in, a FAILED TO SUBMIT CONFIGURATION DETAILS error is displayed. For more information, see Diskless operation.

clrip -C

If multiple jobs are presented on the command line and one of those jobs causes an error, a Job Not Completed message appears and the remaining jobs on the command line will not run. Use the -C option to ensure that other jobs are processed.

clrip -D cdrom, fixed, ramdisk, remote, removable

(Windows only) Allows drive types to be specified. Options are cdrom , fixed , ramdisk , remote , removable . The default, when -D is not used, is to use cdrom , fixed and remote . By specifying the drive types you can improve performance by preventing unnecessary network searches.

clrip -f filename-format file1 file2...

This option generates filenames from the input jobname, filename, page and separation names and numbers. Literal characters are copied to the filename, formats preceded by % are expanded.

The available formats are listed in Formats for the -f clrip argument

Note that format values are case-sensitive.

clrip -f directoryname/

If the value of the -f argument ends with a / or a \ then it is taken as specifying only the folder name. In this case the output file names are formed by appending the format string in the relevant backend to this folder name.

For this case only, any %f or %I tokens in the format string are interpreted as %b or %i respectively (i.e., any input folder name is removed). The output folder is created if it doesn't exist.

On Windows, either \ or / in the folder name for the -f option may be used interchangeably as from Harlequin 12.0r2.

If the directory name is surrounded by quotes the / or \ at the end must be outside the closing quote.

clrip -F feature

Loads page features, see Page feature support.

clrip -k id

Use the specified LDK protection key, which skips the "find the best" search and just attempts to use the specified key. If no license is available from that key, e.g. it is already in use, then Harlequin Core will fail to start.

The functionality of clrip -k id and clrip -kp command-line options is also available via a new API in ldkapi.h q.v.

clrip -kp

From Harlequin 12.0r2: Use the same LDK protection key as for the previous run of this Harlequin Core instance. Information about which LDK protection key was used is saved in the SW folder, and the same protection key will be used if possible. If no saved information is available the normal search is performed.

clrip -m value

The -m option is specified in mebibytes and is used on the command line to override the default value for the RIP's maximum memory allowance. This option specifies using virtual memory from the OS. See Memory allowance for more information.

clrip -ma value

The address space size for VM arena.

clrip -mc value

The -mc option is specified in mebibytes and is used on the command line to override the default value for the RIP's maximum memory allowance. This option specifies using a single preallocated block. See Memory allowance for more information.

The parameters -m , –ma , and -me are incompatible with the –mc parameter. Either use –mc or the others, but not both.

clrip -me value

Memory reserve size specified in mebibytes. If a particular job is so large that it cannot all be fitted into memory at once, the RIP starts to paint partial page buffers to disk. To try and avoid this, you can allocate extra temporary memory for the RIP, using this option. This allows the RIP to use additional physical and virtual memory while completing the job.

The default value for -me is 5 mebibytes, and usually there is not much reason for this to be changed except under rare circumstances such as when ripping large transparencies and not wanting partial painting and paging to occur.

clrip -mr value

amount to reduce and retry memory request by if unsatisfied

clrip -o output-type

The -o switch can be used to override the value of /PageBufferType. See Override pagebuffer type for more information.

To view the available output types, use clrip -l.

clrip -p n

If your hardware supports multiple processors the -p option can be used to specify the number of parallel processes to allow multi-threaded operation. For more information see Multi-threaded processing .

clrip -P

Enable the timing probe. Use -h P to list all available options.

clrip -R configuration filename

The -R option enforces the “diskless” processing model. This reverts to using RAM for pagebuffer data, provided that the SW folder is read-only. You can only gain true diskless execution by compiling the SW folder into memory and supplying -R on the command line. See Diskless operation for more information.

clrip -s output-target

The -s switch can be used to override the value of /OutputTarget. On the command line you can select None, FILE, PRINTER, SOCKET, and STREAM to override the value of /OutputTarget in the configuration file.

The default is File. PRINTER is available on Windows only. See Override output target for more information.

clrip -X

The -X option copies all monitor output to a single logfile called LE_LGFLE in the SW folder.

clrip -! n

The option provides a mechanism by which textual messages are sent, filtered, localized, logged and output.

The \lib\interface\monitor\monevent.h file describes the Monitor Event, SWEVT_MONITOR . The example handler for this is located in \lib\skintest\<platform>\src\main.c.

clrip -h displays help for this option. Currently there are three defined modes:

-! 0 : no change in behavior (same as no switch).

-! or -! 1 : switches on colorization. This uses the Monitor Event metadata to change the console colors (and font in the Unix case) to communicate additional information about the text being displayed. For example, it displays errors in yellow on a red background, benign warnings as black on yellow and failure warnings as red on yellow. It displays timing messages (on Windows) in grey or (on Unix) as dark yellow and job control messages as white on blue.

This is achieved by registering a Handler for the Monitor Event and inspecting the metadata to decide the colorization, changing the console colors if necessary and then calling SwEventTail to allow the normal behavior to occur, and then restoring the previous colors afterwards. This means the text is still delivered by the legacy method of the Progress and Monitor Devices, as achieved by the Compatibility Handlers in the Core. This implementation allows the benefit of colorization without changing any legacy code, and this approach could, in principle, be applied to any existing code-base. That is, it has no effect on any existing logging.

-! 2 : the same as -! 1 , but instead of using SwEventTail to use the old mechanism and the legacy devices, it handles the event itself, changes color, displays the text, and then returns SW_EVENT_HANDLED so that the Compatibility Handlers and the legacy Devices are not used. Note that this mode produces slightly more output than the legacy route, because it doesn't feature the same message suppression that the legacy code does. It also features “native” UTF-8 support If output is redirected to a file you get UTF-8 throughout.

-! 3 : this option is useful for developers. As well as colorizing in the same way as -! 1 (that is, via the legacy devices) it also displays the metadata associated with each message, and the Timeline type/title as that changes.

This allows you to see the metadata which could be used for filtering, logging, error detecting, warning detection and so on. Many unique error codes have been allocated. This allows you to see, for example, that a specific RANGECHECK error is due to a broken CMap (MON_RANGECHECK_CMAPMAPPING ) whereas another RANGECHECK error is due to a truncated charstring (MON_RANGECHECK_CS2EOF ).

These IDs can be looked up in doc/monitoruids.csv or doc/monitoruids.html.

Formats for the -f clrip argument

The following values may be used in the string provided for the -f clrip command line argument to specify the location and naming of raster output.


The base file name of the input file (excludes any directory or extension part)


The document number


The full input file name (includes directory and extension)


The optimized PDF ID, i.e., the hash for each raster when using Harlequin VariData in external mode. Do not use without HVD.


The optimized PDF ID appended to job's directory.


The job name


The job name, or the input file name if the job name is empty


The job number as set by setpagedevice.


The job number, as set by the skin timeline.


The separation number


The separation number, if more than one separation was generated


The output type (pagedevice /PageBufferType)


The page number, combined with the (normally zero) page offset. Page offsets are set when a PageRange is used.


 The ID of the current Scalable RIP instance (zero if not running Scalable RIP).


The separation name


The separation name, if one channel was mapped to the sheet


The tile bounding box of four integers, separated by commas. See PageRelativeBBox in RasterDescription for more detail on the bounding box values.


The tile bounding box, but only if one or more elements of that box is non-zero. PageRelativeBBox can be set by using tiling. For information see Tiling in the Harlequin Core or ImagingBBox, TileDeviceBBox .


Zero-pad the numeric format y to a minimum width of w. The width w must be a positive number. The formats generating numeric values are n, N, p, d, k, K, t and T.


An explicit percent (% ) character


If format y expands to a non-empty string, insert prefix character x and then the expansion of y


Expand format y, removing all characters to the first occurrence of 'x'. An empty string is returned if x was not found. See Illegal characters below.


Expand format y, removing all characters to the last occurrence of 'x'. An empty string is returned if x was not found. See Illegal characters below.


Expand format y, removing all characters from the first occurrence of 'x'. The whole expansion is returned if x was not found. See Illegal characters below.


Expand format y, removing all characters from the last occurrence of 'x'. The whole expansion is returned if x was not found. See Illegal characters below.

Illegal characters

Note that < and > are illegal characters on the command line, so when entering you must use a delimiter before each illegal character for it to work or quote the entire -f argument using single or double quotes. For example, on Windows:

                      -f %^<xy
                      -f %^<^<xy
                      -f %^>xy
                      -f %^>^>xy

On Linux or macOS:

                      -f %\<xy
                      -f %\<\<xy
                      -f %\>xy
                      -f %\>\>xy

When using in a batch file, rather than typing directly into a command line, you must use %% rather than single % at the start of each command.

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.