HELIOS ImageServer User manual


6 ImageServer utility programs
6.1 General remarks
Fig. 35 again lists all tasks that are related to ImageServer. This chapter describes some modules of our software that are only accessible when working on the UNIX server. It is meant for those who want to change or check specific OPI settings manually.
Fig. 35: OPI-related tasks (highlighted) described in this chapter

UNIX
programs
belonging to ImageServer 2.5
ImageServer 2.5 is composed of many individual UNIX-based programs, e.g. "opisrv", "opitouch", "layout", "oiinfo", "oiimginfo", "oictable", "hirespath". In addition,
it also makes use of the EtherShare modules "papsrv" and "psresolve" and different printer interface programs ("papif", "tcpif", and others). Some of the above-mentioned programs are described in the following chapters.
The HELIOS utility programs described in this chapter are located in the "HELIOSDIR/bin" directory.
You may use them for setting specific parameters manually. This may be useful because some of these parameters have especially been designed to deal with application-inherent incompatibilities.
For programs that are not described in this manual and for instructions on how to integrate plug-ins, please refer to the "HELIOS OpenImage Software Developer Kit". This documentation can be found on the HELIOS Web site, section "Support"/"Developer specifications", and is meant for third-party developers only.
About defaults
Please note that parameters you set, using e.g. the "layout" or the "psresolve" program, override the settings in the preference data base. If you do not specify a specific parameter, ImageServer will check the entry in the preference data base. In case the preference data base does not contain an entry for this parameter, the parameter default will be used. Otherwise, the entry in the preference data base is valid. For changing entries in the preference data base see 4.3 "OPI server settings" and 8 "ImageServer preferences and notification features".
6.2 The "layout" program

Note: The HELIOS CD-ROM contains the "imageconv" script (in sample-images/template-images%0), as well as various sample images.

Usually, layout files will be generated automatically by the ImageServer and new layouting parameters must be set using the EtherShare Admin program on any Macintosh client. If you want to create a layout manually, or if you want to use a special set of parameters for the creation, you may call the UNIX "layout" program directly.
There are two main possibilities of calling the "layout" program. If you want to create layout files for a single file or a set of known files, you can use the following call:
layout [options] file(s)
or
layout [options] -l file(s) destination
If you want the "layout" program to scan permanently for high-resolution files in a special directory, use the call:
layout [options] -p polltime directory &
or
layout [options] -p polltime -l directory
destination &

Now, the layout process will go into the background and scan the given directory constantly with the given interval polltime in seconds for a new or changed high-resolution file to create a layout file from. This feature should only be used for small directories because it is not as fast and efficient as automatic layout generation.
Instead, we recommend to utilize the new Script Server, which is described in 7 "Script Server".
In the following, we list the parameters that may be used with "layout" and then - at the end of this chapter - give you some examples that may be used for specific workflows.

Note: Parameters that can also be specified in one of the EtherShare Admin dialogs are described with the note "Compare EtherShare Admin!".

6.2.1 Syntax conventions
Independent of whether you call the "layout" program for a set of files or use it to poll permanently in the background, you may use the options described below. The type and the default value are shown in angle brackets just before the description. The following types are used:
32-bit integer value (e.g. 72)
floating point value (e.g. 72.6)
any string enclosed in quotation marks (e.g. "foo")
comma-separated strings (e.g. "foo","bar") - without spaces between the strings
(e.g. TRUE or FALSE)
6.2.2 Options for the "layout" program
-h
Display all options for the "layout" program (help text).
-v
Display progress of layout generation on "stdout".
-D
Use the "layouts" subdirectory for generating layouts.
-H
Disable all users' home directories as EtherShare volumes.
-a attributes
Lets you specify a comma-separated list of attribute key=value pairs (see also option Attributes below).
-r dpi <double:72.0>
Set resolution (in dpi) used for creating layout files.
-M <boolean:TRUE> (opposite to -P)
Produce layout files for the Macintosh platform only (see also option CrossPlatformLayout below).
-P <boolean:FALSE> (opposite to -M)
Generate cross-platform layouts (see also option CrossPlatformLayout below).
-n <boolean:TRUE> (opposite to -N)
Limit size of EPSF layout files on generation.
-N <boolean:FALSE> (opposite to -n)
Do not limit size of EPSF layout files on generation.
-K <boolean:TRUE> (opposite to -k)
Create layout files with unspecified colors.
-k <boolean:FALSE> (opposite to- K)
Do not create layout files with unspecified colors.
-L dir <string:None>
Set destination directory for layout file generation. May only be used for manual (not for automatic "polling") mode. This option creates all layouts in the indicated directory. This option is mostly needed when the high-resolution files reside on a read-only medium e.g. a CD-ROM.
-l File(s) Destination
When using the -l option, one or more files to convert, as well as a destination file (if converting a single file) or directory (if converting several files) must be specified with an absolute path.
The image type of the destination file(s) is given by specifying the destination as a complete "OpenImage" file specification.
Example:
layout -o PrintColor=RGB -l file1 file2 "{unix,native,,TIFF}/tmp"
will convert "file1" and "file2" to RGB TIFF images and store them as plain UNIX files in "/tmp".
The "OpenImage" file specification precedes the file or directory name and is put in braces. It is structured as follows:
{File System Type, FileRepresentation, Creator, ImageType, ImageTypeExtension}
FileSystem Type must be unix.
FileRepresentation may be either native, ES, or PCS.
Creator is a Macintosh file creator signature (if left blank, 8BIM for Adobe Photoshop is used).
ImageType is a file type signature (as e.g. TIFF or EPSF).
ImageTypeExtension is an optional extension to the file type and may be empty.
The -l option may be combined with the -p option:
layout [options] -p polltime -l directory destination &
When using the -l option together with the -p option, a destination directory must be specified with an absolute path.
The image type of the destination files is given by specifying the destination as a complete "OpenImage" file specification.
Example:
layout -o PrintColor=RGB -p 45 -l /user/dir
"{unix,native,,TIFF}/tmp"

