.\" $Header:
.TA p
.TH pd_att_document 5
.SH NAME
pd_att_document \- list of attributes for an HPDPS document object
.SH DESCRIPTION
The following is a list of valid attributes and values for the document object
class of the HP Distributed Print Service.
.SS Attributes for a Document Object         

.cs 1 22
.lg 0
.nf
|------------------------------------------------------------------------|
| Settable Attribute Listing         | Specifiable Attribute Listing     |
|------------------------------------|-----------------------------------|
|     bottom-margin                  |     document-file-name            |
|     content-orientation            |     document-type                 |
|     copy-count                     |     initial-value-document        |
|     default-character-set          |     octet-count                   |
|     default-font                   |     transfer-method               |
|     default-input-tray             |                                   |
|     default-medium                 |                                   |
|     default-printer-resolution     |                                   |
|     document-comment               |                                   |
|     document-format                |                                   |
|     input-tray-select              |                                   |
|     left-margin                    |                                   |
|     number-up                      |                                   |
|     page-select                    |                                   |
|     plex                           |                                   |
|     printer-pass-through           |                                   |
|     right-margin                   |                                   |
|     sides                          |                                   |
|     top-margin                     |                                   |
|------------------------------------------------------------------------|


|------------------------------------------------------------------------|
| Table  1-1. Document Attributes                                        |
|------------------------------------------------------------------------|
| Attribute  | Description                                               |
|------------|-----------------------------------------------------------|
| Name       | beginning-page-requested                                  |
|------------|-----------------------------------------------------------|
| Type       | Non Settable.                                             |
|------------|-----------------------------------------------------------|
| Usage      |                                                           |
|------------|-----------------------------------------------------------|
| Explanation| Identifies the beginning page of the document specified   |
|            | by the beginning-page component of the document page-     |
|            | select attribute.                                         |
|------------|-----------------------------------------------------------|
| Value Type | Single Value.                                             |
|------------|-----------------------------------------------------------|
| Values     | An integer from 1 to 2147483647. Implicitly set by HPDPS. |
|------------|-----------------------------------------------------------|
| Default    | No default                                                |
|------------|-----------------------------------------------------------|
| Usage      | o   This attribute is intended for use in the ipmap file  |
| Guidelines |     to convert the beginning-page component of the        |
|            |     page-select attribute to the interface program option.|
|            |     Use the page-select attribute to specify the starting |
|            |     page to print with the pdpr command.                  |
|------------|-----------------------------------------------------------|
|------------|-----------------------------------------------------------|
| Attribute  | Description                                               |
|------------|-----------------------------------------------------------|
| Name       | bottom-margin                                             |
|------------|-----------------------------------------------------------|
| Input      | bm                                                        |
| Synonym    |                                                           |
|------------|-----------------------------------------------------------|
| Type       | Settable with the pdpr, pdset, or pdmod commands.         |
|------------|-----------------------------------------------------------|
| Usage      |                                                           |
|------------|-----------------------------------------------------------|
| Explanation| Specifies the distance between the bottom edge of the     |
|            | logical page and the bottom edge of the text area when    |
|            | held in the reading orientation.  The values are in units |
|            | of characters.                                            |
|------------|-----------------------------------------------------------|
| Value Type | Single value.                                             |
|------------|-----------------------------------------------------------|
| Values     | An integer from 1 to 2147483647.                          |
|------------|-----------------------------------------------------------|
| Default    | No default.                                               |
|------------|-----------------------------------------------------------|
| Usage      |                                                           |
| Guidelines |                                                           |
|------------|-----------------------------------------------------------|
|------------|-----------------------------------------------------------|
| Attribute  | Description                                               |
|------------|-----------------------------------------------------------|
| Name       | content-orientation                                       |
|------------|-----------------------------------------------------------|
| Input      | orientation                                               |
| Synonym    |                                                           |
|------------|-----------------------------------------------------------|
| Type       | Settable with the pdpr, pdset, or pdmod commands.         |
|------------|-----------------------------------------------------------|
| Usage      | Values vary by printer model.                             |
|------------|-----------------------------------------------------------|
| Explanation| Identifies the page presentation (how the data is to be   |
|            | placed on a page) for the document.                       |
|------------|-----------------------------------------------------------|
| Value Type | Single value.                                             |
|------------|-----------------------------------------------------------|
| Values     | One of the following fixed values:                        |
|            |                                                           |
|            | landscape                                                 |
|            | portrait                                                  |
|            | reverse-portrait                                          |
|            | reverse-landscape                                         |
|------------|-----------------------------------------------------------|
| Default    | portrait                                                  |
|------------|-----------------------------------------------------------|
| Usage      | o   The document is validated and scheduled against the   |
| Guidelines |     printer attribute content-orientations-supported.     |
|------------|-----------------------------------------------------------|
|------------|-----------------------------------------------------------|
| Attribute  | Description                                               |
|------------|-----------------------------------------------------------|
| Name       | copy-count                                                |
|------------|-----------------------------------------------------------|
| Input      | copies                                                    |
| Synonym    |                                                           |
|------------|-----------------------------------------------------------|
| Type       | Settable with the pdpr, pdset, or pdmod commands.         |
|------------|-----------------------------------------------------------|
| Usage      |                                                           |
|------------|-----------------------------------------------------------|
| Explanation| Specifies the number of document copies to be printed per |
|            | job copy.                                                 |
|------------|-----------------------------------------------------------|
| Value Type | Single value.                                             |
|------------|-----------------------------------------------------------|
| Values     | An integer from 1 to 2147483647.                          |
|------------|-----------------------------------------------------------|
| Default    | 1                                                         |
|------------|-----------------------------------------------------------|
| Usage      | o   The document is validated and scheduled against the   |
| Guidelines |     printer attribute maximum-copies-supported.           |
|            | o   A value of zero (0) is an error.                      |
|------------|-----------------------------------------------------------|
|------------|-----------------------------------------------------------|
| Attribute  | Description                                               |
|------------|-----------------------------------------------------------|
| Name       | default-character-set                                     |
|------------|-----------------------------------------------------------|
| Type       | Settable with the pdpr, pdset, or pdmod commands.         |
|------------|-----------------------------------------------------------|
| Usage      | Values vary by printer model.                             |
|------------|-----------------------------------------------------------|
| Explanation| Identifies the default character set to be used.          |
|------------|-----------------------------------------------------------|
| Value Type | Single value.                                             |
|------------|-----------------------------------------------------------|
| Values     | One of the following fixed values:                        |
|            |                                                           |
|            | iso-ucs-2-level2                                          |
|            | other                                                     |
|            | ascii                                                     |
|            | iso-latin1                                                |
|            | iso-latin2                                                |
|            | iso-latin3                                                |
|            | iso-latin4                                                |
|            | iso-latin-cyrillic                                        |
|            | iso-latin-arabic                                          |
|            | iso-latin-greek                                           |
|            | iso-latin-hebrew                                          |
|            | iso-latin5                                                |
|            | iso-latin6                                                |
|            | iso-text-communication                                    |
|            | half-width-katakana                                       |
|            | jis-encoding                                              |
|            | shift-jis                                                 |
|            | euc-packed-format-japanese                                |
|            | euc-fixed-width-japanese                                  |
|            | iso-reg4-united-kingdom                                   |
|            | iso-reg11-swedish-for-names                               |
|            | iso-reg15-italian                                         |
|            | iso-reg17-spanish                                         |
|            | iso-reg21-german                                          |
|            | iso-reg60-danish-norwegian                                |
|            | iso-reg69-french                                          |
|            | unicode                                                   |
|            | ucs4                                                      |
|            | unicode-ascii                                             |
|            | unicode-latin1                                            |
|            | unicode-ibm-2039                                          |
|            | unicode-ibm-1261                                          |
|            | unicode-ibm-1268                                          |
|            | unicode-ibm-1276                                          |
|            | unicode-ibm-1264                                          |
|            | unicode-ibm-1265                                          |
|            | windows30-latin1                                          |
|            | windows31-latin1                                          |
|            | windows31-latin2                                          |
|            | windows31-latin5                                          |
|            | hp-roman8                                                 |
|            | adobe-standard-encoding                                   |
|            | ventura-us                                                |
|            | ventura-international                                     |
|            | dec-mcs                                                   |
|            | pc-page-850-multilingual                                  |
|            | pc-page-852-latin2                                        |
|            | pc8-page-437-us                                           |
|            | pc8-danish-norwegian                                      |
|            | pc-page-862-latin-hebrew                                  |
|            | pc8-turkish                                               |
|            | ibm-symbols                                               |
|            | ibm-thai                                                  |
|            | hp-legal                                                  |
|            | hp-pifont                                                 |
|            | hp-math8                                                  |
|            | hp-ps-math                                                |
|            | hp-desktop                                                |
|            | ventura-math                                              |
|            | microsoft-publishing                                      |
|            | windows31j                                                |
|            | gb-2312                                                   |
|            | big5                                                      |
|            | cns                                                       |
|            | ksc-5601                                                  |
|            | ccdc                                                      |
|------------|-----------------------------------------------------------|
| Default    | No default.                                               |
|------------|-----------------------------------------------------------|
| Usage      | o   The document is validated and scheduled against the   |
| Guidelines |     printer attribute character-sets-supported.           |
|------------|-----------------------------------------------------------|
|------------|-----------------------------------------------------------|
| Attribute  | Description                                               |
|------------|-----------------------------------------------------------|
| Name       | default-font                                              |
|------------|-----------------------------------------------------------|
| Type       | Settable with the pdpr, pdset, or pdmod commands.         |
|------------|-----------------------------------------------------------|
| Usage      | Values vary by printer model.                             |
|------------|-----------------------------------------------------------|
| Explanation| Identifies the default font to be used.                   |
|------------|-----------------------------------------------------------|
| Value Type | Single value.                                             |
|------------|-----------------------------------------------------------|
| Values     | A text string up to 4095 characters that contains the     |
|            | font name.                                                |
|------------|-----------------------------------------------------------|
| Default    | No default.                                               |
|------------|-----------------------------------------------------------|
| Usage      | o   The document is validated and scheduled against the   |
| Guidelines |     printer attribute fonts-supported.                    |
|------------|-----------------------------------------------------------|
|------------|-----------------------------------------------------------|
| Attribute  | Description                                               |
|------------|-----------------------------------------------------------|
| Name       | default-input-tray                                        |
|------------|-----------------------------------------------------------|
| Type       | Settable with the pdpr, pdset, or pdmod commands.         |
|------------|-----------------------------------------------------------|
| Usage      | Values vary by printer model.                             |
|------------|-----------------------------------------------------------|
| Explanation| Identifies an input-tray on the printer that contains the |
|            | medium that is to be used for normal document pages.      |
|------------|-----------------------------------------------------------|
| Value Type | Single value.                                             |
|------------|-----------------------------------------------------------|
| Values     | A text string of up to 255 characters that describes the  |
|            | input tray, or one of the following fixed values:         |
|            |                                                           |
|            | top                                                       |
|            | middle                                                    |
|            | bottom                                                    |
|            | envelope                                                  |
|            | manual                                                    |
|            | large-capacity                                            |
|            | main                                                      |
|            | side                                                      |
|------------|-----------------------------------------------------------|
| Default    | No default.                                               |
|------------|-----------------------------------------------------------|
| Usage      | o   The document is validated and scheduled against the   |
| Guidelines |     printer attribute input-trays-supported.              |
|            |                                                           |
|            | o   The following attributes may be used to select the    |
|            |     input tray.  If more than one of these attributes are |
|            |     supplied then the attribute with the highest          |
|            |     precedence, as numbered, is chosen:                   |
|            |                                                           |
|            |         1. input-tray-select                              |
|            |         2. default-medium                                 |
|            |         3. default-input-tray                             |
|------------|-----------------------------------------------------------|
|------------|-----------------------------------------------------------|
| Attribute  | Description                                               |
|------------|-----------------------------------------------------------|
| Name       | default-medium                                            |
|------------|-----------------------------------------------------------|
| Type       | Settable with the pdpr, pdset, or pdmod commands.         |
|------------|-----------------------------------------------------------|
| Usage      | Values vary by printer model.                             |
|------------|-----------------------------------------------------------|
| Explanation| Identifies the medium for normal document pages on which  |
|            | this document is to be printed.                           |
|------------|-----------------------------------------------------------|
| Value Type | Single value.                                             |
|------------|-----------------------------------------------------------|
| Values     | One of the following fixed values or a text string that   |
|            | contains the name of the medium.  The text string can be  |
|            | up to 255 characters long per medium.                     |
|            |                                                           |
|            | iso-a4-white                                              |
|            | iso-a4-colored                                            |
|            | iso-a4-transparent                                        |
|            | iso-a3-white                                              |
|            | iso-a3-colored                                            |
|            | iso-a5-white                                              |
|            | iso-a5-colored                                            |
|            | iso-b4-white                                              |
|            | iso-b4-colored                                            |
|            | iso-b5-white                                              |
|            | iso-b5-colored                                            |
|            | na-letter-white                                           |
|            | na-letter-colored                                         |
|            | na-letter-transparent                                     |
|            | na-legal-white                                            |
|            | na-legal-colored                                          |
|            | iso-b5-envelope                                           |
|            | iso-b4-envelope                                           |
|            | iso-c4-envelope                                           |
|            | iso-c5-envelope                                           |
|            | designated-long-envelope                                  |
|            | na-10x13-envelope                                         |
|            | na-9x12-envelope                                          |
|            | monarch-envelope                                          |
|            | na-number-10-envelope                                     |
|            | na-7x9-envelope                                           |
|            | na-9x11-envelope                                          |
|            | na-10x14-envelope                                         |
|            | na-number-9-envelope                                      |
|            | na-6x9-envelope                                           |
|            | na-10x15-envelope                                         |
|            | jis-b4-white                                              |
|            | jis-b4-colored                                            |
|            | jis-b5-white                                              |
|            | jis-b5-colored                                            |
|            | executive                                                 |
|            | folio                                                     |
|            | invoice                                                   |
|            | ledger                                                    |
|            | quarto                                                    |
|            | iso-a0-white                                              |
|            | iso-a1-white                                              |
|            | iso-a2-white                                              |
|            | iso-a6-white                                              |
|            | iso-a7-white                                              |
|            | iso-a8-white                                              |
|            | iso-a9-white                                              |
|            | iso-a10-white                                             |
|            | iso-b10-white                                             |
|            | iso-b0-white                                              |
|            | iso-b1-white                                              |
|            | iso-b2-white                                              |
|            | iso-b3-white                                              |
|            | iso-b6-white                                              |
|            | iso-b7-white                                              |
|            | iso-b8-white                                              |
|            | iso-b9-white                                              |
|            | iso-b10-white                                             |
|            | jis-b0-white                                              |
|            | jis-b1-white                                              |
|            | jis-b2-white                                              |
|            | jis-b3-white                                              |
|            | jis-b6-white                                              |
|            | jis-b7-white                                              |
|            | jis-b8-white                                              |
|            | jis-b9-white                                              |
|            | jis-b10-white                                             |
|            | a                                                         |
|            | b                                                         |
|            | c                                                         |
|            | d                                                         |
|            | e                                                         |
|------------|-----------------------------------------------------------|
| Default    | No default.                                               |
|------------|-----------------------------------------------------------|
| Usage      | o   The document is validated against the                 |
| Guidelines |     logical printer attribute media-supported and the     |
|            |     physical printer attribute media-supported            |
|            | o   The document is scheduled against the                 |
|            |     physical printer attributes media-supported and       |
|            |     media-ready                                           |
|            |                                                           |
|            | o   The following attributes may be used to select the    |
|            |     input tray.  If more than one of these attributes are |
|            |     supplied then the attribute with the highest          |
|            |     precedence, as numbered, is chosen:                   |
|            |                                                           |
|            |         1. input-tray-select                              |
|            |         2. default-medium                                 |
|            |         3. default-input-tray                             |
|------------|-----------------------------------------------------------|
|------------|-----------------------------------------------------------|
| Attribute  | Description                                               |
|------------|-----------------------------------------------------------|
| Name       | default-printer-resolution                                |
|------------|-----------------------------------------------------------|
| Type       | Settable with the pdpr, pdset, or pdmod commands.         |
|------------|-----------------------------------------------------------|
| Usage      | Values vary by printer model.                             |
|------------|-----------------------------------------------------------|
| Explanation| Identifies the default printer resolution to be used.     |
|------------|-----------------------------------------------------------|
| Value Type | Single Value.                                             |
|------------|-----------------------------------------------------------|
| Values     | One of the following fixed values or an integer from 1 to |
|            | 2147483647.                                               |
|            |                                                           |
|            | highest                                                   |
|            | lowest                                                    |
|            | middle                                                    |
|------------|-----------------------------------------------------------|
| Default    | No default.                                               |
|------------|-----------------------------------------------------------|
| Usage      | o   The value of this attribute is validated against the  |
| Guidelines |     printer attribute printer-resolutions-supported.      |
|------------|-----------------------------------------------------------|
|------------|-----------------------------------------------------------|
| Attribute  | Description                                               |
|------------|-----------------------------------------------------------|
| Name       | document-comment                                          |
|------------|-----------------------------------------------------------|
| Type       | Settable with the pdpr, pdset, or pdmod commands.         |
|------------|-----------------------------------------------------------|
| Usage      |                                                           |
|------------|-----------------------------------------------------------|
| Explanation| Provides information that is associated with this         |
|            | document.                                                 |
|------------|-----------------------------------------------------------|
| Value Type | Single value.                                             |
|------------|-----------------------------------------------------------|
| Values     | A text string up to 4095 characters that contains         |
|            | information about this document such as the fonts to be   |
|            | used.                                                     |
|------------|-----------------------------------------------------------|
| Default    | No default.                                               |
|------------|-----------------------------------------------------------|
| Usage      |                                                           |
| Guidelines |                                                           |
|------------|-----------------------------------------------------------|
|------------|-----------------------------------------------------------|
| Attribute  | Description                                               |
|------------|-----------------------------------------------------------|
| Name       | document-file-name                                        |
|------------|-----------------------------------------------------------|
| Input      | file-name                                                 |
| Synonym    |                                                           |
|------------|-----------------------------------------------------------|
| Type       | Specifiable                                               |
|------------|-----------------------------------------------------------|
| Usage      |                                                           |
|------------|-----------------------------------------------------------|
| Explanation| Specifies the file name or other source that provided the |
|            | data for the document to be or was printed.               |
|------------|-----------------------------------------------------------|
| Value Type | Single value.                                             |
|------------|-----------------------------------------------------------|
| Values     | A text string up to 4095 characters that contains the     |
|            | global ID.                                                |
|------------|-----------------------------------------------------------|
| Default    | No default.                                               |
|------------|-----------------------------------------------------------|
| Usage      | o   Set by HPDPS from the name of the file or source      |
| Guidelines |     specified with the pdpr command.                      |
|------------|-----------------------------------------------------------|
|------------|-----------------------------------------------------------|
| Attribute  | Description                                               |
|------------|-----------------------------------------------------------|
| Name       | document-format                                           |
|------------|-----------------------------------------------------------|
| Input      | format                                                    |
| Synonym    |                                                           |
|------------|-----------------------------------------------------------|
| Type       | Settable with the pdpr, pdset, or pdmod commands.         |
|------------|-----------------------------------------------------------|
| Usage      | Values vary by printer model.                             |
|------------|-----------------------------------------------------------|
| Explanation| Identifies the format (datatype) of the document.         |
|------------|-----------------------------------------------------------|
| Value Type | Single value.                                             |
|------------|-----------------------------------------------------------|
| Values     | One of the following fixed values:                        |
|            |                                                           |
|            | Fixed Value                      Input Synonym            |
|            | ascii                                                     |
|            | pcl                              hppcl                    |
|            |                                  hp-pcl                   |
|            | hpgl                             hp-gl                    |
|            | pjl                                                       |
|            | postscript                       ps                       |
|            | ipds                                                      |
|            | ppds                                                      |
|            | escapep                                                   |
|            | epson                                                     |
|            | ddif                                                      |
|            | interpress                                                |
|            | iso-6429                                                  |
|            | line-data                                                 |
|            | modca                                                     |
|            | regis                                                     |
|            | scs                                                       |
|            | spdl                                                      |
|            | tek4014                                                   |
|            | pds                                                       |
|            | igp                                                       |
|            | codev                                                     |
|            | dsc-dse                                                   |
|            | wps                                                       |
|            | ln03                                                      |
|            | ccitt                                                     |
|            | quic                                                      |
|            | cpap                                                      |
|            | dec-ppl                                                   |
|            | simple-text                                               |
|            | npap                                                      |
|            | doc                                                       |
|            | impress                                                   |
|            | pinwriter                                                 |
|            | npdl                                                      |
|            | nec201pl                                                  |
|            | automatic                                                 |
|            | pages                                                     |
|            | lips                                                      |
|            | tiff                                                      |
|            | diagnostic                                                |
|            | capsl                                                     |
|            | excl                                                      |
|            | lcds                                                      |
|            | xes                                                       |
|            | passthru                                                  |
|------------|-----------------------------------------------------------|
| Default    | ascii                                                     |
|------------|-----------------------------------------------------------|
| Usage      | o   The document is validated and scheduled against the   |
| Guidelines |     printer attribute document-formats-supported.         |
|------------|-----------------------------------------------------------|
|------------|-----------------------------------------------------------|
| Attribute  | Description                                               |
|------------|-----------------------------------------------------------|
| Name       | document-sequence-number                                  |
|------------|-----------------------------------------------------------|
| Input      | sequence-number, document-number                          |
| Synonym    |                                                           |
|------------|-----------------------------------------------------------|
| Type       | Not Settable                                              |
|------------|-----------------------------------------------------------|
| Usage      |                                                           |
|------------|-----------------------------------------------------------|
| Explanation| Specifies the document number in relation to the other    |
|            | documents of a multiple document job.  HPDPS sets this    |
|            | value.                                                    |
|------------|-----------------------------------------------------------|
| Value Type | Single value.                                             |
|------------|-----------------------------------------------------------|
| Values     | One of the integers from 1 to 2147483647.                 |
|------------|-----------------------------------------------------------|
| Default    | No default.                                               |
|------------|-----------------------------------------------------------|
| Usage      | o   Used to identify this document in request status or   |
| Guidelines |     when HPDPS provides event status.                     |
|------------|-----------------------------------------------------------|
|------------|-----------------------------------------------------------|
| Attribute  | Description                                               |
|------------|-----------------------------------------------------------|
| Name       | document-type                                             |
|------------|-----------------------------------------------------------|
| Input      | type                                                      |
| Synonym    |                                                           |
|------------|-----------------------------------------------------------|
| Type       | Specifiable using the pdpr command.                       |
|------------|-----------------------------------------------------------|
| Usage      | Values vary by printer model.                             |
|------------|-----------------------------------------------------------|
| Explanation| Indicates that the document is either a printable         |
|            | document, a font, or some other resource.                 |
|------------|-----------------------------------------------------------|
| Value Type | Single value.                                             |
|------------|-----------------------------------------------------------|
| Values     | One of the following fixed values:                        |
|            |                                                           |
|            | printable                                                 |
|------------|-----------------------------------------------------------|
| Default    | printable                                                 |
|------------|-----------------------------------------------------------|
| Usage      | o   The document is validated and scheduled against the   |
| Guidelines |     printer attribute document-types-supported.           |
|------------|-----------------------------------------------------------|
|------------|-----------------------------------------------------------|
| Attribute  | Description                                               |
|------------|-----------------------------------------------------------|
| Name       | ending-page-requested                                     |
|------------|-----------------------------------------------------------|
| Type       | Non Settable.                                             |
|------------|-----------------------------------------------------------|
| Usage      |                                                           |
|------------|-----------------------------------------------------------|
| Explanation| Identifies the ending page of the document specified      |
|            | by the ending-page component of the document page-select  |
|            | attribute.                                                |
|------------|-----------------------------------------------------------|
| Value Type | Single Value.                                             |
|------------|-----------------------------------------------------------|
| Values     | An integer from 1 to 2147483647. Implicitly set by HPDPS. |
|------------|-----------------------------------------------------------|
| Default    | No default                                                |
|------------|-----------------------------------------------------------|
| Usage      | o   This attribute is intended for use in the ipmap       |
| Guidelines |     file to convert the ending-page component of the      |
|            |     page-select attribute to the interface program option.|
|            |     Use the page-select attribute to specify the ending   |
|            |     page to print with the pdpr command.                  |
|------------|-----------------------------------------------------------|
|------------|-----------------------------------------------------------|
| Attribute  | Description                                               |
|------------|-----------------------------------------------------------|
| Name       | initial-value-document                                    |
|------------|-----------------------------------------------------------|
| Type       | Specifiable with the pdpr command.                        |
|------------|-----------------------------------------------------------|
| Usage      |                                                           |
|------------|-----------------------------------------------------------|
| Explanation| Identifies an initial-value-document object (within a     |
|            | given spooler) that is to be used for this document.      |
|            | This object may be used when a document is created during |
|            | job submission.                                           |
|------------|-----------------------------------------------------------|
| Value Type | Single value.                                             |
|------------|-----------------------------------------------------------|
| Values     | Any text string up to 255 characters that contains the    |
|            | name of this initial-value-document.                      |
|------------|-----------------------------------------------------------|
| Default    | No default                                                |
|------------|-----------------------------------------------------------|
| Usage      | o   If this attribute is specified, the document uses the |
| Guidelines |     attribute values from the initial-value-document      |
|            |     object to set the document attribute values, unless   |
|            |     initial-value-document attribute values are           |
|            |     overridden by attribute values supplied at the        |
|            |     command line.                                         |
|------------|-----------------------------------------------------------|
|------------|-----------------------------------------------------------|
| Attribute  | Description                                               |
|------------|-----------------------------------------------------------|
| Name       | input-tray-select                                         |
|------------|-----------------------------------------------------------|
| Type       | Settable with the pdpr, pdset, or pdmod commands.         |
|------------|-----------------------------------------------------------|
| Usage      | Values vary by printer model.                             |
|------------|-----------------------------------------------------------|
| Explanation| Identifies which input tray (bin) contains the medium     |
|            | that is to be used for this document.                     |
|------------|-----------------------------------------------------------|
| Value Type | Single value.                                             |
|------------|-----------------------------------------------------------|
| Values     | A text string of up to 255 characters that describes the  |
|            | input tray, or one of the following fixed values:         |
|            |                                                           |
|            | top                                                       |
|            | middle                                                    |
|            | bottom                                                    |
|            | envelope                                                  |
|            | manual                                                    |
|            | large-capacity                                            |
|            | main                                                      |
|            | side                                                      |
|------------|-----------------------------------------------------------|
| Default    | No default                                                |
|------------|-----------------------------------------------------------|
| Usage      | o   The document is validated and scheduled against the   |
| Guidelines |     printer attribute input-trays-supported.              |
|            |                                                           |
|            | o   The following attributes may be used to select the    |
|            |     input tray.  If more than one of these attributes are |
|            |     supplied then the attribute with the highest          |
|            |     precedence, as numbered, is chosen:                   |
|            |                                                           |
|            |         1. input-tray-select                              |
|            |         2. default-medium                                 |
|            |         3. default-input-tray                             |
|------------|-----------------------------------------------------------|
|------------|-----------------------------------------------------------|
| Attribute  | Description                                               |
|------------|-----------------------------------------------------------|
| Name       | left-margin                                               |
|------------|-----------------------------------------------------------|
| Input      | lm                                                        |
| Synonym    |                                                           |
|------------|-----------------------------------------------------------|
| Type       | Settable with the pdpr, pdset, or pdmod commands.         |
|------------|-----------------------------------------------------------|
| Usage      |                                                           |
|------------|-----------------------------------------------------------|
| Explanation| Specifies the distance between the left edge of the       |
|            | logical page and the left edge of the text area when      |
|            | held in the reading orientation.  The values are in units |
|            | of characters.                                            |
|------------|-----------------------------------------------------------|
| Value Type | Single value.                                             |
|------------|-----------------------------------------------------------|
| Values     | An integer from 1 to 2147483647.                          |
|------------|-----------------------------------------------------------|
| Default    | No default.                                               |
|------------|-----------------------------------------------------------|
| Usage      |                                                           |
| Guidelines |                                                           |
|------------|-----------------------------------------------------------|
|------------|-----------------------------------------------------------|
| Attribute  | Description                                               |
|------------|-----------------------------------------------------------|
| Name       | number-up                                                 |
|------------|-----------------------------------------------------------|
| Type       | Settable with the pdpr, pdset, or pdmod commands.         |
|------------|-----------------------------------------------------------|
| Usage      | Values vary by printer model.                             |
|------------|-----------------------------------------------------------|
| Explanation| Specifies the number of source page-images to impose upon |
|            | a single instance of a selected medium, that is, the      |
|            | number of source pages to appear on a single printed page.|
|            |                                                           |
|            | The possible values are:                                  |
|            |                                                           |
|            |    0   Suppress any number-up operation or embellishment. |
|            |    1   1 source page per physical page.                   |
|            |    2   2 source pages per physical page.                  |
|            |    4   4 source pages per physical page.                  |
|------------|-----------------------------------------------------------|
| Value Type | Single value.                                             |
|------------|-----------------------------------------------------------|
| Values     | One of the following fixed values:                        |
|            |                                                           |
|            | 0                                                         |
|            | 1                                                         |
|            | 2                                                         |
|            | 4                                                         |
|------------|-----------------------------------------------------------|
| Default    | No default.                                               |
|------------|-----------------------------------------------------------|
| Usage      |                                                           |
| Guidelines |                                                           |
|------------|-----------------------------------------------------------|
|------------|-----------------------------------------------------------|
| Attribute  | Description                                               |
|------------|-----------------------------------------------------------|
| Name       | object-class                                              |
|------------|-----------------------------------------------------------|
| Type       | Non Settable                                              |
|------------|-----------------------------------------------------------|
| Usage      |                                                           |
|------------|-----------------------------------------------------------|
| Explanation| Identifies the object class to which this object belongs. |
|------------|-----------------------------------------------------------|
| Value Type | Single value.                                             |
|------------|-----------------------------------------------------------|
| Values     | The value of this attribute is document.                  |
|------------|-----------------------------------------------------------|
| Default    | document                                                  |
|------------|-----------------------------------------------------------|
| Usage      |                                                           |
| Guidelines |                                                           |
|------------|-----------------------------------------------------------|
|------------|-----------------------------------------------------------|
| Attribute  | Description                                               |
|------------|-----------------------------------------------------------|
| Name       | octet-count                                               |
|------------|-----------------------------------------------------------|
| Type       | Non Settable                                              |
|------------|-----------------------------------------------------------|
| Usage      |                                                           |
|------------|-----------------------------------------------------------|
| Explanation| Specifies the document size in octets (bytes).  Computed  |
|            | by HPDPS when this document object is created.            |
|------------|-----------------------------------------------------------|
| Value Type | Single value.                                             |
|------------|-----------------------------------------------------------|
| Values     | An integer from 0 to 9223372036854775800.                 |
|------------|-----------------------------------------------------------|
| Default    | N/A                                                       |
|------------|-----------------------------------------------------------|
| Usage      | o   Used to compute total octet count for a job and to    |
| Guidelines |     provide information about this document.              |
|------------|-----------------------------------------------------------|
|------------|-----------------------------------------------------------|
| Attribute  | Description                                               |
|------------|-----------------------------------------------------------|
| Name       | page-select                                               |
|------------|-----------------------------------------------------------|
| Type       | Settable with the pdpr, pdset, or pdmod commands.         |
|------------|-----------------------------------------------------------|
| Usage      | Support for this attribute varies by printer model.  The  |
|            | value syntax also varies by printer model.                |
|------------|-----------------------------------------------------------|
| Explanation| Specifies the range of pages to be printed.               |
|------------|-----------------------------------------------------------|
| Value Type | Multiple values, however, only the first value is         |
|            | currently used.                                           |
|------------|-----------------------------------------------------------|
| Values     | This is a complex attribute which has the following       |
|            | components:                                               |
|            |                                                           |
|            | 1.  beginning-page (an integer page number)               |
|            | 2.  ending-page    (an integer page number)               |
|------------|-----------------------------------------------------------|
| Syntax     | -x "page-select=beginning-page:ending-page"               |
|            |                                                           |
|            | For example: -x "page-select=10:30" prints only pages     |
|            | 10 through 30.                                            |
|------------|-----------------------------------------------------------|
| Default    | No default.                                               |
|------------|-----------------------------------------------------------|
| Usage      | o   The document is validated against the printer         |
| Guidelines |     attribute page-select-supported.                      |
|            | o   Only a numeric value is supported for this attribute. |
|            | o   Only one page range may be specified.                 |
|------------|-----------------------------------------------------------|
| Component  | Description                                               |
|------------|-----------------------------------------------------------|
| beginning- | An integer from 1 to 2147483647.                          |
| page       |                                                           |
|------------|-----------------------------------------------------------|
| ending-    | An integer from 1 to 2147483647.                          |
| page       |                                                           |
|------------|-----------------------------------------------------------|
|------------|-----------------------------------------------------------|
| Attribute  | Description                                               |
|------------|-----------------------------------------------------------|
| Name       | plex                                                      |
|------------|-----------------------------------------------------------|
| Type       | Settable with the pdpr, pdset, or pdmod commands.         |
|------------|-----------------------------------------------------------|
| Usage      | Values vary by printer model.                             |
|------------|-----------------------------------------------------------|
| Explanation| Indicates whether the page images of this document are    |
|            | conditioned for one-sided or two-sided printing and the   |
|            | relative orientation of consecutive pages.                |
|------------|-----------------------------------------------------------|
| Value Type | Single value.                                             |
|------------|-----------------------------------------------------------|
| Values     | One of the following fixed values:                        |
|            |                                                           |
|            | simplex    (single sided)                                 |
|            | duplex     (double sided)                                 |
|            | tumble     (double sided, every other page upside-down)   |
|------------|-----------------------------------------------------------|
| Default    | simplex                                                   |
|------------|-----------------------------------------------------------|
| Usage      | o   This document is validated and scheduled against the  |
| Guidelines |     printer attribute plexes-supported.                   |
|            | o   HPDPS defaults "sides=2" when plex=duplex.  HPDPS does|
|            |     not currently perform any other conditioning when     |
|            |     plex=duplex.                                          |
|------------|-----------------------------------------------------------|
|------------|-----------------------------------------------------------|
| Attribute  | Description                                               |
|------------|-----------------------------------------------------------|
| Name       | printer-pass-through                                      |
|------------|-----------------------------------------------------------|
| Type       | Settable with the pdpr, pdset, or pdmod commands.         |
|------------|-----------------------------------------------------------|
| Usage      |                                                           |
|------------|-----------------------------------------------------------|
| Explanation| Allows specific printer information to be submitted along |
|            | with the document.                                        |
|------------|-----------------------------------------------------------|
| Value Type | Single value.                                             |
|------------|-----------------------------------------------------------|
| Values     | A text string up to 4095 characters that contains options |
|            | passed directly to the interface program.                 |
|------------|-----------------------------------------------------------|
| Default    | No default.                                               |
|------------|-----------------------------------------------------------|
| Usage      | o   The value of this attribute is passed as the 4th      |
| Guidelines |     argument of the printer interface program.            |
|------------|-----------------------------------------------------------|
|------------|-----------------------------------------------------------|
| Attribute  | Description                                               |
|------------|-----------------------------------------------------------|
| Name       | right-margin                                              |
|------------|-----------------------------------------------------------|
| Type       | Settable with the pdpr, pdset, or pdmod commands.         |
|------------|-----------------------------------------------------------|
| Usage      |                                                           |
|------------|-----------------------------------------------------------|
| Explanation| Specifies the distance between the right edge of the      |
|            | logical page and the right edge of the text area when     |
|            | held in the reading orientation.  The values are in units |
|            | of characters.                                            |
|------------|-----------------------------------------------------------|
| Value Type | Single value.                                             |
|------------|-----------------------------------------------------------|
| Values     | An integer from 1 to 2147483647.                          |
|------------|-----------------------------------------------------------|
| Default    | No default.                                               |
|------------|-----------------------------------------------------------|
| Usage      |                                                           |
| Guidelines |                                                           |
|------------|-----------------------------------------------------------|
|------------|-----------------------------------------------------------|
| Attribute  | Description                                               |
|------------|-----------------------------------------------------------|
| Name       | sides                                                     |
|------------|-----------------------------------------------------------|
| Type       | Settable with the pdpr, pdset, or pdmod commands.         |
|------------|-----------------------------------------------------------|
| Usage      |                                                           |
|------------|-----------------------------------------------------------|
| Explanation| Specifies the number of media sides on which the document |
|            | is to be printed.                                         |
|------------|-----------------------------------------------------------|
| Value Type | Single value.                                             |
|------------|-----------------------------------------------------------|
| Values     | An integer of 1 or 2.                                     |
|------------|-----------------------------------------------------------|
| Default    | 1                                                         |
|------------|-----------------------------------------------------------|
| Usage      | o   This document is validated and scheduled against the  |
| Guidelines |     printer attribute sides-supported.                    |
|------------|-----------------------------------------------------------|
|------------|-----------------------------------------------------------|
| Attribute  | Description                                               |
|------------|-----------------------------------------------------------|
| Name       | top-margin                                                |
|------------|-----------------------------------------------------------|
| Input      | tm                                                        |
| Synomym    |                                                           |
|------------|-----------------------------------------------------------|
| Type       | Settable with the pdpr, pdset, or pdmod commands.         |
|------------|-----------------------------------------------------------|
| Usage      |                                                           |
|------------|-----------------------------------------------------------|
| Explanation| Specifies the distance between the bottom edge of the     |
|            | logical page and the bottom edge of the text area when    |
|            | held in the reading orientation.  The values are in units |
|            | of characters.                                            |
|------------|-----------------------------------------------------------|
| Value Type | Single value.                                             |
|------------|-----------------------------------------------------------|
| Values     | An integer from 1 to 2147483647.                          |
|------------|-----------------------------------------------------------|
| Default    | No default.                                               |
|------------|-----------------------------------------------------------|
| Usage      |                                                           |
| Guidelines |                                                           |
|------------|-----------------------------------------------------------|
|------------|-----------------------------------------------------------|
| Attribute  | Description                                               |
|------------|-----------------------------------------------------------|
| Name       | transfer-method                                           |
|------------|-----------------------------------------------------------|
| Type       | Specifiable with the pdpr command.                        |
|------------|-----------------------------------------------------------|
| Usage      |                                                           |
|------------|-----------------------------------------------------------|
| Explanation| Identifies the method by which the document is            |
|            | transferred to, or acquired by, the print server.         |
|------------|-----------------------------------------------------------|
| Value Type | Single value.                                             |
|------------|-----------------------------------------------------------|
| Values     | One of the following fixed values:                        |
|            |                                                           |
|            | dce-pipe-pull                                             |
|            | with-request                                              |
|------------|-----------------------------------------------------------|
| Default    | dce-pipe-pull                                             |
|------------|-----------------------------------------------------------|
| Usage      | o   This document is validated and scheduled against the  |
| Guidelines |     supervisor attribute transfer-methods-supported.      |
|------------|-----------------------------------------------------------|
.lg
.\"
.\" toc@\f3pd_att_document(5)\f1@@@list of attributes for a document object (HP Distributed Print Service)
.\"
.\" index@\f1pd_att_document \- list of attributes for a document object (HP Distributed Print Service)@@@\f3pd_att_document(5)\f1
.\"
