Attributes

introduction

Here are attributes and their values, as described in various RFCs related to IPP.

Attributes

Attributes with dedicated functions

copies

integer (1:max)

setCopies(5)

document-format

mime media type as described in RFC 2046: Multipurpose Internet Mail Extensions (MIME) Part Two: Media Types. (Updated by RFC2646, RFC3798).

setMimeMediaType($document_format)

default: "application/octet-stream"

page-ranges

1 set Of range Of Integer (1:max)
2-3
1-3 8-12 9-25

setPageRanges("1-2 9-19")

sides

keyword
one-sided
setSides(1)
two-sided-long-edge
setSides(2)
two-sided-short-edge
setSides(2CE)

Attributes settable via setAttribute()

finishings

1 set Of enum
none
staple
punch
holes are required in the finished document.
cover
select a non-printed (or pre-printed) cover for the document. This does not supplant the specification of a printed cover (on cover stock medium) by the document itself.
bind
saddle-stitch
one or more staples (wire stitches) along the middle fold
edge-stitch
Bind the document(s) with one or more staples (wire stitches) along one edge.
staple-top-left
staple-bottom-left
staple-top-right
staple-bottom-right
edge-stitch-left
Bind the document(s) with one or more staples (wire stitches) along the left edge
edge-stitch-top
edge-stitch-right
edge-stitch-bottom
staple-dual-left
two staples along the left edge assuming a portrait document
staple-dual-top
staple-dual-right
staple-dual-bottom

job-hold-until

keyword | name
no-hold
immediately
indefinite
until RelaeseJob()
day-time
during the day
evening
night
weekend
second-shift
after close of business
third-shift
after midnight

job-priority

integer 1:100

job-sheets

keyword | name
none
standard
one or more site specific standard job sheets are printed, e.g. a single start sheet or both start and end sheet is printed

media

keyword | name

not limited to list, as An administrator MAY define additional values using the 'name' or 'keyword' attribute syntax, depending on implementation.

The better way to determine which media sizes are supported is to parse the media-supported attribute after getPrinterAttributes() (eg. $ipp->printer_attributes->media_supported).

