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):
| Displays the usage information and the available options. Append a switch for more detailed information. For example: |
| Supports the hotfolder. For more information see clrip hotfolder support |
| 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 . |
| 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 * 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. |
| 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 |
| If multiple jobs are presented on the command line and one of those jobs causes an error, a |
| (Windows only) Allows drive types to be specified. Options are |
| 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 The available formats are listed in Formats for the -f clrip argument Note that format values are case-sensitive. |
| If the value of the For this case only, any On Windows, either If the directory name is surrounded by quotes the |
| Loads page features, see Page feature support. |
| 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 |
| 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. |
| The |
| The address space size for VM arena. |
| The
The parameters
-m , –ma , and -me are incompatible with the –mc parameter. Either use –mc or the others, but not both.
|
| 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. |
| amount to reduce and retry memory request by if unsatisfied |
| The To view the available output types, use |
| If your hardware supports multiple processors the |
| Enable the timing probe. Use |
| The |
| The The default is |
| The |
| 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,
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
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 These IDs can be looked up in |
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 |
| The tile bounding box, but only if one or more elements of that box is non-zero. |
| 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 ( |
| 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 %^>^>xyOn Linux or macOS:
-f %\<xy
-f %\<\<xy
-f %\>xy
-f %\>\>xyWhen 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.