ipptransform(1)

✨ ipptransform(1) ✨ 💅

okay bestie so this is the tea on ipptransform — it's a lil command-line girlie from Apple Inc. and she's part of the ippsample era. she converts your document data into other formats. main character energy fr.

---

🌸 NAME 🌸

ipptransform — convert document data to alternate formats 🦋

---

🎀 SYNOPSIS 🎀

ipptransform [ --help ] [ -d device-uri ] [ -f output-filename ] [ -i
input/format ] [ -m output/format ] [ -o name=value [... name=value] ] [
-r resolution[,...,resolution] ] [ -s {flipped|manual-
tumble|normal|rotated} ] [ -t type[,...,type] ] [ -v ] filename

---

💖 DESCRIPTION 💖

so basically, ipptransform takes your input file, turns it into the output format, and if you want, she'll send that output straight to a network printer. no biggie. 💁‍♀️

ngl, ipptransform is usually run by ippserver(8) — like, that's her whole job, converting document data for printing. she's the backstage queen. 👑

---

✨ OPTIONS ✨

these are the options ipptransform recognizes, bestie, and yes we're going through all of them:

• --help — shows program help. when u need her to explain herself 💖
• -d device-uri — specifies an output device as a URI. rn 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) and "image/jpeg" (JPEG) MIME media types are supported. that's it, that's the roster 🎀
• -m output/format — specifies the MIME media type of the output file. current the "application/vnd.hp-pcl" (HP PCL) and "image/pwg-raster" (PWG Raster) MIME media types are supported. 🌈
• -o "name=value[...name=value]" — specifies one or more named options for the conversion. currently the "copies", "media", "media-col", "page-ranges", "print-color-mode", "print-quality", "printer-resolution", and "sides" options are supported. see the NAMED OPTIONS section for more info 👇
• -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" — she's picky, respect it 💅
• -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. she will literally tell u everything 💀

---

🫶 NAMED OPTIONS 🫶

the following named options are supported:

• copies — specifies the number of copies to produce. 🖨️
• 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. look at her being flexible 💅
• 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). 👑

---

😭 DIAGNOSTICS 😭

ipptransform sends all messages to the standard error. each message is prefixed with "ERROR", "INFO", or "DEBUG" depending on the level of verbosity. so if she's yelling, she's yelling with labels, periodt. 💀

---

🦋 EXIT STATUS 🦋

the ipptransform program returns 0 if the input file is converted successfully and 1 otherwise. simple as that bestie 💖

---

🧚 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. ✨
• 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. 🎀
• IPP_PWG_RASTER_DOCUMENT_RESOLUTION_SUPPORTED — lists the supported output resolutions. 🌸
• IPP_PWG_RASTER_DOCUMENT_SHEET_BACK — specifies the coordinate system of the back side of duplex sheets. 🦋
• IPP_PWG_RASTER_DOCUMENT_TYPE_SUPPORTED — lists the supported output color spaces and bit depths. 🎨
• IPPTRANSFORM_MAX_RASTER — specifies the maximum number of bytes 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 🌈

ippdoclint(7), ippserver(8), ipptool(1), ipptransform3d(7)

---

👑 COPYRIGHT 👑

Copyright © 2016-2019 by the IEEE-ISTO Printer Working Group. Copyright © 2016-2019 by Apple Inc.

---

okay that's the whole page, bestie, no cap, we did not skip a single crumb 🫶 this was the ippsample version dated 2019-05-17, and yeah she's still called ipptransform(1) at the bottom too. slay. 💅✨