default
The default medium for the output device
iso-a4-white
ISO A4 white medium: 210 mm x 297 mm
iso-a4-colored
ISO A4 colored medium: 210 mm x 297 mm
iso-a4-transparent
ISO A4 transparent medium: 210 mm x 297 mm
iso-a3-white
ISO A3 white medium: 297 mm x 420 mm
iso-a3-colored
iso-a5-white
ISO A5 white medium: 148 mm x 210 mm
iso-a5-colored
iso-b4-white
ISO B4 white medium: 250 mm x 353 mm
iso-b4-colored
iso-b5-colored
jis-b4-white
JIS B4 white medium: 257 mm x 364 mm
jis-b4-colored
jis-b5-white
JIS B5 white medium: 182 mm x 257 mm
jis-b5-colored
na-letter-white
North American letter white
na-letter-colored
na-letter-transparent
na-legal-white
North American legal white
na-legal-colored
iso-b4-envelope
ISO B4 envelope
iso-b5-envelope
iso-c3-envelope
iso-c4-envelope
iso-c5-envelope
iso-c6-envelope
iso-designated-long-envelope
ISO Designated Long envelope
na-10x13-envelope
North American 10x13 envelope
na-9x12-envelope
monarch-envelope
na-number-10-envelope
North American number 10 business envelope
na-7x9-envelope
North American 7x9 inch envelope
na-9x11-envelope
na-10x14-envelope
na-number-9-envelope
na-6x9-envelope
na-10x15-envelope
executive-white
executive
folio-white
folio white
invoice-white
ledger-white
quarto-white
iso-a0-white
ISO A0 white medium: 841 mm x 1189 mm
iso-a0-transparent
iso-a0-translucent
ISO A0 translucent
iso-a1-white
ISO A1 white medium: 594 mm x 841 mm
iso-a1-transparent
iso-a1-translucent
iso-a2-white
ISO A2 white medium: 420 mm x 594 mm
iso-a2-transparent
iso-a2-translucent
iso-a3-transparent
ISO A3 transparent medium: 297 mm x 420 mm
iso-a3-translucent
iso-a4-translucent
ISO A4 translucent medium: 210 mm x 297 mm
iso-a5-transparent
ISO A5 transparent medium: 148 mm x 210 mm
iso-a5-translucent
iso-a6-white
ISO A6 white medium: 105 mm x 148 mm
iso-a7-white
ISO A7 white medium: 74 mm x 105 mm
iso-a8-white
ISO A8 white medium: 52 mm x 74 mm
iso-a9-white
ISO A9 white medium: 37 mm x 52 mm
iso-a10-white
ISO A10 white medium: 26 mm x 37 mm
iso-b0-white
ISO B0 white medium: 1000 mm x 1414 mm
iso-b1-white
ISO B1 white medium: 707 mm x 1000 mm
iso-b2-white
ISO B2 white medium: 500 mm x 707 mm
iso-b3-white
ISO B3 white medium: 353 mm x 500 mm
iso-b6-white
ISO B6 white medium: 125 mm x 176 mm
iso-b7-white
ISO B7 white medium: 88 mm x 125 mm
iso-b8-white
ISO B8 white medium: 62 mm x 88 mm
iso-b9-white
ISO B9 white medium: 44 mm x 62 mm
iso-b10-white
ISO B10 white medium: 31 mm x 44 mm
jis-b0-white
JIS B0 white medium: 1030 mm x 1456 mm
jis-b0-transparent
jis-b0-translucent
jis-b1-white
JIS B1 white medium: 728 mm x 1030 mm
jis-b1-transparent
jis-b1-translucent
jis-b2-white
JIS B2 white medium: 515 mm x 728 mm
jis-b2-transparent
jis-b2-translucent
jis-b3-white
JIS B3 white medium: 364 mm x 515 mm
jis-b3-transparent
jis-b3-translucent
jis-b4-transparent
JIS B4 transparent medium: 257 mm x 364 mm
jis-b4-translucent
jis-b5-transparent
JIS B5 transparent medium: 182 mm x 257 mm
jis-b5-translucent
jis-b6-white
JIS B6 white medium: 128 mm x 182 mm
jis-b7-white
JIS B7 white medium: 91 mm x 128 mm
jis-b8-white
JIS B8 white medium: 64 mm x 91 mm
jis-b9-white
JIS B9 white medium: 45 mm x 64 mm
jis-b10-white
JIS B10 white medium: 32 mm x 45 mm
a-white
ANSI A size white medium: 8.5 inches x 11 inches
a-transparent
a-translucent
b-white
ANSI B size white medium: 11 inches x 17 inches
b-transparent
b-translucent
c-white
ANSI C size white medium: 17 inches x 22 inches
c-transparent
c-translucent
d-white
ANSI D size white medium: 22 inches x 34 inches
d-transparent
d-translucent
e-white
ANSI E size white medium: 34 inches x 44 inches
e-transparent
e-translucent
axsynchro-white
Specifies the roll paper having the width of the longer edge (11 inches) of the engineering ANSI A size white medium and cuts synchronizing with data.
axsynchro-transparent
axsynchro-translucent
bxsynchro-white
Specifies the roll paper having the width of the longer edge (17 inches) of the engineering ANSI B size white medium and cuts synchronizing with data.
bxsynchro-transparent
bxsynchro-translucent
cxsynchro-white
Specifies the roll paper having the width of the longer edge (22 inches) of the engineering ANSI C size white medium and cuts synchronizing with data.
cxsynchro-transparent
cxsynchro-translucent
dxsynchro-white
Specifies the roll paper having the width of the longer edge (34 inches) of the engineering ANSI D size white medium and cuts synchronizing with data.
dxsynchro-transparent
dxsynchro-translucent
exsynchro-white
Specifies the roll paper having the width of the longer edge (44 inches) of the engineering ANSI E size white medium and cuts synchronizing with data.
exsynchro-transparent
exsynchro-translucent
arch-a-white
Specifies the Architectural A size white medium: 9 inches x 12 inches
arch-a-transparent
arch-a-translucent
arch-b-white
Architectural B size white medium: 12 inches x 18 inches
arch-b-transparent
arch-b-translucent
arch-c-white
Architectural C size white medium: 18 inches x 24 inches
arch-c-transparent
arch-c-translucent
arch-d-white
Architectural D size white medium: 24 inches x 36 inches
arch-d-transparent
arch-d-translucent
arch-e-white
Architectural E size white medium: 36 inches x 48 inches
arch-e-transparent
arch-e-translucent
arch-axsynchro-white
Specifies the roll paper having the width of the longer edge (12 inches) of the Architectural A size white medium and cuts synchronizing with data.
arch-axsynchro-transparent
arch-axsynchro-translucent
arch-bxsynchro-white
Specifies the roll paper having the width of the longer edge (18 inches) of the Architectural B size white medium and cuts synchronizing with data.
arch-bxsynchro-transparent
arch-bxsynchro-translucent
arch-cxsynchro-white
Specifies the roll paper having the width of the longer edge (24 inches) of the Architectural C size white medium and cuts synchronizing with data.
arch-cxsynchro-transparent
arch-cxsynchro-translucent
arch-dxsynchro-white
Specifies the roll paper having the width of the longer edge (36 inches) of the Architectural D size white medium and cuts synchronizing with data.
arch-dxsynchro-transparent
arch-dxsynchro-translucent
arch-exsynchro-white
Specifies the roll paper having the width of the longer edge (48 inches) of the Architectural E size white medium and cuts synchronizing with data.
arch-exsynchro-transparent
arch-exsynchro-translucent
iso-a1x3-white
Specifies the ISO A1X3 white medium having the width of the longer edge (841 mm) of the ISO A1 medium
iso-a1x3-transparent
iso-a1x3-translucent
iso-a1x4-white
Specifies the ISO A1X4 white medium having the width of the longer edge (841 mm) of the ISO A1 medium
iso-a1x4-transparent
iso-a1x4-translucent
iso-a2x3-white
Specifies the ISO A2X3 white medium having the width of the longer edge (594 mm) of the ISO A2 medium
iso-a2x3-transparent
iso-a2x3-translucent
iso-a2x4-white
Specifies the ISO A2X4 white medium having the width of the longer edge (594 mm) of the ISO A2 medium
iso-a2x4-transparent
iso-a2x4-translucent
iso-a2x5-white
Specifies the ISO A2X5 white medium having the width of the longer edge (594 mm) of the ISO A2 medium
iso-a2x5-transparent
iso-a2x5-translucent
iso-a3x3-white
Specifies the ISO A3X3 white medium having the width of the longer edge (420 mm) of the ISO A3 medium
iso-a3x3-transparent
iso-a3x3-translucent
iso-a3x4-white
Specifies the ISO A3X4 white medium having the width of the longer edge (420 mm) of the ISO A3 medium
iso-a3x4-transparent
iso-a3x4-translucent
iso-a3x5-white
Specifies the ISO A3X5 white medium having the width of the longer edge (420 mm) of the ISO A3 medium
iso-a3x5-transparent
iso-a3x5-translucent
iso-a3x6-white
Specifies the ISO A3X6 white medium having the width of the longer edge (420 mm) of the ISO A3 medium
iso-a3x6-transparent
iso-a3x6-translucent
iso-a3x7-white
Specifies the ISO A3X7 white medium having the width of the longer edge (420 mm) of the ISO A3 medium
iso-a3x7-transparent
iso-a3x7-translucent
iso-a4x3-white
Specifies the ISO A4X3 white medium having the width of the longer edge (297 mm) of the ISO A4 medium
iso-a4x3-transparent
iso-a4x3-translucent
iso-a4x4-white
Specifies the ISO A4X4 white medium having the width of the longer edge (297 mm) of the ISO A4 medium
iso-a4x4-transparent
iso-a4x4-translucent
iso-a4x5-white
Specifies the ISO A4X5 white medium having the width of the longer edge (297 mm) of the ISO A4 medium
iso-a4x5-transparent
iso-a4x5-translucent
iso-a4x6-white
Specifies the ISO A4X6 white medium having the width of the longer edge (297 mm) of the ISO A4 medium
iso-a4x6-transparent
iso-a4x6-translucent
iso-a4x7-white
Specifies the ISO A4X7 white medium having the width of the longer edge (297 mm) of the ISO A4 medium
iso-a4x7-transparent
iso-a4x7-translucent
iso-a4x8-white
iso-a4x8-transparent
iso-a4x8-translucent
iso-a4x9-white
Specifies the ISO A4X9 white medium having the width of the longer edge (297 mm) of the ISO A4 medium
iso-a4x9-transparent
iso-a4x9-translucent
iso-a0xsynchro-white
Specifies the paper having the width of the longer edge (1189 mm) of the ISO A0 white medium and cuts synchronizing with data.
iso-a0xsynchro-transparent
iso-a0xsynchro-translucent
iso-a1xsynchro-white
Specifies the paper having the width of the longer edge (841 mm) of the ISO A1 white medium and cuts synchronizing with data.
iso-a1xsynchro-transparent
iso-a1xsynchro-translucent
iso-a2xsynchro-white
Specifies the paper having the width of the longer edge (594 mm) of the ISO A2 white medium and cuts synchronizing with data.
iso-a2xsynchro-transparent
iso-a2xsynchro-translucent
iso-a3xsynchro-white
Specifies the paper having the width of the longer edge (420 mm) of the ISO A3 white medium and cuts synchronizing with data.
iso-a3xsynchro-transparent
iso-a3xsynchro-translucent
iso-a4xsynchro-white
Specifies the paper having the width of the longer edge (297 mm) of the ISO A4 white medium and cuts synchronizing with data.
iso-a4xsynchro-transparent
iso-a4xsynchro-translucent
auto-white
Specifies that the printer selects the white medium with the appropriate fixed size (e.g. a1, a2, etc.) or data- synchro size, and the selection is implementation-defined.
auto-transparent
auto-translucent
auto-fixed-size-white
Specifies that the printer selects the white medium with the appropriate fixed size (e.g. a1, a2, etc.) or the appropriate long fixed size listed above.
auto-fixed-size-transparent
auto-fixed-size-translucent
auto-synchro-white
Specifies that the printer selects the white paper with the appropriate width and cuts it synchronizing with data.
auto-synchro-transparent
auto-synchro-translucent

