ipptransform(1)

NAME
ipptransform - convert document data to alternate formats
ippevepcl - convert document data to hp pcl
ippeveps - convert document data to postscript

SYNOPSIS
ipptransform [ --help ] [ --version ] [ -d DEVICE-URI ] [ -f OUTPUT-FILENAME ] [ -i INPUT/FORMAT ] [ -m OUTPUT/FORMAT ] [ -o NAME=VALUE [... NAME=VALUE] ] [ -r RESOLUTION[,...] ] [ -s {flipped|manual-tumble|normal|rotated} ] [ -t TYPE[,...] ] [ -v ] filename

DESCRIPTION
ipptransform converts the input file into the output format and optionally sends the output to a network printer.

OPTIONS
The following options are recognized by ipptransform:

--help
    Shows program help.

--version
    Shows program version.

-d DEVICE-URI
    Specifies an output device as a URI. Currently only the "ipp", "ipps", and "socket" URI schemes are supported, for example "socket://10.0.1.42" to send print data to an AppSocket printer at IP address 10.0.1.42.

-i INPUT/FORMAT
    Specifies the MIME media type of the input file. Currently the "application/pdf" (PDF), "image/jpeg" (JPEG), "image/png" (PNG), "image/pwg-raster" (PWG Raster), and "text/plain" MIME media types are supported.

-m OUTPUT/FORMAT
    Specifies the MIME media type of the output file. Currently the "application/PCLm" (PCLm), "application/pdf" (PDF), "application/postscript" (PostScript), "application/vnd.hp-pcl" (HP PCL), "image/pwg-raster" (PWG Raster), and "image/urf" (Apple Raster) MIME media types are supported.

-o "NAME=VALUE [... NAME=VALUE]"
    Specifies one or more named options for the conversion. See the "NAMED OPTIONS" section for more information.

-r RESOLUTION[,...RESOLUTION]
    Specifies the supported resolutions. Resolutions are of the form "NNNdpi" or "NNNxNNNdpi", for example "300dpi" or "600x300dpi". HP PCL output only supports resolutions of "300dpi" and "600dpi".

-s {flipped|manual-tumble|normal|rotated}
    Specifies the coordinate system for the back side of duplex sheets.

-t TYPE[,...,TYPE]
    Specifies the output color spaces and bit depths, separated by commas. Types include "adobe-rgb_8" and "adobe-rgb_16" for 8-bit and 16-bit AdobeRGB, "black_1" and "black_8" for 1-bit and 8-bit black, "cmyk_8" for 8-bit CMYK, "sgray_1" and "sgray_8" for 1-bit and 8-bit grayscale with a 2.2 gamma correction, and "srgb_8" for 8-bit sRGB color. Run ipptransform with the --help option to see the list of supported color spaces and bit depths.

-v  Increases the verbosity for any diagnostics.

NAMED OPTIONS
The following named options are supported:

copies
    Specifies the number of copies to produce.

force-front-side
    Forces the numbered pages to start on the front side of a sheet. Only has effect when "sides" is "two-sided-long-edge" or "two-sided-short-edge".

image-orientation
    Specifies the rotation of each page image as an "orientation-requested" value.

imposition-template
    Specifies an imposition template to use for the input pages. Currently only the "booklet" template (for printing folded booklets) is supported.

job-error-sheet
    Specifies when and where to print the job error sheet.

job-pages-per-set
    Specifies the number of raster input pages per set for finishing operations.

job-sheet-message
    Specifies a message to show on the banner page.

job-sheets
    Enables banner pages on the default job media.

job-sheets-col
    Enables banner pages on specific media.

media
    Specifies the media size as a PWG standardized media size name. For example, US Letter (8.5x11in) is "na_letter_8.5x11in" and ISO A4 is "iso_a4_210x297mm".

media-col
    Specifies the media size as a collection. Both the "media-size" and "media-size-name" members can be used to specify the size. For example, both "media-col={media-size={x-dimension=21000 y-dimension=29700}}" and "media-col={media-size-name=iso_a4_210x297mm}" specify ISO A4 media.

multiple-document-handling
    Specifies whether to produce uncollated ("separate-documents-uncollated-copies") or collated ("separate-documents-collated-copies", "single-document", or "single-document-new-sheet").

number-up
    Specifies the number of input pages to impose on each output page. The values 1, 2, 4, 6, 9, 12, and 16 are supported.

orientation-requested
    Specifies the orientation of input pages, 3 for portrait, 4 for landscape, 5 for reverse landscape, and 6 for reverse portrait.

overrides
    Specifies per-page overrides of "media", "media-col", and/or "orientation-requested".

page-delivery
    Specifies normal ("same-order-face-down" or "same-order-face-up") or reverse ("reverse-order-face-down" or "reverse-order-face-up") order output.

page-ranges
    Selects a single range of pages to print. For example, the value "5-12" selects pages 5 through 12.

print-color-mode
    Specifies the color mode as "auto" (automatic), "monochrome" (grayscale), or "color".

