File: ipptransform.html

package info (click to toggle)
ippsample 0.0~git20220607.72f89b3-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 36,580 kB
  • sloc: ansic: 108,192; sh: 3,417; makefile: 1,163
file content (181 lines) | stat: -rw-r--r-- 8,129 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
<!DOCTYPE HTML>
<html>
<!-- SECTION: Man Pages -->
<head>
	<link rel="stylesheet" type="text/css" href="../cups-printable.css">
	<title>ipptransform(1)</title>
</head>
<body>
<h1 class="title">ipptransform(1)</h1>
<h2 class="title"><a name="NAME">Name</a></h2>
ipptransform - convert document data to alternate formats
<h2 class="title"><a name="SYNOPSIS">Synopsis</a></h2>
<b>ipptransform</b>
[
<b>--help</b>
] [
<b>-d</b>
<i>device-uri</i>
] [
<b>-f</b>
<i>output-filename</i>
] [
<b>-i</b>
<i>input/format</i>
] [
<b>-m</b>
<i>output/format</i>
] [
<b>-o</b>
<i>"name=value [... name=value]"</i>
] [
<b>-r</b>
<i>resolution[,...,resolution]</i>
] [
<b>-s</b>
<i>{flipped|manual-tumble|normal|rotated}</i>
] [
<b>-t</b>
<i>type[,...,type]</i>
] [
<b>-v</b>
]
<i>filename</i>
<h2 class="title"><a name="DESCRIPTION">Description</a></h2>
<b>ipptransform</b>
converts the input file into the output format and optionally sends the output to a network printer.
<b>ipptransform</b>
is normally run by
<b>ippserver</b>(8)
to convert document data for printing.
<h2 class="title"><a name="OPTIONS">Options</a></h2>
The following options are recognized by
<b>ipptransform:</b>
<dl class="man">
<dt><b>--help</b>
<dd style="margin-left: 5.0em">Shows program help.
<dt><b>-d</b><i> device-uri</i>
<dd style="margin-left: 5.0em">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.
<dt><b>-i</b><i> input/format</i>
<dd style="margin-left: 5.0em">Specifies the MIME media type of the input file.
Currently the "application/pdf" (PDF) and "image/jpeg" (JPEG) MIME media types are supported.
<dt><b>-m</b><i> output/format</i>
<dd style="margin-left: 5.0em">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.
<dt><b>-o</b><i> "name=value [... name=value]"</i>
<dd style="margin-left: 5.0em">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 information.
<dt><b>-r</b><i> resolution[,...,resolution]</i>
<dd style="margin-left: 5.0em">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".
<dt><b>-s</b> {flipped|manual-tumble|normal|rotated}
<dd style="margin-left: 5.0em">Specifies the coordinate system for the back side of duplex sheets.
<dt><b>-t</b> type[,...,type]
<dd style="margin-left: 5.0em">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
<b>ipptransform</b>
with the
<i>--help</i>
option to see the list of supported color spaces and bit depths.
<dt><b>-v</b>
<dd style="margin-left: 5.0em">Increases the verbosity for any diagnostics.
</dl>
<h2 class="title"><a name="NAMED_OPTIONS">Named Options</a></h2>
The following named options are supported:
<dl class="man">
<dt><b>copies</b>
<dd style="margin-left: 5.0em">Specifies the number of copies to produce.
<dt><b>media</b>
<dd style="margin-left: 5.0em">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".
<dt><b>media-col</b>
<dd style="margin-left: 5.0em">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.
<dt><b>page-ranges</b>
<dd style="margin-left: 5.0em">Selects a single range of pages to print.
For example, the value "5-12" selects pages 5 through 12.
<dt><b>print-color-mode</b>
<dd style="margin-left: 5.0em">Specifies the color mode as "auto" (automatic), "monochrome" (grayscale), or "color".
<dt><b>print-quality</b>
<dd style="margin-left: 5.0em">Specifies the print quality with value 3 (draft), 4 (normal), or 5 (high/best).
<dt><b>print-scaling</b>
<dd style="margin-left: 5.0em">Specifies the scaling to use when converting image files.
The values "auto", "fit", and "fill" are supported.
<dt><b>printer-resolution</b>
<dd style="margin-left: 5.0em">Specifies the print resolution using one of the supported print resolutions.
<dt><b>sides</b>
<dd style="margin-left: 5.0em">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).
</dl>
<h2 class="title"><a name="DIAGNOSTICS">Diagnostics</a></h2>
<b>ipptransform</b>
sends all messages to the standard error.
Each message is prefixed with "ERROR", "INFO", or "DEBUG" depending on the level of verbosity.
<h2 class="title"><a name="EXIT_STATUS">Exit Status</a></h2>
The
<b>ipptransform</b>
program returns 0 if the input file is converted successfully and 1 otherwise.
<h2 class="title"><a name="ENVIRONMENT">Environment</a></h2>
<b>ipptransform</b>
recognizes the following environment variables:
<dl class="man">
<dt><b>CONTENT_TYPE</b>
<dd style="margin-left: 5.0em">Specifies the MIME media type of the input file.
<dt><b>DEVICE_URI</b>
<dd style="margin-left: 5.0em">Specifies the output device as a URI.
<dt><b>DOCUMENT_NAME</b>
<dd style="margin-left: 5.0em">Specifies the title of the input file.
<dt><b>IPP_xxx</b>
<dd style="margin-left: 5.0em">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.
<dt><b>IPP_xxx_DEFAULT</b>
<dd style="margin-left: 5.0em">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.
<dt><b>IPP_PWG_RASTER_DOCUMENT_RESOLUTION_SUPPORTED</b>
<dd style="margin-left: 5.0em">Lists the supported output resolutions.
<dt><b>IPP_PWG_RASTER_DOCUMENT_SHEET_BACK</b>
<dd style="margin-left: 5.0em">Specifies the coordinate system of the back side of duplex sheets.
<dt><b>IPP_PWG_RASTER_DOCUMENT_TYPE_SUPPORTED</b>
<dd style="margin-left: 5.0em">Lists the supported output color spaces and bit depths.
<dt>IPPTRANSFORM_MAX_RASTER
<dd style="margin-left: 5.0em">Specifies the maximum number of bytes to use when generating raster data.
The default is 16MB.
<dt><b>OUTPUT_TYPE</b>
<dd style="margin-left: 5.0em">Specifies the MIME media type of the output file.
<dt><b>SERVER_LOGLEVEL</b>
<dd style="margin-left: 5.0em">Specifies the log level (verbosity) as "error", "info", or "debug".
</dl>
<h2 class="title"><a name="EXAMPLES">Examples</a></h2>
Print a PDF file to a PCL printer at 10.0.1.42:
<pre class="man">

    ipptransform -d socket://10.0.1.42 -m application/vnd.hp-pcl \
        filename.pdf
</pre>
<p>Print a PDF file to an IPP Everywhere printer at 10.0.1.42:
<pre class="man">

    ipptransform -d ipp://10.0.1.42/ipp/print -m image/pwg-raster \
        filename.pdf
</pre>
<p>Convert a JPEG file to sRGB PWG Raster at 600dpi:
<pre class="man">

    ipptransform -m image/pwg-raster -r 600dpi -t sgray_8,srgb_8 \
        filename.jpg >filename.ras
</pre>
<h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
<b>ippdoclint</b>(7),
<b>ippserver</b>(8),
<b>ipptool</b>(1),
<b>ipptransform3d</b>(7)
<h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
Copyright &copy; 2016-2019 by the IEEE-ISTO Printer Working Group.
Copyright &copy; 2016-2019 by Apple Inc.

</body>
</html>