Now, the layout process will go into the background, scan the given directory every 45 seconds for a new or changed image file, and then converts this file into a TIFF-RGB image which will be stored in the directory "/tmp".

Important: The following six options are supported for backward compatibility with previous ImageServer (then called "EtherShare OPI") versions only; please do not use these options for new installations or configurations.

-c <boolean:FALSE> [compatibility only - use CompressScreen preference]
Compress screen previews.
-d dcsSuffixes <string:"CMYK"> [compatibility only - use DcsSuffixes preference]
Defines valid DCS suffixes. You may specify any number of characters here. These characters are handled case-insensitive.
-C [rgb|cmyk] <string:"CMYK"> [compatibility only - use PrintColor preference]
Defines the color space used for raster-based layouts (e.g. TIFF layouts).
-e [rgb|cmyk|bw] <string:"CMYK"> [compatibility only - use PrintColor preference]
Defines the color space used for EPSF printable previews.
-t [rgb|cmyk|bw] <string:"CMYK"> [compatibility only - use ScreenColor preference]
Defines the color space used for EPSF screen previews.
6.2.3 Further options for the "layout" program
Usage: layout -o Option=Value
DcsSuffixes <string list:"C","M","Y","K">
Suffixes of DCS plates that need not be processed.
ProfileRepository <string:"ICC-Profiles">
Defines Macintosh volume name (repository) where ICC profiles reside.
Compare EtherShare Admin!
ProfileSearchPaths <string list:None>
Additional directories where to search for ICC profiles.
ProfilePaths <string list: (RGB="ICC-Profiles:Scanner:HELIOS:CCIR-EBU-RGB",CMYK="ICC-Profiles:Printer:HELIOS:Euro 2.6 UCR-370")>
Defines RGB or CMYK profiles used if the color space for the destination layout file and the color space of the high-resolution file are different. These profiles are used to match between color spaces properly. Each string has the format <color space>=<path name>.
PreferredCMM <string:"LinoType-Hell">
Defines preferred color matching method.
RenderingQuality <uint32:2>
Defines ICC rendering quality. You may choose one of the values listed below:
MissingIccProfileIsError <boolean:TRUE>
Defines missing profile as error when creating layout file.
LogMissingIccProfile <boolean:TRUE>
Log missing profile in "syslog" file.
UseLayoutDir <boolean:TRUE>
Use the "layouts" subdirectory for generating layouts (compare -D option above).
Compare EtherShare Admin!
MinLayoutSize <uint32:0>
Defines minimum size in bytes needed to start layout process (0 = any size).
KeepImageResolution <boolean:FALSE>
Do not consider PrintResolution option (see below); layout file will inherit the resolution of the high-resolution image.
PrintResolution <double:72.0)
Defines dpi used for printable part of layout (0 = omit printable part).
Compare EtherShare Admin!
ScreenResolution <double:72.0)
Defines dpi used for screen preview part of layout (0 = omit screen preview).
Compare EtherShare Admin!
PrintColor <string:"CMYK">
Defines color space used for printable part of layout file. If the string is set to None, the color space of the high-resolution file is used. For valid color spaces, see table 5 below. Please note that some color spaces cannot be applied to each file format.
Compare EtherShare Admin!
ScreenColor <string:"RGB">
Defines color space used for screen preview part of layout file. If the string is set to None, the color space of the high-resolution file is used. For valid color spaces, see Table 5 below. Please note that some color spaces cannot be applied to each file format.
Table 5: List of layout color spaces
Name of color space
None
HSV
YCbCr
Spot
HLS
CIELab
Bilevel
CMY
CIEXYZ
Grayscale
CMYK
CIELuv
Indexed
Multi
CIEYxy
RGB
Duotone
YCC