print-quality
    Specifies the print quality with value 3 (draft), 4 (normal), or 5 (high/best).

print-scaling
    Specifies the scaling to use when converting image files. The values "auto", "fit", and "fill" are supported.

printer-resolution
    Specifies the print resolution using one of the supported print resolutions.

sides
    Specifies whether to do 1-sided printing ("one-sided") or 2-sided printing ("two-sided-long-edge" for portrait and "two-sided-short-edge" for landscape).

x-image-position
    Specifies the relative horizontal position - "center", "left", "none", or "right".

x-image-shift
    Specifies the relative horizontal offset in hundredths of millimeters.

x-side1-image-shift
    Specifies the relative horizontal offset for front sides in hundredths of millimeters.

x-side2-image-shift
    Specifies the relative horizontal offset for back sides in hundredths of millimeters.

y-image-position
    Specifies the relative vertical position - "bottom", "center", "none", or "top".

y-image-shift
    Specifies the relative vertical offset in hundredths of millimeters.

y-side1-image-shift
    Specifies the relative vertical offset for front sides in hundredths of millimeters.

y-side2-image-shift
    Specifies the relative vertical offset for back sides in hundredths of millimeters.

DIAGNOSTICS
ipptransform sends all messages to the standard error. Each message is prefixed with "ERROR", "INFO", or "DEBUG" depending on the level of verbosity.

EXIT STATUS
The ipptransform program returns 0 if the input file is converted successfully and 1 otherwise.

ENVIRONMENT
ipptransform recognizes the following environment variables:

CONTENT_TYPE
    Specifies the MIME media type of the input file.

DEVICE_URI
    Specifies the output device as a URI.

DOCUMENT_NAME
    Specifies the title of the input file.

IPP_xxx
    Specifies the value of the "xxx" Job Template attribute, where "xxx" is converted to uppercase. For example, the "media" Job Template attribute is stored as the "IPP_MEDIA" environment variable. When the source attribute contains multiple values, they are separated by commas in the environment variable string.

IPP_xxx_DEFAULT
    Specifies the default value of the corresponding "xxx-default" Printer Description attribute, where "xxx" is converted to uppercase. For example, the "media-default" Printer Description attribute is stored as the "IPP_MEDIA_DEFAULT" environment variable. When the source attribute contains multiple values, they are separated by commas in the environment variable string.

IPP_xxx_READY
    Specifies the loaded value(s) of the corresponding "xxx-ready" Printer Status attribute, where "xxx" is converted to uppercase. For example, the "media-ready" Printer Status attribute is stored as the "IPP_MEDIA_READY" environment variable. When the source attribute contains multiple values, they are separated by commas in the environment variable string.

IPP_xxx_SUPPORTED
    Specifies the supported value(s) of the corresponding "xxx-supported" Printer Description attribute, where "xxx" is converted to uppercase. For example, the "media-supported" Printer Description attribute is stored as the "IPP_MEDIA_SUPPORTED" environment variable. When the source attribute contains multiple values, they are separated by commas in the environment variable string.

IPP_PCLM_RASTER_BACK_SIDE
    Specifies the coordinate system of the back side of duplex sheets. The default is 'normal'.

IPP_PCLM_SOURCE_RESOLUTION_SUPPORTED
    Lists the supported output resolutions, separated by commas. The default is 600dpi.

IPP_PCLM_STRIP_HEIGHT_PREFERRED
    Specifies the preferred strip height for the printer. The default is 16.

IPP_PWG_RASTER_DOCUMENT_RESOLUTION_SUPPORTED
    Lists the supported output resolutions, separated by commas. The default is 300dpi.

IPP_PWG_RASTER_DOCUMENT_SHEET_BACK
    Specifies the coordinate system of the back side of duplex sheets. The default is 'normal'.

IPP_PWG_RASTER_DOCUMENT_TYPE_SUPPORTED
    Lists the supported output color spaces and bit depths, separated by commas. The default is 'sgray_8'.

IPPTRANSFORM_MAX_RASTER
    Specifies the maximum number of bytes of memory to use when generating raster data. The default is 16MB.

OUTPUT_TYPE
    Specifies the MIME media type of the output file.

SERVER_LOGLEVEL
    Specifies the log level (verbosity) as "error", "info", or "debug".

EXAMPLES
Print a PDF file to a PCL printer at 10.0.1.42:
    ipptransform -d socket://10.0.1.42 -m application/vnd.hp-pcl \
        filename.pdf

Print a PDF file to an IPP Everywhere printer at 10.0.1.42:
    ipptransform -d ipp://10.0.1.42/ipp/print -m image/pwg-raster \
        filename.pdf

Convert a JPEG file to sRGB PWG Raster at 600dpi:
    ipptransform -m image/pwg-raster -r 600dpi -t sgray_8,srgb_8 \
        filename.jpg >filename.ras

SEE ALSO
ipptool(1),

COPYRIGHT
Copyright © 2023-2026 by OpenPrinting. Copyright © 2016-2019 by the Printer Working Group. Copyright © 2016-2019 by Apple Inc.