remotexf--Transform data remotely
Format
remotexf [-j "jobattributes"] ... [-o outputfile] [inputfile]
Description
The remotexf command transforms data from one format to another remotely using Ricoh InfoPrint Transform Manager for Linux transforms. The command converts files to another format without printing the files.
- Adobe Portable Document Format (PDF)
- Adobe PostScript
- Graphics interchange format (GIF)
- HP Printer Control Language (PCL)
- Joint Photographic Experts Group (JPEG) file information format (JFIF)
- Tagged image file format (TIFF)
InfoPrint Transform Manager for Linux transforms also convert files from AFP (MO:DCA-P only) format to PDF format.
In addition, if InfoPrint Transform Manager for Linux adds new transforms to the AFP format in the future, you can specify a transform ID value in the remotexf command to use the new transforms.
The command automatically detects the format of the input file and uses the appropriate transform, such as PDF to AFP, for that data format. However, you can specify the document-format job attribute to override the input format.
The remotexf command automatically detects the format of the input file and uses the appropriate transform to AFP, such as PDF to AFP, for that data format. However, if the input file is in AFP (MO:DCA:P) format, the transform does not select the appropriate transform. You must specify the output format in the output-format transform attribute.
You can specify only one input file to be transformed. If you do not specify an input file name, or if you specify a dash (-) as the file name, remotexf uses standard input. The output file name is also optional. If you do not specify one, the remotexf command writes the results to standard output.
Infoprint Server writes error messages for recoverable data stream errors on a trailer error page (a page that is written at the end of the output data) when it creates an AFP document. If you do not want a trailer error page, you can specify the trailer-error-page transform attribute in the xf-options job attribute. For the AFP to PDF transform, no trailer error page is created.
- For information about the InfoPrint Transform Manager for Linux transforms, including functions, limitations, and transform options, see InfoPrint Transform Manager for Linux and InfoPrint Transform Manager for Linux: afp2pdf Transform Installation and User's Guide.
- To use the remotexf command, Infoprint Server must be customized. For information, see the section about customizing the Transform Interface in z/OS Infoprint Server Customization.
Options
- -j "jobattributes"
- Specifies one or more job attributes in the format attribute=value,
separated by spaces. You can specify -j multiple
times. If job attributes are repeated, the last value that is specified
for the job attribute is used.
You can specify any of these job attributes:
- document-format, which specifies the format of the input document
- filter-options, which specifies InfoPrint Transform Manager for Linux transform options
- xf-options, which specifies these
transform
attributes:
- fail-on-datastream-error
- output-format
- trailer-error-page
- transform-id
Tip: Instead of entering a string of job attributes on the command line, you can store job attributes and values in a file. You use a special attribute that is called attributes to specify the file.For more information about the job attributes, see Job attribute listing. For information about the transform options you can specify in filter-options, see InfoPrint Transform Manager for Linux.
When you specify job attributes:
- If a value contains spaces, enclose
the value in single or double
quotation marks:
attribute='value with spaces' attribute="value with spaces"
- If a job attribute
(attribute=value) contains spaces or characters
that might be interpreted by the shell (such as $ & ( ) > < | ' "),
enclose the job attribute in single quotation marks:
For information about how the shell interprets special characters, see z/OS V2R2.0 UNIX System Services User's Guide.-j 'attribute1=value1 attribute2=value2'
- If both the value and the job attribute require quotation marks,
do either of these:
- Use two pairs of double quotation marks
and place a backslash
before each quotation mark that surrounds the value:
-j "attribute=\"value with spaces\""
- Use different quotation marks around the job attribute and value.
For example:
-j 'attribute="value with spaces"' -j "attribute='value with spaces'"
- Use two pairs of double quotation marks
and place a backslash
before each quotation mark that surrounds the value:
- -o outputfile
- Specifies
the output path and file into which the transform output
(such as AFP data)
is written. The transform overwrites any existing data in the output
file. If you do not specify an output file, the result is written
to standard output (STDOUT).
To specify an MVS™ data set, such as a sequential or partitioned data set, precede the data set name with //. When you specify a fully qualified name, two sets of quotation marks are required. For example, "//'hlq.PDS(MYDOC)'" or "//'hlq.SEQDS'". When you specify a partially qualified name, you need only one set of quotation marks. For example, "//PDS(MYDOC)" or "//SEQDS".
If you specify an MVS data set, allocate and catalog the data set before you run this command. Allocate a data set that is large enough to hold the output data stream. The size of the output data stream depends on the complexity of the document and the type of image compression used. Typically, an output AFP data stream is several times as large as the input data stream. Allocate the AFP output data set with these characteristics:- Record format: VBM
- Record length: 32 K
Tip: For InfoPrint Transform Manager for Linux, if you do not use the -pragma afpdsrecordlength option, allocate the data set with a record length that is at least 32017 bytes. By default, the transforms to AFP create AFP records that are 32000 bytes. To request that the transforms create AFP records that are a smaller maximum length, you can use the -pragma afpdsrecordlength option. Valid values for the option are 8000 - 32000. The default is 32000. For example, to set the maximum number of bytes in a record to 8000, specify:-j "filter-options='-pragma afpdsrecordlength=8000'"
Operand
- inputfile
- Specifies an input
file to be transformed. The results are written
to a single output file (if one is specified in -o)
or to standard output.
If you do not specify an input file, or if you specify a dash (-) for the file name, remotexf uses standard input.
To specify an MVS data set, precede the data set name with //. When you specify a fully qualified name, two sets of quotation marks are required. For example, "//'hlq.PDS(MYDOC)'" or "//'hlq.SEQDS'". When you specify a partially qualified name, you need only one set of quotation marks. For example, "//PDS(MYDOC)" or "//SEQDS".
Examples -- remotexf
Transform a file
remotexf -o myfile.afp myfile.pdf
Transform and print a file
remotexf myfile.pdf | lp
Transform a file, specifying image size
remotexf -j "filter-options='-l 8i -w 5i'" -o myfile.afp myfile.ps
Transform a file, specifying paper size
remotexf -j "filter-options='-paper a4'" -o myfile.afp myfile.gif
Transform a file, specifying resolution
remotexf -j "filter-options='-r 300'" -o myfile.afp myfile.ps
Transform a file, specifying resolution and omitting errors
remotexf -j "filter-options='-r 300' xf-options='trailer-error-page=no'"
-o myfile.afp myfile.tiff
Transform a file, creating output only if data stream is error-free
remotexf -j "xf-options='fail-on-datastream-error=yes'" -o myfile.afp myfile.gif
Transform a file with redirection
remotexf < input.ps > output.afp
Transform a UNIX file to an MVS data set
remotexf -o "//'hlq.OUTPUT.AFP(member)'" input.pcl
Transform an AFP document to PDF format
remotexf -j "xf-options='output-format=pdf'" -o myfile.pdf myfile.afp
Transform an AFP document in an MVS data set to PDF format
remotexf -j "xf-options='output-format=pdf'" -o output.pdf "//'hlq.INPUT.AFP(member)'"
Environment variables
- AOPRXF_CONF
- Names the Infoprint Server remote transform configuration file. This variable takes precedence over the default remote transform configuration file (/etc/Printsrv/aoprxf.conf). For more information about the remote transform configuration file, see z/OS Infoprint Server Customization.
- LANG
- The language that is used for messages.
- LIBPATH
- The path that is used to locate dynamic link libraries (DLLs).
- NLSPATH
- Names the directory paths that the remotexf command searches for message catalogs.
For information about setting and using environment variables, see z/OS V2R2.0 UNIX System Services User's Guide.
Files
- /etc/Printsrv/aoprxf.conf
- Contains the Infoprint Server default remote transform configuration file.
Exit values
- 0
- The data was transformed successfully. However, the output document might contain error messages that are related to errors in the input data stream. If a recoverable data stream error occurs and the fail-on-datastream-error transform attribute is no, the exit value is 0.
- >0
- An error occurred. No output document was created. If any data stream errors occur and the fail-on-datastream-error transform attribute is yes, the exit value is >0.