CompressPrint <string:None>
Defines compression mode used to generate printable part of layout file using a string from Table 6. Please note that some compression modes cannot be applied to each file format.
Compare EtherShare Admin! (The Admin provides less options.)
CompressScreen <string:None>
Defines compression mode used to generate screen preview of layout file using a string from Table 6. Please note that some compression modes cannot be applied to each file format.
Table 6: List of layout compression modes
Name of compression mode
None
CCITTG4
Thunder
Compress
JPEG
Berthold Lineart
CCITTRLE
PackBits
Pixar
CCITTG3
NextRLE
Flate

CompressQuality <uint32>
Defines compression quality of layout files using lossy compression methods (e.g. "JPEG") in the range of:
1=maximum compression/minimum quality
to
100=minimum compression/maximum quality.
LayoutHighQuality <boolean:TRUE>
Create the best layouts possible. Otherwise (FALSE), the first part of high-resolution image that matches defined layout resolution is used (high quality setting uses a bilinear resolution converter, low quality setting uses the "nearest neighbor" algorithm).
LayoutCreator <string:"8BIM">
Defines Macintosh file creator used to create layout (only applicable to EtherShare volumes; 8BIM defines Adobe Photoshop).
ForceRasterLayout <boolean:FALSE>
By specifying this parameter all layout images will be TIFF files even if there is no need to create a TIFF file from a raster-based high-resolution original image.
ForceEpsLayout <boolean:FALSE>
By specifying this parameter all layout images will be EPSF files even if there is no need to create an EPSF file from a raster-based high-resolution original image.
RasterImageType <string:"TIFF">
Usually, if the high-resolution file uses raster format and does not include any mask, the resulting layout file will use a raster format too, otherwise - if the high-resolution image is an EPSF file - EPSF will also be used for the layout file. The used layout file format can be overridden using this option. You may use any string defined for the file type member (e.g. "JPEG").
RasterImageExt <string:None>
Specifies the file type by means of the file extension when generating layouts from raster-based images.
RasterImageSuffix <string:".tif">
Defines suffix used for created layout when the high-resolution file uses raster format and has the registered suffix.
EpsImageType <string:"EPSF">
Defines file type which is used to select the manager that creates layout files. You may use any string defined for the file type member here.
EpsImageExt <string:None>
Specifies the file type by means of the file extension when generating layouts from EPSF images.
EpsImageSuffix <string:".eps">
Defines suffix used for created layouts when the high-resolution file uses EPSF format and has the registered suffix.
ReplaceSuffix <boolean:TRUE>
This parameter controls if a known suffix will be replaced by the type-dependent suffix while creating the layout file name. This parameter is ignored if layouting is done for PCs or on PCShare volumes.
Example:
A high-resolution TIFF file "Image.tif" normally leads to the layout file name "Image.eps" in case an EPSF layout file is generated. If the option ReplaceSuffix is set to FALSE on the command line of the layout program, the suffix will stay ".tif" even if the layout file type is EPSF.
EpsSkipUnknownColorspaces <boolean:FALSE>
Defines whether EPSF high-resolution files without color space specification should be processed or skipped.

Important: Please note that the following four options can only be used if the created layout file is an EPSF file.