The following standard values are defined for input-trays (from ISO DPA and the Printer MIB):

top
The top input tray in the printer.
middle
The middle input tray in the printer.
bottom
The bottom input tray in the printer.
envelope
The envelope input tray in the printer.
manual
The manual feed input tray in the printer.
large-capacity
The large capacity input tray in the printer.
main
The main input tray
side
The side input tray

The following standard values are defined for media sizes (from ISO DPA):

iso-a0
Specifies the ISO A0 size: 841 mm by 1189 mm as defined in ISO 216
iso-a1
594 mm by 841 mm
iso-a2
420 mm by 594 mm
iso-a3
297 mm by 420 mm
iso-a4
210 mm by 297 mm
iso-a5
148 mm by 210 mm
iso-a6
105 mm by 148 mm
iso-a7
74 mm by 105 mm
iso-a8
52 mm by 74 mm
iso-a9
37 mm by 52 mm
iso-a10
26 mm by 37 mm
iso-b0
1000 mm by 1414 mm
iso-b1
707 mm by 1000 mm
iso-b2
500 mm by 707 mm
iso-b3
353 mm by 500 mm
iso-b4
250 mm by 353 mm
iso-b5
176 mm by 250 mm
iso-b6
125 mm by 176 mm
iso-b7
88 mm by 125 mm
iso-b8
62 mm by 88 mm
iso-b9
44 mm by 62 mm
iso-b10
31 mm by 44 mm
na-letter
Specifies the North American letter size: 8.5 inches by 11 inches
na-legal
8.5 inches by 14 inches
na-8x10
8 inches by 10 inches
na-5x7
5 inches by 7 inches
executive
executive size (7.25 X 10.5 in)
folio
folio size (8.5 X 13 in)
invoice
invoice size (5.5 X 8.5 in)
ledger
ledger size (11 X 17 in)
quarto
quarto size (8.5 X 10.83 in)
iso-c3
ISO C3 size: 324 mm by 458 mm as defined in ISO 269
iso-c4
229 mm by 324 mm
iso-c5
162 mm by 229 mm
iso-c6
114 mm by 162 mm
iso-designated-long
ISO Designated Long size: 110 mm by 220 mm
na-10x13-envelope
Specifies the North American 10x13 size: 10 inches by 13 inches
na-9x12-envelope
9 inches by 12 inches
na-number-10-envelope
number 10 business envelope size: 4.125 inches by 9.5 inches
na-7x9-envelope
7x9 inch
na-9x11-envelope
9x11 inch
na-10x14-envelope
10x14 inch
na-number-9-envelope
Specifies the North American number 9 business envelope size
na-6x9-envelope
Specifies the North American 6x9 envelope size
na-10x15-envelope
North American 10x15 envelope size
monarch-envelope
Monarch envelope size (3.87 x 7.5 in)
jis-b0
JIS B0 size: 1030mm x 1456mm
jis-b1
728mm x 1030mm
jis-b2
515mm x 728mm
jis-b3
364mm x 515m
jis-b4
257mm x 364mm
jis-b5
182mm x 257mm
jis-b6
128mm x 182mm
jis-b7
91mm x 128mm
jis-b8
64mm x 91mm
jis-b9
45mm x 64mm
jis-b10
32mm x 45mm
a
engineering ANSI A size medium: 8.5 inches x 11 inches
b
11 inches x 17 inches
c
17 inches x 22 inches
d
22 inches x 34 inches
e
34 inches x 44 inches
arch-a
Architectural A size medium: 9 inches x 12 inches
arch-b
12 inches x 18 inches
arch-c
18 inches x 24 inches
arch-d
24 inches x 36 inches
arch-e
36 inches x 48 inches

multiple-document-handling

keyword
single-document
the result of processing all the document data (a and then b) MUST be treated as a single sequence of media sheets for finishing operations
separate-documents-uncollated-copies
the result of processing the data in each document instance MUST be treated as a single sequence of media sheets for finishing operations
separate-documents-collated-copies
same + If more than one copy is made, the ordering of the sets of media sheets resulting from processing the document data MUST be a(*), b(*), a(*), b(*)
single-document-new-sheet
Same as 'single-document', except that the Printer object MUST ensure that the first impression of each document instance in the job is placed on a new media sheet. This value allows multiple documents to be stapled together with a single staple where each document starts on a new sheet.

number-up

integer (1:max)

This attribute specifies the number of print-stream pages to impose upon a single side of an instance of a selected medium.

orientation-requested

enum
portrait
landscape
Landscape is defined to be a rotation of the print-stream page to be imaged by +90 degrees with respect to the medium (i.e. anti-clockwise) from the portrait orientation.
reverse-landscape
reverse-portrait

printer-resolution

resolution
1440x720dpi
dots per inch
300x300dpc
dots per centimeter

Readable attributes

See file readable-attributes.html

CUPS specific attributes

See file cups-attributes.html