EpsKeepSize <double:10.0>
Defines the allowed difference in size between the layout file and the high-resolution file (in percent). 20.0, e.g., specifies that the layout file must be smaller than 120% of the high-resolution file, or else only a copy of the high-resolution file will be used as layout file. You may also specify negative values here. Valid values range from -99% to any positive value. Applies to EPSF layout files only.
EpsPrintablePreview <boolean:TRUE>
If set to FALSE, "layout" creates a screen preview of the image but no printable layout. Applies only to EPSF layout files.
EpsLevel2Preview <boolean:FALSE>
Defines whether the layout process may use PostScript level 2 features (e.g. whether EPSF may include JPEG compressed data). Applies to EPSF layout files only.
EpsBinaryEncoding <boolean:TRUE>
Defines that image data may be stored using 8bit values (otherwise 7bit hex is used). Applies to EPSF layout files only.
PreviewFromPict <boolean:TRUE>
Macintosh PICT may be used as source for layout generation.
OmitScreenPreviewTypes <string list:"TIFF","8BPS">
By default, all provided managers create a screen preview in addition to the print preview. Thus, TIFF layouts may contain an additional PICT element. With this option you can define a list of layout file types for which the screen preview should not be included in the layout file, e.g.
<"TIFF","JPEG">
FailureInfoLayouts <boolean:TRUE>
Defines whether a standard default layout (indicating the error) should be created in case of layout generation failure.
CrossPlatformLayout <boolean:FALSE> (see also -P -M options above)
Defines whether the created layouts have to be usable on all supported platforms (e.g. all relevant data are stored in the data fork). If the high-resolution file has a resource, the layout file may have a resource too, when stored on a Macintosh volume. If the high-resolution file does not have a resource, the layout generation depends on the
CrossPlatformFiles option described below. In the DOS name space under PCShare, a resource will only be created if the volume "root" directory (mount point) has an underlying ".rsrc" directory.
Compare EtherShare Admin!
CrossPlatformFiles <boolean:FALSE>
Defines whether a resource fork should be created or not (see also CrossPlatformLayout option above).
Thumbnail <boolean:TRUE>
Include Macintosh icon in layout file (not applicable to cross-platform files).
UseProfile <boolean:TRUE>
Process color matching for layout files, if the high-resolution files have tagged ICC profiles.
IncludeProfile <boolean:FALSE>
Include profile in layout as value (copy) instead of a reference. Only applicable if UseProfile option is set.
OmitProfile <boolean:FALSE>
A generated layout/picture will not contain any profile even if a profile was specified for the generation of the layout/picture. This option is useful if the generated layout/picture is small while the specified profile was large.
ImageProfilePaths <string list:None>
When creating layout files which are not yet tagged with ICC profiles, this parameter can be set for temporarily attaching a profile to the image while generating the layout. Each string has the format <color space>=<Pathname> and defines the ICC-profile path name for the given color space.
SpotToEps <boolean:TRUE>
Causes the creation of EPSF layout images if a high-resolution raster image contains extra colors like spot colors. This allows placement of the layout file in most DTP applications.
DcsCompatible <boolean:FALSE>
Lets the program generate DCS1 or DCS2 EPSF layout images if the raster-based high-resolution images include colors other than Black&White or Grayscale.
KeepDcs <boolean:TRUE>
Lets EPSF layout images of DCS1 or DCS2 high-resolution images keep the DCS structure. Changing the option to FALSE will lead to simple EPSF layout files.
SpotToProcess <boolean:FALSE>
Forces layout images to always contain only the default inks of the layout color space. Spot colors defined in a high-resolution image will be converted into the appropriate values of the layout color space.
MultiInkSeparationColors <string list:None>
Defines the names and order of the color components when using Multichannel ICC profiles (5 or more channels). This option has to be specified if converting to the "Multi" color space. Usage of the "Multi" color space requires the use of ICC profiles. For (future) ICC profiles that include the names of the color components, this option will become obsolete.
ForceMatch <boolean:FALSE>
Forces ICC color matching while creating layout images even if no color matching would be applied by the "layout" default behavior.
KeepImageCompression <boolean:FALSE>
Forces the layout image to be compressed the same way the high-resolution file is compressed. This option will only be recognized if the high-resolution file and the layout image have the same file format.
Fast <boolean:FALSE>
Switches the "layout" program into a fast layout mode. Using this mode will stop ICC color matching and define a fast picking algorithm for downsampling.
Compare EtherShare Admin!
LayoutComment <string:"HELIOS ImageServer 2.5.0 layout of %T file \"%f\", size %k kbytes, created by %C" >
Overrides the default comment field for layout images. The parameter is a string which will be placed in the comment section of a Macintosh file and can be viewed in the Finder using the Get Info dialog box. This string may include the following symbols (the comment may contain up to 199 characters):
%f file name of the original image.

%b size (bytes) of the original image.

%k size (kilobytes) of the original image.

%m size (megabytes) of the original image.

%t file type of the original image printed as
4 byte signature.

%c
file creator of the original image printed as
4 byte signature.

%T file type of the original image printed as clear text
if possible (otherwise printed as with %t).

%C file creator of the original image printed as
application name if possible (otherwise printed as
with %c.
LayoutLabel <uint32:0>
Sets the label color of a layout file. An integer number between 1 and 8 reflects the Macintosh Finder label colors, "0" turns this option off.
FailureComment <string:"Failed HELIOS ImageServer 2.5.0 layout file of \"%f\" ">
Defines the comment string for a failed layout image (see also LayoutComment).
FailureLabel <uint32:0>
Specifies the label color of a failed layout image (see also LayoutLabel).
ColorAliases <string list:None>
Defines mappings from application or localization dependent color names to the names used in "OpenImage". String format is <ColorName>=<ColornameAlias>.
Signature <string:None>
Defines a signature filter configuration file. See "HELIOS OpenImage Software Developer Kit" for details.
RssLimit <uint32:0>
Controls resource usage of main memory. The specified value limits the maximum use of main memory in kilobytes. Zero means no limits.
IgnoreMasks <boolean:FALSE>
Causes that an existing clipping path is used to provide transparency when creating a layout image. See 3.3.3 "Clipping paths" and 5.3 "Defining folder specific OPI settings" for a description.
IgnoreSpots <boolean:FALSE>
Causes that additional channels (e.g. spot colors) are used when creating a layout image. See 3.3.5 "Additional channels in bitmap images" and 5.3 "Defining folder specific OPI settings" for a description.
xPix/yPix <uint32:None>
Allows the user to define the size of their layouts in pixels either in x or y direction. The layouts always maintain their ratio. Layout guarantees that the resulting layouts will always be smaller or equal these sizes. If the use of xPix would mean that a given yPix value cannot be maintained, yPix will control the layout image dimensions and vice-versa.
Example: layout -o xPix=150 -o yPix=150 image.tif
This will make a layout-picture that is equal to, or smaller than 150 by 150 pixels.
upscale<boolean:FALSE>
Allows upward scaling so that the layout image may have a resolution greater than the resolution of the original image.
ProtectLayouts <boolean:FALSE>
With this option set to TRUE generated layout files will have the Macintosh Finder flag Locked turned on. Before setting this flag to TRUE make sure that the DTP application you use can handle locked layout files!

Note: The following 9 options can only be used with the -l option (convert mode):

cropLeft <double:0.0>
Applies left margin cropping to the layout image.
cropRight <double:0.0>
Applies right margin cropping to the layout image.
cropTop <double:0.0>
Applies top margin cropping to the layout image.
cropBottom <double:0.0>
Applies bottom margin cropping to the layout image.

Note: A number between 0.0 and 1.0 specifies a per cent value. A number > 1.0 specifies a pixel value.

rotate <double:0.0>
Rotates the generated layout image a certain number of degrees (0, 90, 180, 270 are permitted).
flipVertical <boolean:FALSE>
Causes the generated layout image to be flipped vertically.
flipHorizontal <boolean:FALSE>
Causes the generated layout image to be flipped horizontally.
RemoveAfterConvert <boolean:FALSE>
If set to TRUE, files converted using the -l option will be removed after successful conversion.
SkipLikeLayout <boolean:FALSE>
If set to TRUE, layout -l will skip the same files as "layout" in standard mode would skip them.
6.2.4 Attributes for "layout" options
The attributes are entered as command line options using the layout -o Attributes=<attributes>=<value> syntax. Additional attributes are delimited by comma characters.
Attributes <string list:"key=value">
Consists of key=value pairs, delimited by comma characters. These attributes are passed to the image managers of OPI. The keys and possible values recognized depend on the image managers.
Baseline (JPEG only) <boolean:FALSE>
Create Baseline JPEG.
DctMethod (JPEG only) <uint32:0>
Use slow, fast, or precise DCT (0, 1, 2).
Quality (JPEG only) <uint32:75>
Create poor-high quality image (1-100).
AntiAlias (PDF only) <boolean:TRUE>
This attribute smooths the screen preview.
PageNumber (PDF only) <uint32:1>
This attribute lets you specify a certain page of a PDF document for the layout process.
SaveUnseenColor (PNG only) <boolean:FALSE>
Normally transparent points become white. This attribute leaves them in their original color if this option is set to TRUE. Does not work with indexed images.
ColorMasking (PNG only) <string:"None">
This attribute allows the definition of a transparency color. This color is set in the form <r>:<rd>,<g>:<gd>,<b>:<bd>. Each of these variables is a positive integer with values between 0 and 255. "r", "g" and "b" are the red, green and blue values of the color that shall be transparent, while "rd", "gd" and "bd" stand for the distance that a color can have to the transparent color and still be transparent. So ColorMasking=255:1,255:1,255:1 would mean: Every white pixel with RGB values between 255,255,255 to 254,254,254 shall be transparent.

Note: This attribute only works with True-color or Indexed-color images.

WebOptimize (PNG only) <boolean:TRUE>
By default, all PNG-layouts are interlaced, so a web browser can show an impression of this picture while the image is still loading. If you want to turn this feature off you will have to use this option.
Example: layout -o Attributes="AntiAlias=TRUE",
"PageNumber=1"

6.2.5 Examples
Example 1
If you want to induce the generation of layouts for a specific folder (e.g. "testimgs") manually without changing any preferences or defaults you may just call the "layout" program as shown below:
# /usr/local/helios/bin/layout -v
/opi-test/images/testimgs/*

You do not need the -o statement as long as you do not want to change any parameters, -v may be used to display the progress of layout generation.
Example 2
If you want to create from a TIFF-CMYK high-resolution image without a clipping path a JPEG-RGB layout you have to induce the "layout" program to convert CMYK color data into RGB and the TIFF file format into JPEG. In that case you have to change the PrintColor parameter because the default for PrintColor is CMYK. Furthermore, you have to use the RasterImageType option to create a JPEG layout file. The complete command line is given below:
# /usr/local/helios/bin/layout -v
-o PrintColor=RGB -o RasterImageType=JPEG
/opitest/images/testimgs/cmyktif.tif

More examples
The "imageconv" script which uses many of the layout conversion features can be found on the HELIOS CD-ROM in the sample-images/template-images%0 folder.
The "template-images%0" directory contains about 70 MB of sample images and the "imageconv" shell script. This script uses the "layout" command with several options to convert the original images to any supported image type with different color spaces. After the conversion is finished all images will take about 1 GB of hard disk space.

Note: The "imageconv" script will run - depending on the used server - about 30 minutes or longer.

6.3 The "opitouch" program
The "opitouch" command can be used to create OPI-layout files from high-resolution images which can be done with the "layout" command, as well. The benefit of "opitouch" is that jobs are processed by "opisrv" and that it uses the global OPI-parameters and OPI folder options for layout generation. This is the same as saving images from a Macintosh or Windows client using EtherShare and PCShare.
opitouch [-h host][-s service][-dr] files_or_direcory_path names
"opitouch" is the UNIX version of the Macintosh program "touch" allowing virtual touching of image files without modifying the high-resolution file date or time, while causing automatic OPI layout generation. This program is a stand-alone utility which is not bound to an EtherShare license or installation, and therefore can be used on any system of the architectures supported by HELIOS ImageServer. It allows touching single files, all files of a directory, or even a complete directory tree on the local or remote system. Since "opitouch" does not recognize the types of the files specified, touching a non-image file may cause system error messages and failure info layout files.
Unless otherwise specified, "opitouch" touches files on the local host.
-h
Allows you to select a remote host by name or its dotted decimal internet address. You may only gain access to ImageServer systems with appropriate IP access control setup done with the EtherShare Admin program using the IP Access dialog.
The default service used is - if defined - OPIEvent or its default value 2002.
-s
Allows you to select the OPI event service port of the "opisrv" by name or numeric port number. Specifying a service port that is served by anything other than "opisrv", may cause "opitouch" to hang.
Unless otherwise specified, "opitouch" assumes that the path name arguments refer to plain files. In this case directories will be ignored by the contacted "opisrv".
-d
Requires all path names to be directories. In this case, all plain files contained in the specified directories will be touched. Subdirectories will be skipped.
-r
Requires all path names to be directories. In this case, all plain files and subdirectories contained in the specified directory path names will be touched recursively.

Note: Be aware that the usage of this option may cause heavy system load on the OPI server system.

Important: All files and directories have to be specified with their absolute path names beginning with a "/" character. The path names must NOT end with a "/" character!

6.4 The "hirespath" program
The "hirespath" program resolves an OPI layout file name to the appropriate high-resolution UNIX path name. It also maps client (UNIX, Mac or PC) file names to UNIX path names. "hirespath" receives the low-resolution file name or reference as a command line argument or on "stdin". It prints the file name or reference of the high-resolution image on "stdout". It recognizes all known OPI printer interface parameters. "hirespath" may also check a complete PostScript job for OPI references and give a detailed report on "stdout". If checking a PostScript job, "hirespath" receives a file name of the job to check as a command line argument or uses "stdin" as source.
6.4.1 Possible commands and return codes
"hirespath" always understands the arguments:
-e
Enable explanatory error messages of unresolved references
-o
Set an interface option as known from "psresolve"
hirespath [-P <printer>] [-d <pathprefix>] [<loResRef>] or
hirespath -j [-P <printer>] [<postScriptFileName>] or
hirespath -m [-d <pathprefix>] [<clientName>]
with
<printer>
The name of a specific printer queue. "hirespath" will then access the OPI parameters for that printer queue.
<pathprefix>
A UNIX directory path name which precedes the
<clientName>. If this parameter is supplied, <clientName> has to be a file name without directory specification. <pathprefix> must NOT end with a "/" character!
<loResRef>
File name or reference of the low-resolution image. This name is taken from the OPI comment without any modification. It can be in the format of the client's file system (i.e. Mac, PC, UNIX, etc.). The file name is quoted to allow for spaces. If <loResRef> is omitted, "hirespath" will read <loResRef> from "stdin".
<clientName>
File name of a UNIX, Mac, or PC file. If <clientName> is omitted, "hirespath" will read <clientName> from "stdin".
<postScriptFileName>
Name of a file containing a complete PostScript print job.
"hirespath" returns the name or reference on "stdout", and returns an integer to indicate the result of the operation:
result: <hiResRef>
with:
<hiResRef>
File name and path of the high-resolution image. Nothing is printed on "stdout" if the program cannot resolve
<loResRef>. The high-resolution file location has the format of the native file system on which "hirespath" is running.
or result: List of <opiRef> references, each on a single line
with:
<opiRef>
<code>\t(<Reference>)\t(<resolvedName>)
<code> is one of the codes listed below, <reference> is the OPI reference found in the PostScript file and
<resolvedName> is the name of the replaced image.
<resolvedName> may be empty. The names are quoted in
( ) using the ADSC quoting conventions.
or result: <UNIXPath>
with:
<UNIXPath>
Mapped UNIX Path name of <clientName>.
The return code of the program can be any of the following:
0 Success; <loResRef> was successfully resolved into <hiResRef>, and the high-resolution file is accessible. <hiResRef> is printed on "stdout".
1 Error; an (UNIX) error occurred. An explanatory error message is printed on "stderr". Nothing is printed on "stdout".
2 Error; <loResRef> cannot be resolved into <hiResFile>. If the theoretical <hiResFile> is reasonable, it is printed on "stdout".
3 Error; <loResRef> can be accessed but is a <hiResRef> and the parameter resolveall is not set. If the theoretical <hiResFile> is reasonable, it is printed on "stdout".
4 Error; <loResRef> can be accessed but is not a valid layout file. Nothing is printed on "stdout".
-j
If the option -j is specified, "hirespath" instead will check the PostScript job for all OPI-references and check each reference as described above. On exit a report will be printed on "stdout" as list of <opiRef>.
The return code of the program can be any of the following:
0 Success. All OPI references could be resolved.
1 Error; an (UNIX) error occurred. An explanatory error message is printed on "stderr". Nothing is printed on "stdout".
2 Error; one of the OPI-references could not be resolved.
-m
If the option -m is specified, "hirespath" instead will map a client file name <clientName> to a UNIX path name
<UNIXPath> without OPI resolving. This works for UNIX, Mac, and PC client file names. There are a few restrictions:
The return code of the program can be any of the following:
0 Success; <clientName> was successful mapped into <UNIXPath>, and the file is accessible. <UNIXPath> is printed on "stdout".
1 Error; An (UNIX) error occurred. An explanatory error message is printed on "stderr". Nothing is printed on "stdout".
2 Error; <clientName> cannot be mapped into
<UNIXPath> or <UNIXPath> is not accessible. If the theoretical <UNIXPath> is reasonable, it is printed on "stdout".
6.4.2 Example
The following example shows the command you have to enter if you want the program to return the UNIX path name of a high-resolution image for a given layout image in a particular print job:
# hirespath -P lw HELIOS:Texel:layouts:sample.tif
The server will return the UNIX path name:
/usr/helios/Texel/sample.jpg
6.5 The "oiinfo" program
The "oiinfo" program allows you to view a list of all "OpenImage" plug-ins that are installed and available with ImageServer 2.5. The program, by default, searches the directory "HELIOSDIR/lib/OpenImage/Plug-ins". Every file in this directory will be checked to find out whether it is a correct plug-in and - if so - what type of plug-in it is.
The program returns information about the name and version of the respective plug-ins.
Example:
# /usr/local/helios/bin/oiinfo
Found Plugin at /usr/local/helios/lib/OpenImage
/Plug-ins/opibase.so:
Magic is HeliosOpenImage.
Version is 1.0.
Module is HeliosBase

Module description is
"HELIOS ImageServer base functionality".
Module version is 2.8.

Furthermore, for every correct plug-in, the "oiinfo" program lists all included "OpenImage" managers.
Example:
Modtoc:
Sectiontype 1: HeliosUnixFs (Helios Unix Fs mgrs)
Sectiontype 1: HeliosNativeFspec (Helios Native
Fspec mgrs)
Sectiontype 1: HeliosESFspec (Helios EtherShare
Fspec mgrs)
Sectiontype 1: HeliosPCSFspec (Helios PCShare
Fspec mgrs)
Sectiontype 1: HeliosAdjust (Helios Adjust
mgrs)
Sectiontype 1: HeliosTiff (Helios TIFF mgrs)
Sectiontype 1: HeliosJPEG (Helios JPEG mgrs)
Sectiontype 1: HeliosEPSF (Helios EPSF mgrs)
Sectiontype 1: HeliosScitexCT (Helios Scitex CT
mgrs)
Sectiontype 1: HeliosAdobePhotoShop (Helios
Adobe PhotoShop mgrs)
Sectiontype 1: HeliosPICT (Helios PICT mgrs)
Sectiontype 1: HeliosMacintoshIcons (Helios
Macintosh Icon mgrs)
Sectiontype 1: HeliosAdobePath (Helios Adobe
Path mgrs)
Sectiontype 1: HeliosColor (Helios simple
Color mgrs)

After that, you will get a list of "OpenImage"-registered managers. This specific list provides information about which managers are available for use.
Example:
Manager type : Color
Predicate : 17530
Version : 1
Quality : 127
Registered key is
Scope : (00269) HeliosColorAll
Filesystem : (00000) *
Filespec : (00000) *
Filecreator : (00000) *
Filetype : (00000) *
Filetype Extension : (00271) RGB
Manager supports raster images.
Manager supports the following capabilities:
Capability 1:
Supports colorspace mapping:
Maps colorspace from RGB to Bilevel.
Supports image valuating.
Supports inkset change:
Accepts imagedata with any inkset.
Produces imagedata with any inkset.
Supports bpc change:
Accepts imagedata with 8 bpc.
Produces imagedata with 1 bpc.
...
Capability 4:
Supports colorspace mapping:
Maps colorspace from RGB to CMYK.
Supports image valuating.
Supports inkset change:
Accepts imagedata with any inkset.
Produces imagedata with any inkset.
Supports bpc change:
Accepts imagedata with 8 bpc.
Produces imagedata with 8 bpc.

-f (registered fonts)
With this option specified, information about all registered fonts are listed.
6.6 The "oiimginfo" program
With the "oiimginfo" program you can prompt various information about single image files.
There are three different possible parameters, they are optional:
oiimginfo [-v VerboseLevel] [-e]
[-o prefix_for_export] files

-v (VerboseLevel (0 - 9))
The higher the verbose level, the more detailed the information you will receive. Default is 0. With level 9 you request all available image data. This level should only be used after careful consideration.
-e (Export Image Data)
With this option, all objects that can be found in an image file are exported to files. Raster data are exported "as is". The names of the export files are created using the prefix that is entered with the -o option, followed by the object ID, the numeric object type, quality, and access method.
-o (prefix_for_export)
See explanation of the -e option above.
Example:
If you want to check a specific image file (e.g. "test.tif") to find out whether this image is already tagged with an image profile, you may proceed as follows:
-> Change to the directory that contains the image file and then enter the following command:
#/usr/local/helios/bin/oiimginfo -v 1 test.tif
Verbose Level: 1 Info for test.tif:
Creator: 8BIM
File type: TIFF (Tagged Image File
Format)
Extension: 3.0
Reference ID: (None)

Itoc manager 'HeliosTiff' used with registered key:
Fstype: (None)
Fspec: (None)
Creator: 8BIM
Type: TIFF
Extension: 3.0
File contains 4 objects:
Object 1:
Id: 1
Type: Image
Quality: Print
Main access method: Raster
Image type: TIFF
Type extension: 3.0
Reference ID: (None)

Object may be handled by any image manager
by using binary access of region 1 from L-File 1 (see below) Image manager 'HeliosTiff' used with registered key:

Fstype: (None)
Fspec: (None)
Creator: 8BIM
Type: TIFF
Extension: 3.0

There is one L-File assocciated to the object:
L-File 1:

Filename: test.tif
File type: TIFF
Creator: 8BIM
File Id: 490
Comment:

Has custom icon resource
File is handled by fspec manager
'HeliosNativeFspec' with registered key:

Fstype: unix
Fspec: native
Creator: (None)
Type: (None)
Extension: (None)
GFX information of this object:
Colorspace: CMYK
Colorspace dependent info:
Dot range: [255 0]
Compression: None

Minimum is low color value
Image data is organized interleaved
Image data must be accessed with all channels
simultaneously
Image data may be accessed in any order
Image data must be accessed as
complete scanlines or
tiles Rows: 394
Columns: 394
Depth: 1
X resolution: 200.000000 dpi
Y resolution: 200.000000 dpi
Size per unit: 1576 bytes
Bits per channel: 8
Number of channels: 4
There are 4 inks defined:
Ink 0:
Name: Process `Cyan'
Opacity: 100.00 percent
Reference ID: (None)
Ink 1:
Name: Process `Magenta'
Opacity: 100.00 percent
Reference ID: (None)
Ink 2:
Name: Process `Yellow'
Opacity: 100.00 percent
Reference ID: (None)
Ink 3:
Name: Process `Black'
Opacity: 100.00 percent
Reference ID: (None)
There is one ICC profile connected:
ICC profile 1:
Profile pathname: ICC-Profiles:Printer:HELIOS:
Euro 2.6 UCR-370
Profile creation: 19960627111511
Object 2:
Id: 1
Type: Mask
Quality: Print
Main access method: AdobeMask
Image type: TIFF
Type extension: (None)
Reference ID: (None)
.
.
.

Information about the image profile is displayed bold in the above example.
6.7 The "psresolve" program
The "psresolve" program lets you set printer interface OPI options manually on the UNIX server for one single print job. A complete description can be found in the HELIOS Base manual.

© 2002 HELIOS Software GmbH