HP Output Server 3.

5 System Administrators Attribute Reference

Part No. T2358-90021

 1991-2005 Hewlett-Packard Development Company, L.P. Reproduction, adaptation or translation without prior written permission is prohibited, except as allowed under the copyright laws. Refer to the license.txt file shipped with the software for comprehensive third-party copyright information. December 2005 Edition for HP Output Server Confidential computer software. Valid license from HP required for possession, use or copying. Consistent with FAR 12.211 and 12.212, Commercial Computer Software, Computer Software Documentation, and Technical Data for Commercial Items are licensed to the U.S. Government under vendors standard commercial license. The information contained herein is subject to change without notice. The only warranties for HP products and services are set forth in the express warranty statements accompanying such products and services. Nothing herein should be construed as constituting an additional warranty. HP shall not be liable for technical or editorial errors or omissions contained within. Software Warranty. The specific warranty terms applicable to your Hewlett-Packard software can be found in your software license. Restricted Rights Legend. All rights are reserved. No part of this document may be photocopied, reproduced, or translated to another language without the prior written consent of Hewlett-Packard Company. The information contained in this document is subject to change without notice. Use, duplication or disclosure by the U.S. Government is subject to restrictions as set forth in subparagraph (c) (1) (ii) of the Rights in Technical Data and Computer Software clause at DFARS 252.227-7013 for DOD agencies, and subparagraphs (c) (1) and (c) (2) of the Commercial Computer Software Restricted Rights clause at FAR 52.227-19 for other agencies. Use of this manual and flexible disk(s), tape cartridge(s), or CD-ROM(s) supplied for this pack is restricted to this product only. Additional copies of the programs may be made for security and back-up purposes only. Resale of the programs in their present form or with alterations, is expressly prohibited. Software Copyright Notices Copyright 1991-2004 Hewlett-Packard Development Company, L.P. Portions Copyrighted By Copyright 2000-2005 MySQL AB & MySQL Finland AB & TCX DataKonsult AB. Copyright 2000 Carnegie Mellon University. Copyright 1987-2003 Larry Wall. Perl is distributed without warranty or the implied warranty of merchantability or fitness for a particular purpose. See either the GNU General Public License or the Artistic License for more details. For the copyright notice and full text of the General Public License, contact Customer Support.

Copyright 1990 Massachusetts Institute of Technology. Permission to use, copy, modify, and distribute M.I.T. software and its documentation for any purpose and without fee is hereby granted, provided that the above copyright notice and this permission appear in all copies and that both that copyright notice and this permission notice appear in supporting documentation, and that the name of M.I.T. not be used in supporting advertising or publicity pertaining to the distribution of the software without specific written prior permission. M.I.T. makes no representations about the suitability of this software for any purpose. It is provided as is without express or implied warranty. Copyright 2001-2002 Robin Berjon. Copyright 1998-2000 Larry Wall and Clark Cooper. Copyright 2001 Matt Sergeant. Copyright 1999-2003 Grant McLean. Copyright 1999 Megginson Technologies. Copyright 2000 AxKit.com. Copyright 1990, 1991, 1992, 1993 Michael Sample and the University of British Columbia. Copyright 1994, 1995 Robert Joop and GMD FOKUS. Copyright 1999, 2000, 2001, 2002, 2003 Free Software Foundation, Inc. Copyright 1993 - 2005 SAP AG, Walldorf. Trademark Notices Adobe, Acrobat, Acrobat Logo, and PostScript are trademarks of Adobe Systems Incorporated. Microsoft and Windows are U.S. registered trademarks of Microsoft Corporation. UNIX is a registered trademark of the Open Group. Hewlett-Packard Limited Warranty Statement HP Product HPOM Software Period of Limited Warranty 90 Days A. Extent of Limited Warranty 1. Hewlett-Packard ("HP") warrants to the customer ("Customer") that the HP software product specified above ("Product") shall execute its programming instructions for the period specified above. The warranty period begins on the date of purchase by Customer. 2. HP does not warrant that the operation of the Product shall be uninterrupted or error free. 3. HP's limited warranty covers only those defects which arise as a result of normal use of the Product, and does not cover any other problems, including those which arise as a result of: a. Improper use, maintenance, or modification; b. Software, media, accessories, or supplies not provided or supported by HP; c. Operation outside a Product's specifications; or, d. Improper site preparation or maintenance.

4. If HP receives, during the applicable warranty period, notice of a defect in any Product, HP shall at its option either fix or replace the defective Product. 5. If HP cannot fix or replace the defective Product that is covered by HP's limited warranty, HP shall, within a reasonable time after being notified of the defect, refund the purchase price for the Product. 6. HP shall have no obligation to issue a refund until Customer returns the defective Product to HP. 7. HP's limited warranty for the Product is valid in any country or locality where HP has a support presence for the Product and has marketed the Product. The level of warranty service may vary according to local standards. HP shall not alter form, fit or function of the Product to make it operate in a country or region for which it was never intended to function for legal or regulatory reasons. B. Limitations of Warranty 1. TO THE EXTENT ALLOWED BY LOCAL LAW, NEITHER HP NOR ITS THIRD PARTY SUPPLIERS MAKE ANY OTHER WARRANTY OR CONDITION OF ANY KIND, WHETHER EXPRESS OR IMPLIED, WITH RESPECT TO THE PRODUCT, AND SPECIFICALLY DISCLAIM THE IMPLIED WARRANTIES OR CONDITIONS OF MERCHANTABILITY, SATISFACTORY QUALITY, AND FITNESS FOR A PARTICULAR PURPOSE. C. Limitations of Liability 1. To the extent allowed by local law, the remedies provided in this Limited Warranty Statement ("LWS") are Customer's sole and exclusive remedies. 2. TO THE EXTENT ALLOWED BY LOCAL LAW, EXCEPT FOR THE OBLIGATIONS SET FORTH IN THIS LWS, IN NO EVENT SHALL HP OR ITS THIRD PARTY SUPPLIERS BE LIABLE FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, WHETHER BASED ON CONTRACT, TORT, OR ANY OTHER LEGAL THEORY AND WHETHER ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. D. Local Law 1. This LWS gives Customer specific legal rights. Customer may also have other rights that vary from state to state in the United States, from province to province in Canada, and from country to country elsewhere in the world. 2. To the extent this LWS is inconsistent with local law, this LWS shall be deemed modified to be consistent with local law. Under local law, certain disclaimers and limitations of this LWS may not apply to Customer. For example, the federal government of the United States, some states in the United States, and some governments outside the United States (including provinces in Canada) may: a. Grant Customer additional warranty rights; b. Preclude the disclaimers and limitations in this LWS from limiting the statutory rights of a consumer (e.g. the United Kingdom); c. Otherwise restrict the ability of a manufacturer to enforce such disclaimers or limitations; d. Specify the duration of implied warranties that the manufacturer cannot disclaim; or, e. Disallow limitations on the duration of implied warranties. 3. For consumer transactions in the United States, any implied warranties imposed by law are limited in duration to the express warranty period.

4. FOR CONSUMER TRANSACTIONS IN AUSTRALIA AND NEW ZEALAND, THE TERMS IN THIS LWS, EXCEPT TO THE EXTENT LAWFULLY PERMITTED, DO NOT EXCLUDE, RESTRICT, OR MODIFY, AND ARE IN ADDITION TO, THE MANDATORY STATUTORY RIGHTS APPLICABLE TO THE SALE OF A PRODUCT TO SUCH CUSTOMERS. Printed in the U.S.A.

Contents
Preface ..............................................................................xxix
Related documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxix Typographic conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxxi Training . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxxii Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxxii Before you call . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxxiv

Introduction .....................................................................1
Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2 Object classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3 Data types. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

Attribute reference information. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

HP Output Server

vii

Contents

Attribute syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4 Setting attributes with the -x switch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 Setting attributes with the -o switch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 Setting attributes with both switches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 Setting multi-valued attributes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 Requesting attribute values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 Abbreviating attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 Attribute order . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 Attribute precedence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15 Using attribute variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

viii

System Administrators Attribute Reference

Contents

Attributes .......................................................................23
-accounting-profile. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23 -afp-device . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27 -agent-termination-signal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27 -bits-per-pixel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28 -bits-per-pixel-default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28 -bits-per-pixel-supported . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28 -black-correction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29 -black-correction-default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29 -black-corrections-supported . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29 -bottom-margin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31 -bottom-margin-default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31 -brief-specification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31 -building . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31 -cancel-arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32 -cancel-program . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32 -capabilities-name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32 -capabilities-supported . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33 -capabilities-ticket . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33 -character-set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34 -character-sets-used . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34 -character-set-default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34 -character-sets-supported . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34 -city . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35 -class. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35 -cleanup-checkjob-interval. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35 -cleanup-checkjob-period-limit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36 -cleanup-interval . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37 -completion-time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37 -connection-lifetime . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37 -content-orientation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38 -orientation-default. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38 -orientations-supported . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38 -copy-count . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38 -copy-from . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39

HP Output Server

ix

Contents

-cp-max-proxies. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -cp-max-slaves. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -cp-port-number. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -current-job-state . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -database-client-max-connections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -database-server-hostname . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -database-server-password. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -database-server-port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -database-server-socket . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -database-server-user . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -dazel-guest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -deliver-arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -deliver-document-arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -deliver-program . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -depletion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -depletion-default. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -depletions-supported . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -descriptor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -destination . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -destination-type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -device-state. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -disabled. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -document-descriptor. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -document-filename. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -document-format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -document-format-content-type. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -document-format-printer-language . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -document-sequence-number. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -document-type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -dump. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -encoding-method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -encoding-method-default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -encoding-methods-supported . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -end-sheet. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -end-sheet-default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -end-sheets-supported . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

39 39 40 40 41 42 43 44 45 46 47 47 47 48 48 48 48 49 49 50 50 50 51 51 51 51 52 53 54 54 54 54 54 55 55 55

System Administrators Attribute Reference

Contents

-end-sheet-type-format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56 -end-sheet-type-format-variants . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56 -end-sheet-type-format-version . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57 -end-sheet-type-path. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57 -event-client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58 -event-date . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58 -event-identifier . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58 -event-message. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58 -event-server. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58 -event-time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58 -extended-features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59 -extended-features-default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59 -failed-job-retention-period . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59 -failed-job-retention-period-default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59 -fax-class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60 -fax-class-default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60 -fax-classes-supported . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60 -fax-comments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61 -fax-copy-count . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61 -fax-footer-text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61 -fax-footer-text-default. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61 -fax-from-extension . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63 -fax-from-person . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63 -fax-header-footer-character-set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63 -fax-header-footer-font. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64 -fax-header-footer-font-size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64 -fax-header-text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64 -fax-header-text-default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64 -fax-no-page-count. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66 -fax-no-page-count-default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66 -fax-page-number. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66 -fax-phone-number. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66 -fax-phone-number-default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66 -fax-phone-numbers-supported . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66 -fax-phone-number-long-distance-prefix. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68 -fax-phone-number-prefix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68

HP Output Server

xi

Contents

-fax-phone-number-suffix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -fax-serialize-conversion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -fax-station-id . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -fax-subject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -fax-to-company . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -fax-to-person . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -fax-to-voice-phone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -fifo-directory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -fifo-permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -file-base-directory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -file-directory. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -file-directory-default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -file-directories-supported . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -file-directory-permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -file-filename . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -file-filename-default. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -file-filenames-supported. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -file-overwrite . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -file-overwrite-default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -file-permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -file-permissions-default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -file-permissions-mask . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -file-transfer-by-link . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -file-transfer-retry-count . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -file-transfer-retry-count-default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -file-transfer-retry-interval. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -file-transfer-retry-interval-default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -floor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -fold . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -fold-default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -fold-supported . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -font-directories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -footer-text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -footer-text-default. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -force . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -form-description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

69 69 70 70 70 71 71 71 72 72 72 72 72 73 73 73 73 74 74 74 74 75 76 76 76 76 76 77 77 77 77 78 79 79 80 81

xii

System Administrators Attribute Reference

Contents

-form-feed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81 -form-feed-default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81 -form-file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82 -form-name. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82 -form-path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82 -form-type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83 -form-x-scaling. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83 -form-y-scaling. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83 -form-x-translation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84 -form-y-translation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84 -forms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84 -ftp-account . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85 -ftp-account-default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85 -ftp-accounts-supported . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85 -ftp-directory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85 -ftp-directory-default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85 -ftp-directories-supported. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85 -ftp-filename. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86 -ftp-filename-default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86 -ftp-filenames-supported . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86 -ftp-host . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87 -ftp-host-default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87 -ftp-hosts-supported . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87 -ftp-operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87 -ftp-operation-default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87 -ftp-operations-supported. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87 -ftp-password . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88 -ftp-password-default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88 -ftp-quote-cmd-post . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88 -ftp-quote-cmd-post-default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88 -ftp-quote-cmd-pre . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89 -ftp-quote-cmd-pre-default. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89 -ftp-reply-timeout. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90 -ftp-reply-timeout-default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90 -ftp-type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90 -ftp-type-default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90

HP Output Server

xiii

Contents

-ftp-types-supported. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90 -ftp-user . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91 -ftp-user-default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91 -ftp-users-supported. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91 -ghostscript-device. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91 -ghostscript-options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93 -ghostscript-options-default. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93 -ghostscript-program . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94 -group-by-attribute. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95 -header-footer-character-set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95 -header-footer-font. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96 -header-footer-font-size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96 -header-text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96 -header-text-default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96 -imposition. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98 -impositions-default. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98 -impositions-supported . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98 -incomplete-job-timeout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98 -indent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99 -input-content-type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99 -input-content-type-default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99 -input-content-types-supported . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99 -input-document-format. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100 -input-document-format-default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100 -input-document-formats-supported . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100 -input-document-format-variants. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101 -input-document-format-variants-defaults. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101 -input-document-format-variants-supported . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101 -input-document-format-version . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102 -input-tray-select . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103 -input-trays-used . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103 -input-tray-default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103 -input-trays-supported . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103 -input-trays-medium . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104 -input-trays-xlate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105 -intervening-jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106

xiv

System Administrators Attribute Reference

Contents

-intervening-octets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106 -jes-formdef . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106 -jes-formdef-default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106 -jes-pagedef . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107 -jes-pagedef-default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107 -job-class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108 -job-class-default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108 -job-client-id. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108 -job-comment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108 -job-completion-status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109 -job-deadline-period. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109 -job-deadline-time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110 -job-event-attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110 -job-event-class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111 -job-finishing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112 -job-finishings-default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112 -job-finishings-supported . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112 -job-hold. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113 -job-hold-default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113 -job-hold-jobname . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113 -job-hold-jobname-default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113 -job-hold-key . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114 -job-hold-key-required . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115 -job-hold-key-required-default. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115 -job-hold-mailbox . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115 -job-hold-mailbox-default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115 -job-hold-mode. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116 -job-hold-mode-default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116 -job-hold-modes-supported . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116 -job-hold-username . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117 -job-hold-username-default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117 -job-identifier . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118 -job-identifier-on-printer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118 -job-message-from-administrator. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119 -job-message-to-operator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119 -job-name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119

HP Output Server

xv

Contents

-job-order . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -job-order-preserved . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -job-originator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -job-owner . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -job-page-count . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -job-print-after . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -job-priority . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -job-priority-default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -job-punch-count . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -punch-count-default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -punch-counts-supported . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -job-punch-location . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -punch-location-default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -punch-locations-supported . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -job-punch-type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -punch-type-default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -punch-types-supported . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -job-retention-period . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -retention-period-default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -job-retention-period-limit. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -job-retention-time. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -job-staple-count . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -staple-count-default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -staple-counts-supported . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -job-staple-location . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -staple-location-default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -staple-locations-supported . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -job-staple-type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -staple-type-default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -staple-types-supported . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -job-state-on-printer. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -job-submission-complete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -job-validate. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -last-job-events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -left-margin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -left-margin-default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

119 120 121 121 121 122 122 122 123 123 123 123 123 123 125 125 125 125 125 126 127 127 127 127 128 128 128 129 129 129 130 130 131 131 131 131

xvi

System Administrators Attribute Reference

Contents

-length . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132 -length-default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132 -list-of-managers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132 -logical-page-border. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132 -logical-page-origin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133 -logical-page-scaling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134 -logical-page-x-offset. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134 -logical-page-y-offset. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134 -logical-printers-assigned. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134 -lpd-file-format. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135 -lpd-file-format-default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135 -lpd-host . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136 -lpd-host-default. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136 -lpd-hosts-supported. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136 -lpd-non-root-connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136 -lpd-printer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137 -lpd-printer-default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137 -lpd-printers-supported. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137 -lpd-timeout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137 -lpd-timeout-default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137 -lpg-job-owner-all-jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138 -lpg-masterlock . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138 -lpg-options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139 -lpg-printcap. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139 -mail-message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140 -mail-message-default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140 -mail-program . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140 -mail-protocol. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141 -mail-protocol-default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141 -mail-protocols-supported . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141 -mail-recipient . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141 -mail-recipient-default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141 -mail-recipients-supported . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141 -mail-recipient-bcc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142 -mail-recipient-bcc-default. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142 -mail-recipients-bcc-supported . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142

HP Output Server

xvii

Contents

-mail-recipient-cc. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -mail-recipient-cc-default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -mail-recipients-cc-supported . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -mail-reply-to. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -mail-return . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -mail-return-default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -mail-return-reply-type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -mail-return-reply-type-default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -mail-sender . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -mail-sender-default. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -mail-set-dsn . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -mail-set-dsn-default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -mail-subject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -mail-subject-default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -managing-server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -maximum-tries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -maximum-tries-default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -medium-select . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -media-used . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -medium-default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -media-supported . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -minimum-retry-interval . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -minimum-retry-interval-default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -modem-force-long-distance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -modem-initialization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -modem-international-prefix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -modem-international-prefix-default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -modem-international-suffix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -modem-international-suffix-default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -modem-local-area-code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -modem-local-call-area-codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -modem-local-country-code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -modem-long-distance-prefix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -modem-long-distance-prefix-default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -modem-long-distance-suffix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

143 143 143 143 143 143 144 144 144 144 145 145 146 146 146 147 147 147 147 147 147 150 150 150 151 151 151 151 152 152 152 152 153 153 153 154

xviii

System Administrators Attribute Reference

Contents

-modem-long-distance-suffix-default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154 -modem-pbx-outside-prefix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154 -modem-pbx-outside-suffix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155 -modem-phone-number . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155 -modem-phone-number-default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155 -modem-phone-numbers-supported . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155 -modem-prefix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156 -modem-prefix-default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156 -modem-rings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157 -modem-suffix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157 -modem-suffix-default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157 -modification-time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158 -name-of-last-accessor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158 -network-probe-address . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158 -network-probe-ending-address . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159 -network-probe-retries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159 -network-probe-snmp-query . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159 -network-probe-snmp-response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160 -network-probe-starting-address . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160 -network-probe-timeout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161 -next-document-timeout. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161 -nm-dazel-data-file. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161 -notification-profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161 -notification-profile-default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161 -number-of-documents. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163 -number-of-times-tried. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163 -number-up. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163 -number-up-border . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164 -number-up-keep-scale. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164 -number-up-keep-scale-default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164 -object-log-buffer-type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165 -object-log-message-limit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165 -object-log-messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165 -object-log-severity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166 -object-log-strategy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166 -object-log-threshold . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166

HP Output Server

xix

Contents

-octet-count . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -operator-notification-profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -order-by-attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -organization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -orientation-default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -orientations-supported . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -original-template-list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -output-bin-name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -output-bin-name-default. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -output-bin-names-supported. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -output-bin-number . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -output-bin-number-supported. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -output-bin-xlate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -output-content-type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -output-content-type-default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -output-content-types-supported . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -output-document-format. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -output-document-format-default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -output-document-formats-supported . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -output-document-format-variants. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -output-document-format-variants-supported . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -output-document-format-version . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -page-count . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -page-number. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -page-select . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -page-size. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -page-sizes-supported . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -pager-id-number . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -pager-id-number-default. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -pager-id-numbers-supported . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -pager-id-type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -pager-id-type-default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -pager-id-types-supported . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -pager-message-length-limit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -pager-message-number-limit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

167 167 169 169 170 170 170 171 171 171 171 172 172 172 173 173 173 174 174 174 175 175 176 176 176 177 177 177 178 178 178 179 179 179 179 180

xx

System Administrators Attribute Reference

Contents

-pager-phone-number . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180 -pager-phone-number-default. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180 -pager-phone-numbers-supported . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180 -pager-protocol . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181 -pager-protocol-default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181 -pager-protocols-supported . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181 -pager-system-name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181 -pager-system-name-default. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181 -pager-system-names-supported . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181 -pages-completed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182 -paging-system-baud . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182 -paging-system-name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183 -paging-system-phone-number . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183 -paging-system-protocol . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183 -paging-systems-supported . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184 -paused . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184 -pcl-echo-support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184 -pcl-input-trays-xlate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184 -pcl-level . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185 -pcl-output-bin-xlate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185 -pdf-color-output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186 -pdf-color-output-default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186 -physical-device-type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186 -physical-printer-assigned . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187 -physical-printers-registered . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187 -pjl-capabilities. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188 -pjl-exclusions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189 -plex . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189 -plex-default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189 -plexes-supported . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189 -pm-id-mode. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190 -poll-arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191 -poll-interval. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192 -poll-period. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192 -poll-program . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192 -previous-job-state . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192

HP Output Server

xxi

Contents

-printer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -printer-auto-pause-timeout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -printer-connection-mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -printer-device-address . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -printer-line-setting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -printer-message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -printer-model . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -printer-name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -printer-name-requested. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -printer-ping-data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -printer-ping-interval . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -printer-read-timeout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -printer-realization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -printer-resolutions-requested . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -printer-resolution-default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -printer-resolutions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -printer-resume-delivery-time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -printer-serialize-conversion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -printer-serialize-conversion-default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -printer-state. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -printer-task-maximum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -printer-task-ratio . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -printer-x-resolutions-requested . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -printer-x-resolutions-default. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -printer-x-resolutions-supported . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -printer-y-resolutions-requested . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -printer-y-resolutions-default. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -printer-y-resolutions-supported . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -processing-time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -processing-time-warned . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -ps-init-directories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -ps-input-trays-xlate. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -ps-output-bin-xlate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -ps-printer-echoes-eof . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -ps-printer-suppress-eof . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -ps-prologue-file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

193 193 193 194 194 194 195 195 196 196 196 197 198 198 198 198 199 199 199 200 200 200 201 201 201 201 201 201 202 202 203 203 203 204 204 205

xxii

System Administrators Attribute Reference

Contents

-punch-count-default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205 -punch-counts-supported . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205 -punch-location-default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205 -punch-locations-supported . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205 -punch-type-default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205 -punch-types-supported . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205 -qms-ftp-account . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205 -qms-ftp-host . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206 -qms-ftp-password . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206 -qms-ftp-user . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206 -qms-status-monitor-delay . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207 -qms-status-read-timeout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207 -queue-assigned . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207 -queue-disable-threshold . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208 -queue-name. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208 -queue-supported . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208 -queue-task-maximum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209 -queue-task-ratio . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209 -queue-warning-threshold . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210 -remote-device-identifier . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210 -requested-attributes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210 -reserve-by-attribute. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211 -resource-name. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212 -retention-period-default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212 -retry-count. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212 -retry-interval . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212 -right-margin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213 -right-margin-default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213 -scheduler-assigned . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213 -scheduling-algorithms-supported . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213 -separator-sheet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214 -separator-sheet-default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214 -separator-sheets-supported . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214 -separator-sheet-type-format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215 -separator-sheet-type-format-variants . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215 -separator-sheet-type-format-version . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216

HP Output Server

xxiii

Contents

-separator-sheet-type-path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -server-address . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -server-cache-size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -server-environment-variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -server-hostname . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -server-log-level. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -server-log-maximum-size. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -server-log-tz-cut . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -server-login-name. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -server-login-name-default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -server-message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -server-name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -server-start-enabled . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -server-start-order . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -server-startup-limit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -server-startup-completion-time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -server-startup-time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -server-type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -server-uses-syslog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -server-version . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -server-working-directory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -sheet-format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -shingling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -shingling-default. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -shinglings-supported . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -sides . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -sides-default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -sides-supported. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -spooler-job-processing-time-warning-time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -staple-count-default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -staple-counts-supported . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -staple-location-default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -staple-locations-supported . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -staple-type-default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -staple-types-supported . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -start-sheet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

216 217 217 218 218 219 219 220 220 220 221 221 221 222 222 223 224 224 224 225 225 225 226 226 226 227 227 228 228 228 228 228 228 229 229 229

xxiv

System Administrators Attribute Reference

Contents

-start-sheet-default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229 -start-sheets-supported . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229 -start-sheet-type-format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229 -start-sheet-type-format-variants . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230 -start-sheet-type-format-version. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231 -start-sheet-type-path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231 -started-printing-time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232 -state . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232 -submission-time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232 -supervisor-ping-interval . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233 -supervisor-retry-interval . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233 -synchronicity. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234 -synchronicity-default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234 -system-job-message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235 -system-job-message-buffer-limit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235 -system-job-message-buffer-limit-default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235 -system-job-message-buffer-type. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236 -system-job-message-buffer-type-default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236 -system-job-message-strategy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236 -system-job-message-strategy-default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236 -tcp-data-port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237 -tcp-host . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238 -tcp-status-port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238 -template. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238 -template-classification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239 -template-component . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239 -template-device-name. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240 -template-site . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240 -template-type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240 -text-conversion-font . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241 -text-conversion-font-default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241 -text-conversion-font-size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241 -text-conversion-font-size-default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241 -text-conversion-line-size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242 -text-conversion-line-size-default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242 -text-conversion-real-font-size. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242

HP Output Server

xxv

Contents

-text-conversion-real-font-size-default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -text-conversion-real-line-size. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -text-conversion-real-line-size-default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -top-margin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -top-margin-default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -total-job-octets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -track-dazel-guest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -transfer-method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -transfer-methods-supported . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -transformer-input-format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -transformer-name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -transformer-output-format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -transformer-priority . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -transformer-productions-excluded . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -transformer-productions-included . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -transformer-productions-supported . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -transformer-program . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -transformer-program-arguments. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -transformer-program-description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -transformers-supported. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -udp-port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -use-pjl-filter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -use-pjl-filter-default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -use-pjl-filters-supported . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -use-ps-filter. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -use-ps-filter-default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -use-selective-pjl-filter. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -use-selective-pjl-filter-default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -use-server-features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -use-text-filter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -use-text-filter-default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -user-exit-predoc-arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -user-exit-predoc-program . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -user-exit-prejob-arguments. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -user-exit-prejob-program . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -user-filter-arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

242 242 242 243 243 244 244 244 244 245 246 246 246 246 247 247 248 248 248 248 249 249 249 249 250 250 251 251 253 254 254 254 255 255 256 256

xxvi

System Administrators Attribute Reference

Contents

-user-filter-output-format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256 -user-filter-output-format-variants . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256 -user-filter-output-format-version . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256 -user-filter-program . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256 -user-filter-force-attr-mods. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257 -uses-stdattr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258 -verbose-specification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258 -when . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259 -width . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259 -width-default. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259 -write-only-device . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259 -x-image-shift. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260 -x-image-shift-default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260 -y-image-shift. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260 -y-image-shift-default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260

Attributes by Object Class .........................................263

Capabilities class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264 Destination class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264 Logical destinations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264 Physical destinations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267 Form class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 272 Job class. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 272 Job attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 272 Document attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 274 Paging system class. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 276 Queue class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 276 Server class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 277

Index ...................................................................................281

HP Output Server

xxvii

Contents

xxviii

System Administrators Attribute Reference

Preface
This manual provides information about the attributes you can use to manage HP Output Server with the HP Output Server command line interface (CLI). This manual is intended for HP Output Server system administrators and assumes the following: You have a working knowledge of the UNIX operating system, Windows operating system, or both, depending on your computing environment. You have installed HP Output Server and configured the minimum servers required for job delivery.

As an HP Output Server system administrator, you can centrally monitor and control HP Output Server with two tools: The HP Output Server command line interface (CLI), which is a comprehensive set of commands to manipulate and manage components of HP Output Server HP Output Explorer, a suite of graphical user interface (GUI) tools to manage components of HP Output Server

This manual explains how to perform administrative tasks with the HP Output Server CLI attributes. See the HP Output Explorer online help for information about the HP Output Explorer GUI tools.

Related documentation
The HP Output Server documentation library includes: The Installation and Configuration Guide describes system requirements and planning and explains how to install and configure HP Output Server.

HP Output Server

xxix

Preface
Related documentation

The System Administrators Guide explains how to perform administrative tasks with the HP Output Server CLI. The System Administrators Attribute Reference and System Administrators Command Reference provide information about the HP Output Server CLI commands and attributes. The Release Notes document provides important information that was not included in the manuals, including specific requirements for each supported platform and information about specific hardware and software that you may want to use with HP Output Server. Additionally, this document lists the directory structure and contents of the software and documentation CD-ROMs.

HP integrates the MySQL relational database management system from MySQL AB with HP Output Server 3.5 and HP Output Distributor 3.5. The documentation set for MySQL for HP Output Management includes: The Installation and Configuration Guide for MySQL for HP Output Management describes how to install and configure MySQL for HP Output Management. The Release Notes document lists the directory structure and contents of the MySQL for HP Output Management CD-ROM and provides important information that was not included in the manual. If you purchased a license for HP Output Manager for SAP 3.5, your HP Output Server installation includes a CD-ROM that contains documentation for configuring and using HP Output Manager for SAP. For more information, see the Release Notes for HP Output Manager for SAP 3.5. If you purchased a license for HP Output Distributor 3.5, your HP Output Server installation includes a CD-ROM that contains documentation for configuring and using HP Output Distributor and the software and documentation for installing and using HP Output Distributor Manager, a Windows-based program for configuring and maintaining HP Output Distributor. For more information, see the Release Notes for HP Output Distributor 3.5.

Depending on your configuration, your document set may include the following:

You can access the documentation in PDF format on each product CD-ROM or download it from the following Web site: http://itrc.hp.com NOTE: You must register to access this Web site. For more information about HP Output Management products, visit: http://hp.com/go/outputmanagement

xxx

System Administrators Attribute Reference

Preface
Typographic conventions

This site offers a variety of information about HP Output Management products and solutions. Included on the site are links to technical notes. Technical notes provide specific information about a particular device, configuration, or situation. For example, a technical note might explain how to configure HP Output Server to deliver to a specific HP printer.

Typographic conventions
HP product documentation follows the typographic conventions described in this table. Each convention includes an example of usage.
Convention bold Meaning Used to denote new terms and to indicate user interface elements such as menu names, command names, icon names, dialog box titles, field names, dialog box options, and button names. Used for emphasis, book titles, user input variables, and command syntax variables. Examples Each of these objects has attributes that define, control, and report its characteristics. Click the Modify button.

italic

Install the program in the installDir directory. Refer to the System Administrators Command Reference. DZL_HOME HKEY_CLASSES_ROOT pdls -c server ids_ccm: Type y to confirm the selection. Delete the example.txt document when you have completed the exercise. Select File>Save. (Instructs you to select the Save command from the File menu.)

UPPERCASE

Denotes acronyms, device names, logical operators, environment variables, and registry entries. Represents text, commands, attributes, and code examples that constitute user input or computer output. Also includes file names, file name extensions, and directory names. Shows a selection from a menu in a user interface.

monospace

>

HP Output Server

xxxi

Preface
Training

Command examples in HP documentation are operating system-independent and appear separate from the text. Hanging indentation indicates that a command line wraps: pdshutdown -c server -x"-message \"Down for maintenance\" -when after-all" jqm_01 In text, absolute and relative path and file names follow UNIX conventions: Change directories to the installDir/var/log directory.

Training
We offer training courses for most of our products. You can attend HP Output Management training in North America or EMEA. Some courses can also be taught at a customer site. For other training options or to register for classes, visit our Web site at http://www.hp.com/united-states/outputmanagement/training/

Support
To obtain assistance, offer feedback, or request enhancements, contact Customer Support on the Web or by telephone. To contact Customer Support on the Web, use the following URL: http://itrc.hp.com To contact Customer Support by telephone, use the following telephone numbers:
Country/Region or City Telephone In-country/Region Americas United States 800 633 3600 International

xxxii

System Administrators Attribute Reference

Preface
Support

Country/Region or City

Telephone In-country/Region International +32 2 620 00 55 +358 203 66 200 +33 241 74 24 65 +49 2102 90 7244 +39 (0) 2 385 91090 +31 (0) 20 547 9666 +351 213 176 350 +966 1 273 1200 +27 11 785 1010 +34 902 012 069 +46 (8) 579 29 119 +41 (0) 848 800 724 +44 1344 389 421 +61 2 9022 9218 +61 2 9022 9218

Europe/Middle East/Africa (EMEA)

Belgium Finland France Germany Italy Netherlands Portugal Saudi Arabia South Africa Spain Sweden Switzerland United Kingdom

078 250 144 0203 66 200 0825 00 41 23 01 805 332 525 02 385 91090 020 547 9666 808 203 203 800 124 1001 08 6000 1010 902 012 069 08 579 29 119 0800 55 33 13 0870 842 2330 1800 329 3588 1800 032 935

Asia Pacific

Singapore Sydney

Country/Region United States

Postal Address Hewlett-Packard Company 14231 Tandem Boulevard Austin, TX 78728 USA Hewlett-Packard Company 80, rue Camille Desmoulins 92788 Issy les Moulineaux Cedex 9 France

Europe

HP Output Server

xxxiii

Preface
Support

Country/Region Asia Pacific

Postal Address Hewlett-Packard Far East Pte. Ltd. 460 Alexandria Road, PSA Building Singapore 119963

Before you call

If you experience a problem with an HP product, you can help us diagnose and solve your problem more efficiently by collecting the following information prior to contacting Customer Support: Which product are you calling about? What is the version number? What is the service pack level?

What operating system(s) does your environment use? Are you running any clients, such as HP Output Envoy or SAP R/3? What kind of documents are you sending, for example text, PCL, or PostScript? From what application are you sending them? What application did you use to create the document? From what operating system are you delivering? To what operating system are you delivering?

If you are calling about delivering to an FTP site, -

Can you repeat the problem or is it intermittent?

xxxiv

System Administrators Attribute Reference

Chapter 1

Introduction
This chapter introduces HP Output Server attributes. Attributes are descriptors with one or more associated values that define HP Output Server objects. HP Output Server objects include jobs, destinations and queues, servers, transformers, forms, and paging systems. You can specify an attribute in a command, a function call, or an object configuration file. When you use the command line interface (CLI) to manipulate HP Output Server processes, you can pass attributes to the command through -x. The attributes are sub-options within -x. Function calls can also receive attributes specified by the user at a command line in the attribute-string format. A separate interface (program-attribute-string) allows an application to add its own attribute values in addition to the users. This chapter includes the following sections to introduce HP Output Server attributes: Attribute reference information on page 2 describes the information in each attributes description. Attribute syntax on page 4 describes how to set attributes. NOTE: For information about HP Output Server commands, see the System Administrators Command Reference for HP Output Server.

HP Output Server

Chapter 1

Introduction

Attribute reference information

To help provide context for using HP Output Server attributes, this manual organizes the attributes as follows: Chapter 2, Attributes on page 23 provides reference information for HP Output Server attributes. These entries are arranged alphabetically. Related attributes are grouped together. Appendix A, Attributes by Object Class on page 263 organizes attributes by the object the attribute affects. The appendix groups attributes by object class.

Attribute reference information

Each attribute entry in this manual contains the following information about the attribute: Description indicates the attributes function and usage. Type indicates whether the attribute returns a status, controls an object, or sets configuration information. Object indicates the class of objects that the attribute affects. Data Type indicates the format for the attributes value. Valid Values lists values (where appropriate) that you can specify with the attribute.

Types
This manual classifies attributes by type: control, status, and configuration. These attribute types are for the purpose of discussion, and are not related to formal divisions of function made by other entities. Attributes that are inaccessible to users and programmers, such as protocol attributes, are not covered in this manual. Control attributes control objects, usually in the context of submitting a job or managing a job with the pdpr or pdmod commands. Some control attributes are used for objects other than jobs. Status attributes indicate the current characteristics of an object when using the pdls or pdq commands. The -requested-attributes attribute specifies how to return status information. The specification defines a set of status attributes to return as the status of the job. You can specify all, verbose, brief, none, or any combination of attributes. You receive the union of what you specify. The following specification returns all the attributes defined in the brief specification plus the value for -intervening-jobs: -requested-attributes brief, intervening-jobs

System Administrators Attribute Reference

Chapter 1

Introduction

Attribute reference information

In a status request, you can use attributes listed in the status category as values for the requested-attributes attribute. Configuration attributes define the behavior and characteristics of HP Output Server objects and servers. Use the pdset and pdcreate commands to define an objects configuration stored at the CM. Use the config_server command to define a servers configuration stored in the HostConfig.sgml file. Use the config_host command to define the local hosts configuration stored in the HostConfig.sgml file.

Object classes
Each attribute works on one or more object classes. The following list defines HP Output Server object classes: server, such as DLM, JQM, or DSM job (PS, PCL, text, pager, fax, LPR, FTP, file, dialup, and for each document) queue destination logical destination, such as PS, PCL, text, fax, pager, FTP, and so forth physical destination, such as PS, PCL, text, fax, pager, FTP, and so forth

forms paging system transformer capabilities

Data types
An attributes data type specifies the format for valid values for the attribute. In addition, some data type entries include examples of valid values or descriptions of how to set the valid values. Data types can be one of the following: integer real number text (alphanumeric characters and spaces)

HP Output Server

Chapter 1
Attribute syntax

Introduction

The delivery servers enforce a limit of 253 characters on attributes whose values are strings. The -job-name attribute is an example of such an attribute. Although HP Output Server allows you to specify a value greater than this limit (through pdpr or pdmod, for example), commands attempting to use these values (pdls, for example) may return unexpected results. identifier (another attribute type) Boolean object (object name) time The character value for the time data type is Coordinated Universal Time (UTC) in Zulu format. You can abbreviate the string from the right. For example, the value 20040528200015Z represents 8:00:15PM UTC, May 28, 2004:

20040528200015Z
Year Day Month Hour Min Sec

Because time values are stored as UTC values, you must adjust the value for your time zone. For example, to adjust UTC for Central Standard Time (CST), subtract six hours.

Attribute syntax
Manipulating an HP Output Server object can involve setting attribute values for the object. Depending on the object, you may use one of the following commands to set attribute values: config_server pdcreate pdset pdpr pdmod

System Administrators Attribute Reference

Chapter 1

Introduction
Attribute syntax

Use -x and (excluding config_server) -o to set attribute values. NOTE: The sections that follow apply to the pd* and config_server commands only. An attribute consists of a name (also referred to as an attribute type) and one or more values. A value can be numeric or a string, depending on the attribute. The following general rules apply when you specify attribute values: For single-valued attributes, separate the attribute name from its value with a space. copy-count 3 For multi-valued attributes, separate the attribute values with a comma and a space. If the values of an attribute contain spaces, tabs or other special characters, enclose the value in escaped quotation marks. header-text \"Lease Agreement\", \"Atticus Properties\", \"Residential Contract\" Some attributes take attribute names as values, as in the following example: -requested-attributes job-identifier You can abbreviate attributes to the shortest string that uniquely identifies them. For multi-word attribute names, you must represent every word. In many cases, the first letters of the word are sufficient, as is the case with the -requested-attributes attribute: -r-a all -r-a current-job-state, started-printing-time The following sections describe attribute syntax in more detail, including the following topics: Setting attributes with the -x switch Setting attributes with the -o switch on page 7 Setting attributes with both switches on page 8 Setting multi-valued attributes on page 8 Requesting attribute values on page 9 Abbreviating attributes on page 11 Attribute order on page 12 Attribute precedence on page 15 Using attribute variables on page 17

HP Output Server

Chapter 1
Attribute syntax

Introduction

Setting attributes with the -x switch

The -x switch includes one or more attribute specifications enclosed in double quotes. Syntax for the -x switch is as follows: -x"-attribute value -attribute value,value,..." You can also include a space between the -x switch and its attribute specification, as in the following example: pdpr -d ps1 -x "-copy-count 5" memo.ps NOTE: In command examples, this manual omits the space after the -x switch. Use the following rules with the -x switch. Table 1-1. Rules for using the -x switch
Rule Separate an attribute name and its value with a space. Separate multiple attribute-value pairs with a space. Separate multiple values with a comma and a space. Enclose a value that contains embedded spaces (or other special characters, including commas and hyphens) in escaped double-quotes. Command Syntax -x"-attribute value" -x"-attribute value -attribute value" -x"-attribute value, value, value" -x"-attribute \"This is a value.\""

The following table provides examples of setting attributes with the -x switch. Table 1-2. Using the -x switch to set attributes
Task Set the -maximum-tries attribute to 15 for a job sent to fax1. Set the -fax-phone-number attribute to 1-800-999-9999 and the -maximum-tries attribute to 15 for a job sent to fax1. Command pdpr -d fax1 -x"-maximum-tries 15" memo.ps pdpr -d fax1 -x"-fax-phone-number 1-800-999-9999 -maximum-tries 15" memo.ps

System Administrators Attribute Reference

Chapter 1 Table 1-2. Using the -x switch to set attributes (continued)

Task Set the -fax-phone-number attribute to 1-800-999-9999 and 1-800-888-8888 for a job sent to fax1. Set the -fax-to-person attribute to Sales Department for a job sent to fax1. Command

Introduction
Attribute syntax

pdpr -d fax1 -x"-fax-phone-number 1-800-999-9999, 1-800-888-8888" memo.ps pdpr -d fax1 -x"-fax-to-person \"Sales Department\"" memo.ps

Setting attributes with the -o switch

The -o switch identifies a file that contains attribute specifications. Syntax for the -o switch takes the following form: -o optionsFile The file containing the attribute specifications includes one or more attribute specifications separated by a space or new line character: -attribute value -attribute value -attribute value, value, value For example, in -o faxToSales, the faxToSales file might contain the following attribute specifications: -fax-phone-number 1-800-999-9999, 800-888-8888 -fax-to-person "Sales Department" -maximum-tries 15 To specify an attribute value that spans multiple lines and include it in an options file, use a backslash character (\) at the end of each line and enclose the entire range of values within double quotes. The following example sets the -mail-message attribute: -mail-message "\ first line \ second line"

HP Output Server

Chapter 1
Attribute syntax

Introduction

Setting attributes with both switches

You can specify attributes with both the -o and -x switches. If you set an attribute more than once on the command line, the command uses the last value set. In the following example, both the -o switch (through the faxToSales options file) and the -x switch set the -maximum-tries attribute. Because the -x switch appears later in the command line, it sets the -maximum-tries value to 10. pdpr -d fax1 -o faxToSales -x"-maximum-tries 10" file.ps

Setting multi-valued attributes

HP Output Server attributes can take single or multiple values, depending on the attribute. Typically, you use the pdset command with the + and - operators to set and unset a multi-valued attribute. You can also use the config_host -u and config_server -u constructions with the + and - operators to set and unset multi-valued attributes. The following example adds the text_to_ps transformer to dsm_01s list of supported transformers: pdset -c server -x"-+transformers-supported text_to_ps" dsm_01 Omitting the + replaces the entire list with the single text_to_ps value: pdset -c server -x"-transformers-supported text_to_ps" dsm_01 The following example removes the transformer from the list of supported transformers: pdset -c server -x"--transformers-supported text_to_ps" dsm_01 Subtracting the last value in a multi-valued attribute removes the attribute. The following table describes these operators. Table 1-3. Operators for setting multi-valued attributes
Operator -attribute value,... -+attribute value,... Definition This replaces the values of attribute with value,... If no attributes exist, add attribute. This adds the value,... to attribute. If no attributes exist, add attribute.

System Administrators Attribute Reference

Chapter 1

Introduction
Attribute syntax

Table 1-3. Operators for setting multi-valued attributes (continued)

Operator --attribute value,... Definition This removes the value,... from attribute.

If a multi-valued attribute is not set, using the -+attribute value construction has the same effect as using the -attribute value construction. Consider the following sample commands, in which the -server-environment-variables attribute is not set on the installations delivery servers. In this example, both commands set the attribute to 40000-40200. config_server -u -t delivery -x"-+server-environment-variables 'DAZEL_PORTS=40000-40200'" config_server -u -t delivery -x"-server-environment-variables 'DAZEL_PORTS=40000-40200'"

Requesting attribute values

Use the -requested-attributes attribute with the pdls and pdq commands to return attribute values. The -requested-attributes values can be sets of attributes or individual attributes. Multiple values are separated with a comma and space. Attribute names do not have a preceding dash character (-). The following table lists values you can use with -requested-attributes. Table 1-4. Values for -requested-attributes
Value brief verbose all none attribute... Description Short set of object attributes (default) Moderate set of object attributes Set of all object attributes No attributes One or more individual object attributes

You can request attribute values with either the -x switch or the -a switch.

HP Output Server

Chapter 1
Attribute syntax

Introduction

Requesting attribute values with the -x switch

Use the -x switch with -requested-attributes as follows. If you specify more than one value for -requested-attributes, HP Output Server returns the union. -x"-requested-attributes value, value,..." NOTE: Do not precede attribute names that follow -requested-attributes with a - (dash). The following table lists some examples of requesting attribute values with the -x switch. Table 1-5. Using the -x switch to request attribute values
Task Request all attributes of the ps1 destination. Request the brief set of attributes and the -completion-time attribute of the job with ID dlm_01:12:1:3. Request the -job-owner attribute of the job with ID dlm_01:12:1:3. Command pdls -c d -x"-requested-attributes all" ps1 pdq -x"-requested-attributes brief, completion-time" dlm_01:12:1:3 pdq -x"-requested-attributes job-owner" dlm_01:12:1:3

Requesting attribute values with the -a switch

The -a switch specifies -requested-attributes implicitly. Use the following form with the -a switch, substituting brief, verbose, all, none, or attribute as the value: -a value Separate multiple values with a comma and a space, and enclose the values in double quotes. When you specify multiple values, HP Output Server returns the union. -a "value, value,..." NOTE: Do not precede attribute names that follow -a with a - (dash).

10

System Administrators Attribute Reference

Chapter 1

Introduction
Attribute syntax

The following examples are equivalent to those in Using the -x switch to request attribute values in the preceding section. Table 1-6. Using the -a switch to request attribute values
Task Request all attributes of the ps1 destination. Request the brief set of attributes and the -completion-time attribute of the job with ID dlm_01:12:1:3. Request the -job-owner attribute of the job with ID dlm_01:12:1:3. Command pdls -c d -a all ps1 pdq -a "brief, completion-time" dlm_01:12:1:3 pdq -a job-owner dlm_01:12:1:3

Filtering attribute values

When you use the pdls or pdq command (depending on the HP Output Server object) to list attribute values for an object, you can specify selection criteria with the -x switch. NOTE: Using -a none returns object names only. The following table lists examples of filtering attribute values. Table 1-7. Using pdls to filter attribute values
Task List the names of physical destinations that dsm_01 manages and with a -printer-state of printing. Search the CM database (ids_ccm) to list the names of all physical destinations (-printer-realization 1) in the HP Output Server domain, excluding templates (-template false). Command pdls -c d -a none -x"-printer-state printing" dsm_01: pdls -c d -a none -x"-template false -printer-realization 1" ids_ccm:

Abbreviating attributes
When specifying an attribute, you can abbreviate it to the shortest string that uniquely identifies the attribute. For multi-word attributes, you must represent each word. NOTE: The config_server command does not accept abbreviated attributes.

HP Output Server

11

Chapter 1
Attribute syntax

Introduction

The following table shows examples of unabbreviated and abbreviated attributes. Table 1-8. Unabbreviated and abbreviated attributes
Unabbreviated Attribute -x"-cleanup-interval 900" -x"-requested-attributes cleanup-interval" -a cleanup-interval Abbreviated Attribute -x"-clean-int 900" -x"-r-a clean-int" -a clean-int

Attribute order
Attribute order in the command line can affect how HP Output Server carries out the command. If a job includes multiple documents, the attribute type and its placement in the command affect the outcome of the job. Job attributes act on the entire job and include -job-print-after and -job-priority. Document attributes act on subsequent documents in a job and include -copy-count and -page-select. If a job includes only one document, attributes specified at job submission apply to both the job and to the document. NOTE: For a list of job and document attributes, see Appendix A, Attributes by Object Class on page 263. You can type a job attribute anywhere in the command line. If a job attribute appears more than once, the system uses the last attribute value. You must type a document attribute immediately before the document it affects. Unless you reset it, a document attribute applies to subsequent documents in the command line. The following examples illustrate the effect of attribute order on the command line. To print three copies of file1.ps and file2.ps at printers ps1 and ps2, type the following command: pdpr -d ps1,ps2 -x"-copy-count 3" file1.ps file2.ps

12

System Administrators Attribute Reference

Chapter 1

Introduction
Attribute syntax

Because the -copy-count attribute precedes both file names, the attribute applies to both files.
file1 file2 Destination ps1 file1

file2

Destination ps2

file1

file2

HP Output Server

13

Chapter 1
Attribute syntax

Introduction

To print one copy (the default) of file1.ps and three copies of file2.ps at printers ps1 and ps2, type the following command. Because the -copy-count attribute precedes file2.ps, the attribute applies only to file2.ps. pdpr -d ps1,ps2 file1.ps -x"-copy-count 3" file2.ps
file1 file2 Destination ps1 file1

file2

Destination ps2

file1

file2

To print three copies of file1.ps and two copies of file2.ps at printers ps1 and ps2, type the following command. The first occurrence of the -copy-count attribute applies to file1.ps, and the second occurrence to file2.ps. pdpr -d ps1,ps2 -x"-copy-count 3" file1.ps -x"-copy-count 2" file2.ps
file1 file2 Destination ps1 file1

file2

Destination ps2

file1 file2

14

System Administrators Attribute Reference

Chapter 1

Introduction
Attribute syntax

To send the text1.txt file to faxDest and fileDest, type the following command: pdpr -d faxDest,fileDest -x"-fax-phone-number 9-1-555-1212 -fax-to-person \"John Doe\" -file-filename archive.txt -file-permissions 655" text1.txt The -fax-phone-number and -fax-to-person attributes are job attributes for the fax destination; the -file-filename and -file-permissions attributes are document attributes for the file system destination. Because the delivery request is for one document, the order of attributes in the -x attribute string is not important. NOTE: If a job attribute does not apply, the attribute is ignored. For example, HP Output Server ignores the value of the -fax-phone-number attribute if you specify it for delivery to file destination or a printer. You cannot set an attribute that acts on a destination multiple times in one job; that is, you cannot specify one -fax-phone-number for destination fax1 and another -fax-phone-number for destination fax2 in the same job. Instead, you must submit two separate jobs.

Attribute precedence
You can set most attributes at the following three points: 1. 2. 3. at job submission at a logical destination as a default at a physical destination as a default

An attribute value set at job submission takes precedence over a default value set at the logical destination or physical destination. A default value set at the logical destination takes precedence over a default value set at the physical destination. In general, the attribute value set closest to job submission takes precedence over subsequent (default) attribute values in the delivery cycle. The following table illustrates how many HP Output Server attributes are related. Table 1-9. Attribute precedence
Attribute -attribute Description The -attribute is set at job submission.

HP Output Server

15

Chapter 1
Attribute syntax

Introduction Table 1-9. Attribute precedence (continued)

Attribute -attribute-default Description The -attribute-default is set at the logical or physical destination. If -attribute is not set at job submission, the -attribute-default is used. The -attributes-supported are set at the logical destination and specify valid attribute values. The job or document attribute is validated automatically. With few exceptions, validation does not occur automatically at the physical destination.

-attribute-supported

With default values set at the logical or physical destination, users can submit jobs without having to specify required or commonly used attribute values. Attribute precedence also lets a job owner (the value of the -job-owner attribute) override default attribute values set at the logical or physical destination. The following examples illustrate attribute precedence.

Example 1: Attributes set at the job and logical destination

Job -attribute Logical Destination -attribute-default Physical Destination

The attribute value set at job submission overrides the default value set at the logical destination.

Example 2: Attributes set at the job and physical destination

Job -attribute Logical Destination Physical Destination -attribute-default

The attribute value set at job submission overrides the default value set at the physical destination.

16

System Administrators Attribute Reference

Chapter 1

Introduction
Attribute syntax

Example 3: Attributes set at the job and logical and physical destinations
Job -attribute Logical Destination -attribute-default Physical Destination -attribute-default

The attribute value set at job submission overrides the default values set at the logical and physical destinations.

Example 4: Attributes set at logical and physical destinations

Job Logical Destination -attribute-default Physical Destination -attribute-default

The default attribute value set at the logical destination overrides the default value set at the physical destination.

Example 5: Attribute set at the physical destination

Job Logical Destination Physical Destination -attribute-default The default attribute value set at the physical destination is used.

Using attribute variables

Using attribute variables instructs the DSM to replace the variables with values. You can use attribute variables on job sheets, in headers and footers, in file names, as program arguments, and in some cases, as attribute values. Single-valued attribute variables are formatted as follows. Note that the attribute is not preceded by a dash. !{job-owner}!

HP Output Server

17

Chapter 1
Attribute syntax

Introduction

When the DSM encounters the delimiters !{ and }!, it replaces the attribute variable -job-owner with the attribute value. Consider multi-valued attributes as an array or list of values. For example, -fax-comments, a multi-valued attribute, might be composed of the following three values: red,green,blue A sequential index number (beginning with 1) corresponds to each -fax-comments value as shown in the following table.
Index 1 2 3 Value red green blue

To select the value, append the : (colon) and the index number to the variable name, as follows: !{fax-comments:2}! When the fax cover sheet prints, the DSM replaces the -fax-comments attribute variable with the value green. To replace all values of -fax-comments, append the : and the index number 0 to the attribute, for example, !{fax-comments:0}!. The DSM replaces the -fax-comments variable with the following values: red,green,blue Not specifying an index number is equivalent to specifying index number 1. For example, the following are equivalent: !{fax-comments}! !{fax-comments:1}! In both cases, the -fax-comments attribute variable is replaced with the value red.

18

System Administrators Attribute Reference

Chapter 1

Introduction
Attribute syntax

Specifying attribute value length

You can specify the length, or number of characters, in attribute variable values. NOTE: With an attribute variable, you can specify the printed length of the attribute value; the length that you specify does not affect the length of the stored attribute value. For a single-valued attribute, specify the value length as follows: !{attribute,length}! where attribute is the attribute name and length specifies the length of the attribute value. The following example specifies 20 characters for the length of the value of -job-owner: !{job-owner,20}! For a multi-valued attribute, specify the value length as follows: !{attribute:index,length}! where attribute is the attribute name, index identifies the attribute value, and length specifies the length (number of characters) of the attribute value. The following example specifies 75 characters for the length of the second value of -fax-comments: !{fax-comments:2,75}! If the length of the attribute value is greater than the specified length, the attribute value is truncated to the specified length. For example, if the value of -job-owner is John Doe, the value of the attribute variable !{job-owner,4}! is John; the DSM truncates the value to four characters. If the length you specify is greater than the length of the attribute value or if you set the length to 0, the entire attribute value replaces the attribute variable. The following examples yield equivalent values, assuming that the value of -job-owner is John Doe: !{job-owner}! !{job-owner,0}! !{job-owner,75}! NOTE: Do not insert spaces within an attribute variable.

HP Output Server

19

Chapter 1
Attribute syntax

Introduction

Replacing attributes
Variables are replaced recursively by HP Output Server. In the following example, HP Output Server replaces the !{job-comment}! variable with the text Submitted at and the value of the -job-submission-time attribute: pdpr -d ps1 -x"-job-name !{job-comment}! -job-comment \"Submitted at !{job-submission-time}!\"" file1.ps Recursive attribute replacement also works with conditional attribute replacement. For information about conditional attribute replacement, see the System Administrators Guide for HP Output Server. In the following example, the -header-text-default attribute contains the value of the -job-comment attribute if it is present, or None: pdset -c d -x"-header-text-default \"Comment: \${ job-comment ? !{job-comment}! :: None }$\"" pps1 Table 1-10. Examples of using attribute variables
To Automatically generate file names for file and FTP physical destinations Use attribute variables for file physical destinations Include Attribute variables in the file name, as in the following example: !{job-id}!.txt Attribute variables for the -file-directory and -file-directory-default attributes, as in the following example: misc/memos !{document-sequence-number}!/ Specify the external agent the DSM uses to deliver jobs to an external device Attribute variables for the -deliver-program, -deliver-arguments, and -deliver-document-arguments attributes.

Conditional replacement
HP Output Server can recursively or conditionally replace variables.

20

System Administrators Attribute Reference

Chapter 1

Introduction
Attribute syntax

You can use a conditional expression to perform attribute replacement based on a set of conditions. The syntax for this type of attribute replacement is similar to the use of the ?: operator in the C programming language. For example, condRepExp = ${condition ? setValue}$ condRepExp = ${condition ? setValue :: unsetValue}$ condRepExp = ${condition ? setValue :: condRepExp}$ In the examples, the ${ and }$ characters enclose the conditional expression. The ? character denotes a then clause, and the :: characters represent an optional else clause. The condition in the examples is an attribute. If the attribute evaluates to true, the value of condRepExp is set to the value of setValue. If the attribute is not set or if the attribute does not have a value, the result of condRepExp is set to the value of unsetValue, or the nested condition is evaluated to determine a value. You can nest conditional replacement expressions by adding conditions after the :: characters as shown in the following example: ${condition ? setValue :: ${condition ? setValue}$}$ The setValue and unsetValue can be a simple name or an attribute variable. For example, ${job-name ? \"There is a name for this job\"}$ ${job-name ? !{job-name}!}$ The first example replaces the -job-name attribute in a command with the string, There is a name for this job. The second example replaces the -job-name attribute with the value of the attribute. When you are setting up conditional replacement of attribute variables, you may find syntax restrictions that are specific to the operating system. In the following UNIX example, the \ is used to escape the $ and each argument is enclosed in single quotes ('): pdset c transformer -x"-transformer-program installDir/bin/perl -transformer-program-arguments installDir/custom/custom_transform.pl, '\${job-custom-1 ? !{job-custom-1}!}\$', '\${job-custom-2 ? !{job-custom-2}!}\$'" custom_transform In the following Windows example, each argument is enclosed in single quotes ('): pdset c transformer x"-transformer-program installDir\bin\perl -transformer-program-arguments installDir\custom\custom_transform.pl,

HP Output Server

21

Chapter 1
Attribute syntax

Introduction

'${job-custom-1 ? !{job-custom-1}!}$', '${job-custom-2 ? !{job-custom-2}!}$'" custom_transform

22

System Administrators Attribute Reference

Chapter 2

Attributes
This chapter provides an alphabetical listing of HP Output Server attributes. Each attribute entry includes the following: Description indicates the attributes function and usage. Type indicates whether the attribute returns a status, controls an object, or sets configuration information. Objects indicates the class of objects that the attribute affects. Data Types indicates the format for the attributes value. Valid Values indicates a list of values that you can specify with the attribute. NOTE: Valid values are included only where appropriate.

-accounting-profile
The -accounting-profile multi-valued attribute lets you collect event information about jobs, destinations, servers, and operations. The Accounting and Inventory Manager (AIM) stores accounting information in the following AIM classes: job-accounting destination-accounting server-accounting

HP Output Server

23

Chapter 2

Attributes

-accounting-profile

The Job and Queue Managers (JQMs), Destination Managers (DSMs), and Configuration Manager (CM) can create records in the accounting classes as follows: JQMs can create records in the job-accounting class. DSMs can create records in the destination-accounting class. The CM and all delivery servers can create records in the server-accounting class.

To populate an accounting class, you must turn it on by setting the -accounting-profile attribute at the appropriate server. The values associated with this attribute at the specified server determine what information the accounting class stores. These values have the same name as the attributes maintained in each accounting record. The -accounting-profile attribute is multi-valued and takes the following form: -accounting-profile {{event [, ...]}, accountingService, "accountingClass accountingClassAttribute = \"string [...]\", accountingServiceInstance"} The -accounting-profile attribute for the job-accounting class has 17 fields, and the -accounting-profile attribute for the destination-accounting and server-accounting classes has 5 fields. For information about scripts to automate setting this attribute, contact Customer Support. For information on setting up accounting, see the System Administrators Guide for HP Output Server.

24

System Administrators Attribute Reference

Chapter 2

Attributes

-accounting-profile

The following table lists arguments and values for the -accounting-profile attribute. Table 2-1. Arguments and values for the -accounting-profile attribute
Argument event Value This argument specifies one or more event classes or events for which to generate notices. Separate multiple values with a comma and space. You can combine event classes and events. For example, {error, report-job-completed} includes all events in the error class (error-past-deadline, error-past-discard, and so forth) and the report-job-completed event. The all class includes all events. The aborted class includes the following events: aborted-by-server aborted-by-operator aborted-by-user aborted-by-supervisor

The error class includes the following events: error-past-deadline error-past-discard error-printer-shutdown error-no-resource error-unrecognized-resource error-no-document error-job-submission-not-complete error-printerror error-other

HP Output Server

25

Chapter 2

Attributes

-accounting-profile

Table 2-1. Arguments and values for the -accounting-profile attribute (continued)
Argument event, (continued) Value The warning class includes the following events: warning-resource-needs-attention warning-resource-needs-operator warning-printer-shutdown warning-job-modified warning-close-to-deadline warning-close-to-discard-time warning-criterion-exceeded warning-duplicate-attribute-ignored warning-job-paused warning-job-interrupted warning-attribute-ignored warning-other

The report class includes the following events: report-job-completed report-checkpoint-taken report-resource-message report-job-discarded report-file-transferred report-job-promoted report-job-resumed report-processing-started report-job-resubmitted report-ready-for-job

The state-changed class includes the following events: accountingService state-changed-job state-changed-printer state-changed-server state-changed-supervisor

query-service is the only argument.

26

System Administrators Attribute Reference

Chapter 2 Table 2-1. Arguments and values for the -accounting-profile attribute (continued)
Argument accountingClass Value This argument specifies one of the following: accountingClassAttribute \"string\" accountingServiceInstance job-accounting destination-accounting server-accounting operation-accounting

Attributes
-afp-device

This argument specifies one or more attributes of accountingClass. This argument is a string that can contain job attributes in the form !{attribute}! If the string contains spaces, use quotation marks as indicated. This argument is the AIM server name for accounting; qsd is the internal name of the AIM. To centralize accounting in one domain, the server name can be qualified with an HP Output Server domain name. For example, qsd@dazel is a legitimate qualified name.

Types Objects

Configuration and Status Servers: JQM, DSM, DLM, CM

-afp-device
The -afp-device single-valued attribute identifies the Advanced Function Presentation (AFP) device associated with the physical destination. In most cases, the value of the -afp-device attribute is the IBM PSF/6000 printer queue to which HP Output Server jobs are sent for conversion to AFP.
Types Object Data Type Configuration and Status Destination: Physical Text

-agent-termination-signal
The -agent-termination-signal single-valued attribute reacts to errors by providing a UNIX signal to the process that the DSM has already created. This attribute is ignored on Windows. The meaning of the value is standard UNIX signaling. The

HP Output Server

27

Chapter 2
-bits-per-pixel

Attributes

default value is 15, which sends a signal to end the process gracefully. Not all UNIX signal values are related to terminating a process. For more information, consult a UNIX reference manual.
Types Object Data Type Configuration and Status Destination: Physical Integer

-bits-per-pixel -bits-per-pixel-default -bits-per-pixel-supported

The -bits-per-pixel single-valued attribute controls the number of bits used to represent each pixel in the final output. Typically, a greater number of bits for each pixel yields higher print quality at the cost of speed and memory. The -bits-per-pixel-default single-valued attribute sets the default -bits-per-pixel value. The -bits-per-pixel-supported multi-valued attribute lists valid -bits-per-pixel values. The following -ghostscript-device types support the -bits-per-pixel* attributes. Table 2-2. Printer drivers for -ghostscript-device
Driver lj4dith cdeskjet cdjcolor cdjmono cdj500 cdj550 pj pjxl Definition HP LaserJet 4 (enhanced greyscale support) HP DeskJet 500C (3 bit/pixel color) HP DeskJet 500C (24 bit/pixel color); DeskJet 540C HP DeskJet 500C (black only); DeskJet 510, 520, and 540C (black only) HP DeskJet 500C (same as cdjcolor) HP DeskJet 550C/560C/660C HP PaintJet XL HP PaintJet XL color printer

28

System Administrators Attribute Reference

Chapter 2 Table 2-2. Printer drivers for -ghostscript-device (continued)

Driver pjxl300 declj250 dnj650c Definition

Attributes

-black-correction

HP PaintJet XL300 color printer; PaintJet 1200C and 1600C; and Color LaserJet DEC LJ250 driver HP DesignJet 650C

Types

-bits-per-pixel: Control and Status -bits-per-pixel-default: Configuration and Status -bits-per-pixel-supported: Configuration and Status

Objects

-bits-per-pixel: Job -bits-per-pixel-default: Destinations: Logical, Physical (PCL) -bits-per-pixel-supported: Destination: Logical (PCL)

Data Type Valid Values

Integer (Positive) 1 3 8 16 24 32 monochrome standard color, using internal dithering greyscale medium quality color high quality color highest quality color

-black-correction -black-correction-default -black-corrections-supported

The -black-correction single-valued attribute produces enhanced shades of black if the device has a color driver. The -black-correction-default single-valued attribute specifies the default -black-correction value. The -black-corrections-supported multi-valued attribute lists valid -black-correction values.

HP Output Server

29

Chapter 2

Attributes

-black-corrections-supported

You can configure the following -ghostscript-device printer drivers to control the amount of black correction. Table 2-3. Printer drivers for -ghostscript-device
Driver lj4dith cdeskjet cdjcolor cdjmono cdj500 cdj550 pj pjxl pjxl300 declj250 dnj650c Type Objects Control -black-correction: Document (PCL) -black-correction-default: Destinations: Logical (PCL), Physical -black-corrections-supported: Destination: Logical (PCL) Data Type Valid Values Integer (Positive) 0 to 10, where 0 equals no correction and 10 equals the greatest degree of correction. The lower the degree of correction, the more similar all shades of black appear when printed. Definition HP LaserJet 4 (enhanced greyscale support) HP DeskJet 500C (3 bit/pixel color) HP DeskJet 500C (24 bit/pixel color); DeskJet 540C HP DeskJet 500C (black only); DeskJet 510, 520, and 540C (black only) HP DeskJet 500C (same as cdjcolor) HP DeskJet 550C/560C/660C HP PaintJet XL HP PaintJet XL color printer HP PaintJet XL300 color printer; PaintJet 1200C and 1600C; Color LaserJet DEC LJ250 driver HP DesignJet 650C

30

System Administrators Attribute Reference

Chapter 2

Attributes

-bottom-margin

-bottom-margin -bottom-margin-default
The -bottom-margin single-valued attribute specifies the size, in points, of the bottom margin of a text document sent to a PostScript destination. The -bottom-margin-default single-valued attribute specifies the default size, in points, of the bottom margin.
Types -bottom-margin: Control -bottom-margin-default: Configuration Objects -bottom-margin: Document -bottom-margin-default: Destinations: Logical, Physical Data Type Integer (Positive)

-brief-specification
The -brief-specification multi-valued attribute sets the values to be displayed when you specify brief for the -requested-attributes attribute. HP Output Server provides default attributes for the brief listing for different classes. You can override the default with -brief-specification.
Types Objects Data Type Valid Values Control and Status All Identifier All attributes valid for the class

-building
The -building single-valued attribute sets location information for a logical destination. If you do not specify values for location attributes (-organization, -city, -building, -floor) when you create a logical destination, you can use pdset to insert these values into the record. The values for this attribute cannot contain embedded spaces.
Types Object Configuration and Status Destination: Logical

HP Output Server

31

Chapter 2

Attributes

-cancel-arguments

Data Type

Text

-cancel-arguments
The -cancel-arguments multi-valued attribute passes command-line arguments to the -cancel-program attribute.
Types Object Data Type Configuration and Status Destination: Physical (External) Text

-cancel-program
The -cancel-program single-valued attribute names the program (an absolute path and file name) that cancels a submitted job at the device.
Types Object Data Type Configuration and Status Destination: Physical (External) Text

-capabilities-name
The -capabilities-name single-valued attribute indicates the name of a capabilities object stored in the CM. To list all of the capabilities objects stored in the CM, type the following: pdls -c capabilities -a none ids_ccm: To list the contents of a specific capabilities object stored in the CM, type: pdls -c capabilities -a all capabilitiesObjectName The -capabilities-name attribute applies to advanced delivery pathways only. For more information about advanced printers and advanced delivery pathways, see the System Administrators Guide for HP Output Server.
Types Object Data Type Control and Status Capabilities Text

32

System Administrators Attribute Reference

Chapter 2

Attributes

-capabilities-supported

-capabilities-supported
The -capabilities-supported single-valued attribute indicates the capabilities ticket associated with a logical destination, queue, transformer, or physical destination. The value of -capabilities-supported identifies a capabilities object stored in the CM. When you use a certified advanced printer template to create a new physical destination for an advanced printer, the -capabilities-supported attribute is automatically set. The -capabilities-supported attribute applies to advanced delivery pathways only. For more information about advanced printers and advanced delivery pathways, see the System Administrators Guide for HP Output Server.

Types Objects

Control and Status Destinations: Logical and Physical Queue Transformer

Data Type

Text

-capabilities-ticket
The -capabilities-ticket single-valued attribute contains the XML file that defines a destinations features. The process of aggregation dynamically calculates the contents of the -capabilities-ticket. The -capabilities-ticket attribute applies to advanced delivery pathways only. For more information about advanced printers and advanced delivery pathways, see the System Administrators Guide for HP Output Server.
Types Objects Data Type Control and Status Destinations: Logical and Physical Text

HP Output Server

33

Chapter 2
-character-set

Attributes

-character-set -character-sets-used -character-set-default -character-sets-supported

The -character-set single-valued attribute defines the character encoding of text documents. The -character-sets-used multi-valued attribute specifies the character encoding of text documents. The -character-set-default single-valued attribute specifies a default value for a character set that applies if you do not set the -character-set or -character-sets-used attribute. The -character-sets-supported multi-valued attribute defines the character sets supported on a logical destination. When you submit a job, the DSM determines the documents character set by checking the following attributes in order: -character-set -character-sets-used -character-set-default If a value is specified for -character-set, the DSM uses that character set. If you have not set -character-set or -character-set-default, then the value ascii is assumed. If one of the values is set, it is validated against the device attribute -character-sets-supported.
Types -character-set: Control and Status -character-sets-used: Control and Status -character-set-default: Configuration and Status -character-sets-supported: Configuration and Status Objects -character-set: Document -character-sets-used: Document -character-set-default: Destinations: Logical, Physical -character-sets-supported: Destination: Logical Data Type Valid Values Identifier ascii, iso-latin-1, ebcdic

34

System Administrators Attribute Reference

Chapter 2

Attributes
-city

-city
The -city single-valued attribute sets location information for a logical destination. If you do not specify values for location attributes (-organization, -city, -building, -floor) when you create a logical destination, you can use pdset to insert these values into the record. The values for this attribute cannot contain embedded spaces.
Types Object Data Type Configuration and Status Destination: Logical Text

-class
The -class single-valued attribute specifies the class of an object passed as an argument to the HP Output Server CLI. The full specification of an object includes the class and instance. For example, -class queue qp1 specifies a queue (the class) named qp1 (the instance).
Types Objects Data Type Valid Values Control and Status All Objects Identifier capabilities, form, destination (synonymous with printer), host, job, paging-system, printer, queue, server, transformer

-cleanup-checkjob-interval
The -cleanup-checkjob-interval single-valued attribute specifies the interval at which the DLM checks job status information at the JQM. Normally, the JQM informs the DLM when the JQM deletes a subjob from its database. If communication is interrupted, the JQM may not inform the DLM of a subjob deletion. To prevent stale jobs from remaining in its database, the DLM checks with the JQM to determine the status of subjobs every time the -cleanup-checkjob-interval elapses for the subjob. If the subjob is no longer in the JQMs database, the DLM considers the job stale and deletes it from its own database. To prevent the DLM from checking job status at the JQM prematurely, set -cleanup-checkjob-interval to a value greater than the -retention-period-default of any logical destination managed by the JQM.

HP Output Server

35

Chapter 2

Attributes

-cleanup-checkjob-period-limit

Consider setting -cleanup-checkjob-interval to a value 1800 seconds (30 minutes) greater than -retention-period-default. Because the value of -retention-period-default is in minutes, use the following formula to calculate the value of -cleanup-checkjob-interval: (value of -retention-period-default x 60) + 1800 seconds The default is 23400 seconds (6.5 hours).
Types Object Data Type Configuration and Status Server: DLM Integer (Positive)

-cleanup-checkjob-period-limit
The -cleanup-checkjob-period-limit single-valued attribute specifies the time frame a DLM uses to build an internal list of jobs that require processing because they have exceeded the -cleanup-checkjob-interval. If this attribute is not defined, the default is 1800 seconds (30 minutes). With the attribute set to the default, the DLM will query the database for all jobs that are due to exceed the -cleanup-checkjob-interval within the next 1800 seconds. With the list of jobs built, the list grows smaller as jobs expire. When the -cleanup-checkjob-period-limit is reached, the DLM queries the database for the next set of jobs due to exceed the -cleanup-checkjob-interval within the -cleanup-checkjob-period-limit. If no jobs are due to exceed the interval within this limit, the DLM does nothing until the limit is reached and the next list of jobs is built. If the job list is large, the DLMs memory usage can increase significantly. Setting the -cleanup-checkjob-period-limit to a smaller value, such as 600 seconds (10 minutes), can decrease the number of jobs in the list and, as a result, the memory allocated to the task. A trade-off to setting the attribute to a value smaller than the default is that the DLM will query the database more frequently for jobs set to exceed the -cleanup-checkjob-interval.
Types Object Data Type Control and Status Server: DLM Integer (Seconds)

36

System Administrators Attribute Reference

Chapter 2

Attributes

-cleanup-interval

-cleanup-interval
The -cleanup-interval single-valued attribute sets the interval between deletions of complete and expired jobs from the servers database. The default value is 600 (seconds) for JQMs.
Types Objects Data Type Configuration and Status Servers: JQM Integer (Positive)

-completion-time
The -completion-time single-valued attribute reports the time of a jobs completion. The JQM sets this attribute when the DSM finishes delivering the job.
Type Object Data Type Status Job Time (UTC)

-connection-lifetime
The -connection-lifetime single-valued attribute indicates whether the printer connection is always maintained (device) or is maintained for the duration of a job only (job). If the -connection-lifetime attribute is not set on a physical destination, the DSM maintains connections for the duration of a job only. To use job overlay, you must set the value to device. For more information about configuring physical destinations to support job overlay, see the System Administrators Guide for HP Output Server. If you set this attributes value to device, the DSM maintains a constant connection between the server and the printer. The constant connection allows the server to use a printers job overlay capabilities. However, the constant connection also means that other servers cannot send jobs to the printer because it is dedicated to one server. If several servers must print to the printer (which is not recommended), do not set this attribute to device.
Type Objects Data Type Configuration Destination: Physical (PostScript or PCL printers) Identifier

HP Output Server

37

Chapter 2

Attributes

-content-orientation

Valid Values

device, job

-content-orientation -orientation-default -orientations-supported

The -content-orientation single-valued attribute specifies the longest axis of the page: portrait for vertically-oriented pages and landscape for horizontally-oriented pages. Page positioning takes the value of this attribute into consideration using the -imposition and -number-up attributes. The -orientation-default single-valued attribute defines a default orientation if the -content-orientation attribute is not set. The -orientations-supported multi-valued attribute lists valid orientation values.
Types Objects Control and Status -content-orientation: Documents: PS, PCL, Fax -orientation-default: Destination: Logical -orientations-supported: Destination: Logical Data Type Valid Values Identifier landscape, mixed, portrait, reverse-portrait, reverse-landscape, seascape (synonymous with reverse-landscape)

-copy-count
The -copy-count single-valued attribute specifies the number of copies of a document to deliver. The default is 1. For fax destinations, see the -fax-copy-count attribute.
Types Object Data Type Control and Status Document Integer (0, Positive)

38

System Administrators Attribute Reference

Chapter 2

Attributes
-copy-from

-copy-from
The -copy-from multi-valued attribute contains the value of the -printer-name or -queue-name attribute from an object template. The pdcreate command uses the value of the -copy-from attribute to identify the source template to use when creating a new object.
Type Objects Data Type Control Server, Queue, Destination (Physical, Logical) Text

-cp-max-proxies
The -cp-max-proxies single-valued attribute defines the maximum number of connections allowed for the CP instance. If this attribute is not set, the default value is 3.
Type Object Data Type Control Server: Communications Proxy (CP) Integer

-cp-max-slaves
The -cp-max-slaves single-valued attribute defines the maximum number of slave proxies that the master proxy is allowed to create. The master proxy creates a slave each time the master proxy receives a request, until the maximum number is reached. After this point, the master proxy begins assigning additional process requests to existing slaves. Although each slave can handle multiple requests, a higher number of slaves allows for greater numbers of client requests to be handled simultaneously. If this attribute is not set, the default value is 10.
Type Object Data Type Control Server: Communications Proxy (CP) Integer

HP Output Server

39

Chapter 2

Attributes

-cp-port-number

-cp-port-number
The -cp-port-number single-valued attribute specifies the port number on which the CP is listening. If this attribute is not set, the default value is 1776.
Type Object Data Type Control Server: Communications Proxy (CP) Integer

-current-job-state
The -current-job-state single-valued attribute describes the state of the job. The JQM maintains the value of this attribute for each job. The following table describes the valid values (job states) for the -current-job-state attribute. Table 2-4. Job states
Job State unknown Description This is a pseudo job state. A job changes from unknown to another state when it is created, and from another state to unknown when it disappears. This is the initial state of a subjob during creation. For example, when a job is created with the pdpr command, its state is preprocessing. The state changes when creation completes. This is the state of a job waiting for documents to transfer to a spool area over the network. A job does not change to this state if files are transferred by reference (that is, shared job databases). Files are transferring to the spool area. For example, the job is in the middle of network transfer. The job waiting is in the queue until a physical device is ready. The job is processing at the physical device. The job has been interrupted and re-queued. This state is similar to pending, except that a condition (a busy fax number, for example) prevented job completion, and so the job is waiting for the -minimum-retry-interval to expire.

preprocessing

document-transfer -pending

transferring pending processing interrupted

40

System Administrators Attribute Reference

Chapter 2 Table 2-4. Job states (continued)

Job State aborting Description

Attributes

-database-client-max-connections

The job is canceled during processing (with the pdrm command, for example). After canceling is complete, the job is retained. The job is completed (successfully or unsuccessfully) and is retained in the job database. The job is deleted when its retention period expires. A retained job can result from a number of conditions, including: The job completes successfully. That is, the value of the job-completion-status attribute is success. The job is aborted while printing. That is, the value of the job-completion-status attribute is aborted-in-printing. The job is canceled by the user, a system administrator, or with the pdclean command. That is, the value of the job-completion-status attribute is cancelled.

retained

held paused Type Object Data Type Valid Values Status Job Identifier

The job is in the queue with the -job-hold attribute set to true. The job is paused in the queue.

aborting, document-transfer-pending, held, interrupted, paused, pending, pre-processing, processing, retained, transferring, unknown Although unknown is a valid state, it only occurs before a job begins delivery and after it completes delivery.

-database-client-max-connections
The -database-client-max-connections single-valued attribute specifies the maximum number of concurrent MySQL connections allowed per HP Output Server server.

HP Output Server

41

Chapter 2

Attributes

-database-server-hostname

You can use this attribute to manage growth of the HP Output Server servers. During periods of heavy load, lowering the value of -database-client-max-connections may decrease the size of the specified HP Output Server server. If the limit is reached, any pending database connections must wait until the current connections finish operations and close. Increasing the value of -database-client-max-connections may improve the servers performance, but the size of the server will also increase. If you set -database-client-max-connections too high, it is possible that HP Output Server will exceed the value of the MySQL max_connections parameter. The max_connections parameter is stored in the my.cnf file and limits the number of concurrent client connections from all applications, including HP Output Server and any other application accessing the MySQL server. Typically, max_connections is set to 1000. If max_connections is exceeded, database connection errors will be logged to the server log files and job processing will fail. To set -database-client-max-connections for all HP Output Server servers in an HP Output Server domain, use the config_host command as follows: config_host -u -x"-database-client-max-connections number" To set -database-client-max-connections on an individual server or group of servers, use the config_server command. Any value set with config_server overrides a host-wide value set with config_host. config_server -u -x"-database-client-max-connections number" serverName If this attribute is not set (neither on the host nor on a server), the default value is 10 for each server.
Type Object Data Type Configuration Server Text

-database-server-hostname
The -database-server-hostname single-valued attribute specifies the host name of the MySQL server. The value of this attribute must be a host name, not an IP address, and the host name must resolve to an IP address. If this attribute is not set, its default value is localhost.

42

System Administrators Attribute Reference

Chapter 2

Attributes

-database-server-password

On both UNIX and Windows systems, HP Output Server uses a host name and port to connect to a remote MySQL server. If you installed HP Output Server without configuring the connection to the MySQL server, you can use the config_host command to set up the connection between HP Output Server and MySQL before configuring HP Output Server servers. In the following example, HP Output Server communicates with MySQL as root and with the password set to dazel. In this example, HP Output Server will use the nigel host name and port 3308 to communicate with the MySQL server on the remote host. config_host -u -x"-database-server-user root -database-server-password dazel -database-server-hostname nigel -database-server-port 3308" Typically, you will configure the MySQL connection with config_host before creating any servers. Because existing servers already have associated data in a database, you cannot simply update an existing HP Output Server host with config_host to point it to a new database server. You must also migrate the data. For more information about this process, consult your Professional Services representative. To set -database-server-hostname on an individual server or group of servers when you create the server, use the config_server command. Any value set with config_server overrides a host-wide value set with config_host. config_server -t serverType -x"-database-server-hostname hostName" serverName Do not use config_server -u to point an existing server to a new database server without first migrating the data. For more information, consult your Professional Services representative. For information about installing and configuring the MySQL server, see the Installation and Configuration Guide for HP Output Server.
Type Object Data Type Configuration Server Text

-database-server-password
The -database-server-password single-valued attribute specifies the password the HP Output Server -database-server-user uses for accessing the MySQL server.

HP Output Server

43

Chapter 2

Attributes

-database-server-port

To set -database-server-password for all HP Output Server servers in an HP Output Server domain, use the config_host command as follows: config_host -u -x"-database-server-password password" To set -database-server-password on an individual server or group of servers when you create the server, use the config_server command. Any value set with config_server overrides a host-wide value set with config_host. config_server -t serverType -x"-database-server-password password" serverName CAUTION: If your MySQL connection is already configured and you want to change this attribute, you must first stop the HP Output Server servers and then shut down the MySQL server. For information about installing and configuring the MySQL server, see the Installation and Configuration Guide for HP Output Server.
Type Object Data Type Configuration Server Text

-database-server-port
The -database-server-port single-valued attribute specifies the port number HP Output Server uses for communicating with the MySQL server. If this attribute is not set, its default value is 3306. On both UNIX and Windows systems, HP Output Server uses a host name and port to connect to a remote MySQL server. For local MySQL servers, consider the following: On Windows, HP Output Server must use a port to connect to a local MySQL server. On UNIX, setting this attribute to connect to a local MySQL server is not allowed.

To set -database-server-port for all HP Output Server servers in an HP Output Server domain, use the config_host command as follows: config_host -u -x"-database-server-port portNumber"

44

System Administrators Attribute Reference

Chapter 2

Attributes

-database-server-socket

To set -database-server-port on an individual server or group of servers when you create the server, use the config_server command. Any value set with config_server overrides a host-wide value set with config_host. config_server -t serverType -x"-database-server-port portNumber" serverName CAUTION: If your MySQL connection is already configured and you want to change this attribute, you must first stop the HP Output Server servers and then shut down the MySQL server. For information about installing and configuring the MySQL server, see the Installation and Configuration Guide for HP Output Server.
Type Object Data Type Configuration Server Text

-database-server-socket
The -database-server-socket single-valued attribute specifies the file socket HP Output Server uses for communicating with the MySQL server. On UNIX systems, HP Output Server uses a file socket to connect to a local MySQL server. NOTE: This attribute is not available on Windows. To set -database-server-socket for all HP Output Server servers in an HP Output Server domain, use the config_host command as follows: config_host -u -x"-database-server-socket mySQLInstallDir/mysql.sock"

HP Output Server

45

Chapter 2

Attributes

-database-server-user

To set -database-server-socket on an individual server or group of servers when you create the server, use the config_server command. Any value set with config_server overrides a host-wide value set with config_host. config_server -t serverType -x"-database-server-socket mySQLInstallDir/mysql.sock" serverName CAUTION: If your MySQL connection is already configured and you want to change this attribute, you must first stop the HP Output Server servers and then shut down the MySQL server. For information about installing and configuring the MySQL server, see the Installation and Configuration Guide for HP Output Server.
Type Object Data Type Configuration Server Text

-database-server-user
The -database-server-user single-valued attribute specifies the user name HP Output Server uses to communicate with the MySQL server. The value of this attribute must be a user who has been granted full MySQL privileges. The -database-server-user is not required to be the same user who starts and owns the MySQL process. If this attribute is not set, its default value is root. To set -database-server-user for all HP Output Server servers in an HP Output Server domain, use the config_host command as follows: config_host -u -x"-database-server-user user" To set -database-server-user on an individual server or group of servers when you create the server, use the config_server command. Any value set with config_server overrides a host-wide value set with config_host. config_server -t serverType -x"-database-server-user user" serverName CAUTION: If your MySQL connection is already configured and you want to change this attribute, you must first stop the HP Output Server servers.

46

System Administrators Attribute Reference

Chapter 2

Attributes
-dazel-guest

For information about installing and configuring the MySQL server, see the Installation and Configuration Guide for HP Output Server.
Type Object Data Type Configuration Server Text

-dazel-guest
The -dazel-guest single-valued attribute specifies if jobs are submitted by users in the dazel_guest PM group. This attribute is set by the JQM and cannot be specified when delivering a job with the pdpr command.
Types Object Data Type Valid Values Control Job Boolean TRUE, true, FALSE, false, YES, yes, NO, no

-deliver-arguments
The -deliver-arguments multi-valued attribute passes the command line arguments to the -deliver-program attribute.
Types Object Data Type Configuration and Status Destination: Physical (External) Text

-deliver-document-arguments
The -deliver-document-arguments multi-valued attribute passes optional arguments to the program specified by the -deliver-program attribute. The -deliver-document-arguments attribute is associated with individual documents, and becomes useful when combined with conditional attribute replacement because it allows arguments to be associated with individual documents. The command

HP Output Server

47

Chapter 2

Attributes

-deliver-program

line format for invoking the external program resembles the following conditional attribute replacement example, where !{deliver-document-arguments}! defines arguments that apply to the documents doc1, doc2, and docn: !{deliver-program}! !{deliver-arguments}! !{deliver-document-arguments}! doc1 !{deliver-document-arguments}! doc2 !{deliver-document-arguments}! [...] !{deliver-document-arguments}! docn

Types Object Data Type

Configuration and Status Destination: Physical (External) Text

-deliver-program
The -deliver-program single-valued attribute names the program (an absolute path and file name) that submits a new job. Using an attribute variable substitution such as !{dazel-install-directory}! is allowed.
Types Object Data Type Configuration and Status Destination: Physical (External) Text

-depletion -depletion-default -depletions-supported

The -depletion single-valued attribute reduces the volume of ink used to print on the HP color deskjet 550c only. Note that reducing the ink volume diminishes the print quality. The -depletion-default single-valued attribute sets the default -depletion value. The -depletion-supported multi-valued attribute defines the list of valid values for the -depletion attribute.

48

System Administrators Attribute Reference

Chapter 2

Attributes
-descriptor

For a list of the -ghostscript-device printer drivers, see the -ghostscript-device attribute.
Type Objects Control -depletion: Document: PCL -depletion-default: Destinations: Logical, Physical (PCL) -depletions-supported: Destinations: Logical (PCL) Data Type Valid Values Integer (Positive) 1 (No depletion) 2 (25% depletion) 3 (50% depletion)

-descriptor
The value of the -descriptor single-valued attribute represents a user- or administrator-supplied description of the object. For physical destinations, the -descriptor attribute can identify the queue that feeds the physical destination and the logical destinations that map to it. For JQMs, the attribute can identify the list of logical destinations and queues that the JQM manages.
Types Objects Data Type Configuration, Control, and Status Server, Queue, Destinations (Logical, Physical) Text

-destination
The -destination single-valued attribute specifies the name of a logical destination or destinations to which a job is submitted. NOTE: The -printer and -destination attributes are synonymous. The values for this attribute cannot contain embedded spaces.
Type Object Status Job

HP Output Server

49

Chapter 2

Attributes

-destination-type

Data Type

Object name

-destination-type
The -destination-type single-valued attribute identifies the type of logical destination.
Types Objects Data Type Valid Values Configuration and Status Destination: Logical Identifier afp, digital-pager, distributor, file, ftp, g3-fax, jes, lpr, dwd, postscript-printer (used for both PostScript and PCL logical destinations), report-analyzer, smtp-e-mail, text-printer

-device-state
The -device-state single-valued attribute reports the current state of a device. The config-error value represents an HP Output Server configuration error, not a device error or problem. HP Output Server stores messages associated with device states in the -printer-message attribute.
Type Object Data Type Valid Values Status Destination: Physical Identifier idle, config-error, needs-attention, needs-key-operator, printing

-disabled
The -disabled single-valued attribute indicates if the object is disabled.
Types Objects Data Type Valid Values Configuration and Status Server, Queue, Destination Boolean TRUE, true, FALSE, false, YES, yes, NO, no

50

System Administrators Attribute Reference

Chapter 2

Attributes

-document-descriptor

-document-descriptor
The -document-descriptor single-valued attribute is synonymous with the -document-filename attribute.
Types Object Data Type Control and Status Document Text

-document-filename
The -document-filename single-valued attribute specifies the name of the file in the delivery request. If the attribute is not specified at job submission, it is set to the first file name in the delivery request.
Types Object Data Type Control and Status Document Text

-document-format
See the attribute description for -input-document-format.

-document-format-content-type
The -document-format-content-type multi-valued attribute maps an output document format to a MIME content type when sending e-mail in the MIME format. Each value of -document-format-content-type is a data structure that specifies an outputDocumentFormat and a contentString. The value of -document-format-content-type takes the following format: -document-format-content-type {outputDocumentFormat, contentString} Use the pdset command to set this attribute at a physical destination as follows: pdset -c d -x"-document-format-content-type {ps, application/ps}" physicalDestination

HP Output Server

51

Chapter 2

Attributes

-document-format-printer-language

If the physical destination already has the attribute set and you want to add an additional mapping, use the following syntax: pdset -c d -x"-+document-format-content-type {pdf, application/pdf}" physicalDestination To determine the appropriate content type of a document sent as an e-mail attachment, the following attributes are checked in the following order: -encoding-method -output-content-type -output-document-format (defined in the -document-format-content-type attribute) -input-content-type If the encoding method is binhex, the content type is set to application/mac-binhex40. If the encoding method is not set, each of the other attributes is considered one after another in the order listed above. If none of the attributes specify the content type, the content type is set to application/octet-stream. If you use an HP Output Server template to create an e-mail physical destination, the -output-document-format-default attribute for the destination is set to pdf and one of the values of -document-format-content-type is {pdf, application/pdf}. This means that e-mail attachments sent to this destination are automatically converted to pdf, unless you set the -input-document-format attribute to literal or the -output-document-format attribute to a value other than pdf.
Type Object Data Type Configuration and Status Destination: Physical Text

-document-format-printer-language
The -document-format-printer-language multi-valued attribute maps a document format to a specific printer language, such as PostScript or Printer Control Language (PCL).

52

System Administrators Attribute Reference

Chapter 2

Attributes

-document-sequence-number

Each value of -document-format-printer-language is a data structure that specifies an outputDocumentFormat and a printerLanguage according to the following syntax: -document-format-printer-language {outputDocumentFormat, printerLanguage} HP Output Server uses this attribute to send a PJL ENTER command to an output device. The ENTER command processes a job and tells the output device which printer language to use when processing the job. Use the pdset command to set this attribute at a physical destination as follows: pdset -c d -x"-document-format-printer-language {ps, POSTSCRIPT}" physicalDestination If the attribute is already set for a physical destination and you want to add an additional mapping, use the following command: pdset -c d -x"-+document-format-printer-language {pdf, POSTSCRIPT}" physicalDestination

Types Object Data Type

Configuration and Status Destination: Physical Text

-document-sequence-number
The -document-sequence-number single-valued attribute is the position of a document in a job. Document numbering begins at 1.
Type Object Data Type Status Job Integer (Positive)

HP Output Server

53

Chapter 2
-document-type

Attributes

-document-type
The -document-type single-valued attribute identifies the type of document. You use this attribute to distinguish printable documents from resource documents, such as fonts and overlays.
Types Object Data Type Valid Values Control and Status Document Identifier printable, font, other-resource, overlay

-dump
The -dump single-valued attribute is an argument used exclusively with the pdcontrol command to write a servers configuration or statistics to disk in a readable format. You may use the -dump attribute for upgrading from one version of HP Output Server to another or for examining a running servers database. For more information, see the pdcontrol command in the System Administrators Command Reference.
Types Objects Data Type Valid Values Control and Status Servers: CM, DLM, JQM, DSM, AIM, PM, and EM Text yes, device-task-stats, pdb-stats, queue-task-stats

-encoding-method -encoding-method-default -encoding-methods-supported

The -encoding-method single-valued attribute specifies the type of encoding (if any) to apply to documents delivered as e-mail attachments. The -encoding-method-default single-valued attribute specifies the default type of encoding (if any) to apply to documents delivered as e-mail attachments. You can override this setting with the -encoding-method job attribute.

54

System Administrators Attribute Reference

Chapter 2

Attributes
-end-sheet

The -encoding-methods-supported multi-valued attribute lists valid values for the -encoding-method attribute.
Types Objects Control and Status -encoding-method: Job: E-mail -encoding-method-default: Destinations: Physical, Logical (E-mail) -encoding-methods-supported: Destination: Logical (E-mail) Data Type Valid Values Identifier base64, uuencode, binhex, none

-end-sheet -end-sheet-default -end-sheets-supported

The -end-sheet single-valued attribute specifies the type of end sheet for a job. The -end-sheet-default single-valued attribute specifies the default type of end sheet to use for a job if the -end-sheet attribute is undefined. The -end-sheets-supported multi-valued attribute lists the types of end sheets that are supported.
Types -end-sheet: Control and Status -end-sheet-default: Configuration and Status -end-sheets-supported: Configuration and Status Object -end-sheet: Job -end-sheet-default: Destinations: Logical, Physical -end-sheets-supported: Destination: Logical Data Type Valid Values Identifier none, blank, full, brief

HP Output Server

55

Chapter 2

Attributes

-end-sheet-type-format

-end-sheet-type-format
The -end-sheet-type-format single-valued attribute specifies the -end-sheet document format. The type is blank, brief, full, none, or retry. NOTE: HP Output Server can perform attribute replacement in the sheets only if the attribute syntax is in clear text in the file. For more information on document formats, see the -input-document-format attribute.
Types Object Data Type Valid Values Configuration and Status Destination: Physical Identifier afp, hp-pcl, html, iso-6429, literal, PDF, pdf, PS, ps, TEXT, text, webviewable

-end-sheet-type-format-variants
The -end-sheet-type-format-variants multi-valued attribute defines the -end-sheet document format variant. The type is blank, brief, full, none or retry. For more information, see the -end-sheet-type-format attribute. The lf-implies-cr value is the default that applies only if the -input-document-format attribute is set to text. See also the -input-document-format-variants attribute.
Types Object Data Type Control and Status Destination: Physical Identifier

56

System Administrators Attribute Reference

Chapter 2

Attributes

-end-sheet-type-format-version

Valid Values

PS variants: PS-L1, ps-l1, PS-L2, ps-l2, PS-DSC1, ps-dsc1, PS-DSC2, ps-dsc2, PS-DSC3, ps-dsc3 iso-6429 (text) variants: simple-text, ht, lf-implies-cr (default), cr-implies-lf, cr-overstrike, bs-overstrike, iso-10538-pif-level1, iso-10538-pif-level2, iso-10538-pif-level3, iso-10538-pif-level4, iso-10538, fft-level1v, iso-10538, fft-level2, iso-10538, fft-level2a, iso-10538, fft-level2b, iso-10538 hp-pcl variants: hp-pcl1, hp-pcl2, hp-pcl3, hp-pcl4, hp-pcl5 html variant: html-32 Other variants: ppds-level1, ppds-level2, ppds-level3, fft-level2c, sgr-underline-bold, dec-pp12, dec-pp13, line-ansi-cc, line-machine-cc, line-trc, line-sosil, line-sosi2, line-sosi3, modca-isl, modca-pt1, modca-dr2, modca-dr3, modca-fs10, modca-fs20, modca-bcdl, modca-iml, scs-sosi1, SCS-sosi1, scs-sosi2, SCS-sosi2, scs-sosi3, SCS-sosi3, BINARY, binary, CLEARTEXT, cleartext, asterx-wp, applix-wp, asterx-gr, applix-gr, asterx-ss, applix-ss

-end-sheet-type-format-version
The -end-sheet-type-format-version single-valued attribute defines the variant-independent -end-sheet document format version. The type is blank, brief, full, none, or retry. For more information, see the -end-sheet-type-format attribute.
Types Object Data Type Control and Status Document Text

-end-sheet-type-path
The -end-sheet-type-path single-valued attribute specifies the absolute path and file name of an end sheet. The type is blank, brief, full, none, or retry. The retry start sheet overrides other job sheet types when a job has a -number-of-times-tried value of 1 or greater.

HP Output Server

57

Chapter 2
-event-client

Attributes

To set the -end-sheet-type-path for a physical destination, type the following command: pdset -c d -x"-end-sheet-type-path endSheetFilePath -end-sheet-type-format format" destination

Types Object Data Type

Configuration and Status Destination: Physical Text

-event-client -event-date -event-identifier -event-message -event-server -event-time

The -event* single-valued attributes provide information that can be useful for formatting accounting records. The delivery descriptor of an accounting profile defines the format of the accounting record by specifying attributes in special spaced sequences. The accounting profile eventually replaces these spaced sequences with appropriate values. These generic attributes provide more detailed formatting of the accounting records. In addition, the -event-identifier and -event-message attributes can be used by an external program to communicate an event to an external physical printer. In the example, sending the following information on the printer fifo causes the appropriate notification to be generated: "-event-identifier warning-resource-needs-operator -event-message \"out of paper\""

Types Objects

Configuration and Status Servers: All

58

System Administrators Attribute Reference

Chapter 2

Attributes

-extended-features

Data Type

-event-identifier: Identifier -event-time: Integer -event-date: Time -event-server: Text -event-client: Text -event-message: Message

-extended-features -extended-features-default
The -extended-features multi-valued attribute contains XML fragments describing features that HP Output Server has not converted into its own attribute-value pairs. An advanced printer may offer a feature (in its capabilities ticket) that has no corresponding HP Output Server attribute. To access the feature through HP Output Server, the -extended-features attribute can be set with job deliveries using pdpr. You can also use pdset to set the -extended-features-default attribute at the logical or physical destination. The value of -extended-features is an XML fragment that describes the desired feature and its value from the destinations capabilities ticket. NOTE: Setting -extended-features requires knowledge of XML and familiarity with the physical destinations capabilities ticket. To use this attribute, contact your Professional Services representative.
Type -extended-features: Control -extended-features-default: Configuration and Status Objects -extended-features: Document -extended-features-default: Destinations: Logical, Physical Data Type Text

-failed-job-retention-period -failed-job-retention-period-default
The -failed-job-retention-period single-valued attribute specifies the amount of time that a failed job is retained. If this attribute is not specified, the retention period for the job is defined by the -job-retention-period attribute. To set the

HP Output Server

59

Chapter 2
-fax-class

Attributes

-failed-job-retention-period attribute and override any existing value for the -failed-job-retention-period-default attribute, type the following command: pdpr -d ps -x"-failed-job-retention-period minutes" fileName The -failed-job-retention-period-default single-valued attribute specifies the default period if -failed-job-retention-period is not set. To set the -failed-job-retention-period-default attribute, type the following command: pdset -c d -x"-failed-job-retention-period-default minutes" logicalDestination

Types Objects

Control -failed-job-retention-period: Job -failed-job-retention-period-default: Destination: Logical

Data Type

Time (minutes)

-fax-class -fax-class-default -fax-classes-supported

The -fax-class single-valued attribute sets the fax class for modems that support more than one faxing class. If neither the -fax-class nor the -fax-class-default attribute is set, the DSM selects the highest fax class level supported by the modem. The -fax-class-default single-valued attribute sets the default fax class for modems that support more than one faxing class. The -fax-classes-supported multi-valued attribute specifies the fax classes supported by the logical destination.
Types -fax-class: Control and Status -fax-class-default: Configuration and Status -fax-classes-supported: Configuration and Status

60

System Administrators Attribute Reference

Chapter 2

Attributes

-fax-comments

Objects

-fax-class: Job: Fax -fax-class-default: Destinations: Logical, Physical (Fax) -fax-classes-supported: Destination: Logical

Data Type Valid Values

Identifier unknown, 1, 2, 2-0 NOTE: 2-0 is greater than 2.

-fax-comments
The -fax-comments multi-valued attribute adds information to a fax cover sheet. This attribute can contain one or more values, each representing a line of a comment. Each value is limited to a maximum size of 127 characters.
Types Object Data Type Control and Status Job Text

-fax-copy-count
The -fax-copy-count single-valued attribute sets the number of document copies for a fax delivery request. The default is 1.
Types Object Data Type Control and Status Document Integer (0, Positive)

-fax-footer-text -fax-footer-text-default
The -fax-footer-text multi-valued attribute specifies the text to print at the bottom of each page of a fax. You can specify text to print at the left margin of the page footer, in the center of the page footer, or at the right margin of the page footer. You must specify text to print or an empty string at the left margin of the page footer. The -fax-footer-text-default multi-valued attribute assigns a default running footer to print at the bottom of a fax page if the -fax-footer-text attribute is not specified with the job.

HP Output Server

61

Chapter 2

Attributes

-fax-footer-text-default

The following example illustrates the syntax of the -fax-footer-text attribute. The position of each argument corresponds to its location in the page footer (left, center, or right). The left square bracket ([) and right square bracket (]) characters delimit optional arguments and the combination of a comma and a space separates arguments: argument[, argument][, argument] If you specify one argument, the value of that argument is displayed in the left location in the page footer. If you specify two arguments, the value of the first argument is displayed in the left location and the value of the second argument is displayed in the center location in the page footer. If you specify three arguments, the values are displayed in the left, center, and right locations in the page footer, respectively. To display no text in the left, center, or right locations in a page footer, specify an argument with an escaped pair of quotation marks. -fax-footer-text \"\" If an argument contains non-alphanumeric characters such as an attribute variable or a space, delimit the argument with quotation marks. You can specify attribute variables in page footer arguments. The DSM replaces attribute variables with the value of the specified attribute. You can specify a font with the -fax-header-footer-font attribute. You can specify the size of a font with the -fax-header-footer-font-size attribute. If you specify the -fax-footer-text attribute, a blank rectangle prints below the page image to ensure that the footer is readable. The page footer may obscure text on faxes with information close to the bottom of the page. In the following example, the value of the -fax-to-person attribute appears at the left margin of the page footer, the value of the -started-printing-time attribute appears in the center of the page footer, and the value of the -fax-page-number attribute and the -job-page-count attribute appear at the right margin of the page footer (separated by a slash): -fax-footer-text \"!{fax-to-person}!\", \"!{started-printing-time}!\", \"!{fax-page-number}!/!{job-page-count}!\"

Types

-fax-footer-text: Control and Status -fax-footer-text-default: Configuration and Status

Objects

-fax-footer-text: Job -fax-footer-text-default: Destination: Logical, Physical (Fax)

62

System Administrators Attribute Reference

Chapter 2

Attributes

-fax-from-extension

Data Type

Text

-fax-from-extension
The -fax-from-extension single-valued attribute defines the voice phone number of the person transmitting the fax. This number can be used on the fax cover sheet.
Types Object Data Type Control and Status Job Text

-fax-from-person
The -fax-from-person single-valued attribute names the person transmitting the fax. This name can be used on the fax cover sheet.
Types Object Data Type Control and Status Job Text

-fax-header-footer-character-set
The -fax-header-footer-character-set single-valued attribute defines the character set for fax headers and footers. The default value is iso-latin-1.
Types Object Data Type Valid Values Configuration and Status Job Identifier ascii, iso-latin-1

HP Output Server

63

Chapter 2

Attributes

-fax-header-footer-font

-fax-header-footer-font
The -fax-header-footer-font single-valued attribute defines the font for fax headers and footers. All input to fax physical destinations must be able to be transformed to PostScript format. Only PostScript fonts are valid.
Types Object Data Type Valid Values Configuration and Status Destination: Physical (Fax) Text The valid values vary according to the printer. Refer to the documentation for the specific device.

-fax-header-footer-font-size
The -fax-header-footer-font-size single-valued attribute defines the font size (in points) for fax headers and footers.
Types Object Data Type Configuration and Status Destination: Physical (Fax) Integer (Positive)

-fax-header-text -fax-header-text-default
The -fax-header-text multi-valued attribute specifies the text to print at the top of each page of a fax. You can specify text to print at the left margin of the page header, in the center of the page header, or at the right margin of the page header. You must specify text to print, or an empty string, at the left margin of the page header. The -fax-header-text-default multi-valued attribute assigns a default running header to print at the top of a fax page if the -fax-header-text attribute is not specified with the job. The following example illustrates the syntax of the -fax-header-text attribute. The position of each argument corresponds to its location in the page header (left, center, or right). The left square bracket ([) and right square bracket (]) characters delimit optional arguments and the combination of a comma and a space separates arguments: argument[, argument][, argument]

64

System Administrators Attribute Reference

Chapter 2

Attributes

-fax-header-text-default

If you specify one argument, the value of that argument is displayed in the left location in the page header. If you specify two arguments, the value of the first argument is displayed in the left location and the value of the second argument is displayed in the center location in the page header. If you specify three arguments, the values are displayed in the left, center, and right locations in the page header, respectively. To display no text in the left, center, or right locations in a page header, specify an argument with an escaped pair of quotation marks. -fax-header-text \"\" If an argument contains non-alphanumeric characters such as an attribute variable or a space, delimit the argument with quotation marks. You can specify attribute variables in page header arguments. The DSM replaces attribute variables with the value of the specified attribute. You can specify a font with the -fax-header-footer-font attribute. You can specify the size of a font with the -fax-header-footer-font-size attribute. If you specify the -fax-header-text attribute, a blank rectangle prints above the page image to ensure that the footer is readable. The page header may obscure text on faxes with information close to the top of the page. In the following example, the value of the -fax-to-person attribute appears at the left margin of the page header, the value of the -started-printing-time attribute appears in the center of the page header, and the value of the -fax-page-number attribute and the -job-page-count attribute appear at the right margin of the page header (separated by a slash): -fax-header-text \"!{fax-to-person}!\", \"!{started-printing-time}!\", \"!{fax-page-number}!/!{job-page-count}!\"

Types

-fax-header-text: Control and Status -fax-header-text-default: Configuration and Status

Objects

-fax-header-text: Job -fax-header-text-default: Destinations: Physical, Logical (Fax)

Data Type

Text

HP Output Server

65

Chapter 2

Attributes

-fax-no-page-count

-fax-no-page-count -fax-no-page-count-default
The -fax-no-page-count single-valued attribute enables or disables page counting. By default (false), the DSM processes each fax document one time to count the number of pages, then reprocesses them for transmission. If you turn off page counting, job throughput improves, but headers and footers cannot display the total number of pages in the job and in documents. The -fax-no-page-count-default single-valued attribute sets the default value for the -fax-no-page-count attribute.
Types Object Control and Status -fax-no-page-count: Job -fax-no-page-count-default: Destinations: Physical, Logical (Fax) Data Type Valid Values Boolean TRUE, true, FALSE, false, YES, yes, NO, no

-fax-page-number
The -fax-page-number attribute is valid only within the context of the attribute variable !{fax-page-number}!. Its value is the number of the processing page and should be used only within a fax header or footer. For more information, see the -fax-header-text attribute.
Types Object Control and Status Job

-fax-phone-number -fax-phone-number-default -fax-phone-numbers-supported

The -fax-phone-number multi-valued attribute specifies the telephone number of the receiving fax machine. You can include a PBX or long-distance access prefix (such as 1 800 nnn nnnn or 9 1 010 nnn nnnn) with the telephone number. The number format depends on modem requirements, but dash-separated or space-separated strings are usually acceptable.

66

System Administrators Attribute Reference

Chapter 2

Attributes

-fax-phone-numbers-supported

The -fax-phone-number-default single-valued attribute specifies the default telephone number of the receiving fax machine. Include PBX and/or long-distance access prefixes, such as 1 800 nnn nnnn or 9 1 010 nnn nnnn. The -fax-phone-numbers-supported multi-valued attribute specifies the list of supported telephone numbers of receiving fax machines. Include PBX and/or long-distance access prefixes, such as 1 800 nnn nnnn or 9 1 010 nnn nnnn. NOTE: If you use !{fax-phone-number}! with your personal dialing code (such as a Sprint or MCI number) before the fax number, your personal dialing code appears on the cover sheet. You can also use the following destination attributes to specify prefix and suffix numbers. Setting one of these attributes on a destination appends the value to jobs sent to that destination. -fax-phone-number-prefix -fax-phone-number-long-distance-prefix -fax-phone-number-suffix NOTE: Specify prefix and suffix numbers with -fax-phone-number or the *-prefix and *-suffix attributes, not both. If you set a prefix/suffix with both attributes, the prefix/suffix will be set twice, causing an error to occur. You can use the following two methods to represent phone numbers for fax destinations: Specify phone numbers with -modem-phone-number and its related attributes. Specify phone numbers with -fax-phone-number and its related attributes.

For more information about representing phone numbers for fax destinations, see the System Administrators Guide for HP Output Server.
Types -fax-phone-number: Configuration, Control, and Status -fax-phone-number-default: Configuration and Status -fax-phone-numbers-supported: Configuration and Status

HP Output Server

67

Chapter 2

Attributes

-fax-phone-number-long-distance-prefix

Objects

-fax-phone-number: Destination: Job -fax-phone-number-default: Destinations: Logical, Physical (Fax) -fax-phone-numbers-supported: Destination: Logical (Fax)

Data Type

Text

-fax-phone-number-long-distance-prefix
The -fax-phone-number-long-distance-prefix single-valued attribute specifies the sequence of numbers that must precede long distance calls. This attribute is set by the HP Output Server system administrator. NOTE: This attribute applies only when -fax-phone-number contains exactly ten digits, such as for U.S. and Canadian long-distance calls. For example, to configure the fax physical destination fax1 to dial 1 before applying any -fax-phone-number with ten digits, type the following command: pdset -c d -x"-fax-phone-number-long-distance-prefix \"1\"" fax1

Types Object Data Type

Configuration Destination: Physical (Fax) Text

-fax-phone-number-prefix
The -fax-phone-number-prefix single-valued attribute specifies a sequence of numbers to dial before the destination phone number, such as 9 to access an outside line. This attribute is set by the HP Output Server system administrator. NOTE: All number sequences that end in a comma must also have a space after the comma.

68

System Administrators Attribute Reference

Chapter 2

Attributes

-fax-phone-number-suffix

For example, to configure the fax physical destination fax1 to dial a 9 before it dials a destinations phone number, type the following command: pdset -c d -x"-fax-phone-number-prefix \"9, \"" fax1

Type Object Data Type

Configuration Destination: Physical (Fax) Text

-fax-phone-number-suffix
The -fax-phone-number-suffix single-valued attribute specifies a number to add to the end of the destination faxs phone number, such as when access codes are necessary. For example, to configure the fax physical destination fax1 to dial the access code 953 before it dials a destinations phone number, type the following command: pdset -c d -x"-fax-phone-number-suffix \"953\"" fax1

Types Object Data Type

Configuration Destination: Physical (Fax) Text

-fax-serialize-conversion
The -fax-serialize-conversion single-valued attribute specifies when to contact the remote fax destination: at the same time that documents begin converting to G3 fax format, or after the conversion is complete. When set to false (the default for all operating systems except HP/UX), contact is attempted with the remote fax destination at the same time that the document begins converting to G3 fax format. When set to true (the HP/UX default), the remote fax is contacted after the document converts to G3 fax format. To configure the fax physical destination fax1 to contact the remote fax machine after the document completes converting, type the following command: pdset -c d -x"-fax-serialize-conversion true" fax1

HP Output Server

69

Chapter 2
-fax-station-id

Attributes

Types Object Data Type Valid Values

Configuration Destination: Physical (Fax) Boolean TRUE, true, FALSE, false, YES, yes, NO, no

-fax-station-id
The -fax-station-id single-valued attribute specifies an identification string that is displayed on appropriately equipped fax machines when they receive the fax. The -fax-station-id is a string of up to 20 characters in the ASCII range from 20 to 7E (alphanumeric characters, spaces, and !"#$%&()*+,-.//:;<=>?@[\]^_{|}~). To include the value in other fax attribute text strings, use !{fax-station-id}!. If the -fax-station-id is longer than the display, characters are truncated from the left.
Types Object Data Type Configuration and Status Destination: Physical (Fax) Text

-fax-subject
The -fax-subject single-valued attribute specifies the subject of a fax, and can be printed on the fax cover sheet.
Types Object Data Type Control and Status Job Text

-fax-to-company
The -fax-to-company single-valued attribute specifies the fax recipients company. The value of this attribute can be printed on the fax cover sheet.
Types Control and Status

70

System Administrators Attribute Reference

Chapter 2

Attributes
-fax-to-person

Object Data Type

Job Text

-fax-to-person
The -fax-to-person single-valued attribute specifies the name of the recipient of the fax, and can be printed on the fax cover sheet.
Types Object Data Type Control and Status Job Text

-fax-to-voice-phone
The -fax-to-voice-phone single-valued attribute specifies the voice phone number of the fax recipient, and can be printed on the fax cover sheet.
Types Object Data Type Control and Status Job Text

-fifo-directory
The -fifo-directory single-valued attribute is the absolute path of the directory in which named pipes are created for communication between an external physical destination and an external agent. Using an attribute variable substitution such as !{dazel-install-directory}! is allowed. The -fifo-directory attribute must be defined before the DSM is started.
Types Object Data Type Configuration and Status Destination: Physical (External) Text

HP Output Server

71

Chapter 2

Attributes

-fifo-permissions

-fifo-permissions
The -fifo-permissions single-valued attribute specifies the permissions to use when creating a named pipe destination or queue. The default is 0600. The default value allows an external agent to write to a named pipe or queue if it has the same user ID as the DSM that manages the external device. NOTE: The -fifo-permissions attribute applies to UNIX only.
Types Object Data Type Configuration and Status Destination: Physical (External) Text (in octal format)

-file-base-directory
The -file-base-directory single-valued attribute specifies the absolute path of the base directory to which files are delivered. Using an attribute variable substitution such as !{dazel-install-directory}! is allowed. This attribute allows you to control the part of a file that an HP Output Server client can access through a file destination.
Types Object Data Type Configuration and Status Destination: Physical (File) Text

-file-directory -file-directory-default -file-directories-supported

The -file-directory single-valued attribute specifies the relative path of the subdirectory to which files are delivered. This subdirectory path is relative to the setting of the -file-base-directory attribute. It can include attribute variables. The -file-directory-default single-valued attribute specifies the directory to use if you have not specified the -file-directory job attribute. It can include attribute variables.

72

System Administrators Attribute Reference

Chapter 2

Attributes

-file-directory-permissions

The -file-directories-supported multi-valued attribute lists valid entries for the -file-directory job attribute. Jobs submitted with a -file-directory value not listed in the -file-directories-supported attribute are rejected.
Types -file-directory: Control and Status -file-directory-default: Configuration and Status -file-directories-supported: Configuration and Status Objects -file-directory: Document -file-directory-default: Destinations: Logical, Physical (File) -file-directories-supported: Destination: Logical (File) Data Type Text

-file-directory-permissions
The -file-directory-permissions single-valued attribute specifies the permissions value of the -file-base-directory attribute when it is created. The default is 777.
Types Object Data Type Configuration and Status Destination: Physical (File) Text (in octal format)

-file-filename -file-filename-default -file-filenames-supported

The -file-filename single-valued attribute specifies the file name of documents delivered to file destinations. The file name can include attribute variables such as!{job-name}!. The -file-filename-default single-valued attribute specifies the default file name of documents delivered to file destinations.

HP Output Server

73

Chapter 2
-file-overwrite

Attributes

The -file-filenames-supported multi-valued attribute lists valid entries for the -file-filename job attribute. Jobs are rejected if you submit them with a -file-filename value not listed in the valid values of the -file-filenames-supported attribute.
Types -file-filename: Control and Status -file-filename-default: Configuration and Status -file-filenames-supported: Configuration and Status Objects -file-filename: Document -file-filename-default: Destinations: Logical, Physical (File) -file-filenames-supported: Destination: Logical (File) Data Type Text

-file-overwrite -file-overwrite-default
The -file-overwrite single-valued attribute specifies if an existing file is overwritten. If the value is true (or equivalent) and the destination file exists, the file is replaced. If the value is false and the destination file exists, job delivery fails. If a destination file does not exist, one is created whether the value is true or false. This attribute overrides the -file-overwrite-default attribute. The -file-overwrite-default single-valued attribute applies if no value is set for the -file-overwrite job attribute.
Types Objects Configuration and Status -file-overwrite: Document -file-overwrite-default: Destinations: Logical, Physical Data Type Valid Values Boolean TRUE, true, FALSE, false, YES, yes, NO, no

-file-permissions -file-permissions-default
The -file-permissions single-valued attribute sets the permissions for documents.

74

System Administrators Attribute Reference

Chapter 2

Attributes

-file-permissions-mask

The -file-permissions-default single-valued attribute sets the default permissions for documents if -file-permissions is not set at the job. UNIX uses an octal representation for file permissions (the same permissions that the chmod(1) command uses). For example, a setting of 644 for the -file-permissions attribute allows read and write permission to the file owner, but only read permission for the group and others. Windows uses the same octal representation, but only the owner-write-bit (bit 7, octal 200) has any effect. If the owner-write-bit is set, the file is created with read and write permission. If the owner-write-bit is not set, the file is created with read-only permission.
Types Object Configuration and Status -files-permissions: Document -files-permissions-default: Destinations: Logical, Physical Data Type Text (in octal format)

-file-permissions-mask
The -file-permissions-mask single-valued attribute specifies a permissions value in octal format. The default is 666. The -file-permissions-mask is bitwise-ANDed with -file-permissions to give the actual file permissions value. For example, if -file-permissions-mask is 770 and -file-permissions is 644, the destination file is created with permissions 640 (770 & 644), namely, rw-r-----. On Windows, the bitwise AND is performed between the -file-permissions and -file-permissions-mask attributes, but the same permissions restrictions apply as those belonging to the -file-permissions attribute. Only bit 7 of the resulting permissions is used to determine if the file will be read/write or read-only.
Types Object Data Type Configuration and Status Destination: Physical Text (in octal format)

HP Output Server

75

Chapter 2

Attributes

-file-transfer-by-link

-file-transfer-by-link
The -file-transfer-by-link single-valued attribute creates a hard link to a file when you print to HP Output Server.
Type Object Data Type Valid Values Control Destination: Physical Boolean TRUE, true, FALSE, false, YES, yes, NO, no

-file-transfer-retry-count -file-transfer-retry-count-default
The -file-transfer-retry-count single-valued job attribute defines the number of attempts to make to transfer a file to a JQM if the DLM fails in its first attempt. Use this attribute with -file-transfer-retry-interval to instruct the DLM to wait the specified number of seconds between retries. If neither attribute is set, the DLM makes one attempt to transfer a file. If a retry count is set but the interval is not, the DLM does not wait between retries. If only the interval is set but the retry count is not, the DLM makes one attempt to transfer job files. The -file-transfer-retry-count-default single-valued server attribute defines the default count.
Type Objects Control -file-transfer-retry-count: Job -file-transfer-retry-count-default: Server (DLM) Data Type Integer (Positive)

-file-transfer-retry-interval -file-transfer-retry-interval-default
The -file-transfer-retry-interval single-valued job attribute defines the number of seconds to wait between file transfer retry attempts. Use this attribute with -file-transfer-retry-count to instruct the DLM to wait the specified number of seconds between retries. If neither attribute is set, the DLM makes one attempt to transfer a file. If a retry count is set but the interval is not, the DLM does not wait between retries. If only the interval is set but the retry count is not, the DLM makes one attempt to transfer job files.

76

System Administrators Attribute Reference

Chapter 2

Attributes
-floor

The -file-transfer-retry-interval-default single-valued server attribute defines the default interval.

Type Objects Control -file-transfer-retry-interval: Job -file-transfer-retry-interval-default: Server (DLM) Data Type Integer (Seconds)

-floor
The -floor single-valued attribute sets location information for a logical destination. If you do not type values for location attributes (-organization, -city, -building, -floor) when you create a logical destination, you can use pdset to insert these values in the record. The values for this attribute cannot contain embedded spaces.
Types Object Data Type Configuration and Status Destination: Logical Text

-fold -fold-default -fold-supported

The -fold single-valued attribute specifies the folding and binding to be applied to the print job. NOTE: The -fold attribute applies to advanced printers only. For more information about advanced printers and advanced delivery pathways, see the System Administrators Guide for HP Output Server. The -fold-default single-valued attribute specifies the default folding and binding if -fold is not set at the job.

HP Output Server

77

Chapter 2
-font-directories

Attributes

The -fold-supported multi-valued attribute specifies the supported values for the -fold attribute.
Types -fold: Control and Status -fold-default: Configuration -fold-supported: Configuration Objects -fold: Job -fold-default: Destination: Logical and Physical -fold-supported: Destination: Logical Data Type Valid Values Text none halffoldinward halffoldinwardtrim The sheets are not folded. The sheets are folded in half with the job printed inside the fold. The sheets are folded in half with the job printed inside the fold. After being folded, the sheets are trimmed. The sheets are folded in half with the job printed outside the fold. The sheets are folded in thirds with the job printed inside the fold. The sheets are folded in thirds with the job printed outside the fold. The sheets are folded in half and stapled to form a booklet. The sheets are folded in thirds, accordion style.

halffoldoutward trifoldinward trifoldoutward foldandstitch zfold

-font-directories
The -font-directories multi-valued attribute specifies the absolute directory location of fonts for PostScript conversions. For more information, see the -ps-init-directories attribute.
Types Object Configuration and Status Destination: Physical (PS, PCL, Text, Fax, E-mail)

78

System Administrators Attribute Reference

Chapter 2

Attributes
-footer-text

Data Type

Text

-footer-text -footer-text-default
The -footer-text multi-valued attribute specifies the text to print at the bottom of each page of a text document. The -footer-text-default multi-valued attribute supplies a footer for text documents for which no footer has been specified with the -footer-text attribute. NOTE: The -footer-text and -header-text attributes apply only to text documents. You can specify text to print at the left margin of the page footer, in the center of the page footer, or at the right margin of the page footer. You must specify text to print or an empty string at the left margin of the page footer. The following example illustrates the syntax of the -footer-text attribute. The position of each argument corresponds to its location in the page footer (left, center, or right). The left square bracket ([) and right square bracket (]) characters delimit optional arguments and the combination of a comma and a space separates arguments: argument[, argument][, argument] If you specify one argument, the value of that argument is displayed in the left location in the page footer. If you specify two arguments, the value of the first argument is displayed in the left location and the value of the second argument is displayed in the center location in the page footer. If you specify three arguments, the values are displayed in the left, center, and right locations in the page footer, respectively. To display no text in the left, center, or right locations in a page footer, specify an argument with an escaped pair of quotation marks as in the following example: -footer-text \"\" If an argument contains non-alphanumeric characters, for example, an attribute variable or a space, delimit the argument with quotation marks. You can specify attribute variables in page footer arguments. The DSM replaces attribute variables with the value of the specified attribute.

HP Output Server

79

Chapter 2
-force

Attributes

For text documents sent to fax destinations, do not set any value for the -footer-text attribute; also, set an empty value for the -footer-text-default attribute. Setting non-empty -footer-text-default and -footer-text values for text documents sent to fax destinations may cause unwanted multiple footers to appear on faxes. The following example defines a footer with Chapter One appearing on the far left and Destinations appearing on the far right. -footer-text \"Chapter One\", \"\", Destinations The following is an example of the syntax for -footer-text-default: -footer-text-default \"\", \"Page !{page-number}!\", \"!{job-name}!\"

Types

-footer-text: Control and Status -footer-text-default: Configuration and Status

Objects

-footer-text: Document: Text -footer-text-default: Destinations: Logical, Physical

Data Type

Text

-force
The -force single-valued attribute forces the re-creation of an existing object. If you attempt to recreate an existing object without setting -force to true, you will see an error. Consider the following example, in which an existing queue, queue1, created with the batch_queue_template, is recreated with the fifo_queue_template. This command changes the queue to use the FIFO scheduling method. pdcreate -c queue -x"-force true -copy-from fifo_queue_template -managing-server jqm1" queue1

Type Objects Data Type

Control All Objects (except servers) Boolean

80

System Administrators Attribute Reference

Chapter 2

Attributes

-form-description

Valid Values

TRUE, true, FALSE, false, YES, yes, NO, no

-form-description
The -form-description single-valued attribute describes the form.
Type Object Data Type Control Form Text

-form-feed -form-feed-default
The -form-feed single-valued attribute specifies if a form-feed character is added to the end of each copy of a PostScript document that is delivered to a text destination. If the value is true (the default), HP Output Server adds a form-feed character to the end of each copy. If the value is false, HP Output Server does not add a form-feed character to the end of each copy. The -form-feed-default single-valued attribute specifies a default -form-feed value at the logical destination.
Types -form-feed: Control -form-feed-default: Configuration Objects -form-feed: Document -form-feed-default: Destination: Logical Data Type Valid Values Boolean TRUE, true, FALSE, false, YES, yes, NO, no

HP Output Server

81

Chapter 2
-form-file

Attributes

-form-file
The -form-file single-valued attribute specifies the relative file name of the TIFF or encapsulated PostScript (EPS) file that contains the form data. For more information, see the -form-path attribute. NOTE: EPS files cannot contain bitmapped images.
Type Object Data Type Control Form Text

-form-name
The -form-name single-valued attribute specifies the symbolic name of the form. When you specify a form to apply to a document, the symbolic name of the form is used as a parameter to the -forms attribute. The values for this attribute cannot contain embedded spaces.
Type Object Data Type Control Form Text

-form-path
The -form-path single-valued attribute specifies one or more absolute path names to search for forms to apply to the document. Using an attribute variable substitution such as !{dazel-install-directory}! is allowed. For UNIX, separate multiple path names with a colon (:). For Windows, separate multiple path names with a semicolon (;). The form overlay production cannot use a form file that resides on a mapped network drive. The form file must reside on the local drive.
Type Object Data Type Control Form Text

82

System Administrators Attribute Reference

Chapter 2

Attributes
-form-type

-form-type
The -form-type single-valued attribute specifies the document format of the form. For more information, see the -input-document-format attribute. NOTE: EPS files cannot contain bitmapped images.
Type Object Data Type Valid Values Control Form Identifier ps, PS, tiff, TIFF

-form-x-scaling
The -form-x-scaling single-valued attribute specifies a horizontal scaling factor to apply to the form. For example, if the value is 0.5, the image is reduced by one-half along the horizontal axis.
Type Object Data Type Control Form Real

-form-y-scaling
The -form-y-scaling single-valued attribute specifies a vertical scaling factor to apply to the form. For example, if the value is 0.5, the image is reduced by one-half along the vertical axis.
Type Object Data Type Control Form Real

HP Output Server

83

Chapter 2

Attributes

-form-x-translation

-form-x-translation
The -form-x-translation single-valued attribute specifies the positive or negative horizontal offset in points. (A point is approximately 1/72 of an inch.)
Type Object Data Type Control Form Integer

-form-y-translation
The -form-y-translation single-valued attribute specifies the positive or negative vertical offset in points. (A point is approximately 1/72 of an inch.)
Type Object Data Type Control Form Integer

-forms
The -forms multi-valued attribute contains the names of all forms to apply to a document and the page numbers on which to apply them. The form must be specified. The values for form cannot contain embedded spaces. The form is followed by a space and the page range and/or interval. Ranges are expressed by startingPageNumber-endingPageNumber. An increment specifies the number of pages between pages to which the form is applied. The syntax for -forms follows: -forms form startingPage-endingPage+increment For example, if a form named purchase_order applies to pages one through five of a document, specify it as follows: -forms purchase_order 1-5 It is also possible to apply the form incrementally. In other words, you can apply a form to every other page, or every three pages, or at whichever interval you prefer. You can also specify a page range, followed by an increment that only applies within the page range. The following example applies the form to the first page, and every following second page (1, 3, 5, ...): -forms purchase_order 1+2

84

System Administrators Attribute Reference

Chapter 2

Attributes
-ftp-account

To specify multiple forms, separate each form/range set with a comma, as in the following example: -forms purchase_order 1+2,office_memo 1-5

Types Object Data Type

Control and Status Document Text

-ftp-account -ftp-account-default -ftp-accounts-supported

The -ftp-account single-valued attribute specifies the account with which the DSM logs into -ftp-host. The -ftp-account single-valued attribute specifies the default account to use while logging in to an FTP server. The -ftp-accounts-supported attribute specifies valid values for the -ftp-account attribute. NOTE: These attributes are not the same as the FTP user ID. For more information, see the -ftp-user attribute.
Types Object Configuration and Status -ftp-account: Job -ftp-account-default: Destinations: Logical, Physical (FTP) -ftp-accounts-supported: Destination: Logical (FTP) Data Type Text

-ftp-directory -ftp-directory-default -ftp-directories-supported

The -ftp-directory single-valued attribute specifies the directory on -ftp-host in which to put documents. This attribute can include attribute variables.

HP Output Server

85

Chapter 2
-ftp-filename

Attributes

The -ftp-directory-default single-valued attribute specifies the default directory on -ftp-host. The -ftp-directories-supported multi-valued attribute specifies valid -ftp-directory values.
Types -ftp-directory: Control and Status -ftp-directory-default: Configuration and Status -ftp-directories-supported: Configuration and Status Objects -ftp-directory: Document: FTP -ftp-directory-default: Destinations: Logical, Physical (FTP) -ftp-directories-supported: Destination: Logical (FTP) Data Type Text

-ftp-filename -ftp-filename-default -ftp-filenames-supported

The -ftp-filename single-valued attribute specifies the document file name delivered to FTP destinations. To generate file names automatically, include attribute variables in the file name, for example, !{job-id}!.txt. The -ftp-filename-default single-valued attribute specifies the default document file name delivered to FTP destinations. The -ftp-filenames-supported multi-valued attribute lists valid -ftp-filename values. If neither -ftp-filename nor -ftp-filename-default is set, the DSM uses the -document-filename (the original file name). If the original file name is unavailable, because the job is submitted from stdin, for example, the DSM generates the file name from the attribute variable !{job-identifier}!_!{document-sequence-number}!.
Types -ftp-filename: Control and Status -ftp-filename-default: Configuration and Status -ftp-filenames-supported: Configuration and Status

86

System Administrators Attribute Reference

Chapter 2

Attributes
-ftp-host

Objects

-ftp-filename: Document -ftp-filename-default: Destinations: Logical, Physical (FTP) -ftp-filenames-supported: Destination: Logical (FTP)

Data Type

Text

-ftp-host -ftp-host-default -ftp-hosts-supported

The -ftp-host single-valued attribute specifies the host name of the FTP server to which the job is delivered. See also the -ftp-password attribute. The -ftp-host-default single-valued attribute specifies a default host name to use if you have not specified the -ftp-host job attribute. The -ftp-hosts-supported multi-valued attribute defines valid entries for the -ftp-host job attribute. Jobs with an -ftp-host setting not in the -ftp-hosts-supported list are rejected.
Types -ftp-host: Control and Status -ftp-host-default: Configuration and Status -ftp-hosts-supported: Configuration and Status Objects -ftp-host: Job -ftp-host-default: Destinations: Logical, Physical (FTP) -ftp-hosts-supported: Destination: Logical (FTP) Data Type Text

-ftp-operation -ftp-operation-default -ftp-operations-supported

The -ftp-operation single-valued attribute specifies whether to append or overwrite an existing file at the FTP destination. Attribute replacement occurs, if necessary. The -ftp-operation-default single-valued attribute specifies the default -ftp-operation value.

HP Output Server

87

Chapter 2
-ftp-password

Attributes

The -ftp-operations-supported attribute specifies valid values for the -ftp-operation attribute. If neither -ftp-operation nor -ftp-operation-default is set, the value is create.
Types Objects Control and Status -ftp-operation: Job -ftp-operation-default: Destinations: Physical, Logical (FTP) -ftp-operations-supported: Destination: Logical (FTP) Data Type Valid Values Text append, create (default)

-ftp-password -ftp-password-default
The -ftp-password single-valued attribute specifies the password to access the FTP server to which the job is delivered. This attribute is not required. The -ftp-password-default single-valued attribute indicates the default password if you have not specified the -ftp-password attribute.
Types -ftp-password: Control and Status -ftp-password-default: Configuration and Status Objects -ftp-password: Job -ftp-password-default: Destination: Physical (FTP) Data Type Text

-ftp-quote-cmd-post -ftp-quote-cmd-post-default
The -ftp-quote-cmd-post single-valued attribute specifies commands to deliver to an FTP server after data transfer is complete. The -ftp-quote-cmd-post-default single-valued attribute specifies a default -ftp-quote-cmd-post value.

88

System Administrators Attribute Reference

Chapter 2

Attributes

-ftp-quote-cmd-pre

The following command delivers file.txt to the ftp1 destination, changing file permissions after the file has transferred: pdpr -d ftp1 -x"-ftp-quote-cmd-post \"site chmod 777\"" file.txt The following command sets a default -ftp-quote-cmd-post value at the ftp1 destination: pdset -c d -x"-ftp-quote-cmd-post-default \"site chmod 777\"" ftp1

Types Objects

Control and Status -ftp-quote-cmd-post: Job: FTP -ftp-quote-cmd-post-default: Destination: Logical, Physical

Data Type

Text

-ftp-quote-cmd-pre -ftp-quote-cmd-pre-default
The -ftp-quote-cmd-pre single-valued attribute specifies commands to deliver to an FTP server before data transfer is initiated. The -ftp-quote-cmd-pre-default single-valued attribute specifies a default -ftp-quote-cmd-pre value. The following command delivers file.txt to the ftp1 destination, issuing the site idle command before the file begins transferring: pdpr -d ftp1 -x"-ftp-quote-cmd-pre \"site idle\"" file.txt The following command sets a default -ftp-quote-cmd-pre value at the ftp1 destination: pdset -c d -x"-ftp-quote-cmd-pre-default \"site idle\"" ftp1

Types Objects

Control and Status -ftp-quote-cmd-pre: Job: FTP -ftp-quote-cmd-pre-default: Destination: Logical, Physical

HP Output Server

89

Chapter 2

Attributes

-ftp-reply-timeout

Data Type

Text

-ftp-reply-timeout -ftp-reply-timeout-default
The -ftp-reply-timeout single-valued attribute extends the FTP connection to a specified amount of time (in seconds) at the job level. The default value is set to a 15-second FTP connection time. The -ftp-reply-timeout-default single-valued attribute sets a default -ftp-reply-timeout value at the logical or physical destination. This attribute should only be set if a time-out error occurs in the DSM log file.
Types Objects Configuration and Status -ftp-reply-timeout: Destination: Job -ftp-reply-timeout-default: Destinations: Logical, Physical Data Type Time (Seconds)

-ftp-type -ftp-type-default -ftp-types-supported

The -ftp-type single-valued attribute specifies the file transfer mode. The -ftp-type-default single-valued attribute indicates the default file transfer mode if you have not specified the -ftp-type attribute. The -ftp-types-supported multi-valued attribute lists valid entries for -ftp-type. Jobs submitted with an -ftp-type setting not in the -ftp-types-supported list are rejected. A value of none causes the FTP physical destination not to send a TYPE command to the remote FTP server.
Types -ftp-type: Control and Status -ftp-type-default: Configuration and Status -ftp-types-supported: Configuration and Status

90

System Administrators Attribute Reference

Chapter 2

Attributes
-ftp-user

Objects

-ftp-type: Document -ftp-type-default: Destinations: Logical, Physical (FTP) -ftp-types-supported: Destination: Logical (FTP)

Data Type Valid Values

Identifier ascii, binary, none

-ftp-user -ftp-user-default -ftp-users-supported

The -ftp-user single-valued attribute specifies the user name with which the DSM logs into the FTP server defined by the -ftp-host attribute. The -ftp-user-default single-valued attribute indicates the default user name if you have not specified the -ftp-user attribute. The -ftp-users-supported multi-valued attribute lists the valid values for the -ftp-user attribute. Jobs submitted with an -ftp-user setting not in the -ftp-users-supported list are rejected.
Types -ftp-user: Control and Status -ftp-user-default: Configuration and Status -ftp-users-supported: Configuration and Status Objects -ftp-user: Job -ftp-user-default: Destinations: Logical, Physical (FTP) -ftp-users-supported: Destination: Logical (FTP) Data Type Text

-ghostscript-device
The -ghostscript-device single-valued attribute selects the device driver for the printer. The default is a generic PCL printer driver, based on the value of the -pcl-level attribute: -pcl-level 3 defaults to -ghostscript-device pcl3. -pcl-level 4 defaults to -ghostscript-device pcl4.

HP Output Server

91

Chapter 2

Attributes

-ghostscript-device

-pcl-level 5 defaults to -ghostscript-device pcl5.

Type Object Data Type Valid Values* Control Destination: Physical (Printers) Text The following values have been developed to work in an HP Output Server environment and are required for certain devices: pcl3 (generic PCL level 3) pcl4 (generic PCL level 4) pcl5 (generic PCL level 5) pcl5_600 (generic PCL level 5 (600 dpi) spcl5 (alternate PCL level 5) deskjet (HP DeskJet and DeskJet Plus) djet500 (HP DeskJet 500) laserjet (HP LaserJet) ljetplus (HP LaserJet Plus) ljet2p (HP LaserJet IId/IIp/III with TIFF compression) ljet3 (HP LaserJet III with Delta Row compression) ljet3d (HP LaserJet IIID with duplex capability) ljet4 (HP LaserJet 4 (defaults to 600 dpi)) lj4dith (HP LaserJet 4 with enhanced greyscale support) cdeskjet (HP DeskJet 500C with 3 bit/pixel color) cdjcolor (HP DeskJet 500C with 24 bit/pixel color; also good for DeskJet 540C) cdjmono (HP DeskJet 500C printing black only; also good for DeskJet 510, 520, and 540C black only) cdj500 (HP DeskJet 500C (same as cdjcolor)) cdj550 (HP DeskJet 550C/560C/660C) clhpjet5c (PCL color printers) pxlcolor (PCL level 6 color printers) pxlmono (PCL level 6 monochrome printers) tiffg3 (multi-function printer fax destinations; if value not set, Ghostscript uses supfhigh)

92

System Administrators Attribute Reference

Chapter 2

Attributes

-ghostscript-options * This table lists values tested for specific uses with HP Output Server and is not a comprehensive list of devices available to the Ghostscript program. If you use a value that is not in HP Output Servers list of valid values, your output may vary from the expected results.

-ghostscript-options -ghostscript-options-default
The -ghostscript-options single-valued attribute specifies additional document formatting options to pass to the Ghostscript program to change the way Ghostscript generates document output. The pdf_to_ps and ps_to_pdf transformers can use the formatting options specified with this attribute. Set the-ghostscript-options attribute when using the pdpr command to deliver a document to HP Output Server. For example, to deliver doc.pdf to 1fax, specifying centering and best-fit rotation, type the following command: pdpr -d 1fax -x"-ghostscript-options \"-dPDFFixedPage -dLandscapeOrient1\"" doc.pdf The -ghostscript-options-default single-valued attribute specifies the default -ghostscript-options value. Set this attribute at the physical or logical destination. The following example specifies centering and best-fit rotation on the p_printer physical destination: pdset -c d -x"-ghostscript-options-default \"-dPDFFixedPage -dLandscapeOrient1\"" p_printer Because Ghostscript offers numerous options that you can pass through the -ghostscript-options attribute, the following tables list of valid values is not comprehensive. An example of a specific use case is controlling the PDF output so that the output document is displayed correctly in Acrobat Reader. Documents converted with some versions of Ghostscript may not be displayed correctly in some versions of Acrobat Reader. To address this issue, you can set -ghostscript-options at the job to \"-dPDFSETTINGS=/ printer\"" when you deliver the document with the pdpr command. This value instructs Ghostscript to select an output similar to the Acrobat Distiller Print Optimized setting.
Type Control

HP Output Server

93

Chapter 2

Attributes

-ghostscript-program

Objects

-ghost-script-options: Document -ghost-script-options-default: Destination: Physical, Logical

Data Type Valid Values

Text -dUseCropBox The Ghostscript program uses an alternate specification (CropBox instead of MediaBox) for defining the boundary of a page in a PDF document. Use this value when HP Output Server truncates the output of a PDF document sent to a printer or fax destination. The Ghostscript program performs a best-fit rotation on a PDF document with landscape specified as the page orientation. The Ghostscript program centers the PDF document using the media specified by the -medium-select, -media-used, or -medium-default attributes. Use this value to print a PDF document that includes both landscape and portrait orientation. Additionally, use this value if a landscape document is being truncated at a fax destination. -dMaxInlineImageSize=0 Use this value to reduce the file size and processing time of PDF files with image overlays.

-dLandscapeOrient1

-dPDFFixedPage

-dNORANGEPAGESIZE

-ghostscript-program
The -ghostscript-program single-valued attribute specifies the absolute path name to the Ghostscript program, which converts PostScript files to other formats. The default value is: !{dazel-install-directory}!/bin/gs
Type Object Data Type Control Destination: Physical (Printers) Text

94

System Administrators Attribute Reference

Chapter 2

Attributes

-group-by-attribute

-group-by-attribute
The -group-by-attribute single-valued attribute changes the scheduling method that the JQM uses to insert subjobs into a queue. It specifies a job or document attribute for the JQM to use to group subjobs before applying the queues default scheduling criteria. The value for -group-by-attribute is any job or document attribute, without the leading dash. For example: fax-phone-number. NOTE: After setting this attribute, ensure that you restart the JQM that manages the queue. The JQM first groups subjobs that share the same value for the specified jobs or document attribute, and then applies the queues default scheduling criteria to the group of subjobs and to the other subjobs in the queue. For information about using this attribute with the -reserve-by-attribute so the JQM can group subjobs sent to the same physical destination in a device farm, see the -reserve-by-attribute. See also the -job-order-preserved attribute. NOTE: Do not set the -job-order-preserved attribute on queues on which -group-by-attribute is set.
Type Object Data Type Control Queue Identifier

-header-footer-character-set
The -header-footer-character-set single-valued attribute specifies the character set for headers and footers. The default is the document character set. For more information, see the -character-set attribute.
Types Object Data Type Valid Values Configuration and Status Job Identifier ascii, iso-latin-1

HP Output Server

95

Chapter 2

Attributes

-header-footer-font

-header-footer-font
The -header-footer-font single-valued attribute specifies the font for headers and footers.
Types Object Data Type Valid Values Configuration and Status Destination: Physical Text Valid values vary according to printer. Refer to the documentation for the specific device.

-header-footer-font-size
The -header-footer-font-size single-valued attribute specifies the font size (in points) for headers and footers.
Types Object Data Type Configuration and Status Destination: Physical Integer (Positive)

-header-text -header-text-default
The -header-text multi-valued attribute specifies the text to print at the top of each page of a text document. The -header-text-default multi-valued attribute specifies a running header to use if you do not specify the -header-text attribute. NOTE: The -header-text and -footer-text attributes apply only to text documents. You can specify text to print at the left margin of the page header, in the center of the page header, or at the right margin of the page header. You must specify text to print or an empty string at the left margin of the page header.

96

System Administrators Attribute Reference

Chapter 2

Attributes

-header-text-default

The following example illustrates the syntax of the -header-text attribute. The position of each argument corresponds to its location in the page header (left, center, or right). The left square bracket ([) and right square bracket (]) characters delimit optional arguments and the combination of a comma and a space separates arguments: argument[, argument][, argument] If you specify one argument, the value of that argument is displayed in the left location in the page header. If you specify two arguments, the value of the first argument is displayed in the left location and the value of the second argument is displayed in the center location in the page header. If you specify three arguments, the values are displayed in the left, center, and right locations in the page header, respectively. To display no text in the left, center, or right locations in a page header, specify an argument with an escaped pair of quotation marks as in the following example: -header-text \"\" If an argument contains non-alphanumeric characters, for example, an attribute variable or a space, delimit the argument with quotation marks. You can specify attribute variables in page header arguments. The DSM replaces attribute variables with the value of the specified attribute. For text documents sent to fax destinations, do not set any values for the -header-text attribute; also set an empty value for the -header-text-default attribute. Setting non-empty -header-text-default and -header-text values for text documents sent to fax destinations may cause unwanted multiple headers to appear on faxes. The following example demonstrates a header with "Chapter One" appearing on the far left and "Destinations" appearing on the far right. -header-text \"Chapter One\", \"\", Destinations

Types

-header-text: Control and Status -header-text-default: Configuration and Status

Objects

-header-text: Document: Text -header-text-default: Destinations: Logical, Physical

Data Type

Text

HP Output Server

97

Chapter 2
-imposition

Attributes

-imposition -impositions-default -impositions-supported

The -imposition multi-valued attribute specifies the imposition to use for the document. The orientation and size of the logical page images are determined automatically (and depend on the value of the -content-orientation attribute, if set). The -imposition attribute values simple-2-up and simple-4-up are equivalent to specifying -number-up 2 and -number-up 4, respectively. The -imposition attribute overrides -number-up and -logical-page* attributes if they are also specified. The -impositions-default attribute specifies the default value used if you do not set the -imposition attribute. The -impositions-supported multi-valued attribute specifies the valid values for the -imposition attribute. If the job is submitted with an -imposition setting not in the -impositions-supported list, the job is rejected.
Types Objects Control and Status -imposition: Documents: PS, PCL, Fax -impositions-default: Destinations: Logical, Physical (PS, PCL, Fax) -impositions-supported: Destination: Logical (PS, PCL, Fax) Data Type Valid Values Identifier simple-2-up, simple-4-up, none

-incomplete-job-timeout
The -incomplete-job-timeout single-valued attribute specifies the length of time (in seconds) after which incomplete jobs are removed from the servers database. Incomplete jobs are those for which document transfer is incomplete. Incomplete document transfer can occur as the job is transferring from the delivery client to the DLM or as the job is transferring from the DLM to the JQM.
Types Objects Data Type Configuration and Status Servers: DLM, JQM Integer

98

System Administrators Attribute Reference

Chapter 2

Attributes
-indent

-indent
The -indent single-valued attribute is set by the I line of the LPR control file to the specified value for jobs sent through the LPR Gateway. NOTE: The -indent attribute does not control a jobs output.
Type Object Data Type Control and Status Document: Text Integer

-input-content-type -input-content-type-default -input-content-types-supported

The -input-content-type single-valued attribute specifies the content type of an incoming document. For more information about how the content type of a document is determined, see the -document-format-content-type attribute. NOTE: The -input-content-type* and -mime-document-format* attributes are synonymous. The -input-content-type-default single-valued attribute specifies the default content type of an incoming document. Setting the -input-content-type attribute overrides the default value. The -input-content-types-supported multi-valued attribute specifies the supported values for -input-content-type.
Types -input-content-type: Control and Status -input-content-type-default: Configuration -input-content-types-supported: Configuration Objects -input-content-type: Document: E-mail -input-content-type-default: Destinations: Physical, Logical (E-mail) -input-content-types-supported: Destination: Logical (E-mail) Data Type Text

HP Output Server

99

Chapter 2

Attributes

-input-document-format

Valid Values

application/octet-stream, application/pdf, application/postscript, text/plain Other valid values for this attribute are defined by the Internet Assigned Numbers Authority (IANA) (see RFC 2045).

-input-document-format -input-document-format-default -input-document-formats-supported

The input-document-format single-valued attribute specifies the format of an incoming document. This attribute identifies a family of document formats, of which variants and versions may exist. To provide a full specification of the documents contents, supply the variant and the version of the document format. The -input-document-format-default single-valued attribute specifies the default format of an incoming documents contents. The -input-document-format attribute overrides the -input-document-format-default attribute. The -input-document-formats-supported multi-valued attribute specifies the document formats accepted by a logical or physical destination. The input-document-formats-supported attribute is validated at the logical destination (if set) and at the physical destination automatically. NOTE: The -document-format* and -input-document-format* attributes are synonymous. If no value is specified for the -input-document-format attribute, the value of the -input-document-format-default attribute is used. If the -input-document-format-default attribute is undefined, the DSM attempts to determine the documents format. The DSM recognizes the following document formats if they are not set explicitly: afp, hp-pcl, html, pdf, ps, and text. If the DSM cannot recognize any of these formats, the -input-document-format is set to literal.
Types Control and Status

100

System Administrators Attribute Reference

Chapter 2

Attributes

-input-document-format-variants

Objects

-input-document-format: Document -input-document-format-default: Destinations: Logical, Physical -input-document-formats-supported: Destinations: Logical, Physical

Data Type Valid Values

Identifier afp, hp-pcl, g3, html, iso-6429, literal, PDF, pdf, PS, ps, TEXT, text, TIFF, tiff, webviewable, ZPL*, zpl* The hp-pcl value refers to PCL 5 and earlier versions. To use PCL 6, you must use the literal value unless your installation uses a customized solution.

* The ZPL/zpl document format requires a custom transformer. For more information, contact your Professional Services representative.

-input-document-format-variants -input-document-format-variants-defaults -input-document-format-variants-supported

The -input-document-format-variants multi-valued attribute defines the subclass of each -input-document-format attribute. The -input-document-format-variants-defaults multi-valued attribute specifies the default values for the -input-document-format-variants attribute. The -input-document-format-variants-supported multi-valued attribute lists valid values for the -input-document-format-variants attribute. The lf-implies-cr value is the default value that applies only if the -input-document-format attribute is set to text. If -input-document-format is not set or is set to a value other than text, the -input-document-format-variants attribute has no default value.
Types -input-document-format-variants: Control and Status -input-document-format-variants-defaults: Configuration and Status -input-document-format-variants-supported: Configuration and Status

HP Output Server

101

Chapter 2

Attributes

-input-document-format-version

Object

-input-document-format-variants: Document -input-document-format-variants-defaults: Destination: Logical -input-document-format-variants-supported: Destination: Logical

Data Type Valid Values

Identifier PS variants: PS-L1, ps-l1, PS-L2, ps-l2, PS-DSC1, ps-dsc1, PS-DSC2, ps-dsc2, PS-DSC3, ps-dsc3 iso-6429 (text) variants: simple-text, ht, lf-implies-cr (default), cr-implies-lf, cr-overstrike, bs-overstrike, iso-10538-pif-level1, iso-10538-pif-level2, iso-10538-pif-level3, iso-10538-pif-level4, iso-10538, fft-level1v, iso-10538, fft-level2, iso-10538, fft-level2a, iso-10538, fft-level2b, iso-10538 hp-pcl variants: hp-pcl1, hp-pcl2, hp-pcl3, hp-pcl4, hp-pcl5 html variant: html-32 Other variants: ppds-level1, ppds-level2, ppds-level3, fft-level2c, sgr-underline-bold, dec-pp12, dec-pp13, line-ansi-cc, line-machine-cc, line-trc, line-sosil, line-sosi2, line-sosi3, modca-isl, modca-pt1, modca-dr2, modca-dr3, modca-fs10, modca-fs20, modca-bcdl, modca-iml, scs-sosi1, SCS-sosi1, scs-sosi2, SCS-sosi2, scs-sosi3, SCS-sosi3, BINARY, binary, CLEARTEXT, cleartext, asterx-wp, applix-wp, asterx-gr, applix-gr, asterx-ss, applix-ss

-input-document-format-version
The -input-document-format-version single-valued attribute identifies the variant-independent document format version number.
Types Object Data Type Control and Status Document Text

102

System Administrators Attribute Reference

Chapter 2

Attributes

-input-tray-select

-input-tray-select -input-trays-used -input-tray-default -input-trays-supported

The -input-tray-select single-valued attribute specifies the device input tray. This attribute overrides the -input-trays-used and -input-tray-default attributes. The -input-trays-medium attribute overrides the -input-tray-select attribute. For more information, see the -medium-used and -input-trays-medium attributes. The -input-trays-used application-supplied single-valued attribute specifies the device input tray. The -input-tray-default single-valued attribute specifies the default -input-tray-select value. The -input-trays-supported multi-valued attribute specifies the valid -input-trays-used values. Before a job is delivered to a printer, the jobs input tray and medium are determined by checking the following attributes in the following order: -medium-select -input-trays-medium -input-tray-select -media-used -input-trays-used -medium-default -input-tray-default When a jobs medium or input tray is determined, the -input-trays-medium attribute is consulted. The -input-trays-medium attribute maps input trays with media. If the job determines its medium, it checks the -input-trays-medium attribute to determine which tray is associated with the specified medium. If the job cannot define the missing value with the -input-trays-medium attribute, it searches the remaining attributes until it determines both values.

HP Output Server

103

Chapter 2

Attributes

-input-trays-medium

If none of these attributes set the input tray, it defaults to what is set at the device. If none of the attributes define the paper type, then the value is either north-american-letter-white (8.5-by-11 inches) or iso-a4-white (21-by-29.7 centimeters), depending on your HP Output Server configuration.
Types -input-tray-select: Control -input-trays-used: Control and Status -input-tray-default: Configuration and Status -input-trays-supported: Configuration and Status Objects -input-tray-select: Document -input-trays-used: Document -input-tray-default: Destinations: Logical, Physical (PS, PCL) -input-trays-supported: Destination: Logical Data Type Valid Values Identifier top, middle, bottom, envelope, manual, large-capacity, tray0, tray1, tray2, tray3, tray4, tray5, tray6, tray7, tray8, tray9 Valid value for advanced printers only: tray10

-input-trays-medium
The -input-trays-medium multi-valued attribute consists of two values (inputTray and medium), which map the input tray to a specific medium. Type values in the following format: -input-trays-medium {inputTray, medium} The input tray is a value, such as top, middle, and envelope. The medium can be a medium class value such as iso-a4-white or north-american-legal-white. The valid values for -input-trays-medium are the supported values for InputTray. The valid values for medium depend on the physical printer device being used. For more information, see the -medium-select attribute. If you do not set the -input-trays-medium attribute, the input tray is derived from the value of the -input-trays-used attribute. If this attribute is not set, then the input tray is

104

System Administrators Attribute Reference

Chapter 2

Attributes

-input-trays-xlate

derived from the -input-tray-default attribute. If none of these are set, the input tray defaults to what is set at the printer. The following example defines the top and middle input trays for a printer: pdset -c d -x"-input-trays-medium {top, iso-a4-white},{middle, north-american-letter-white}" physicalDestination

Types Object Data Type Valid Values

Configuration and Status Destination: Physical (PCL, PS) Text top, middle, bottom, envelope, manual, large-capacity, tray0, tray1, tray2, tray3, tray4, tray5, tray6, tray7, tray8, tray9

-input-trays-xlate
The -input-trays-xlate multi-valued attribute configures a physical destinations input tray. Each value is a data structure that contains two fields in the form {x,y}, where x is the -input-tray-select value, and y is the printer-specific integer that corresponds to the input tray. Typical settings are {top,0}, {middle,1}, and {bottom,4}. Consult your printer manual for the printers input tray values. NOTE: HP Output Server provides templates for supported printers. These printer templates set the -input-trays-xlate attribute. HP Output Server uses -input-trays-xlate only if the input tray is specified, the input tray value is not manual, and PostScript productions are applied. PCL only: If neither the -input-trays-xlate attribute nor the input tray is set, the following are defaults for PCL printer physical destinations: top maps to 1 manual maps to 2 bottom maps to 4 large-capacity maps to 5 envelope maps to 6

HP Output Server

105

Chapter 2

Attributes

-intervening-jobs

For more information, see the -input-tray-select attribute.

Type Object Data Type Control Destination: Physical (PCL, PS) Text and Integer

-intervening-jobs
The -intervening-jobs single-valued attribute is the number of jobs that precede the specified job in the queue. A value of 0 indicates when the job is at the head of the queue.
Type Object Data Type Status Job Integer (Positive)

-intervening-octets
The -intervening-octets single-valued attribute is the total number of bytes of all documents in the jobs that precede the specified job in the queue.
Type Object Data Type Status Job Integer (Positive)

-jes-formdef -jes-formdef-default
The -jes-formdef single-valued attribute contains the name of a form to apply to a document sent to a JES printer. The values cannot contain embedded spaces. The value of the -jes-formdef attribute is used as an argument for the -deliver-document-arguments attribute. You can use -jes-formdef in conjunction with -jes-pagedef.

106

System Administrators Attribute Reference

Chapter 2

Attributes
-jes-pagedef

The -jes-formdef-default single-valued attribute specifies the default value of -jes-formdef.

Types -jes-formdef: Control and Status -jes-formdef-default: Configuration Object -jes-formdef: Document: JES -jes-formdef-default: Destinations: Logical, Physical Data Type Text

-jes-pagedef -jes-pagedef-default
The -jes-pagedef single-valued attribute contains the page numbers to apply to a document sent to a JES printer. The -jes-pagedef attribute is used in conjunction with the -jes-formdef attribute. The values are expressed by startingPageNumber-endingPageNumber. For example, if a JES form purchase_order applies to pages one through five of a document, use the following syntax: -jes-formdef purchase_order -jes-pagedef 1-5 You can also apply the form incrementally. That is, you can apply a form to every other page, or every three pages, or another interval. You can also specify a page range, followed by an increment that only applies within the page range. The following example applies the form purchase_order to the first page and every following second page (1, 3, 5, ...): -jes-formdef purchase_order -jes-pagedef 1+2 The values of the -jes-formdef and -jes-pagedef attributes are used as arguments for the -deliver-document-arguments attribute.
Types -jes-pagedef: Control and Status -jes-pagedef-default: Configuration Object -jes-pagedef: Document: JES -jes-pagedef-default: Destination: Logical, Physical Data Type Text

HP Output Server

107

Chapter 2
-job-class

Attributes

-job-class -job-class-default
The -job-class single-valued attribute specifies the class of a job that is sent to an lpr destination. The -job-class-default single-valued attribute specifies the default class to apply to incoming jobs that do not explicitly specify the -job-class attribute.
Types -job-class: Control and Status -job-class-default: Configuration and Status Objects -job-class: Job: LPR -job-class-default: Destinations (LPR): Logical, Physical Data Type Text

-job-client-id
The -job-client-id single-valued attribute specifies the job ID assigned by a DLM at job submission. The job ID and associated subjob IDs are stored in the DLM database for the life of the job. The format of the job ID is dlm:integer:integer. For example, dlm1:10:2391 is a job ID. See also the -job-identifier attribute description.
Type Object Data Type Status Job Text

-job-comment
The -job-comment single-valued attribute specifies a job-related message.
Type Object Data Type Status Job Text

108

System Administrators Attribute Reference

Chapter 2

Attributes

-job-completion-status

-job-completion-status
The -job-completion-status single-valued attribute reports the completion status of a job that has been processed. If a job is interrupted, its -job-completion-status attribute gets set even if the job resumes. When a job completes, the -current-job-state attribute becomes retained and the -job-completion-status attribute reports the final result of the job. If the number of times a job tries to deliver meets or exceeds the value of -maximum-tries, the value of the -job-completion-status attribute changes to cancelled.
Type Object Data Type Valid Values Status Job Identifier success, aborted-in-printing, aborted-in-translation, cancelled

-job-deadline-period
The -job-deadline-period single-valued attribute specifies a default -job-deadline-time. The default is specified as a relative period, which is then added to the submission time for each job to calculate a default -job-deadline-time for that job. You can set a deadline period at the job or at the logical destination. As administrator, you can control the length of time a job stays in the system with the -job-deadline-period and -job-retention-period attributes. NOTE: -job-deadline-period is synonymous with -job-discard-period (or -discard-period). If both attributes are set, -job-deadline-period will override -job-discard-period. For more information about job processing, see the System Administrators Guide for HP Output Server.
Types Object Data Type Control and Status Destination: Logical Integer (Seconds)

HP Output Server

109

Chapter 2

Attributes

-job-deadline-time

-job-deadline-time
The -job-deadline-time single-valued attribute specifies the time by which the job must be processed. The value for this attribute is calculated at job submission time. If the -job-deadline-period attribute is set on the logical destination, the -job-deadline-time is calculated from the job submission time plus the value of the -job-deadline-period attribute. If the -job-deadline-time attribute is not set, there is no limit to the length of time a job can attempt to complete. If the job is in the retained state when the specified amount of time elapses, or if the job is in the processing state and completes successfully, then the -job-deadline-time attribute has no effect. If the job is in any other state when the deadline time occurs, or is in the processing state and completes unsuccessfully, then the job is removed from the queue and set to cancelled. NOTE: -job-deadline-time is synonymous with -job-discard-time.
Types Object Data Type Control and Status Job Time (UTC)

-job-event-attributes
The -job-event-attributes multi-valued job attribute specifies additional attributes to include as job-related events. HP Output Server includes the following job-related events by default. Specifying additional -job-event-attributes adds to this list. -job-identifier -job-owner message -job-client-id -destination -job-name -processing-time -pages-completed -job-page-count

110

System Administrators Attribute Reference

Chapter 2

Attributes

-job-event-class

-remote-device-identifier (fax only)

To set -job-event-attributes when you deliver a job with pdpr, use the following syntax: pdpr -d destinationName -x"-job-event-attributes jobAttribute1, jobAttribute2" documentName The following example adds four attributes to file1.pss job events: pdpr -d ps1 -x"-job-event-attributes sap-oms-rmg-id, sap-oms-spool-id, sap-oms-system-id, system-job-message" file1.ps The maximum number of attributes you can specify depends on the total size of all of the attributes collected as job events. The limit is 512 KB.
Type Object Data Type Valid Values Configuration Job Identifier Job object attributes

-job-event-class
The -job-event-class single-valued job attribute specifies an additional job event class that is notified when you deliver a job with pdpr. Job events are reported to one of two event classes, ERP_SAP_CONNECT or ERP_SAP_OMS, for use with the SAPCON and OMSCB servers. These servers are configured with HP Output Manager for SAP. Job events will continue to be reported to the IDS_ALLJOBS class. You can specify the ERP_SAP_CONNECT or ERP_SAP_OMS job event with both single-domain and interdomain delivery. If a job originates in a secondary domain, the job event is sent across the domain back to the originator of the job. NOTE: If you use -job-event-class with interdomain delivery, both HP Output Server domains must be at version 3.5 or above. To generate job events for the ERP_SAP_CONNECT event class, use the following syntax: pdpr -d destinationName -x"-job-event-class erp-sap-connect" documentName

HP Output Server

111

Chapter 2
-job-finishing

Attributes

To generate job events for the ERP_SAP_OMS event class, use the following syntax: pdpr -d destinationName -x"-job-event-class erp-sap-oms" documentName

Type Object Data Type Valid Values

Configuration Job Identifier erp-sap-connect, erp-sap-oms

-job-finishing -job-finishings-default -job-finishings-supported

The -job-finishing multi-valued attribute specifies job finishing functionality for select static printers. To enable this job finishing feature, set the -printer-model attribute on the physical destination to one of the following values, depending on your printer model: hp_pjl lexmark_pjl

The -job-finishings-default multi-valued attribute specifies the default job finishing functionality for a static destination. The -job-finishings-supported multi-valued attribute specifies valid values for the -job-finishing attribute. If a -job-finishing value is specified but is not present in the list of -job-finishings-supported values, that job will be rejected.
Types -job-finishing: Control and Status -job-finishings-default: Configuration and Status -job-finishings-supported: Configuration and Status Objects -job-finishing: Job -job-finishings-default: Destinations: Logical, Physical -job-finishings-supported: Destinations: Logical, Physical Data Type NameOrOID

112

System Administrators Attribute Reference

Chapter 2

Attributes
-job-hold

Valid Values

staples, punch, nopunch

-job-hold -job-hold-default
The -job-hold single-valued attribute holds the job when set to true. This attribute functions independently of pausing and resuming a job. Jobs held with this attribute will be deleted if the time limit set with the -job-deadline-time attribute expires. Typically, the -job-hold attribute is used to hold a job at submission time. The -job-hold-default single-valued attribute specifies a default -job-hold value.
Types Objects Control and Status -job-hold: Job -job-hold-default: Destination: Logical Data Type Valid Values Boolean TRUE, true, FALSE, false, YES, yes, NO, no

-job-hold-jobname -job-hold-jobname-default
The -job-hold-jobname single-valued attribute specifies the job name to be used when delivering jobs with -job-hold-mode set. With -job-hold-mode set to hold, store, proof, or private, the -job-hold-jobname is required. With -job-hold-mode set to private, both the -job-hold-jobname and -job-hold-username are required. The value of the -job-hold-jobname attribute is a string that is limited by the size of a given printers control panel display. For example, HP printers will display up to 80 characters and Lexmark printers will display up to 24 characters. If multiple documents are delivered within the same job, the jobname for each document will have an .n suffix, where n is the document sequence number, for example, _job, _job.1, _job.2, and so forth. The -job-hold-jobname-default single-valued attribute specifies the default -job-hold-jobname. The -job-hold-jobname and -job-hold-jobname-default attributes apply to select static and advanced printers.

HP Output Server

113

Chapter 2
-job-hold-key

Attributes

To enable this job finishing feature on static printers, set the -printer-model attribute on the physical destination to one of the following values, depending on your printer model: hp_pjl lexmark_pjl

For information about using this feature on advanced printers and advanced delivery pathways, see the System Administrators Guide for HP Output Server.
Types -job-hold-jobname: Control and Status -job-hold-jobname-default: Configuration Objects -job-hold-jobname: Job -job-hold-jobname-default: Destinations: Logical, Physical Data Type Text

-job-hold-key
The -job-hold-key single-valued attribute specifies a password to protect a held job. It is a 4-digit string. A key must be specified if -job-hold-mode is private. Different printer models have different requirements for key combinations. For example, HP printers can have a value of any 4-digit combination from 0000 to 9999. Lexmark printers can have a value of any 4-digit combination using digits 1 to 6. The -job-hold-key attribute is available for select static and advanced printers. To enable this job finishing feature on static printers, set the -printer-model attribute on the physical destination to one of the following values, depending on your printer model: hp_pjl lexmark_pjl

For information about using this feature on advanced printers and advanced delivery pathways, see the System Administrators Guide for HP Output Server.
Types Object Data Type Control and Status Job Integer

114

System Administrators Attribute Reference

Chapter 2

Attributes

-job-hold-key-required

-job-hold-key-required -job-hold-key-required-default
The -job-hold-key-required single-valued attribute specifies if a key is required with the accompanying -job-hold-key when the job is delivered. NOTE: The -job-hold-key-required attribute applies to advanced printers only. For more information about advanced printers and advanced delivery pathways, see the System Administrators Guide for HP Output Server. The -job-hold-key-required-default single-valued attribute specifies the default value if -job-hold-key-required is not set at the job.
Types -job-hold-key-required: Control and Status -job-hold-key-required-default: Configuration and Status Objects -job-hold-key-required: Job -job-hold-key-required-default: Destinations: Physical and Logical Data Type Valid Values Boolean TRUE, true, FALSE, false, YES, yes, NO, no

-job-hold-mailbox -job-hold-mailbox-default
The -job-hold-mailbox single-valued attribute specifies the mailbox in which to store the job. NOTE: The -job-hold-mailbox attribute applies to advanced printers only. For more information about advanced printers and advanced delivery pathways, see the System Administrators Guide for HP Output Server. The -job-hold-mailbox-default single-valued attribute specifies the default mailbox if -job-hold-mailbox is not set at the job.
Types -job-hold-mailbox: Control and Status -job-hold-mailbox-default: Configuration and Status

HP Output Server

115

Chapter 2
-job-hold-mode

Attributes

Objects

-job-hold-mailbox: Job -job-hold-mailbox-default: Destinations: Logical, Physical

Data Type

Text

-job-hold-mode -job-hold-mode-default -job-hold-modes-supported

The -job-hold-mode single-valued attribute specifies the job retention functionality that is available on select static and advanced printers. NOTE: If -job-hold-mode is set to any value other than off, HP Output Server will not monitor a printers response. As a result, printer checkpointing, which requires listening to printer feedback, is not available with held jobs. To enable this job finishing feature on static printers, set the -printer-model attribute on the physical destination to one of the following values, depending on your printer model: hp_pjl lexmark_pjl

For information about using this feature on advanced printers and advanced delivery pathways, see the System Administrators Guide for HP Output Server. The -job-hold-mode-default single-valued attribute specifies the default -job-hold-mode. The -job-hold-modes-supported multi-valued attribute lists valid values for the -job-hold-mode attribute.

Types

-job-hold-mode: Control and Status -job-hold-mode-default: Configuration and Status -job-hold-modes-supported: Configuration and Status -job-hold-mode: Job -job-hold-mode-default: Destinations: Logical, Physical -job-hold-modes-supported: Destinations: Logical, Physical

Object

116

System Administrators Attribute Reference

Chapter 2

Attributes

-job-hold-username

Data Type Valid Values

Identifier hold The requested number of copies are printed and the job is temporarily stored on disk. The job is then available for printing additional copies through the printers control panel. The number of jobs that can be stored is limited by the printers disk space. Also, the job associated with this value does not require a holdkey value to be released for printing. The job is printed but not retained in the disk after printing. This is the default value. The job requires a -job-hold-key to be released for printing. If this mode is not specified, the job is considered public. One copy of a job is printed and remaining copies are stored on disk. The job is then available for printing by using the printers control panel menu. The job is not printed immediately but is retained on disk. The job is available for printing by using the printers control panel menu.

off private

proof

store

-job-hold-username -job-hold-username-default
The -job-hold-username single-valued attribute specifies the user name to be used when delivering jobs with -job-hold-mode set. With -job-hold-mode set to private, both the -job-hold-username and -job-hold-jobname are required. The value of this attribute is a string that is limited by the size of a given printers control panel display. HP printers display up to 80 characters and Lexmark printers display up to 24 characters. If the value for this attribute is not set, the default is the HP Output Server user name. The -job-hold-username-default single-valued attribute specifies the default -job-hold-username. The -job-hold-username and -job-hold-username-default attributes apply to select static and advanced printers. To enable this job finishing feature on static printers, set the -printer-model attribute on the physical destination to one of the following values, depending on your printer model:

HP Output Server

117

Chapter 2
-job-identifier

Attributes

hp_pjl lexmark_pjl

For information about using this feature on advanced printers and advanced delivery pathways, see the System Administrators Guide for HP Output Server.
Types -job-hold-username: Control and Status -job-hold-username-default: Configuration Objects -job-hold-username: Job -job-hold-username-default: Destinations: Logical, Physical Data Type Text

-job-identifier
The -job-identifier single-valued attribute reports the subjob ID by the assigned JQM. A subjob is created for each destination in the delivery request. Both the JQM and the DLM store the subjob ID for the life of the job. The format of the subjob ID is jqm:integer. For example, jqm1:34153797 is a subjob ID. See also the -job-client-id attribute.
Type Object Data Type Status Job Job Identifier

-job-identifier-on-printer
The -job-identifier-on-printer single-valued attribute reports the job ID assigned by a remote system. After job submission, the remote system assigns an ID to the job. The attribute associates the submitted job with the job the remote system received. For example, if the lpr physical destination submits a job to an external system, HP Output Server sets the -job-identifier-on-printer attribute so that you can identify the original job in the remote system.
Type Object Data Type Status Job Text

118

System Administrators Attribute Reference

Chapter 2

Attributes

-job-message-from-administrator

-job-message-from-administrator
The -job-message-from-administrator single-valued attribute specifies the contents of the field that is used by system administrators.
Types Object Data Type Control and Status Job Text

-job-message-to-operator
The -job-message-to-operator single-valued attribute specifies the contents of the field that is used to request services from operators.
Types Object Data Type Control and Status Job Text

-job-name
The -job-name single-valued attribute specifies the name of the job. The default is the file name of the first document in the job. If the document originates from stdin, the file name is set to a dash (-).
Types Object Data Type Control and Status Job Text

-job-order
The -job-order multi-valued attribute lists the subjobs in a queue. The subjobs are listed in the order in which they are expected to process. The attribute lists the subjobs by their identification number without the preceding JQM identifier.
Type Object Data Type Status Queue Integer (Positive)

HP Output Server

119

Chapter 2

Attributes

-job-order-preserved

-job-order-preserved
The -job-order-preserved single-valued attribute specifies if the JQM delivers jobs based on the queues scheduling method plus other considerations, or strictly on the queues scheduling method alone. NOTE: After setting this attribute, ensure that you restart the JQM that manages the queue. If the -job-order-preserved attribute is not set or is set to the default, false, the JQM dequeues subjobs (sends subjobs from queues to physical destinations) by selecting the subjob that is at the head of the queue and then considering whether the subjob is ready to be delivered. If the subjob is not ready to be delivered, the JQM selects the next subjob in the queue, and so forth. A subjob may not be ready to be delivered if the user who submits the subjob does not have permission to deliver to a destination when the job reaches the head of the queue, or if the specified delivery time is still in the future. If you set the -job-order-preserved attribute to true, the JQM does not skip subjobs that are not ready to be delivered, and follows the queues scheduling method strictly. If the subjob at the head of the queue is not ready to be delivered, the JQM waits until the job is ready or the job is removed. Setting the -job-order-preserved attribute to true is appropriate for applications that require strict job ordering, such as check printing. CAUTION: The queue will become clogged if the -job-order-preserved attribute is set to true, if the FIFO queue scheduling method is used, or if the MIN_DEL_TIME and MAX_DEL_TIME permission rules are set and the job submission time is out of this range. For more information about changing a queues scheduling method, see -group-by-attribute and -reserve-by-attribute. NOTE: Do not set the -job-order-preserved attributes on queues on which the -group-by-attribute and -reserve-by-attribute attributes are set.
Type Control

120

System Administrators Attribute Reference

Chapter 2

Attributes
-job-originator

Object Data Type Valid Values

Queue Boolean TRUE, true, FALSE, false, YES, yes, NO, no

-job-originator
The -job-originator single-valued attribute specifies the principal ID of the user who originated the job. The DLM sets the ID, and the JQM uses the ID to check authorization for requests to access jobs and destinations. The values for this attribute cannot contain embedded spaces.
Type Object Data Type Status Job Text

-job-owner
The -job-owner single-valued attribute specifies the principal ID of the user who owns the job. Authorized users can set this attribute to a value other than their principal ID. The values for this attribute cannot contain embedded spaces. The syntax for the -job-owner attribute can be summarized as follows: -job-owner [WindowsNTDomain\]user[@domainDir] On Windows, the user must be preceded by the Windows domain. For both UNIX and Windows, if the user is not in the local HP Output Server domain, the user must be followed by "@" and the name of the remote domain.
Types Object Data Type Control and Status Job Text

-job-page-count
The -job-page-count single-valued attribute reports the number of physical pages in the job. If you do not set this attribute, the fax physical destination computes the number automatically and uses it to set page references on the fax cover sheet.

HP Output Server

121

Chapter 2
-job-print-after

Attributes

For more information, see the -fax-no-page-count and -page-count attributes.

Types Object Data Type Control and Status Job: Fax Integer (Positive)

-job-print-after
The -job-print-after single-valued attribute specifies the time at which the job is available for scheduling to be processed. Processing does not necessarily start at that time. A job is subject to deletion if the -job-deadline-time arrives.
Types Object Data Type Control and Status Job Time (UTC)

-job-priority -job-priority-default
The -job-priority single-valued attribute specifies the priority for a job in a priority-based (pd-batch) queue. If the delivery request does not specify the priority with the -job-priority attribute, and the -job-priority-default attribute is not set, the job has the lowest priority. The -job-priority-default single-valued attribute specifies the priority for a job in a priority-based (pd-batch) queue when the priority has not been set with the -job-priority attribute. Set this attribute on the logical destination that feeds the priority-based queue.
Types Objects Control and Status -job-priority: Job -job-priority-default: Destination: Logical Data Type Valid Values Integer 0 through 100

122

System Administrators Attribute Reference

Chapter 2

Attributes

-job-punch-count

-job-punch-count -punch-count-default -punch-counts-supported

The -job-punch-count single-valued attribute specifies the number of hole punches at a job. Some printer models may support features that require setting both -job-punch-count and -job-punch-location. For features available to your printer, consult the printer and printer accessory manual. NOTE: The -job-punch-count attribute applies to advanced printers only. For more information about advanced printers and advanced delivery pathways, see the System Administrators Guide for HP Output Server. The -punch-count-default single-valued attribute specifies the default number of hole punches if -job-punch-count is not set at the job. The -punch-counts-supported multi-valued attribute specifies the valid values for the -job-punch-count attribute.
Types -job-punch-count: Control and Status -punch-count-default: Configuration and Status -punch-counts-supported: Configuration and Status Objects -job-punch-count: Job -punch-count-default: Destination: Logical, Physical -punch-counts-supported: Destination: Logical Data Type Valid Values Integer 0,2,3 and 4

-job-punch-location -punch-location-default -punch-locations-supported

The -job-punch-location single-valued attribute specifies the hole punch location at a job. It also specifies if the punch is required for a job.

HP Output Server

123

Chapter 2

Attributes

-punch-locations-supported

Some printer models may support features that require setting both -job-punch-location and -job-punch-count. For features available to your printer, consult the printer and printer accessory manual. NOTE: The -job-punch-location attribute applies to advanced printers only. For more information about advanced printers and advanced delivery pathways, see the System Administrators Guide for HP Output Server. The -punch-location-default single-valued attribute specifies the default hole punch location if -job-punch-location is not set at the job. The -punch-locations-supported multi-valued attribute specifies valid values for the -job-punch-location attribute.
Types -job-punch-location: Control and Status -punch-location-default: Configuration -punch-locations-supported: Configuration Objects -job-punch-location: Job -punch-location-default: Destination: Logical, Physical -punch-locations-supported: Destination: Logical Data Type Text

Valid Values

none, true, left, top, and right

124

System Administrators Attribute Reference

Chapter 2

Attributes

-job-punch-type

-job-punch-type -punch-type-default -punch-types-supported

The -job-punch-type single-valued text job attribute specifies the hole punch type for a job. Because -job-punch-type can define both hole punch count and location, do not use this attribute with -job-punch-count or -job-punch-location. NOTE: The -job-punch-type attribute applies to advanced printers only. For more information about advanced printers and advanced delivery pathways, see the System Administrators Guide for HP Output Server. The -punch-type-default single-valued attribute specifies the default hole punch type if -job-punch-type is not set at the job. The -punch-types-supported multi-valued attribute specifies valid values for the -job-punch-type attribute.
Types -job-punch-type: Control and Status -punch-type-default: Configuration -punch-types-supported: Configuration Objects -job-punch-type: Job -punch-type-default: Destination: Logical, Physical -punch-types-supported: Destination: Logical Data Type Valid Values Text printerselect

-job-retention-period -retention-period-default
The -job-retention-period single-valued attribute specifies the time (in minutes) that jobs should remain in the database after they complete. The -retention-period-default single-valued attribute specifies the length of time (in minutes) that the JQM retains a subjob after it completes (successfully or not). This attribute defines the retention period if the -job-retention-period attribute has not been set.

HP Output Server

125

Chapter 2

Attributes

-job-retention-period-limit

Although there is no system default value, most logical destination templates that are provided with HP Output Server set the -retention-period-default attribute to 360 minutes (6 hours). If the retention period is not set, the subjob is discarded immediately after completion.
Types -job-retention-period: Control and Status -retention-period-default: Configuration and Status Objects -job-retention-period: Job -retention-period-default: Destinations: Logical, Physical Data Type Integer (Minutes)

-job-retention-period-limit
The -job-retention-period-limit single-valued attribute specifies the job-expiration time frame a JQM uses to build an internal list of jobs that require processing. If this attribute is not defined, the default is 1800 seconds (30 minutes). Each JQM monitors asynchronous events that require processing, including job expiration. The JQM queries the database for a list of the jobs that will expire within the time frame defined by the -job-retention-period-limit. With the attribute set to the default, the JQM will query the database for all jobs that are due to expire within the next 30 minutes. With the list of jobs built, the list grows smaller as jobs expire. When the -job-retention-period-limit is reached, the JQM queries the database for the next set of jobs set to expire within the -job-retention-period-limit. If no jobs are set to expire within this limit, the JQM does nothing until the limit is reached and the next list of jobs is built. If the job list is large, the JQMs memory usage can increase significantly. Setting the -job-retention-period-limit to a smaller value, such as 600 seconds (10 minutes), can decrease the number of jobs in the list and, as a result, the memory allocated to the task. A trade-off to setting the attribute to a value smaller than the default is that the JQM will query the database more frequently for expiring jobs.
Types Object Data Type Control and Status Server: JQM Integer (Seconds)

126

System Administrators Attribute Reference

Chapter 2

Attributes

-job-retention-time

-job-retention-time
The -job-retention-time single-valued attribute reports the time when a jobs retention period is set to expire and the job is to be deleted. The value of -job-retention-time is calculated by added the value of a jobs -job-retention-period to the time the job was completed.
Types Object Data Type Control and Status Job Time (UTC)

-job-staple-count -staple-count-default -staple-counts-supported

The -job-staple-count single-valued attribute specifies the number of staples for a document. Some printer models may support features that require setting both -job-staple-count and -job-staple-location. For example, with -job-staple-count 2 and -job-staple-location topleft, the dual topleft feature is enabled on some printer models. For features available to your printer, consult the printer and printer accessory manual. The -staple-count-default single-valued attribute specifies the default staple count if -job-staple-count is not set at the job. The -staple-counts-supported multi-valued attribute specifies the valid values for the -job-staple-count attribute. The -job-staple-count, -staple-count-default, and -staple-counts-supported attributes apply to select static and advanced printers. To enable this document finishing feature for static printers, set the -printer-model attribute on the physical destination to one of the following values, depending on your printer model: hp_pjl lexmark_pjl

For static printers, if this attribute is not specified, and the -job-finishing attribute is set to staples, then the printer will default to a staple count of 1.

HP Output Server

127

Chapter 2

Attributes

-job-staple-location

For information about using this feature on advanced printers and advanced delivery pathways, see the System Administrators Guide for HP Output Server.
Types -job-staple-count: Status and Control -staple-count-default: Configuration -staple-counts-supported: Configuration Objects -job-staple-count: Document -staple-count-default: Destinations: Logical, Physical -staple-counts-supported: Destination: Logical Data Type Valid Values Integer 0, 1, 2, 3, 6 Valid supported values depend on the model of printer.

-job-staple-location -staple-location-default -staple-locations-supported

The -job-staple-location single-valued attribute specifies the location of staples applied to a job. Some printer models may support features that require setting both -job-staple-count and -job-staple-location. For example, with -job-staple-count 2 and -job-staple-location topleft, the dual topleft feature is enabled on some printer models. For features available to your printer, consult the printer and printer accessory manual. NOTE: The -job-staple-location attribute applies to advanced printers only. For more information about advanced printers and advanced delivery pathways, see the System Administrators Guide for HP Output Server. The -staple-location-default single-valued attribute specifies the default location of staples if -job-staple-location is not set at the job.

128

System Administrators Attribute Reference

Chapter 2

Attributes

-job-staple-type

The -staple-location-supported multi-valued attribute specifies the valid values for -job-staple-location.
Types -job-staple-location: Control and Status -staple-location-default: Configuration -staple-locations-supported: Configuration Objects -job-staple-location: Job: -staple-location-default: Destination: Logical, Physical -staple-locations-supported: Destination: Logical Data Type Valid Values Identifier top, left, right, topleft, topright, front, back

-job-staple-type -staple-type-default -staple-types-supported

The -job-staple-type single-valued attribute specifies the staple type applied to a job. Because -job-staple-type can define both staple count and location, do not use this attribute with -job-staple-count or -job-staple-location. NOTE: The -job-staple-type attribute applies to advanced printers only. For more information about advanced printers and advanced delivery pathways, see the System Administrators Guide for HP Output Server. The -staple-type-default single-valued attribute specifies the default staple type if -job-staple-type is not set at the job. The -staple-types-supported multi-valued attribute specifies the valid values for -job-staple-type.
Types -job-staple-type: Control and Status -staple-type-default: Configuration -staple-types-supported: Configuration Objects -job-staple-type: Job -staple-type-default: Destination: Logical, Physical -staple-types-supported: Destination: Logical

HP Output Server

129

Chapter 2

Attributes

-job-state-on-printer

Data Type Valid Values

Text oneangled oneopposed saddlestitch custom, option3, option4, option5, option6 The staple is angled at top left. The staple is angled at top right. Stapling along the left edge forms a booklet. User-defined custom stapling options are stored on the physical printer.

-job-state-on-printer
The -job-state-on-printer single-valued attribute specifies the job state of a remote system. An external physical destination assumes the job is in the printing state until an external agent notifies it of a completed state transition.
Type Object Data Type Valid Values Status Job Identifier aborting, document-transfer-pending, held, interrupted, paused, pending, pre-processing, processing, retained, transferring, unknown Although unknown is a valid state, it occurs only before a job begins delivery and after it completes delivery.

-job-submission-complete
The -job-submission-complete single-valued attribute indicates that the job is properly constructed, and in particular, that the JQM has received all documents for the job.
Type Object Data Type Valid Values Status Job Boolean TRUE, true, FALSE, false, YES, yes, NO, no

130

System Administrators Attribute Reference

Chapter 2

Attributes
-job-validate

-job-validate
The -job-validate single-valued attribute specifies job validation: the server checks that the destination can satisfy all attributes in the delivery request.
Types Object Data Type Valid Values Control and Status Job Identifier and-print (default) delivers the job normally. The job is not queued if it does not pass validation. submit-only validates the job but does not place it in the queue. The system issues a job ID if the job passes validation, otherwise the system issues an error.

-last-job-events
The -last-job-events multi-valued attribute reports the history of job events in reverse chronological order. When used with the -name-of-last-accessor and -modification-time attributes, the -last-job-events attribute can serve as a tracking tool for a job.
Type Object Data Type Valid Values Status Job Identifier All event values

-left-margin -left-margin-default
The -left-margin single-valued attribute specifies the size, in points, of the left margin of a text document sent to a PostScript destination. The -left-margin-default single-valued attribute specifies the default size of the left margin.
Types -left-margin: Control -left-margin-default: Configuration

HP Output Server

131

Chapter 2
-length

Attributes

Objects

-left-margin: Document -left-margin-default: Destinations: Logical, Physical

Data Type

Integer (Positive)

-length -length-default
The -length single-valued attribute specifies the number of lines (n) on each page. The page break occurs after the nth line. Three lines are added for -header-text and three lines are added for -footer-text. If n is 0, no page break occurs. Form-feed characters are used as the page-break character. The -length-default single-valued attribute specifies the default number of lines (n) on each page.
Types -length: Control and Status -length-default: Configuration and Status Objects -length: Document: Text -length-default: Destinations: Logical, Physical Data Type Integer

-list-of-managers
The -list-of-managers multi-valued attribute specifies a user- or administrator-supplied description. You can apply this attribute to any object, including jobs. The values for this attribute cannot contain embedded spaces.
Types Objects Data Type Configuration, Control, and Status All Objects Text

-logical-page-border
The -logical-page-border single-valued attribute determines the type of border, if any, to draw around the logical page.
Types Control and Status

132

System Administrators Attribute Reference

Chapter 2

Attributes

-logical-page-origin

Objects Data Type Valid Values

Documents: PS, PCL, Fax Identifier none (default), solid, dashed, corners

-logical-page-origin
The -logical-page-origin multi-valued attribute specifies the orientation of the logical page in terms of how the source page origin (the lower-left corner) maps to the logical page origin. The -logical-page-origin attribute defines a list of values, one for each logical page on the physical page. The value of -logical-page-origin specifies the rotation of the logical page: lower-left: 0, lower-right: 90, upper-right: 180, upper-left: 270. All degrees are measured in a counter-clockwise rotation. The resulting corner serves as the origin of the Logical Page Coordinate System (LPCS), from which the positioning of the page is specified with offsets. The logical page origin of each page is specified by -logical-page-x-offset, -logical-page-y-offset, and the size of each page by -logical-page-scaling. The values must proceed in order for each logical page. For logical page functionality to work correctly, you must use all of the following four attributes together: -logical-page-origin -logical-page-scaling -logical-page-x-offset -logical-page-y-offset For more information, see the description for the -logical-page-scaling attribute.
Types Objects Data Type Valid Values Control and Status Documents: PS, PCL, Fax Identifier lower-left, lower-right, upper-right, upper-left

-logical-page-scaling -logical-page-x-offset -logical-page-y-offset

HP Output Server 133

Chapter 2

Attributes

-logical-printers-assigned

The -logical-page-scaling, -logical-page-x-offset, and -logical-page-y-offset attributes work in conjunction with the -logical-page-origin attribute to map a source page to the logical page. All four attributes work together in the following order to provide logical page functionality: 1. 2. 3. The -logical-page-origin specifies the x-y origin (before rotation) of the physical page. The image is moved as specified by the values of -logical-page-x-offset and -logical-page-y-offset. Using the value of -logical-page-origin, the image is rotated.

The -logical-page-scaling multi-valued attribute lists values, one for each logical page on the physical page. Each value is a real number that specifies the size of the logical page image as a percentage of the original page image. A value of 1.0 is equal to 100 percent. The -logical-page-x-offset multi-valued attribute lists values, one for each logical page on the physical page. Each value represents a real number of points (1/72 inch), measured from the LPCS origin along the x-axis. The values must proceed in sequence for each logical page. The nth -logical-page-x-offset and nth -logical-page-y-offset are paired to form the origin of the logical page. The -logical-page-y-offset multi-valued attribute lists values, one for each logical page on the physical page. Each value represents a real number of points (1/72 inch), measured from the LPCS origin along the y axis. The values must proceed in order for each logical page. The nth -logical-page-x-offset and nth -logical-page-y-offset are paired to form the origin of the logical page.
Types Objects Data Type Control and Status Documents: PS, PCL, Fax Real

-logical-printers-assigned
The -logical-printers-assigned multi-valued attribute specifies the logical destinations that are assigned to a queue and their state. To view the value of this attribute for a queue, use the pdls command as follows, ensuring that the managing JQM is running: pdls -a all queueName

134

System Administrators Attribute Reference

Chapter 2

Attributes
-lpd-file-format

The -logical-printers-assigned attribute replaces the following JQM attributes: -logical-printers-supported -logical-printers-ready Additionally, the following attributes should no longer be set on a JQM: -queues-supported-by-server -queues-ready If these attributes are set on a JQM, you may experience delivery interruptions.
Type Object Data Type Configuration and Status Queue Object name

-lpd-file-format -lpd-file-format-default
The -lpd-file-format multi-valued attribute specifies the control file at the lpd server. The -lpd-file-format-default multi-valued attribute specifies the default control file at the lpd server.
Types Objects Configuration and Control -lpd-file-format: Job -lpd-file-format-default: Destination (LPR): Logical Data Type Valid Values Identifier cif, dvi, formatted, plot, literal, ditroff, postscript, pr, fortran, troff, raster

-lpd-host -lpd-host-default -lpd-hosts-supported

The required -lpd-host single-valued attribute specifies the lpd host to which jobs are submitted.

HP Output Server

135

Chapter 2

Attributes

-lpd-non-root-connection

The -lpd-host-default single-valued attribute specifies the default lpd host to which jobs are delivered. The -lpd-hosts-supported multi-valued attribute specifies the valid -lpd-host values. Set this attribute to restrict which hosts are valid destinations. To set this attribute, type the following command, ensuring that you include a space between values (after the comma and before the backslash in the example): pdset -c d -x"-lpd-hosts-supported \"host1\", \"host2\", \"host3\"" logicalDestination

Types

-lpd-host: Control and Status -lpd-host-default: Configuration and Status -lpd-hosts-supported: Configuration and Status

Objects

-lpd-host: Job: LPR -lpd-host-default: Destinations (LPR): Logical, Physical -lpd-hosts-supported: Destination: Logical (LPR)

Data Type

Text

-lpd-non-root-connection
The -lpd-non-root-connection single-valued attribute allows you to configure a standard lpd connected physical printer as a non-root user. If the value is false (the default), lpd connections are established using TCP port numbers below 1024. Consequently, root privileges are required by the DSM. If the value is true, lpd connections are established using TCP port numbers at or above 1024. In this case, root privileges are not required by the DSM.
Type Object Data Type Valid Values Configuration Destination: Physical Boolean TRUE, true, FALSE, false

136

System Administrators Attribute Reference

Chapter 2

Attributes
-lpd-printer

-lpd-printer -lpd-printer-default -lpd-printers-supported

The required -lpd-printer single-valued attribute specifies the queue associated with a printer on an LPR server or a queue on a physical printer. This is the printer on which printing occurs. The -lpd-printer-default single-valued attribute specifies the default -lpd-printer value. The -lpd-printers-supported multi-valued attribute lists valid -lpd-printer values. Set this attribute to restrict which physical destinations or print queues are valid destinations for a given host. For example, if a host is represented by several physical destinations, this attribute can specify that only the hosts physical destination that is configured without a filter can process lpd jobs. The following example illustrates setting the -lpd-printers-supported attribute: pdset -c d -x"-lpd-printers-supported \"printer1\", \"printer2\", \"printer3\"" logicalDestination

Types

-lpd-printer: Control and Status -lpd-printer-default: Configuration and Status -lpd-printers-supported: Configuration and Status

Objects

-lpd-printer: Job: LPR -lpd-printer-default: Destinations (LPR): Logical, Physical -lpd-printers-supported: Destination: Logical (LPR)

Data Type

Text

-lpd-timeout -lpd-timeout-default
The -lpd-timeout single-valued attribute defines the number of minutes the physical destination waits for a response from the remote lpd before considering the connection timed-out.

HP Output Server

137

Chapter 2

Attributes

-lpg-job-owner-all-jobs

The -lpd-timeout-default single-valued attribute sets a default value if -lpd-timeout is not set at the job.
Type Objects Control -lpd-timeout: Job: LPR -lpd-timeout-default: Destinations (LPR): Logical, Physical Data Type Integer (Minutes)

-lpg-job-owner-all-jobs
The -lpg-job-owner-all-jobs single-valued attribute specifies a user ID for all incoming requests to the HP Output Server LPR Gateway. By default, the user submitting a job to the LPR Gateway becomes the owner of the job inside HP Output Server. For example, if user joe sends a job to the LPR Gateway, the HP Output Server job owner is joe. Setting the -lpg-job-owner-all-jobs attribute superimposes a user ID on all incoming requests. For example, if the LPR Gateway is configured with user printer_person as the owner of all jobs, even if joe submits a job to the LPR Gateway, printer_person is still the job owner in HP Output Server.
Types Object Data Type Configuration and Status Server Text

-lpg-masterlock
The -lpg-masterlock single-valued attribute overrides the default location of the lock file for the specified LPR Gateway. On UNIX, the default location of the lock file is /etc/locks/lpd. If you configure two HP Output Server domains in a multiple NIC environment to run two LPR Gateway servers (one for each HP Output Server domain), you must set the -lpg-masterlock attribute on one of the LPR Gateway servers. If you do not specify a lock file, the second LPR Gateway server will not start. NOTE: Support for configuring multiple LPR Gateway servers is available on UNIX systems only.

138

System Administrators Attribute Reference

Chapter 2

Attributes
-lpg-options

To create a second LPR Gateway server and set the -lpg-masterlock attribute to a different lock file, use the config_server command as follows: config_server -t lpg -x"-lpg-masterlock unique-LockFile" lpgName If you are configuring more than one LPR Gateway server, set -lpg-masterlock on the second and subsequent LPR Gateway servers to a uniqueLockFile.
Types Object Data Type Configuration and Status Server Text

-lpg-options
The -lpg-options single-valued attribute overrides the default location of the options mapping file for the specified LPR Gateway. The options mapping file supports the conversion of System V print options to HP Output Server job attributes for jobs sent through the LPR Gateway. The default location of the mapping file is installDir/etc/lpg.options. To configure an LPR Gateway server to use a mapping file other than the default, set the path with the config_server command as follows: config_server -u -x"-lpg-options path" lpgName For information about creating a new mapping file, see the HP Output Server LPR Gateway chapter in the System Administrators Guide for HP Output Server.
Types Object Data Type Configuration and Status Server Text

-lpg-printcap
The -lpg-printcap single-valued attribute overrides the default location of the printcap file. On UNIX, the default location is /etc/printcap; on Windows, the default location is $DAZEL_HOME\etc\printcap. Set this attribute with the config_server command.
Types Configuration and Status

HP Output Server

139

Chapter 2
-mail-message

Attributes

Object Data Type

Server Text

-mail-message -mail-message-default
The -mail-message single-valued attribute specifies the plain text content of a mail message. If an attachment is not part of an e-mail, the -mail-message attribute is either ignored or appears above the message. When assigning multiple lines to the value of -mail-message and including this attribute in an options file, each line must end with a backslash character (\). Additionally, enclose the entire range of values within double quotes, as in the following example: -mail-message "\ first line \ second line" The -mail-message-default single-valued attribute specifies the default value of -mail-message.
Types -mail-message: Control and Status -mail-message-default: Configuration Object -mail-message: Job: E-mail -mail-message-default: Destination: Logical, Physical Data Type Text

-mail-program
The -mail-program single-valued attribute specifies the mail program invoked by the e-mail physical destination.
Types Object Data Type Configuration and Status Destination: Physical (E-mail) Text

140

System Administrators Attribute Reference

Chapter 2

Attributes
-mail-protocol

-mail-protocol -mail-protocol-default -mail-protocols-supported

The -mail-protocol single-valued attribute specifies the protocol for the message body. The message body may or may not be encoded. The MIME value specifies that the message body is encoded using MIME headers. The encoding method for attachments can be specified with the -encoding-method job attribute. The -mail-protocol-default single-valued attribute specifies the default attachment protocol for the e-mail physical destination. Unless overridden by the -mail-protocol attribute, this attribute determines whether attachments are allowed. The -mail-protocols-supported multi-valued attribute specifies valid values for the -mail-protocol attribute.
Types Objects Control and Status -mail-protocol: Job: E-mail -mail-protocol-default: Destinations: Physical, Logical (E-mail) -mail-protocols-supported: Destination: Logical (E-mail) Data Type Valid Values Identifier MIME, standard

-mail-recipient -mail-recipient-default -mail-recipients-supported

The -mail-recipient multi-valued attribute specifies one or more intended recipients of the mail message. This attribute is required for the document to be sent to e-mail destinations. The -mail-recipient-default multi-valued attribute specifies a default value for -mail-recipient.

HP Output Server

141

Chapter 2

Attributes

-mail-recipient-bcc

The -mail-recipient-supported multi-valued attribute specifies valid values for -mail-recipient.

Types -mail-recipient: Control and Status -mail-recipient-default: Configuration -mail-recipients-supported: Configuration Objects -mail-recipient: Job: E-mail -mail-recipient-default: Destination: Logical, Physical -mail-recipients-supported: Destination: Logical Data Type Text

-mail-recipient-bcc -mail-recipient-bcc-default -mail-recipients-bcc-supported

The -mail-recipient-bcc multi-valued attribute specifies one or more intended blind carbon copy (bcc) recipients of the mail message. A blind carbon copy of the mail message is sent to the -mail-recipient-bcc but is not visible to the -mail-recipient and any carbon copy recipients set with -mail-recipient-cc. The -mail-recipient-bcc-default multi-valued attribute specifies a default value for -mail-recipient-bcc. The -mail-recipient-bcc-supported multi-valued attribute specifies valid values for -mail-recipient-bcc.
Types -mail-recipient-bcc: Control and Status -mail-recipient-bcc-default: Configuration -mail-recipients-bcc-supported: Configuration Objects -mail-recipient-bcc: Job: E-mail -mail-recipient-bcc-default: Destination: Logical, Physical -mail-recipients-bcc-supported: Destination: Logical Data Type Text

142

System Administrators Attribute Reference

Chapter 2

Attributes

-mail-recipient-cc

-mail-recipient-cc -mail-recipient-cc-default -mail-recipients-cc-supported

The -mail-recipient-cc multi-valued attribute specifies one or more intended carbon copy (cc) recipients of the mail message. The -mail-recipient-cc receives the mail message in addition to the -mail-recipient and any blind carbon copy recipients specified with -mail-recipient-bcc. The -mail-recipient-cc-default multi-valued attribute specifies a default value for -mail-recipient-cc. The -mail-recipient-cc-supported multi-valued attribute specifies valid values for -mail-recipient-cc.
Types -mail-recipient-cc: Control and Status -mail-recipient-cc-default: Configuration -mail-recipients-cc-supported: Configuration Objects -mail-recipient-cc: Job: E-mail -mail-recipient-cc-default: Destination: Logical, Physical -mail-recipients-cc-supported: Destination: Logical Data Type Text

-mail-reply-to
The -mail-reply-to multi-valued attribute specifies one or more intended recipients of a reply to a mail message. If this attribute is not set, the default reply-to recipient is -mail-sender.
Type Object Data Type Control and Status Job: E-mail Text

-mail-return -mail-return-default
The -mail-return single-valued attribute specifies a return e-mail address other than that of the sender.

HP Output Server

143

Chapter 2

Attributes

-mail-return-reply-type

If the value of the -mail-return attribute exceeds 16,380 characters in length, the job will fail. The -mail-return-default single-valued attribute specifies a default return e-mail address other than that of the sender.
Type Objects Status -mail-return: Job: E-mail -mail-return-default: Destination: Logical, Physical Data Type Text

-mail-return-reply-type -mail-return-reply-type-default
The -mail-return-reply-type single-valued attribute specifies the method of notification to be sent in situations pre-defined by the -mail-set-dsn attribute. If this attribute is set to FULL, the MAILER-DAEMON will return the e-mail document with headers and body content. If set to HDRS, the MAILER-DAEMON will return only the e-mail headers. The -mail-return-reply-type-default single-valued attribute specifies a default method of notification to be sent in situations pre-defined by the -mail-set-dsn attribute.
Types Objects Control and Status -mail-return-reply-type: Job: Email -mail-return-reply-type-default: Destination: Logical, Physical Data Type Valid Values Text FULL, HDRS

-mail-sender -mail-sender-default
The -mail-sender single-valued attribute is the originator of the mail message. The default value is the -job-owner.

144

System Administrators Attribute Reference

Chapter 2

Attributes
-mail-set-dsn

If the value of the -mail-sender attribute exceeds 16,380 characters in length, the job will fail. NOTE: Mail clients, such as sendmail or minimail, may impose a shorter character limit on -mail-sender. If the mail clients character limit is exceeded, the recipient will not receive the mail. The -mail-sender-default single-valued attribute specifies a default value on the physical destination that correctly identifies a mail sender without setting the -mail-sender attribute.
Types -mail-sender: Control and Status -mail-sender-default: Configuration Objects -mail-sender: Job: E-mail -mail-sender-default: Destination: Logical, Physical (E-mail) Data Type Text

-mail-set-dsn -mail-set-dsn-default
The -mail-set-dsn multi-valued attribute specifies the types of job status notification sent to the address set in the -mail-return attribute. If the -mail-return attribute is not set and the -mail-set-dsn attribute is set, the job is canceled. The -mail-set-dsn-default multi-valued attribute specifies the default types of job status notification sent to the address set in the -mail-return attribute. If the -mail-return attribute is not set and the -mail-set-dsn-default attribute is set, the job is canceled.
Types Objects Control and Status -mail-set-dsn: Document -mail-set-dsn-default: Destination: Physical, Logical Data Type Text

HP Output Server

145

Chapter 2
-mail-subject

Attributes

Valid Values

NEVER FAILURE SUCCESS DELAY

No notification is sent on any job status. Using this value along with any other value causes the job to be canceled. Users defined by the -mail-return attribute are notified about failed jobs. Users defined by the -mail-return attribute are notified about successful jobs Users defined by the -mail-return attribute are notified about delayed jobs.

-mail-subject -mail-subject-default
The -mail-subject single-valued attribute is the subject of the mail message that appears in the subject line. The -mail-subject-default single-valued attribute specifies a default value on the physical destination that correctly identifies a mail subject without setting the -mail-subject attribute.
Types -mail-subject: Control and Status -mail-subject-default: Configuration Objects -mail-subject: Job: E-mail -mail-subject-default: Destination: Logical, Physical (E-mail) Data Type Text

-managing-server
The -managing-server single-valued attribute specifies the server that manages an object. A JQM manages itself and its logical destinations and queues. A DSM manages itself and its physical destinations. The values for this attribute cannot contain embedded spaces. The following example illustrates how to create a queue named queue1 and specify that it be managed by the JQM named jqm1: pdcreate -c queue -x"-copy-from batch_queue_template -managing-server jqm1" queue1

Type

Configuration

146

System Administrators Attribute Reference

Chapter 2

Attributes

-maximum-tries

Objects Data Type

All Objects Text

-maximum-tries -maximum-tries-default
The -maximum-tries single-valued attribute specifies the maximum number of delivery attempts to a destination. When delivery attempts exceed the maximum, the job is aborted. Each delivery attempt counts toward the value of -maximum-tries, even if the destination is disabled when the delivery attempt is made. If you send a job to a fax destination farm and the fax physical destination encounters a failure, it is disabled automatically and the job is sent to the next available destination in the farm. If -maximum-tries is set to 1, and the fax destination encounters a failure, the job is not sent to another destination. The -maximum-tries-default single-valued attribute specifies the default number of times that a server should attempt to deliver to a destination.
Types -maximum-tries: Control and Status -maximum-tries-default: Configuration and Status Objects -maximum-tries: Job -maximum-tries-default: Destination: Logical Data Type Integer (Positive)

-medium-select -media-used -medium-default -media-supported

The -medium-select single-valued user-supplied attribute specifies the medium used for a document in a job. The -media-used multi-valued attribute specifies the media for a document in a job. The -medium-default single-valued attribute determines the default medium to be used for jobs. The -media-supported multi-valued attribute lists valid media.

HP Output Server

147

Chapter 2

Attributes

-media-supported

Before a job is delivered to a printer, the jobs input tray and medium are determined by checking the following attributes in the following order: -medium-select -input-tray-select -media-used -input-trays-used -medium-default -input-tray-default When a jobs medium or input tray is determined, the -input-trays-medium attribute is consulted. The -input-trays-medium attribute maps input trays with media. If the job determines its medium, it checks the -input-trays-medium attribute to determine which tray is associated with the specified medium. If the job cannot define the missing value with the -input-trays-medium attribute, it searches the remaining attributes until it determines both values. If none of these attributes set the input tray, it defaults to what is set at the printer. If none of the attributes define the paper type, then the value is either north-american-letter-white (8.5 by 11 inches) or iso-a4-white (21 by 29.7 centimeters), depending on your HP Output Server configuration. Because specifying the medium determines the size page the device uses, the setting for the -media-used attribute affects how the physical destination computes the -page-layout attribute and how it determines which input tray to use. See also the -medium-select and -page-size attributes.
Types -medium-select: Control -media-used: Control -medium-default: Configuration and Status -media-supported: Configuration and Status Objects -medium-select: Document -media-used: Document -medium-default: Destinations: Logical, Physical (PCL, PS, Fax) -media-supported: Destination: Logical Data Type Identifier

148

System Administrators Attribute Reference

Chapter 2

Attributes

-media-supported

Valid Values

7-envelope 7x9-white 10x14-white 10x14-coloured a a-white a-coloured b b-white b-coloured c c-white c-coloured d d-white d-coloured e e-white e-coloured executive-white executive-coloured half-letter-white iso-a0-white iso-a1-white iso-a2-white iso-a3-white iso-a3-coloured iso-a4-white iso-a4-coloured iso-a4-transparent iso-a5-white iso-a5-coloured iso-a6-white iso-a7-white iso-a8-white iso-a9-white iso-a10-white

iso-b0-white iso-b1-white iso-b2-white iso-b3-white iso-b4-white iso-b4-coloured iso-b4-envelope iso-b5-white iso-b5-coloured iso-b5-envelope iso-b6-white iso-b7-white iso-b8-white iso-b9-white iso-b10-white iso-c4-envelope iso-c5-envelope iso-designated-long-envelope north-american-6x9-envelope north-american-7x9-envelope north-american-9x11-envelope north-american-9x12-envelope north-american-10x13-envelope north-american-10x14-envelope north-american-10x15-envelope north-american -business-envelope north-american-letter-white north-american-letter-coloured north-american-letter -transparent north-american-legal-white north-american-legal-coloured north-american-number-9 -envelope north-american-number-10 -envelope two-thirds-a4-white

Valid values for advanced printers only: labels, ledger, north-american-ledger-11x17, tabloid

HP Output Server

149

Chapter 2
-message

Attributes

-message
The -message single-valued attribute specifies a generic message that can be associated with any object. If the attribute is not set explicitly, it records the last action performed on a job, such as, job cancelled, object enabled, object disabled, server shutdown, paused, resumed, or object cleaned.
Types Objects Data Type Configuration, Control, and Status All Objects Text

-minimum-retry-interval -minimum-retry-interval-default
The -minimum-retry-interval single-valued attribute specifies the minimum interval after which to re-send a job. When a job is interrupted due to a transient error, the job is held for at least the number of seconds defined by the -minimum-retry-interval attribute. After these seconds pass, the job is available for processing again. An example of a transient error is when a -fax-phone-number is busy. The -minimum-retry-interval-default single-valued attribute specifies the -minimum-retry-interval attribute default value.
Types

-minimum-retry-interval: Control and Status -minimum-retry-interval-default: Configuration and

Status

Objects

-minimum-retry-interval: Job -minimum-retry-interval-default: Destinations: Logical,

Physical

Data Type

Integer (Seconds)

150

System Administrators Attribute Reference

Chapter 2

Attributes

-modem-force-long-distance

-modem-force-long-distance
The -modem-force-long-distance single-valued destination attribute indicates if all calls are dialed with the long distance prefix and area code. The default is false. Set this attribute to true if the country in which calls originate requires that all in-country calls be dialed as long-distance calls.
Types Object Data Type Valid Values Configuration and Status Destination: Physical Boolean TRUE, true, FALSE, false, YES, yes, NO, no

-modem-initialization
The -modem-initialization single-valued attribute specifies a string of characters that initializes a modem. The characters in the string must be space-separated, and should not be preceded by "AT." The setting depends on the type of modem. HP Output Server provides initialization strings for modems that we support. For more information about the initialization strings, please visit the Customer Support Web site.
Types Object Data Type Configuration and Status Destination: Physical Text

-modem-international-prefix -modem-international-prefix-default
The -modem-international-prefix single-valued job attribute contains the dial string to start an international call. For example, the dial string to start an international call in the USA is 011. For many other countries/regions, the dial string is 00. The -modem-international-prefix-default single-valued destination attribute provides the dial string to start an international call if the -modem-international-prefix job attribute is not set.
Types Configuration and Status

HP Output Server

151

Chapter 2

Attributes

-modem-international-suffix

Objects

-modem-international-prefix: Job -modem-international-prefix-default: Destination: Physical

Data Type

Text

-modem-international-suffix -modem-international-suffix-default
The -modem-international-suffix single-valued job attribute contains the string to append to an international telephone number. The -modem-international-suffix-default single-valued destination attribute provides the string to append to an international telephone number if the -modem-international-suffix job attribute is not set.
Types Objects Configuration and Status -modem-international-suffix: Job -modem-international-suffix-default: Destination: Physical Data Type Text

-modem-local-area-code
The -modem-local-area-code single-valued destination attribute contains the area code of the dialing telephone.
Types Object Data Type Configuration and Status Destination: Physical Text

-modem-local-call-area-codes
The -modem-local-call-area-codes multi-valued destination attribute contains the list of area codes to dial without prepending the value of either the -modem-long-distance-prefix job attribute or the -modem-long-distance-prefix-default destination attribute.

152

System Administrators Attribute Reference

Chapter 2

Attributes

-modem-local-country-code

This attribute is used in major metropolitan areas that require 10-digit local telephone numbers. This attribute is not considered if the -modem-force-long-distance attribute is set to true.
Types Object Data Type Configuration and Status Destination: Physical Text

-modem-local-country-code
The -modem-local-country-code single-valued destination attribute contains the country code of the dialing telephone. For example, the country code for the USA is 1; for the UK, it is 44; for France, it is 33; and for Germany, it is 49.
Types Object Data Type Configuration and Status Destination: Physical Text

-modem-long-distance-prefix -modem-long-distance-prefix-default
The -modem-long-distance-prefix single-valued job attribute contains the dial string to start a long-distance call from within the country. For example, the dial string to start a long-distance call in the USA is 1; for France, Germany, and the UK, it is 0. The -modem-long-distance-prefix-default single-valued destination attribute provides the dial string to start a long-distance call if the -modem-long-distance-prefix job attribute is not set.
Types Objects Configuration and Status -modem-long-distance-prefix: Job -modem-long-distance-prefix-default: Destination: Physical Data Type Text

HP Output Server

153

Chapter 2

Attributes

-modem-long-distance-suffix

-modem-long-distance-suffix -modem-long-distance-suffix-default
The -modem-long-distance-suffix single-valued job attribute contains the string to append to a long-distance telephone number. The -modem-long-distance-suffix-default single-valued destination attribute provides the string to append to a long-distance telephone number if the -modem-long-distance-suffix job attribute is not set.
Types Objects Configuration and Status -modem-long-distance-suffix: Job -modem-long-distance-suffix-default: Destination: Physical Data Type Text

-modem-pbx-outside-prefix
The -modem-pbx-outside-prefix single-valued attribute specifies the PBX or long-distance access prefix sequence (such as 1 800 nnn nnnn or 9 1 010 nnn nnnn) to add before the destinations number to access an outside line. NOTE: For security, when you use the pdls command to list the value of this attribute, the PBX access prefix sequence will appear as asterisks (*).
Types Object Data Type Configuration and Status Destination: Physical Text

154

System Administrators Attribute Reference

Chapter 2

Attributes

-modem-pbx-outside-suffix

-modem-pbx-outside-suffix
The -modem-pbx-outside-suffix single-valued attribute specifies the PBX or long-distance access suffix sequence (such as 1-800-nnn-nnnn or 9-1-010-nnn-nnnn) to add to the end of the destinations phone number, such as when access codes are necessary. NOTE: For security, when you use the pdls command to list the value of this attribute, the PBX suffix sequence will appear as asterisks (*).
Types Object Data Type Configuration and Status Destination: Physical Text

-modem-phone-number -modem-phone-number-default -modem-phone-numbers-supported

The -modem-phone-number multi-valued job attribute contains a destination phone number in the portable phone number format defined by the Telecommunication Standardization Sector of the International Telecommunication Union (ITU-T). To specify multiple phone numbers, separate each phone number with a combination of the comma character (,) and a space. HP Output Server uses multiple phone numbers in left-to-right order. The -modem-phone-number-default single-valued attribute specifies the modem phone number if -modem-phone-number is not set at the job. The -modem-phone-numbers-supported multi-valued attribute specifies the valid numbers for -modem-phone-number. For fax destinations, you can use the following two methods to represent phone numbers: Specify phone numbers with -modem-phone-number and its related attributes. Specify phone numbers with -fax-phone-number and its related attributes.

HP Output Server

155

Chapter 2
-modem-prefix

Attributes

For more information about representing phone numbers for fax destinations, see the System Administrators Guide for HP Output Server.
Types -modem-phone-number: Control -modem-phone-number-default: Configuration and Status -modem-phone-numbers-supported: Configuration Objects -modem-phone-number: Job -modem-phone-number-default: Destination: Physical -modem-phone-numbers-supported: Destination: Logical Data Type Text

-modem-prefix -modem-prefix-default
The -modem-prefix single-valued job attribute contains a long-distance calling card number so that a specific account is billed for the call. For security, the value of this attribute is displayed as asterisks (*). The -modem-prefix-default single-valued attribute specifies a default -modem-prefix value. NOTE: All number sequences that end in a comma must have a space after the comma.
Types Objects Configuration and Status -modem-prefix: Job -modem-prefix-default: Destination: Physical Data Type Text

156

System Administrators Attribute Reference

Chapter 2

Attributes
-modem-rings

-modem-rings
The -modem-rings single-valued attribute sets the maximum number of rings that a fax physical destination waits while dialing and connecting with a remote device through a modem. If the modem does not indicate ringing (through the "RING" result code), it is approximated as four seconds multiplied by the number of -modem-rings.
Types Object Data Type Configuration and Status Destination: Physical Integer (Positive)

-modem-suffix -modem-suffix-default
The -modem-suffix single-valued job attribute contains a long-distance calling card number so that a specific account is billed for the call. For security, the value of this attribute is displayed as asterisks (*). The -modem-suffix-default single-valued attribute specifies a number or series of numbers to add to the end of the destinations phone number, such as when access codes are necessary. For example, to dial the access code 953 after the destination pagers number has been dialed for a specific job, type the following command: pdset -c d -x"-modem-prefix-default 9 -modem-suffix-default \"953\"" object

Types Objects

Configuration and Status -modem-suffix: Job -modem-suffix-default: Destination: Physical

Data Type

Text

HP Output Server

157

Chapter 2

Attributes

-modification-time

-modification-time
The -modification-time single-valued attribute specifies the time at which a job was last modified. The value is NULL if the job is not modified. Used with the -name-of-last-accessor and -last-job-events attributes, the -modification-time attribute can serve as a tracking tool for a job.
Type Object Data Type Status Job Time

-name-of-last-accessor
The -name-of-last-accessor single-valued attribute provides the principal name of the last user to access a job after submission. It is used with the -last-job-events and -modification-time attributes to serve as a tracking tool for a job. The values for this attribute cannot contain embedded spaces.
Type Object Data Type Status Job Text

-network-probe-address
The -network-probe-address single-valued attribute contains the IP address of a device in dotted decimal notation, for example, 10.10.20.3. The probe command returns the values of the -network-probe-address, -network-probe-snmp-query, and -network-probe-snmp-response attributes for each printer it probes.
Type Object Data Type Status Destination: Physical Text

158

System Administrators Attribute Reference

Chapter 2

Attributes

-network-probe-ending-address

-network-probe-ending-address
The -network-probe-ending-address single-valued attribute contains an IP address in dotted decimal notation, for example, 192.207.128.193, and identifies the upper boundary of the range of IP addresses to examine with the probe command. The -network-probe-starting-address attribute defines the lower boundary of the range. The probe command does not search class D network addresses. Therefore, the maximum IP address value for the -network-probe-ending-address attribute is 223.255.255.255. If the -network-probe-starting-address attribute contains an IP address and the -network-probe-ending-address attribute is not specified, the probe command examines only the device at the IP address specified with the -network-probe-starting-address attribute.
Type Object Data Type Configuration Destination: Physical Text

-network-probe-retries
The -network-probe-retries single-valued attribute specifies the number of connection attempts the probe command makes if the initial attempt to connect to a printer fails. The default is 1.
Types Object Data Type Configuration or Status Destination: Physical Integer (Positive)

-network-probe-snmp-query
The -network-probe-snmp-query multi-valued attribute specifies a list of SNMP attributes (variables or tables) to retrieve from printers with the probe command. Each printer-specific component template uses the value of a printers system.sysDescr variable for the value of the -printer-name attribute, and printer-option templates use the value of the host.hrDevice.hrDeviceTable.hrDeviceEntry.hrDeviceDescr variable for the value of the -printer-name attribute.
Type Configuration

HP Output Server

159

Chapter 2

Attributes

-network-probe-snmp-response

Object Data Type

Destination: Physical Text

-network-probe-snmp-response
The -network-probe-snmp-response multi-valued attribute contains the SNMP attribute values that are returned from a printers MIB in response to the SNMP query you send with the probe command. The probe command returns the values of the -network-probe-snmp-response, -network-probe-snmp-query, and -network-probe-address attributes for each printer it probes.
Type Object Data Type Status Destination: Physical Text

-network-probe-starting-address
The -network-probe-starting-address single-valued attribute contains an IP address in dotted decimal notation, for example, 192.207.128.193. This IP address defines the lower boundary of the range of IP addresses to probe when searching for printers in a TCP/IP network, and the -network-probe-ending-address attribute defines the upper boundary of the range. If the -network-probe-starting-address attribute contains an IP address and the -network-probe-ending-address attribute is not specified, the probe command probes only the printer at the IP address specified with the -network-probe-starting-address attribute.
Type Object Data Type Configuration Destination: Physical Text

160

System Administrators Attribute Reference

Chapter 2

Attributes

-network-probe-timeout

-network-probe-timeout
The -network-probe-timeout single-valued attribute specifies the amount of time the probe command waits between retries of an IP address for a response from the IP address. The default is 5 seconds.
Type Object Data Type Configuration Destination: Physical Real (Seconds)

-next-document-timeout
The -next-document-timeout single-valued attribute specifies how long the DSM waits to get a document from the JQM. Communication problems sometimes occur when documents transfer from the JQM to the DSM. If the transfer time exceeds the time specified by the -next-document-timeout attribute, the DSM considers the job failed. The default value is 42 seconds.
Types Object Data Type Configuration and Status Server: DSM Integer (Seconds)

-nm-dazel-data-file
The -nm-dazel-data-file single-valued attribute indicates the file the NM uses for storing host names and port numbers for HP Output Server servers. This file is located at installDir/var/nm/dazel.ns.
Type Object Data Type Configuration Server: NM Text

-notification-profile -notification-profile-default
The -notification-profile multi-valued attribute specifies a set of job events and recipients: the job sends notices to the specified recipients when it encounters the associated job events.

HP Output Server

161

Chapter 2

Attributes

-notification-profile-default

The -notification-profile-default multi-valued attribute specifies a default value for the -notification-profile attribute. With the -notification-profile attribute, you enable a notice to trigger the creation of new notices (class,instance,recipient) to send to people or services who do not receive them otherwise. In other words, you can designate notice recipients for specific job-related events, such as job completion. If you do not set the -notification-profile or -operator-notification-profile attributes, all events are still delivered to the Event Manager (EM), which then distributes the event notices to subscribers. The syntax for the data type EventHandlingProfile is as follows: -notification-profile {{event [, ...]}, deliveryMethod, message, address} [, ...] The event can be an event-class or an individual event, or several of either. The method can be none, electronic-mail (or e-mail), or notification-service (through the EM). You can turn off a notification while keeping its configuration by using the none value for method. The address is either an e-mail address or user name (for notification-service). The format is the same for UNIX and Windows. The following is an example of setting the -notification-profile attribute so that it sends e-mail notification of multiple messages to the user@example.com. NOTE: The multiple values within the examples must be contained in an additional set of brackets. -notification-profile "{{aborted, error, warning, report-job-completed, report-job-resumed, report-processing-started}, electronic-mail, \"Example of Message\", user@example.com}" If you want to send messages to more than one user, for example, all error and warning level messages, type the following command: -notification-profile "{{error, warning}, electronic-mail, \"\", bob@example.com }", "{{error, warning}, electronic-mail, \"\", sue@example.com }"

162

System Administrators Attribute Reference

Chapter 2

Attributes

-number-of-documents

For more information and examples, see the System Administrators Guide for HP Output Server.
Type Objects Status -notification-profile: Job -notification-profile-default: Destination: Logical and Physical (printer) Data Type Valid Values EventHandlingProfile The valid values and format are explained in the attribute description.

-number-of-documents
The -number-of-documents single-valued attribute reports the number of documents in a job.
Type Object Data Type Status Job Integer (Positive)

-number-of-times-tried
The -number-of-times-tried single-valued attribute reports the number of times the JQM attempts to deliver to the destination.
Type Object Data Type Status Job Integer (Positive)

-number-up
The -number-up single-valued attribute specifies the number of page images on each physical page of output. The physical destination automatically calculates the sizing and rotation necessary to position images on the page. For more information, see the -content-orientation and -logical-page-border attributes.
Types Control and Status

HP Output Server

163

Chapter 2

Attributes

-number-up-border

Objects Data Type

Documents: PS, PCL, Fax Integer (Positive)

-number-up-border
The -number-up-border single-valued attribute determines the type of border, if any, drawn around the logical page.
Types Objects Data Type Valid Values Control and Status Documents: PS, PCL, Fax Identifier none (default), solid, dashed, corners

-number-up-keep-scale -number-up-keep-scale-default
The -number-up-keep-scale single-valued attribute specifies the scaling algorithm that HP Output Server applies to the x- and y- axes of a document during a PostScript production when the -number-up attribute is specified for the job. The scaling algorithm that HP Output Server applies affects the size of the gutter margins of a document. When the value of this attribute is true (the default value), HP Output Server applies the same scale to the x- and y- axes. When the value is false, HP Output Server applies different scales to the x- and y- axes. The -number-up-keep-scale-default single-valued attribute specifies the default scaling algorithm if -number-up-keep-scale is not specified.
Types -number-up-keep-scale: Control and Status -number-up-keep-scale-default: Configuration and Status Objects -number-up-keep-scale: Document: PS -number-up-keep-scale-default: Destination: Physical and Logical Data Type Valid Values Boolean TRUE, true, FALSE, false, YES, yes, NO, no

164

System Administrators Attribute Reference

Chapter 2

Attributes

-object-log-buffer-type

-object-log-buffer-type
The -object-log-buffer-type single-valued attribute specifies the method (buffer type) for logging object state messages. The value of the -object-log-message-limit attribute (the message limit) defines the number of messages to store in the buffer. The default value is limited.
Type Object Data Type Valid Values Control All Objects Identifier rolling The object logging mechanism constantly adds new messages to the buffer. When the size of the buffer reaches the message limit, the logging mechanism deletes the oldest message each time it adds a new message. The object logging mechanism collects messages until it reaches the message limit and then stops logging messages.

limited

-object-log-message-limit
The -object-log-message-limit single-valued attribute defines the maximum number of messages to store in the object state message buffer (the message limit). HP Output Server provides no default value for this attribute.
Type Objects Data Type Control All Objects Integer

-object-log-messages
The -object-log-messages multi-valued attribute stores object state messages. The message text includes the severity level of the message.
Type Objects Data Type Status All Objects Text

HP Output Server

165

Chapter 2

Attributes

-object-log-severity

-object-log-severity
The -object-log-severity single-valued attribute defines which types of messages generated by HP Output Server server processes are logged to -object-log-messages. The -object-log-severity message levels are identical to the message levels defined for the -server-log-level attribute.
Type Objects Data Type Valid Values Control All Objects Text all, terse, none, emergency or emerg, critical or crit, alert, error or err, warning or warn, notice, info, debug

-object-log-strategy
The -object-log-strategy single-valued attribute specifies when or whether to log object state messages.
Type Objects Data Type Valid Values Control All Objects Identifier none always automatic Never log object state messages. Constantly log object state messages. Begin logging object state messages when a message of the severity level specified by the -object-log-threshold occurs.

-object-log-threshold
The -object-log-threshold single-valued attribute specifies the message severity level that triggers collection of object state messages when the -object-log-strategy attribute is set to automatic.

166

System Administrators Attribute Reference

Chapter 2

Attributes
-octet-count

The -object-log-threshold message levels are identical to the message levels defined for the -server-log-level attribute. However, you can only specify one severity level to trigger collection, not a combination of levels. For more information, see the -server-log-level attribute.
Type Objects Data Type Valid Values Control All Objects Identifier all, terse, none, emergency or emerg, critical or crit, alert, error or err, warning or warn, notice, info, debug

-octet-count
The -octet-count single-valued attribute reports the number of octets (bytes) in a document.
Type Object Data Type Status Document Integer (Positive)

-operator-notification-profile
The -operator-notification-profile multi-valued attribute specifies a set of events and recipients: the server sends notices to the specified recipient when it encounters the specified events. With the -operator-notification-profile attribute, you enable a notice to trigger the creation of new notices (class,instance,recipient) to send to people or services who do not receive them otherwise. In other words, you can designate notice recipients for specific server-related events, for example, a resource requires operator intervention. If JQMs are in different buildings and a system administrator is assigned to each JQM, you can set the -operator-notification-profile attribute at each JQM with the address of the system administrator responsible for that JQM. For more information and examples, see the System Administrators Guide for HP Output Server.

HP Output Server

167

Chapter 2

Attributes

-operator-notification-profile

You set the -operator-notification-profile attribute at each server. The attribute is multi-valued and takes the following form: -operator-notification-profile {{event [, ...]}, deliveryMethod, message, address} [, ...] The arguments and values for the -operator-notification-profile attribute are the same as those for the -notification-profile attribute. The event can be an event-class or an individual event, or several of either. The method can be none, electronic-mail (or e-mail), or notification-service (through the EM). You can turn off a notification while keeping its configuration by using the none value for method. The address is either e-mail address or user name (for notification-service). The format is the same for UNIX and Windows. The following is an example of setting the -operator-notification-profile attribute so that it sends e-mail notification of multiple messages to the user@example.com. NOTE: The multiple values within the examples must be contained in an additional set of brackets. -operator-notification-profile "{{aborted, error, warning, report-job-completed, report-job-resumed, report-processing-started }, e-mail, \"Example of Message\", user@example.com }".

Types Object Data Type

Control and Status Server EventHandlingProfile

168

System Administrators Attribute Reference

Chapter 2

Attributes
-options

-options
The -options multi-valued attribute specifies a path to a file that contains attribute specifications.
Type Objects Data Type Control All Objects Text

-order-by-attributes
The -order-by-attributes multi-valued attribute specifies additional attributes by which to sort when adding jobs to a queue, letting you customize a queues scheduling method. Each value of -order-by-attributes is a data structure that specifies an attribute by which to sort and a sort order (ascending or descending) for that attribute. The value of -order-by-attributes takes the following format: -order-by-attributes {attributeName, sortOrder} Consider the following example. If the qmarketing queue uses the FIFO scheduling method, setting -order-by-attributes to {total-job-octets, ascending} changes the queues scheduling method from FIFO to shortest subjob first: pdset -c q -x"-order-by-attributes \"{total-job-octets, ascending}\"" qmarketing Sorting specified by -order-by-attributes is considered before the queues implicit scheduling method (defined by the value of the queues -scheduler-assigned attribute). However, the sorting specified by -order-by-attributes does not replace the queues implicit scheduling method. If you specify two values for -order-by-attributes, jobs are sorted in this order: 1. 2. 3. 4. by the first value of -order-by-attributes by the second value by the queues implicit scheduling method subjob creation time

The sorting order also depends on the sorting attributes data type. That is, text attributes are sorted alphabetically, and integer attributes are sorted numerically. Consider the following example of using job ID as a sorting attribute. The DLM assigns the

HP Output Server

169

Chapter 2
-organization

Attributes

-job-client-id attribute at job submission. Because the -job-client-id attributes data type is text, the jobs with IDs 1, 2, 3, 10, 20, and 30 are sorted in this order: 1. 2. 3. 4. 5. 6. 1 10 2 20 3 30
Configuration and Status Queue Text

Types Object Data Type

-organization
The -organization single-valued attribute sets location information for a logical destination. If you do not type values for location attributes (organization, city, building, floor) when you create a logical destination, you can use pdset to insert these values in the record. The values for this attribute cannot contain embedded spaces.
Types Object Data Type Configuration and Status Destination: Logical Text

-orientation-default -orientations-supported
See the -content-orientation attribute description.

170

System Administrators Attribute Reference

Chapter 2

Attributes

-original-template-list

-original-template-list
The -original-template-list multi-valued attribute is set by the config_device command to record the name of the template used when creating a physical destination. The attribute is later used by the verify_device command to determine what attributes on the physical destination, if any, are different from the attributes specified in the template used to create the physical destination.
Type Object Data Type Configuration Destination: Physical Text

-output-bin-name -output-bin-name-default -output-bin-names-supported

The -output-bin-name single-valued attribute specifies the name of the output bin to which to send the document. The -output-bin-name-default single-valued attribute specifies the default output bin if the -output-bin-name attribute is not set. The -output-bin-names-supported multi-valued attribute specifies valid output bins.
Types Objects Control and Status -output-bin-name: Document -output-bin-name-default: Destinations: Physical, Logical (Printers) -output-bin-names-supported: Destination: Logical (Printers) Data Type Identifier

HP Output Server

171

Chapter 2

Attributes

-output-bin-number

Valid Values

top middle, bottom, side, face-up, left, right, large-capacity, private, face-down, bin0, bin1, bin2, bin3, bin4, bin5, bin6, bin7, bin8, bin9 Valid values for advanced printers only: autoselect, bin1-face-up, bin1-face-down, bin2-face-down, bin2-face-up, bin9, bin10, bin11, bin12, bin13, bin14, bin15, bin16, booklet, center, collator, external, private, rear, separator, stacker, stacker-face-down, stacker-face-up, stacker-staples, stapler, stapler2, stapler2-opposing

-output-bin-number -output-bin-number-supported
The -output-bin-number single-valued attribute specifies the bin number to which the document is sent. The value is used directly without any translation. If the -output-bin-number attribute is not specified, the -output-bin-name attribute is used. The -output-bin-number-supported multi-valued attribute specifies valid bin numbers.
Types -output-bin-number: Control -output-bin-number-supported: Configuration Objects -output-bin-number: Document -output-bin-number-supported: Destination: Logical Data Type Integer (Positive)

-output-bin-xlate
The -output-bin-xlate multi-valued attribute configures a physical destinations output bin. Each value is a data structure that specifies a value in the form {x,y}, where x is the value of the -output-bin-name attribute, and y is the printer-specific

172

System Administrators Attribute Reference

Chapter 2

Attributes

-output-content-type

integer that corresponds to the output bin. Typical settings are {top,0}, {middle,1}, and {bottom,4}. Consult your printer manual for the printers output bin values. NOTE: HP Output Server provides templates for the printers that it supports. The printer templates set the -output-bin-xlate attribute.
Types Object Data Type Control and Status Destination: Physical (Printers) Text and Integer

-output-content-type -output-content-type-default -output-content-types-supported

The -output-content-type single-valued attribute specifies the content type of a document delivered by the physical destination. For more information about how the content type of a document is determined, see the -document-format-content-type attribute. The -output-content-type-default single-valued attribute specifies the default content type if -output-content-type is not set. Setting the -output-content-type attribute overrides the default value. The -output-content-types-supported multi-valued attribute specifies the supported values for -output-content-type.
Types -output-content-type: Control and Status -output-content-type-default: Configuration -output-content-types-supported: Configuration Objects -output-content-type: Document: E-mail -output-content-type-default: Destinations: Physical, Logical (E-mail) -output-content-types-supported: Destination: Logical (E-mail) Data Type Text

HP Output Server

173

Chapter 2

Attributes

-output-document-format

Valid Values

application/octet-stream, application/pdf, application/postscript, text/plain Other valid values for this attribute are defined by the Internet Assigned Numbers Authority (IANA) (see RFC 2045).

-output-document-format -output-document-format-default -output-document-formats-supported

The -output-document-format single-valued attribute determines the format of the document delivered by the physical destination. The -output-document-format-default single-valued attribute specifies a default value if an output format is not specified for a document. The -output-document-formats-supported multi-valued attribute lists valid -output-document-format values. At the physical destination, if the -output-document-format is unspecified, the destinations -output-document-format-default is used. If neither -output-document-format nor -output-document-format-default are specified, the DSM assumes the output format is the same as the input format. For more information, see the -input-document-format attribute.
Type Objects Control -output-document-format: Document -output-document-format-default: Destinations: Logical, Physical -output-document-formats-supported: Destinations: Logical Data Type Valid Values Identifier afp, dynamic, hp-pcl, g3, html, iso-6429, literal, PDF, pdf, PS, ps, TEXT, text, TIFF, tiff, webviewable, ZPL*, zpl* The hp-pcl value refers to PCL 5 and earlier versions. To use PCL 6, you must use the literal value unless your installation uses a customized solution.
* The ZPL/zpl document format requires a custom transformer. For more information, contact your Professional Services representative.

174

System Administrators Attribute Reference

Chapter 2

Attributes

-output-document-format-variants

-output-document-format-variants -output-document-format-variants-supported
The -output-document-format-variants multi-valued attribute defines the subclass of each -output-document-format. The -output-document-format-variants-supported multi-valued attribute lists valid -output-document-format-variants. The lf-implies-cr value is the default that applies only if the -input-document-format attribute is set to text. See also the -input-document-format-variants attribute.
Types -output-document-format-variants: Control and Status -output-document-format-variants-supported: Configuration and Status Objects -output-document-format-variants: Document -output-document-format-variants-supported: Destination: Logical Data Type Valid Values Identifier PS variants: PS-L1, ps-l1, PS-L2, ps-l2, PS-DSC1, ps-dsc1, PS-DSC2, ps-dsc2, PS-DSC3, ps-dsc3 iso-6429 (text) variants: simple-text, ht, lf-implies-cr (default), cr-implies-lf, cr-overstrike, bs-overstrike, iso-10538-pif-level1, iso-10538-pif-level2, iso-10538-pif-level3, iso-10538-pif-level4, iso-10538, fft-level1v, iso-10538, fft-level2, iso-10538, fft-level2a, iso-10538, fft-level2b, iso-10538 hp-pcl variants: hp-pcl1, hp-pcl2, hp-pcl3, hp-pcl4, hp-pcl5 html variants: html-32 Other variants: ppds-level1, ppds-level2, ppds-level3, fft-level2c, sgr-underline-bold, dec-pp12, dec-pp13, line-ansi-cc, line-machine-cc, line-trc, line-sosil, line-sosi2, line-sosi3, modca-isl, modca-pt1, modca-dr2, modca-dr3, modca-fs10, modca-fs20, modca-bcdl, modca-iml, scs-sosi1, SCS-sosi1, scs-sosi2, SCS-sosi2, scs-sosi3, SCS-sosi3, BINARY, binary, CLEARTEXT, cleartext, asterx-wp, applix-wp, asterx-gr, applix-gr, asterx-ss, applix-ss

HP Output Server

175

Chapter 2

Attributes

-output-document-format-version

-output-document-format-version
The -output-document-format-version single-valued attribute identifies the variant-independent document output format version number.
Types Object Data Type Control and Status Document Text

-page-count
The -page-count single-valued attribute reports the total number of physical pages in the document. Fax physical destinations compute the -page-count automatically. On fax cover sheets, the -fax-header can contain the -page-count. This attribute accepts attribute variables, as in the following example: "Page !{page-number}! of !{page-count}!" See also the -job-page-count and -fax-no-page-count attributes.
Type Object Data Type Status Document Integer (Positive)

-page-number
The -page-number single-valued attribute is valid only within the context of the attribute variable !{page-number}!. Its value is the number of the processing page. Therefore, it should only be used within a fax header or footer. This attribute accepts attribute variables, as in the following example: "Page !{page-number}! of !{page-count}!" See also the -job-page-count, -fax-no-page-count, and -fax-page-number, and -fax-header-text attributes.
Type Object Data Type Status Document Integer (Positive)

176

System Administrators Attribute Reference

Chapter 2

Attributes
-page-select

-page-select
The -page-select multi-valued attribute specifies the range of pages to print for the document. The format for this attribute is demonstrated by the following example, which prints pages 1-5 and pages 20-30: -page-select 1-5, 20-30 The range of values can be a single page. The range can also be a single value preceded by a dash to select all pages prior to the value. For example, -30 specifies all pages up to and including 30. Finally, the range can be a single value followed by a dash, to select the specified page and all consecutive pages in the document. For example, 30specifies page 30 and all following pages.
Type Object Data Type Control Document Integer

-page-size -page-sizes-supported
The -page-size single-valued attribute specifies the page size that the document was formatted for PostScript documents, or formatted as text. It can affect the scaling and placement of pages on a physical page (if -number-up or -imposition is specified). This attribute can affect the scaling and placement of pages on a physical page if -number-up or -imposition is specified. The -page-sizes-supported multi-valued attribute specifies the supported values for the -page-size attribute.
Types Objects Control and Status -page-size: Documents: PS, PCL, Fax -page-sizes-supported: Destination: Logical (PS, PCL, Fax) Data Type Text

HP Output Server

177

Chapter 2

Attributes

-pager-id-number

Valid Values

iso-a0, iso-a1, iso-a2, iso-a3, iso-a4, iso-a5, iso-a6, iso-a7, iso-a8, iso-a9, iso-a10, iso-b0, iso-b1, iso-b2, iso-b3, iso-b4, iso-b5, iso-b6, iso-b7, iso-b8, iso-b9, iso-b10, iso-c3, iso-c4, iso-c5, iso-c6, iso-designated-long, north-american-letter, north-american-legal, north-american-10x13, -american-9x12, north-american-business-envelope, a, b, c, d, e, 7-envelope, 7x9, half-letter, two-thirds-a4, 10x14, executive Valid values for advanced printers only: labels, ledger, north-american-ledger-11x17, tabloid

-pager-id-number -pager-id-number-default -pager-id-numbers-supported

The -pager-id-number single-valued attribute specifies the pager ID number assigned by the paging service. The -pager-id-number-default single-valued attribute specifies the ID number of the pager to use if you have not set the -pager-id attribute. The -pager-id-numbers-supported multi-valued attribute lists valid pager ID numbers.
Types -pager-id-number: Configuration, Control, and Status -pager-id-number-default: Configuration and Status -pager-id-numbers-supported: Configuration and Status Objects -pager-id-number: Job: Pager -pager-id-number-default: Destinations: Logical, Physical (Pager) -pager-id-numbers-supported: Destination: Logical (Pager) Data Type Text

178

System Administrators Attribute Reference

Chapter 2

Attributes
-pager-id-type

-pager-id-type -pager-id-type-default -pager-id-types-supported

The -pager-id-type single-valued attribute specifies the pager type. The alphanumeric value applies to pagers capable of displaying letters as well as numbers. The digital value applies to pagers which can only display numbers. The -pager-id-type-default single-valued attribute specifies a default value used if the -pager-id-type attribute is not set. The -pager-id-types-supported multi-valued attribute lists valid pager ID types.
Types -pager-id-type: Control and Status -pager-id-type-default: Configuration and Status -pager-id-types-supported: Configuration and Status Objects -pager-id-type: Job: Pager -pager-id-type-default: Destinations: Logical, Physical (Pager) -pager-id-types-supported: Destination: Logical (Pager) Data Type Valid Values Identifier alphanumeric, digital

-pager-message-length-limit
The -pager-message-length-limit single-valued attribute specifies the maximum number of characters in a message (document). It should not exceed the limit imposed by the paging service or the capability of the pager.
Types Object Data Type Configuration and Status Destination: Physical (Pager) Integer (Positive)

HP Output Server

179

Chapter 2

Attributes

-pager-message-number-limit

-pager-message-number-limit
The -pager-message-number-limit single-valued attribute specifies the maximum number of messages (documents) sent to a pager in one job. Paging service restrictions on the number of messages transmitted in one session can affect the -pager-message-number-limit.
Types Object Data Type Configuration and Status Destination: Physical (Pager) Integer (Positive)

-pager-phone-number -pager-phone-number-default -pager-phone-numbers-supported

The -pager-phone-number single-valued attribute specifies the telephone number of the paging service. The number format depends on the requirements of the modem. Dash- or space-separated strings are acceptable in most cases. The pager phone number can also be specified through the paging system. The -pager-phone-number-default single-valued attribute specifies the phone number to dial if no -pager-phone-number is specified. The -pager-phone-numbers-supported multi-valued attribute lists valid pager phone numbers.
Types -pager-phone-number: Configuration, Control, and Status -pager-phone-number-default: Configuration and Status -pager-phone-numbers-supported: Configuration and Status Objects -pager-phone-number: Job: Pager -pager-phone-number-default: Destinations: Logical, Physical (Pager) -pager-phone-numbers-supported: Destination: Logical (Pager) Data Type Text

180

System Administrators Attribute Reference

Chapter 2

Attributes

-pager-protocol

-pager-protocol -pager-protocol-default -pager-protocols-supported

The -pager-protocol single-valued attribute specifies the protocol to use when communicating with the paging service. The -pager-protocol-default single-valued attribute specifies the default protocol if -pager-protocol is not set at the job. The -pager-protocols-supported multi-valued attribute specifies valid pager protocols.
Types -pager-protocol: Control and Status -pager-protocol-default: Configuration and Status -pager-protocols-supported: Configuration and Status Objects -pager-protocol: Job: Pager -pager-protocol-default: Destinations: Logical, Physical (Pager) -pager-protocols-supported: Destination: Logical (Pager) Data Type Valid Values Identifier direct-digital, ixo, ixo1-7e, ixo2-7e, service-digital, skytel

-pager-system-name -pager-system-name-default -pager-system-names-supported

The -pager-system-name single-valued attribute specifies the paging system object from which to retrieve baud rate, phone number, and pager protocol information for the job. Explicitly setting -pager-phone-number or -pager-protocol on the job overrides the settings in the named paging system object. The -pager-system-name-default single-valued attribute specifies the default paging system object. The -pager-system-names-supported multi-valued attribute lists valid paging system objects.

HP Output Server

181

Chapter 2

Attributes

-pages-completed

For more information, see the -paging-system-baud, -paging-system-name, -paging-system-phone-number, and -paging-system-protocol.
Types -pager-system-name: Control and Status -pager-system-name-default: Configuration and Status -pager-system-names-supported: Configuration and Status Objects -pager-system-name: Job: Pager -pager-system-name-default: Destinations: Logical, Physical (Pager) -pager-system-name-supported: Destination: Logical (Pager) Data Type Text

-pages-completed
The -pages-completed single-valued attribute reports the number of pages completed.
Type Object Data Type Status Job Integer (Positive)

-paging-system-baud
The -paging-system-baud single-valued attribute specifies the baud rate of the modem that contacts the pager.
Types Object Data Type Control and Status Paging System Integer (Positive)

182

System Administrators Attribute Reference

Chapter 2

Attributes

-paging-system-name

-paging-system-name
The -paging-system-name single-valued attribute specifies the name of a paging system object, which the -paging-system* attributes define. The values for this attribute cannot contain embedded spaces.
Types Object Data Type Control and Status Paging System Text

-paging-system-phone-number
The -paging-system-phone-number single-valued attribute specifies the telephone number of the paging service. The number format depends on the requirements of the modem. Dash- or space-separated strings are acceptable in most cases. The -paging-system-phone-number single-valued attribute overrides the -pager-phone-number attribute.
Types Object Data Type Control and Status Paging System Text

-paging-system-protocol
The -paging-system-protocol single-valued attribute specifies the pager protocol for this paging system object.
Types Object Data Type Valid Values Control and Status Paging System Identifier skytel, ixo, ixo1-7e, ixo2-7e, direct-digital, service-digital

HP Output Server

183

Chapter 2

Attributes

-paging-systems-supported

-paging-systems-supported
The -paging-systems-supported multi-valued attribute lists one or more paging systems that a physical destination supports. A single physical device can support multiple paging systems. The values for this attribute cannot contain embedded spaces.
Type Object Data Type Control Destination: Physical (Pager) Text

-paused
The -paused single-valued attribute indicates if an object is paused.
Types Objects Data Type Valid Values Configuration and Status Queue, Destination (Logical, Physical), Server (DLM, JQM, DSM) Boolean TRUE, true, FALSE, false, YES, yes, NO, no

-pcl-echo-support
The -pcl-echo-support single-valued attribute specifies if the PCL printer supports the PCL echo command.
Types Object Data Type Valid Values Configuration and Status Destination: Physical (PCL) Boolean TRUE, true, FALSE, false, YES, yes, NO, no

-pcl-input-trays-xlate
The -pcl-input-trays-xlate multi-valued attribute configures the input tray for a physical destination that supports multiple printer languages. The attribute specifies the value of an input trays name and number for jobs that are encoded in the PCL printer language.

184

System Administrators Attribute Reference

Chapter 2

Attributes
-pcl-level

Each value of -pcl-input-trays-xlate is a data structure that specifies a printer input tray and the corresponding number for the input tray. The attribute uses the following syntax: -pcl-input-trays-xlate {inputTray, number} where inputTray is a value, such as top or tray6, and number is the printer-specific number for the tray, such as 2 or 4. For more information, see the -input-tray-select attribute.
Types Object Data Type Control Destination: Physical (PCL, PS) Text and Integer

-pcl-level
The -pcl-level single-valued attribute sets the level of support for the PCL printer. Consult the device documentation for the minimum required level of support (typically 5) if you are not using a template. Choose the highest supported level. For supported levels greater than 5, set the value to 5. All HP Output Server PCL printer templates set the level appropriately.
Types Object Data Type Valid Values Configuration and Status Destination: Physical (PCL) Integer 3, 4, 5

-pcl-output-bin-xlate
The -pcl-output-bin-xlate multi-valued attribute configures the output bin for a physical destination that supports multiple printer languages. The attribute specifies the value of an output bins name and number for jobs that are encoded in the PCL printer language. Each value of -pcl-output-bin-xlate is a data structure that specifies a printer output bin and the corresponding bin number. The attribute uses the following syntax: -pcl-output-bin-xlate {outputBin, number}

HP Output Server

185

Chapter 2

Attributes

-pdf-color-output

where outputBin is a value, such as top or bin2, and number is the printer-specific number for the tray, such as 1 or 5. For more information, see the -output-bin-name attribute.
Type Object Data Type Control Destination: Physical (PCL, PS) Text and Integer

-pdf-color-output -pdf-color-output-default
The -pdf-color-output single-valued attribute specifies whether a PDF file delivered to a PostScript or PCL printer should be delivered in color or monochrome. If the value is true, the output is color; if false, the output is monochrome. The default output is monochrome. The -pdf-color-output-default single-valued attribute specifies the default output color of a PDF file. NOTE: Use these attributes for PDF-to-PostScript and PDF-to-PCL conversions only.
Types -pdf-color-output: Control -pdf-color-output-default: Configuration Objects -pdf-color-output: Document -pdf-color-output-default: Destination: Logical, Physical Data Type Valid Values Boolean TRUE, true, FALSE, false

-physical-device-type
The -physical-device-type single-valued attribute specifies the physical destinations that a DSM manages.

186

System Administrators Attribute Reference

Chapter 2

Attributes

-physical-printer-assigned

If you change the -physical-device-type attribute, for example, from ps-printer to text, you must stop and restart the DSM that manages the physical destination.
Type Object Data Type Valid Values Control Destination: Physical Identifier disk external fax ftp email pager pcl-printer ps-printer text Disk file External device Facsimile device Host accessible by FTP Electronic mail Paging service PCL printer PostScript printer Plain text printer

-physical-printer-assigned
The -physical-printer-assigned single-valued attribute reports the name of the physical destination assigned to process the job. The job persists past this processing state. The values for this attribute cannot contain embedded spaces.
Type Object Data Type Status Job Text

-physical-printers-registered
The -physical-printers-registered multi-valued attribute lists the physical destinations that are registered with a queue and are available (not disabled). The values for this attribute cannot contain embedded spaces. NOTE: The -physical-printers-registered attribute replaces the -physical-printers-supported and -physical-printers-ready DSM attributes.

HP Output Server

187

Chapter 2
-pjl-capabilities

Attributes

To view the value of this attribute for a queue, use the pdls command as follows, ensuring that the managing JQM is running: pdls -a all queueName

Type Object Data Type

Status Queue Text

-pjl-capabilities
The -pjl-capabilities multi-valued attribute specifies the PJL capabilities that a printer supports. This attribute is useful for fine-tuning HP Output Server in unusual situations and should be set only by an administrator with a detailed knowledge of the PJL language. See also the -printer-model and the -pjl-exclusions attributes.
Types Object Data Type Valid Values Control and Status Destination: Physical (PS, PCL) Identifier pjl-comment pjl-default pjl-dinquire pjl-echo pjl-enter pjl-eoj pjl-info-config pjl-info-id pjl-info-memory pjl-info-pagecount pjl-info-status pjl-info-ustatus pjl-info-variables pjl-initialize pjl-inquire pjl-opmsg pjl-job pjl-rdymsg pjl-reset pjl-set pjl-stsmsg pjl-ustatus-device pjl-ustatus-job pjl-ustatus-page pjl-ustatus-timed pjl-ustatusoff

188

System Administrators Attribute Reference

Chapter 2

Attributes
-pjl-exclusions

-pjl-exclusions
The -pjl-exclusions multi-valued attribute specifies the PJL capabilities that a printer does not support. This attribute is useful for fine-tuning the HP Output Server in unusual situations, and should only be set by an administrator with a detailed knowledge of the PJL language. See also the -printer-model and -pjl-capabilities attributes.
Types Object Data Type Valid Values Control and Status Destination: Physical (PS, PCL) Identifier pjl-comment pjl-default pjl-dinquire pjl-echo pjl-enter pjl-eoj pjl-info-config pjl-info-id pjl-info-memory pjl-info-pagecount pjl-info-status pjl-info-ustatus pjl-info-variables pjl-initialize pjl-inquire pjl-opmsg pjl-job pjl-rdymsg pjl-reset pjl-set pjl-stsmsg pjl-ustatus-device pjl-ustatus-job pjl-ustatus-page pjl-ustatus-timed pjl-ustatusoff

-plex -plex-default -plexes-supported

The -plex single-valued attribute specifies whether the page images of the output document are to be conditioned for eventual one-sided (simplex) or two-sided (duplex or tumble) printing. The -plex-default single-valued attribute specifies a default value if the -plex attribute is not set.

HP Output Server

189

Chapter 2
-pm-id-mode

Attributes

The -plexes-supported multi-valued attribute lists valid -plex values. NOTE: The -plex and -sides attributes are not synonymous. The -plex attribute determines the orientation of the image on the paper. The -sides attribute determines whether the image is printed on one or both sides of the paper.
Types Objects Control and Status -plex: Documents: PS, PCL, Fax -plex-default: Destination: Logical (PS, PCL, Fax) -plexes-supported: Destination: Logical (PS, PCL, Fax) Data Type Valid Values Identifier duplex Causes pages to be conditioned for two-sided printing, where the binding edge is along the y-axis. This value shifts an image on the page by applying a positive -x-image-shift to odd-numbered pages and a negative -x-image-shift to even-numbered pages. Causes the pages to be conditioned for one-sided printing. This value shifts an image on the page by applying a positive -x-image-shift. Variation of duplex, tumble causes pages to be conditioned for two-sided printing, where the binding edge is along the x-axis, sometimes referred to as "head-to-toe." This value shifts an image on the page by applying a positive -y-image-shift to odd-numbered pages and a negative -y-image-shift to even-numbered pages.

simplex

tumble

-pm-id-mode
The -pm-id-mode single-valued attribute specifies how the PM authenticates users and groups. By default, this attribute is set to dazel.

190

System Administrators Attribute Reference

Chapter 2

Attributes

-poll-arguments

With -pm-id-mode set to dazel, HP Output Server relies on the authentication mechanisms within external environments, such as the Windows operating system or SAP R/3, to ensure the users identity. This compensates for the differences in how users and groups are defined in different operating environments. NOTE: It is strongly recommended that you use the default, which is Dazel ID mode (dazel). With -pm-id-mode set to unix, HP Output Server obtains user and group information from the underlying UNIX operating system on which HP Output Server is installed. The PM accesses the group and user information that has already been defined in your UNIX environment. Use UNIX ID mode only if your HP Output Server installation runs solely on UNIX hosts. If the PM runs in UNIX ID mode, you cannot use pm_edit or the Privilege Administrator to maintain user membership in groups. For the PM to operate in UNIX mode, you must set up the groups in the /etc/groups file and then set the PMs -pm-id-mode attribute to unix as follows: config_server -u -x"-pm-id-mode unix" pm

Type Object Data Type Valid Values

Configuration Server: PM Text dazel, unix

-poll-arguments
The -poll-arguments multi-valued attribute specifies the arguments passed to the -poll-program attribute.
Types Object Data Type Configuration and Status Destination: Physical (External) Text

HP Output Server

191

Chapter 2
-poll-interval

Attributes

-poll-interval -poll-period
The -poll-interval (or -poll-period) single-valued attribute specifies the frequency (in seconds) that the DSM invokes the -poll-program. If the value is not set or is less than or equal to 0, the poll program is invoked only once, at the start of a job.
Types Object Data Type Configuration and Status Destination: Physical (External) Integer (Seconds)

-poll-program
The -poll-program single-valued attribute sets the absolute path name to the program that polls the external device. Using an attribute variable substitution such as !{dazel-install-directory}! is allowed. There is no default. If you do not set this attribute, no program is invoked.
Types Object Data Type Configuration and Status Destination: Physical (External) Text

-previous-job-state
The -previous-job-state single-valued attribute reports the job state that immediately preceded the current job state. That is, the -previous-job-state attribute reports the previous value of the -current-job-state attribute. For more information on job states, see the -current-job-state attribute.
Type Object Data Type Valid Values Status Job Identifier aborting, document-transfer-pending, held, interrupted, paused, pending, pre-processing, processing, retained, transferring, unknown Although unknown is a valid state, it only occurs before a job begins delivery and after it completes delivery.

192

System Administrators Attribute Reference

Chapter 2

Attributes
-printer

-printer
The -printer single-valued attribute specifies the name of a logical destination or destinations to which a job was submitted. The -printer and -destination attributes are synonymous. The values for this attribute cannot contain embedded spaces.
Type Object Data Type Status Job Object name (Logical Destination)

-printer-auto-pause-timeout
The -printer-auto-pause-timeout single-valued attribute sets the length of time (in seconds) that a logical destination pauses if any job delivered through that destination is interrupted.
Types Object Data Type Configuration and Status Destination: Logical Integer (Seconds)

-printer-connection-mode
The -printer-connection-mode single-valued attribute indicates the type of hardware connection. The attribute is required for physical destinations. The destination type determines the valid value. For example, the only valid value for external destinations is external. For more information, see the section about destination types in the System Administrators Guide for HP Output Server.
Types Object Data Type Valid Values Configuration and Status Destination: Physical (PS, PCL, Fax, Text, Pager) Identifier dialup-tcp, external, file, ftp, lino-tftp, lpd, qms-ftp, tcp, tftp, udp

HP Output Server

193

Chapter 2

Attributes

-printer-device-address

-printer-device-address
The -printer-device-address single-valued attribute specifies the host name for a udp connection.
Types Object Data Type Configuration and Status Destination: Physical (PS, PCL, Text, Pager) Text

-printer-line-setting
The -printer-line-setting single-valued attribute sets the baud rate for a device connected to a host by a serial connection. UNIX only: The -printer-line-setting attribute can also specify the serial device settings. These settings should appear after the baud rate, separated by spaces and/or commas. The settings follow the conventions of the UNIX stty(1) command. For example, to configure a text physical destination so that it can communicate with a printer that is serially attached to a UNIX system at 9600 baud using 7 bits and odd parity, type the following command: pdset -c d -x"-printer-line-setting \"9600 cs7 parenb parodd\"" printer

Types Object Data Type

Configuration and Status Destination: Physical (PS, PCL, Text, Pager, and Fax) Text

-printer-message
The -printer-message single-valued attribute contains the message text, if any, associated with the -device-state attribute.
Type Object Data Type Status Destination: Physical Message

194

System Administrators Attribute Reference

Chapter 2

Attributes
-printer-model

-printer-model
The -printer-model single-valued attribute specifies the control language that the printer uses to communicate status and control messages. The default is generic (no job control language). Some PostScript printers (such as HP Laserjet 3) require this attribute. If the value of the -input-document-format-default attribute is literal, the value of the -printer-model attribute must be generic. Otherwise, the DSM considers a job failed even if it succeeds, and resends the job until the DSM reaches the retry limit. If a printer model value, for example, qms, does not work with your printer, try generic.
Types Object Data Type Valid Values Configuration and Status Destination: Physical (PS, PCL) Text advanced generic hp_pjl lexmark lexmark_pjl pjl qms uel Use this value for physical destinations that are configured to use an advanced delivery pathway. Use this value for printers that cannot use the following values. Use this value for multi-function Hewlett-Packard printers. Use this value for Lexmark printers. Use this value for multi-function Lexmark printers. Use this value for any model of Hewlett-Packard printer later than HP4, for example, hp4si. Use this value for QMS printers. Use this value for Canon printers only.

-printer-name
The -printer-name single-valued attribute sets the name of a logical or physical destination. The values for this attribute cannot contain embedded spaces.
Types Configuration and Status

HP Output Server

195

Chapter 2

Attributes

-printer-name-requested

Objects Data Type

Destinations: Logical, Physical Object name

-printer-name-requested
The -printer-name-requested single-valued attribute is synonymous with the -printer and -destination attributes.
Type Object Status Job

-printer-ping-data
The -printer-ping-data single-valued attribute sets the ping data as a text string that the DSM will send to the physical device at a rate specified by -printer-ping-interval. NOTE: Use -printer-ping-data only with -printer-ping-interval. If -printer-ping-data is not set, the default ping data is used: CTRL+T for PostScript printers and ESC+&r0F for PCL printers.
Types Object Data Type Valid Values Configuration and Status Destination: Physical (PostScript, PCL) Text " " "%% Comment" Space for both PostScript and PCL printers PostScript comment for PostScript printers

-printer-ping-interval
The -printer-ping-interval single-valued attribute sets the rate (in seconds) at which the physical destination sends status packets to the physical device. For example, if this attribute is set to a value of 30, the DSM sends a status packet (ping) to the printer every 30 seconds during jobs. A printer ping interval is necessary because some printers automatically close their connections after a period of inactivity.

196

System Administrators Attribute Reference

Chapter 2

Attributes

-printer-read-timeout

NOTE: If strange characters appear in the middle of documents, remove the -printer-ping-interval attribute. The packet this attribute sends can become mixed with a job and can cause the job to mistakenly print information from the ping. To specify the contents of the status packet, set the -printer-ping-data attribute.
Types Object Data Type Configuration and Status Destination: Physical (PostScript, PCL) Integer (Positive)

-printer-read-timeout
The -printer-read-timeout single-valued attribute sets the amount of time allowed for receiving data from a read/write output device before reporting an error. If the -write-only-device attribute is set to true, the -printer-read-timeout attribute is ignored. If the -printer-read-timeout attribute is set for a device and the time-out period elapses, these events occur: The message "Timeout waiting for synchronization message from printer" is sent to the log. The -device-state attribute is set to printer-needs-attention. A DSM notice of type state-changed-printer is sent with the message "Device connection problem." The -current-job-state is interrupted.

There is no default value for this attribute. This attribute is not supported for fax destinations.
Type Object Data Type Configuration Destination: Physical (PS or PCL Printers only) Positive Integer (Seconds)

HP Output Server

197

Chapter 2

Attributes

-printer-realization

-printer-realization
The -printer-realization single-valued attribute determines the type of object created: logical destination or physical destination.
Types Objects Data Type Valid Values Configuration and Status Destinations: Logical, Physical Integer 0 = logical 1 = physical

-printer-resolutions-requested -printer-resolution-default -printer-resolutions

The -printer-resolutions-requested single-valued attribute sets the printer resolution for printed output in dots per inch (DPI). This attribute applies when a job is sent to a Level 2 PostScript printer or when a PostScript document is converted to PCL. The -printer-resolution-default single-valued attribute sets a default value for -printer-resolutions-requested. The -printer-resolutions multi-valued attribute indicates the printer resolutions that are supported. If a job is sent with a printer resolution that is not supported, the job is rejected.
Type Objects Control -printer-resolutions-requested: Documents: PS, PCL -printer-resolution-default: Destination: Physical -printer-resolutions: Destination: Logical Data Type Integer (Positive)

198

System Administrators Attribute Reference

Chapter 2

Attributes

-printer-resume-delivery-time

-printer-resume-delivery-time
The -printer-resume-delivery-time single-valued attribute sets the interval (in seconds) before a logical destination paused by its JQM is available. A destination is paused (for the length of -printer-auto-pause-timeout) if any job is interrupted during delivery. For more information, see the -printer-auto-pause-timeout attribute.
Types Object Data Type Configuration and Status Destination: Logical Integer (Seconds)

-printer-serialize-conversion -printer-serialize-conversion-default
The -printer-serialize-conversion single-valued attribute serializes document processing at the job level. If the value is true, documents are sequentially processed before printer connections are opened. If the value is false (the default), document processing occurs parallel with the opening of printer connections. The -printer-serialize-conversion-default single-valued attribute serializes document processing at the physical destination. If the value is true, documents are sequentially processed before printer connections are opened. If the value is false (the default), document processing occurs parallel with the opening of printer connections. NOTE: The serialization code stores processed documents in a temporary file before printer connections are opened. Therefore, your system must have sufficient disk space to store this temporary file.
Type Objects Configuration -printer-serialize-conversion: Job -printer-serialize-conversion-default: Destination: Physical Data Type Valid Values Boolean TRUE, true, FALSE, false, YES, yes, NO, no

HP Output Server

199

Chapter 2
-printer-state

Attributes

-printer-state
The -printer-state single-valued attribute reports the current state of a printer.
Type Object Data Type Valid Values Status Server: DSM Identifier idle, printing, needs-attention

-printer-task-maximum
The -printer-task-maximum single-valued attribute limits parallel activities (such as threads) to support the processing of the printers. If you set a value for both -printer-task-maximum and -printer-task-ratio, the calculated maximum of the two values is used. If neither attribute is set, one thread is available for each printer. You do not need to reinitialize the DSM for this attribute to take effect. To evaluate the setting of the -printer-task-maximum attribute, use the pdcontrol command with the -dump attribute set to printer-task-stats.
Types Object Data Type Configuration and Status Server: DSM Integer (Positive)

-printer-task-ratio
The -printer-task-ratio single-valued attribute specifies the ratio of tasks to printers, from 0 to 100. To specify half as many threads as printers, set this attribute to 50. If you set a value for both -printer-task-ratio and -printer-task-maximum, the calculated maximum of the two values is used. If neither attribute is set, one thread is available for each printer. You do not need to reinitialize the DSM for this attribute to take effect. To evaluate the setting of the -printer-task-ratio attribute, use the pdcontrol command with the -dump attribute set to device-task-stats.
Types Configuration and Status

200

System Administrators Attribute Reference

Chapter 2

Attributes

-printer-x-resolutions-requested

Object Data Type

Server: DSM Integer (Positive)

-printer-x-resolutions-requested -printer-x-resolutions-default -printer-x-resolutions-supported

The -printer-x-resolutions-requested single-valued attribute sets the printer resolution for the x-axis in dots per inch (DPI). This attribute is used in conjunction with the -printer-y-resolutions-requested attribute when a job is sent to a Level 2 PostScript printer or when a PostScript document is converted to PCL. If the two attributes are not specified for a job, HP Output Server uses the value of the -printer-resolutions attribute to process the job. The -printer-x-resolutions-default single-valued attribute sets a default value for -printer-x-resolutions-requested. The -printer-x-resolutions-supported multi-valued attribute indicates the printer resolutions that are supported. If a job is sent with a printer resolution that is not supported, the job is rejected.
Type Objects Control -printer-x-resolutions-requested: Documents: PS, PCL -printer-x-resolutions-default: Destination: Logical, Physical -printer-x-resolutions-supported: Destination: Logical, Physical Data Type Integer (Positive)

-printer-y-resolutions-requested -printer-y-resolutions-default -printer-y-resolutions-supported

The -printer-y-resolutions-requested single-valued attribute sets the printer resolution for the y-axis in dots per inch (DPI). This attribute is used in conjunction with the -printer-x-resolutions-requested attribute when a job is sent to a Level 2 PostScript printer or when a PostScript document is converted to PCL. If the two attributes are not specified for a job, HP Output Server uses the value of the -printer-resolutions attribute to process the job.

HP Output Server

201

Chapter 2

Attributes

-processing-time

The -printer-y-resolutions-default single-valued attribute sets a default value for -printer-y-resolutions-requested. The -printer-y-resolutions-supported multi-valued attribute indicates the printer resolutions that are supported. If a job is sent with a printer resolution that is not supported, the job is rejected.
Type Objects Control -printer-y-resolutions-requested: Documents: PS, PCL -printer-y-resolutions-default: Destination: Logical, Physical -printer-y-resolutions-supported: Destination: Logical, Physical Data Type Integer (Positive)

-processing-time
The -processing-time single-valued attribute reports the total amount of time (in seconds) that the physical destination requires to process the job successfully. NOTE: The reported processing time includes only the time required for the successful attempt. The processing time does not include any DSM processing time for retries and failed attempts.
Type Object Data Type Status Job Integer

-processing-time-warned
The -processing-time-warned single-valued attribute reports when a JQM generates a notice indicating that the -processing-time attribute exceeded the time specified for a job within the DSM. For more information, see the -spooler-job-processing-time-warning-time attribute.
Type Object Status Job

202

System Administrators Attribute Reference

Chapter 2

Attributes

-ps-init-directories

Data Type

Time (UTC)

-ps-init-directories
The -ps-init-directories multi-valued attribute specifies the directory location of the PostScript conversion utility. For more information, see the -font-directories attributes.
Types Object Data Type Configuration and Status Destination: Physical Text

-ps-input-trays-xlate
The -ps-input-trays-xlate multi-valued attribute configures the input tray for a physical destination that supports multiple printer languages. The attribute specifies the value of an input trays name and number for jobs that are encoded in the PostScript printer language. Each value of -ps-input-trays-xlate is a data structure that specifies a printer input tray and the corresponding number for the input tray. The attribute uses the following syntax: -ps-input-trays-xlate {inputTray, number} where inputTray is a value, such as top or tray6, and number is the printer-specific number for the tray, such as 2 or 4. For more information, see the -input-tray-select attribute.
Types Object Data Type Control Destination: Physical (PCL, PS) Text and Integer

-ps-output-bin-xlate
The -ps-output-bin-xlate multi-valued attribute configures the output bin for a physical destination that supports multiple printer languages. The attribute specifies the value of an output bins name and number for jobs that are encoded in the PostScript printer language.

HP Output Server

203

Chapter 2

Attributes

-ps-printer-echoes-eof

Each value of -ps-output-bin-xlate is a data structure that specifies a printer output bin and the corresponding bin number. The attribute uses the following syntax: -ps-output-bin-xlate {outputBin, number} where outputBin is a value, such as top or bin2, and number is the printer-specific number for the tray, such as 1 or 5. For more information, see the -output-bin-name attribute.
Types Object Data Type Control Destination: Physical (PCL, PS) Text and Integer

-ps-printer-echoes-eof
The -ps-printer-echoes-eof single-valued attribute indicates if a PostScript printer echoes its end-of-file (EOF) character. The attribute is necessary under some conditions when the -printer-connection attribute is set to tcp.
Types Object Data Type Valid Values Configuration and Status Destination: Physical (PS) Boolean TRUE, true, FALSE, false, YES, yes, NO, no

-ps-printer-suppress-eof
The -ps-printer-suppress-eof single-valued attribute specifies if end-of-transmission (EOT) signals at the end of a data stream are suppressed. EOT is represented by the ^D character. If the value is true, end-of-transmission signals are suppressed and the PostScript code then emulates end-of-transmission signals. If the value is false (the default), EOT signals are not suppressed. HP Output Server can send ^D characters to the printer. NOTE: This attribute must be set to true when delivering jobs to an HP 8550 printer.
Types Object Configuration and Status Destination: Physical (PS)

204

System Administrators Attribute Reference

Chapter 2

Attributes

-ps-prologue-file

Data Type Valid Values

Boolean TRUE, true, FALSE, false, YES, yes, NO, no

-ps-prologue-file
The -ps-prologue-file multi-valued attribute identifies the PostScript prologue file read and downloaded to the printer with each job. The -ps-init-directories configuration attribute identifies the directories that the DSM searches to find the PostScript prologue files.
Type Object Data Type Configuration Destination: Physical (PS, Fax) Text

-punch-count-default -punch-counts-supported
See the -job-punch-count attribute description.

-punch-location-default -punch-locations-supported
See the -job-punch-location attribute description.

-punch-type-default -punch-types-supported
See the -job-punch-type attribute description.

-qms-ftp-account
The -qms-ftp-account single-valued attribute specifies the account to use when logging in to a device connected to the network as a qms-ftp host (when the -printer-connection-mode attribute is set to qms-ftp).
Types Object Configuration and Status Destination: Physical (PS, PCL)

HP Output Server

205

Chapter 2
-qms-ftp-host

Attributes

Data Type

Text

-qms-ftp-host
The -qms-ftp-host single-valued attribute specifies the host name to use when logging in to a device connected to the network as a -qms-ftp host (when the -printer-connection-mode attribute is set to qms-ftp).
Types Object Data Type Configuration and Status Destination: Physical (PS, PCL) Text

-qms-ftp-password
The -qms-ftp-password single-valued attribute specifies the password for -qms-ftp-user when logging in to a device connected to the network as a -qms-ftp host (when the -printer-connection-mode attribute is set to -qms-ftp). The default is the -qms-ftp-user value.
Types Object Data Type Configuration and Status Destination: Physical (PS, PCL) Text

-qms-ftp-user
The -qms-ftp-user single-valued attribute specifies the user name to use when logging in to a device connected to the network as a -qms-ftp host (when the -printer-connection-mode attribute is set to qms-ftp). The default is the name of the associated physical printer.
Types Object Data Type Configuration and Status Destination: Physical (PS, PCL) Text

206

System Administrators Attribute Reference

Chapter 2

Attributes

-qms-status-monitor-delay

-qms-status-monitor-delay
The -qms-status-monitor-delay single-valued attribute defines the amount of time to wait between status port polls when the value of the -printer-model attribute is qms. The default value is 5 seconds. To set this attribute, type the following command: pdset -c d -x"-qms-status-monitor-delay seconds" physicalDestination

Type Object Data Type

Control Destination: Physical Time (Seconds)

-qms-status-read-timeout
The -qms-status-read-timeout single-valued attribute defines the amount of time to wait for data from the status port. The value of the -printer-model attribute is qms. The default value is 5 seconds.
Type Object Control Destination: Physical

-queue-assigned
The -queue-assigned single-valued attribute identifies the queue to which a job is assigned. The values for this attribute cannot contain embedded spaces.
Type Object Data Type Status Job Text

HP Output Server

207

Chapter 2

Attributes

-queue-disable-threshold

-queue-disable-threshold
The -queue-disable-threshold single-valued attribute specifies the maximum number of jobs in the queue before the queue is disabled. NOTE: Because a queues status of disabled is not externally visible when the threshold is reached, the disabled status will not be reported by executing a pdls command. If the queue size shrinks below the threshold, the queue will be re-enabled automatically. By default, this attribute is not set for any queues. You can use this attribute with -queue-warning-threshold to manage queues in high-volume delivery pathways.
Types Object Data Type Configuration and Status Queue Integer (Positive)

-queue-name
The -queue-name single-valued attribute specifies the name of the queue. The values for this attribute cannot contain embedded spaces.
Types Object Data Type Configuration and Status Queue Object name

-queue-supported
The -queue-supported single-valued attribute specifies the queue to which a logical destination feeds jobs or the queue from which a physical destination drains jobs. The values for this attribute cannot contain embedded spaces.
Types Object Data Type Configuration and Status Destinations: Logical, Physical Object name

208

System Administrators Attribute Reference

Chapter 2

Attributes

-queue-task-maximum

-queue-task-maximum
The -queue-task-maximum single-valued attribute limits parallel activities (such as threads) to support the processing of queues. If you set a value for both -queue-task-maximum and -queue-task-ratio, the calculated maximum of the two values is used. If neither attribute is set, one thread is available for each queue. You do not need to reinitialize the JQM for this attribute to take effect. To evaluate the setting of the -queue-task-maximum attribute, use the pdcontrol command with the -dump attribute set to queue-task-stats.
Types Object Data Type Configuration and Status Server: JQM Integer (Positive)

-queue-task-ratio
The -queue-task-ratio single-valued attribute specifies the ratio of tasks to queues, from 0 to 100. For example, to specify half as many tasks as you have queues, set this attribute to 50. If you do not set this attribute, the JQM behavior is the same as setting -queue-task-ratio to 100. If you set a value for both -queue-task-ratio and -queue-task-maximum, the calculated maximum of the two values is used. If neither attribute is set, one thread is available for each queue. You do not need to reinitialize the JQM for this attribute to take effect. To evaluate the setting of the -queue-task-ratio attribute, use the pdcontrol command with the -dump attribute set to queue-task-stats.
Types Object Data Type Configuration and Status Server: JQM Integer (0, Positive)

HP Output Server

209

Chapter 2

Attributes

-queue-warning-threshold

-queue-warning-threshold
The -queue-warning-threshold single-valued attribute specifies the maximum number of jobs in a queue before a warning notice is issued. The default value is 50. You can use this attribute with -queue-disable-threshold to manage queues in high-volume delivery pathways.
Types Object Data Type Configuration and Status Queue Integer (Positive)

-remote-device-identifier
The -remote-device-identifier multi-valued attribute identifies the fax station ID of the remote fax machine. The station ID is typically the phone number of the fax machine or a company name. The attribute is useful for verifying that an outgoing fax job reached its intended destination. The attribute is set after the modem successfully connects with the remote fax machine.
Type Object Data Type Status Job: Fax Text

-requested-attributes
The -requested-attributes multi-valued attribute specifies information to return. It can take a descriptive value (none, brief, verbose, all), one or more individual attributes, or any combination thereof. NOTE: The -requested-attributes, -brief-specification, and -verbose-specification attributes may not be used as values for the -requested-attributes attribute.
Types Objects Data Type Control and Status All Objects Identifier

210

System Administrators Attribute Reference

Chapter 2

Attributes

-reserve-by-attribute

Valid Values

none, brief, verbose, all, or individual, comma-separated attributes

-reserve-by-attribute
The -reserve-by-attribute single-valued attribute changes how the JQM dequeues subjobs, that is, how it sends subjobs from queues to physical destinations. The -reserve-by-attribute attribute specifies a job or document attribute that one or more subjobs in a queue may share. The value is any job attribute, without the leading dash. For example: fax-phone-number. As the JQM dequeues subjobs, it attempts to send subjobs that share the same specified job or document attribute to the same physical destination. NOTE: After setting this attribute, ensure that you restart the JQM that manages the queue. The JQM only considers subjobs, or groups of subjobs, that are at the head of the queue when it selects a physical destination. Therefore, if you set both -group-by-attribute and -reserve-by-attribute on a queue, the JQM can send a group of subjobs to the same physical destination. An example is sending a series of documents to a fax farm. If you set the value of group-by-attribute and -reserve-by-attribute to fax-phone-number, the JQM sends documents that share the same value for the -fax-phone-number attribute to a single fax device, allowing the fax device to fax several documents to the same phone number without redialing the number each time. For information about another attribute that controls dequeuing subjobs, see the -job-order-preserved attribute. NOTE: Do not set the -job-order-preserved attribute on queues on which the -reserve-by-attribute attribute is set.
Type Object Data Type Control Queue Identifier

HP Output Server

211

Chapter 2

Attributes

-resource-name

-resource-name
The -resource-name multi-valued attribute identifies an optional name assigned to a printer resource.
Types Object Data Type Configuration and Status Server: DSM Text

-retention-period-default
See the -job-retention-period attribute description.

-retry-count
The -retry-count multi-valued attribute defines how many attempts to make in establishing a connection for tftp and tcp connection modes before interrupting a job. The default value is 3.
Types Object Data Type Configuration and Status Destination: Physical Integer (Positive)

-retry-interval
The -retry-interval multi-valued attribute specifies for lino-tftp, lpd, and tcp physical destinations the interval (in seconds) between attempts by the DSM to connect to a remote device. The job is interrupted when the -retry-count number of attempts have been made (with -retry-interval seconds in between each attempt) without a successful connection. The default value is 10 seconds.
Types Object Data Type Configuration and Status Destination: Physical Integer (Positive)

212

System Administrators Attribute Reference

Chapter 2

Attributes
-right-margin

-right-margin -right-margin-default
The -right-margin single-valued attribute specifies the size, in points, of the right margin of a text document sent to a PostScript destination. The -right-margin-default single-valued attribute specifies the default size of the right margin.
Types -right-margin: Control -right-margin-default: Configuration Objects -right-margin: Document -right-margin-default: Destinations: Logical, Physical Data Type Integer (Positive)

-scheduler-assigned
The -scheduler-assigned single-valued attribute sets the scheduling method for a queue.
Types Object Data Type Valid Values Configuration and Status Queue Identifier Pd-batch Pd-FIFO Sets order of priority from 0-100, with 100 being highest priority. Sets order of priority to arrival in the queue; the first subjob to arrive is the first subjob that is delivered. Sets order of priority to the subjob with smallest -total-job-octets first.

Pd-shortest-job-first

-scheduling-algorithms-supported
The -scheduling-algorithms-supported multi-valued attribute specifies what scheduling algorithms the server supports.
Type Status

HP Output Server

213

Chapter 2

Attributes

-separator-sheet

Object Data Type Valid Values

Server: JQM Identifier Pd-batch Pd-FIFO Sets order of priority from 0-100, with 100 being highest priority. Sets order of priority to arrival in the queue; the first subjob to arrive is the first subjob that is delivered. Sets order of priority to the subjob -total-job-octets first.

Pd-shortest-job-first

-separator-sheet -separator-sheet-default -separator-sheets-supported

The -separator-sheet single-valued document attribute defines the type of separator sheet to use for the specified document. The -separator-sheet-default single-valued attribute specifies the default type of separator sheet to use for a job if the -separator-sheet attribute is undefined. The -separator-sheets-supported multi-valued attribute lists the types of separator sheets that are supported.
Types -separator-sheet: Control and Status -separator-sheet-default: Configuration and Status -separator-sheets-supported: Configuration and Status Object -separator-sheet: Job -separator-sheet-default: Destinations: Physical, Logical (PS, PCL, Text) -separator-sheets-supported: Destination: Logical Data Type Valid Values Identifier none, blank, full, brief

214

System Administrators Attribute Reference

Chapter 2

Attributes

-separator-sheet-type-format

-separator-sheet-type-format
The -separator-sheet-type-format single-valued attributes indicates the document format of the corresponding -separator-sheet-type-path attribute. NOTE: HP Output Server can perform attribute replacement in the sheets only if the attribute syntax is in clear text in the file. The type is either blank, brief, full, none, or retry.
Types Object Data Type Valid Values Configuration and Status Destination: Physical Identifier afp, hp-pcl, html, iso-6429, literal, PDF, pdf, PS, ps, TEXT, text, webviewable

-separator-sheet-type-format-variants
The -separator-sheet-type-format-variants multi-valued attribute defines the -separator-sheet document format variant. For more information, see the -separator-sheet-type-format attribute. The lf-implies-cr value is the default that applies only if the -input-document-format attribute is set to text. See also the -input-document-format-variants attribute.
Types Object Data Type Control and Status Destination: Physical Identifier

HP Output Server

215

Chapter 2

Attributes

-separator-sheet-type-format-version

Valid Values

PS variants: PS-L1, ps-l1, PS-L2, ps-l2, PS-DSC1, ps-dsc1, PS-DSC2, ps-dsc2, PS-DSC3, ps-dsc3 iso-6429 (text) variants: simple-text, ht, lf-implies-cr (default), cr-implies-lf, cr-overstrike, bs-overstrike, iso-10538-pif-level1, iso-10538-pif-level2, iso-10538-pif-level3, iso-10538-pif-level4, iso-10538, fft-level1v, iso-10538, fft-level2, iso-10538, fft-level2a, iso-10538, fft-level2b, iso-10538 hp-pcl variants: hp-pcl1, hp-pcl2, hp-pcl3, hp-pcl4, hp-pcl5 html variants: html-32 Other variants: ppds-level1, ppds-level2, ppds-level3, fft-level2c, sgr-underline-bold, dec-pp12, dec-pp13, line-ansi-cc, line-machine-cc, line-trc, line-sosil, line-sosi2, line-sosi3, modca-isl, modca-pt1, modca-dr2, modca-dr3, modca-fs10, modca-fs20, modca-bcdl, modca-iml, scs-sosi1, SCS-sosi1, scs-sosi2, SCS-sosi2, scs-sosi3, SCS-sosi3, BINARY, binary, CLEARTEXT, cleartext, asterx-wp, applix-wp, asterx-gr, applix-gr, asterx-ss, applix-ss

-separator-sheet-type-format-version
The -separator-sheet-type-format-version single-valued attribute defines the variant-independent -separator-sheet document format version. The retry start sheet overrides other job sheet types when a job has a -number-of-times-tried value of 1 or greater. For more information, see the -separator-sheet-type-format attribute.
Types Object Data Type Control and Status Document Text

-separator-sheet-type-path
The -separator-sheet-type-path single-valued attribute specifies the absolute path and file name of a separator sheet. The type is either blank, brief, full, none or retry. The retry start sheet overrides other job sheet types when a job has a -number-of-times-tried value of 1 or greater.

216

System Administrators Attribute Reference

Chapter 2

Attributes

-server-address

To set the -separator-sheet-type-path attribute for a physical destination, type the following command: pdset -c d -x"-separator-sheet-type-path sheetFilepath -separator-sheet-type-format format" destination

Types Object Data Type

Configuration and Status Destination: Physical Text

-server-address
The -server-address single-valued attribute identifies the IP address of a servers host.
Type Object Data Type Status Server Text (in octal format)

-server-cache-size
The -server-cache-size single-valued attribute specifies the number of objects a delivery server and the CM can store in memory. If the server reaches its object limit, subsequent queries are made to disk. To evaluate the setting of the -server-cache-size attribute, use the pdcontrol command with the -dump attribute set to pdb-stats.
Type Object Data Type Configuration Server Integer

HP Output Server

217

Chapter 2

Attributes

-server-environment-variables

-server-environment-variables
The -server-environment-variables multi-valued attribute specifies the environment variables and values to be set in the environment of a server when it is started. Use the config_server command to set this attribute as follows: config_server -u -x"-server-environment-variables [\"environmentVariable1=value1\", \"environmentVariable2=value2\"...]" server where environmentVariable is the name of the environment variable, value is the value that you specify for the variable, and server is the name of the server. NOTE: You must stop and start the specified server for the change to take effect. In the following example, the DAZEL_PORTS environment variable is set for an installations delivery servers. Setting DAZEL_PORTS controls which port numbers a server process will use. config_server -u -t delivery -x"-server-environment-variables \"DAZEL_PORTS=40000-40100\""

Types Object Data Type

Configuration and Status Server Text

-server-hostname
The -server-hostname single-valued attribute specifies the name of the host on which the server runs.
Types Object Data Type Configuration and Status Server Text

218

System Administrators Attribute Reference

Chapter 2

Attributes

-server-log-level

-server-log-level
The -server-log-level multi-valued attribute defines the types of messages generated by HP Output Server processes during execution. These messages are divided into eight categories that describe the importance of the information. The categories, from most to least important, are emergency, critical, alert, error, warning, notice, info and debug. You can select multiple categories by separating them with a comma. There are three predefined groups of categories: all, terse, and none. Selecting all causes the server to log every category of message. The terse grouping causes the server to log only messages of the highest importance (emergency through error). Specifying none causes the server to not log any messages. Add logging categories to a group by separating them with commas, for example, terse,notice causes a server to log messages at levels emergency through error as well as notice-level messages. Prepending the level name with a dash causes the server to not log that level of messages even if the group name would normally, for example, all,-debug causes a server to log all categories of messages except debug. During initial configuration and when diagnosing a problem, setting the -server-log-level attribute to all helps when trying to solve delivery conflicts and other problems. Set this attribute with the config_server command.
Types Object Data Type Valid Values Configuration and Status Server Text all, terse, none, emergency, emerg, critical, crit, alert, error, err, warning, warn, notice, info, debug

-server-log-maximum-size
The -server-log-maximum-size single-valued attribute specifies whether a server monitors the size of its log file, and if so, the maximum size (in bytes) its log file may reach. The default behavior (when this attribute is not set) is to not monitor log file size. If this attribute is set and a servers log file reaches its maximum size, the server writes a message in the log file and suspends logging. You must truncate the log file before the server logs messages in the file again.

HP Output Server

219

Chapter 2

Attributes

-server-log-tz-cut

This attribute does not affect syslog message logging.

Type Object Data Type Configuration Server Integer (Bytes)

-server-log-tz-cut
The -server-log-tz-cut single-valued attribute specifies which time zone to use to record timestamps in server log files. If the value is true, the server records timestamps in GMT/Zulu/CUT time. If the value is false (the default), the server records timestamps in local time. This attribute does not affect syslog message logging.
Type Object Data Type Valid Values Configuration Server Boolean TRUE, true, FALSE, false, YES, yes, NO, no

-server-login-name -server-login-name-default
The -server-login-name-default single-valued attribute specifies the name with which to start the HP Output Server server. The value of this attribute is set at installation time to the owner of the installed HP Output Server files. By default, the -server-login-name single-valued attribute is set to the same value as -server-login-name-default. Setting -server-login-name to a different value overrides -server-login-name-default at the specified server.
Types Object Data Type Configuration and Status Server Text

220

System Administrators Attribute Reference

Chapter 2

Attributes

-server-message

-server-message
The -server-message single-valued attribute specifies a message for a server, intended to inform users of changes in the availability of the server or other information.
Types Object Data Type Configuration and Status Server Text (Message)

-server-name
The -server-name single-valued attribute identifies the name of an existing server. The values for this attribute cannot contain embedded spaces.
Type Object Data Type Status Server Text

-server-start-enabled
The -server-start-enabled single-valued attribute enables or disables a servers startup. Use the config_server command to set this attribute as follows. config_server -u -x"-server-start-enabled false" serverName If a servers -server-start-enabled attribute is set to false, you are unable to start the server with the start_server command. To be able to start the server, set the -server-start-enabled attribute to true as follows: config_server -u -x"-server-start-enabled true" serverName If -server-start-enabled is not set, its default value is true.
Type Object Data Type Valid Values Configuration Server

Boolean TRUE, true, FALSE, false, YES, yes, NO, no

HP Output Server

221

Chapter 2

Attributes

-server-start-order

-server-start-order
The -server-start-order single-valued attribute specifies the order in which a server starts relative to the other servers in HP Output Server. Servers start in this order: SSM (Windows only), NM, PM, AIM, EM, CM, JQM, DSM, DLM, CP, LPG, SAPconnect, OMS Callback.
Type Object Data Type Status Server Integer

-server-startup-limit
The -server-startup-limit single-valued attribute defines the maximum number of JQM and then DLM or DSM servers that the start_server command attempts to start at the same time. The start_server command attempts to start all JQM servers before it attempts to start the DLM and DSM servers. The default is 5 servers. For example, if your HP Output Server configuration includes six JQM servers, four DLM servers, and 14 DSM servers on the same host, and the -server-startup-limit attribute is set to 5, the start_server command attempts to start servers in the following manner: 1. 2. 3. JQM servers one through five JQM server six Five DLM or DSM servers (selected randomly)

The start_server command repeats Step 3 until it completes its attempts to start all of the DLM and DSM servers. You can also modify the value of the -server-startup-limit attribute using the config_host command.
Type Object Data Type Configuration Host Integer

222

System Administrators Attribute Reference

Chapter 2

Attributes

-server-startup-completion-time

-server-startup-completion-time
The -server-startup-completion-time single-valued attribute specifies the time when a server completes startup. If a value is not set, the default value (in seconds) depends on the server type as follows:
Server AIM CM DLM DSM EM epod JQM CP LPG NM OMSCB PM SAPCON Default Time in Seconds 25 300 55 100 25 20 300 30 30 30 20 25 20

Type Object Data Type

Status Server Time (UTC)

HP Output Server

223

Chapter 2

Attributes

-server-startup-time

-server-startup-time
The -server-startup-time single-valued attribute specifies a servers start-up date and time.
Type Object Data Type Status Server Time (UTC)

-server-type
The -server-type single-valued attribute identifies the type of the server.
Types Object Data Type Valid Values Configuration and Status Server Identifier AIM: aim, accounting-and-inventory-manager CM: ccm, cm, configuration-manager CP: cp, communication-proxy DLM: dm, dlm, delivery-manager DSM: dsm, destination-manager EM: em, event-manager EPO: epo, event-paging-option JQM: spooler, jqm, job-and-queue-manager, supervisor LPG: lpg, lpr-gateway NM: nm, namespace-manager, name-space-manager OMS: oms-callback PM: pm, privilege-manager SAPCON: sapcon, sap-connect SSM: startup-manager

-server-uses-syslog
The -server-uses-syslog single-valued attribute specifies if the server is to use the host machines logging mechanism. For example, on UNIX, the syslog daemon is the host logging mechanism. This attribute works for both UNIX and Windows. The

224

System Administrators Attribute Reference

Chapter 2

Attributes

-server-version

default value is true, which stores HP Output Server logging messages in the host machines logging mechanism. The false value allows you to define a file (with the -server-log-file attribute) in which to log HP Output Server-specific logging. Set this attribute with the config_server command.
Type Object Data Type Valid Values

Configuration Server Boolean TRUE, true, FALSE, false, YES, yes, NO, no

-server-version
The -server-version single-valued attribute reports the server version number.
Type Object Data Type Status Server Text

-server-working-directory
The -server-working-directory single-valued attribute reports the path of the directory that is supplied to a server when the server starts.
Type Object Data Type Configuration and Status Server Text

-sheet-format
The -sheet-format single-valued attribute specifies the start sheet format for a job. The value of the -sheet-format attribute overrides the default value set at a physical destination with the -start-sheet-full-format, -start-sheet-brief-format, or -separator-sheet-full-format attributes. This attribute is primarily used to override default sheet formats when submitting literal mode documents.

HP Output Server

225

Chapter 2
-shingling

Attributes

To start a job for a literal format document, type the following command: pdpr -d destinationName -x"-sheet-format literal -start-sheet full -input-document-format literal" literalFormatDocument

Type Object Data Type Valid Values

Control Document Identifier afp, hp-pcl, html, iso-6429, literal, modca, pdf, PDF, ps, PS, TEXT, text, webviewable

-shingling -shingling-default -shinglings-supported

The -shingling single-valued attribute specifies the amount of shingling for the document to the driver that controls the shingling mode of the printer. The shingling mode defines the number of passes the print head makes to lay down ink. The -shingling-default single-valued attribute specifies a default value if you have not set the -shingling attribute. The -shinglings-supported multi-valued attribute determines the valid values for the -shingling attribute. The following table lists drivers that support shingling.
Driver lj4dith cdeskjet cdjcolor cdjmono cdj500 cdj550 Definition HP LaserJet 4 with enhanced greyscale support HP DeskJet 500C with 3 bit/pixel color HP DeskJet 500C with 24 bit/pixel color; DeskJet 540C HP DeskJet 500C printing black only; DeskJet 510, 520, and 540C (black only) HP DeskJet 500C (same as cdjcolor) HP DeskJet 550C/560C/660C

226

System Administrators Attribute Reference

Chapter 2

Attributes
-sides

Driver pj pjxl pjxl300 declj250 dnj650c Type Objects

Definition HP PaintJet XL HP PaintJet XL color printer HP PaintJet XL300 color printer; PaintJet 1200C and 1600C; Color LaserJet DEC LJ250 driver HP DesignJet 650C Control -shingling: Document: PCL -shingling-default: Destinations: Logical, Physical (PCL) -shinglings-supported: Destination: Logical (PCL)

Data Type Valid Values

Integer (Positive) 0 = none 1 = 50% 2 = 25%

-sides -sides-default
The -sides single-valued attribute specifies whether printing occurs on one or both sides of a page. If the value is 1, then printing occurs on only one side of the page. If the value is 2, then printing occurs on both sides of the page. To print both sides, the value of the -sides-supported attribute must be set to 1, 2. The -sides-default single-valued attribute specifies whether the document is to be printed on one or both sides of the page if the -sides attribute is not defined for a document.
Type Objects Control

-sides: Document -sides-default: Destinations: Logical, Physical (Printers)

Integer 1 2 one side of the page both sides of the page

Data Type Valid Values

HP Output Server

227

Chapter 2

Attributes

-sides-supported

-sides-supported
The -sides-supported multi-valued attribute lists the valid values for the -sides and -sides-default attributes. To enable a device to print both sides, both 1 and 2 must be typed as values.
Type Objects Data Type Valid Values Control Destinations: Logical, Physical (Printers) Integer 1 1,2 2 one side of the page one or two sides of the page two-sided printing only

-spooler-job-processing-time-warning-time
The -spooler-job-processing-time-warning-time single-valued attribute specifies the time (in seconds) after which a processing job is considered to have been processing for too long. The JQM looks for such jobs once every ten minutes. When it finds a job with an excessive processing time, it generates a criterion-exceeded notice about the job. The default is 3600 seconds (one hour).
Type Object Data Type Status Server: JQM Integer

-staple-count-default -staple-counts-supported
See the -job-staple-count attribute description.

-staple-location-default -staple-locations-supported
See the -job-staple-location attribute description.

228

System Administrators Attribute Reference

Chapter 2

Attributes

-staple-type-default

-staple-type-default -staple-types-supported
See the -job-staple-type attribute description.

-start-sheet -start-sheet-default -start-sheets-supported

The -start-sheet single-valued attribute specifies the type of start sheet for a job. The -start-sheet-default single-valued attribute specifies the default type of start sheet to use for a job if the -start-sheet attribute is undefined. The -start-sheets-supported multi-valued attribute lists the types of start sheets that are supported. NOTE: For e-mail, file, and FTP logical destinations, you are not allowed to specify a value for this attribute.
Types -start-sheet: Control and Status -start-sheet-default: Configuration and Status -start-sheets-supported: Configuration and Status Objects -start-sheet: Job -start-sheet-default: Destinations: Logical, Physical -start-sheets-supported: Destination: Logical Data Type Valid Values Identifier none, blank, brief, full

-start-sheet-type-format
The -start-sheet-type-format single-valued attribute specifies the -start-sheet document format. NOTE: HP Output Server can perform attribute replacement in the sheets only if the attribute syntax is in clear text in the file.

HP Output Server

229

Chapter 2

Attributes

-start-sheet-type-format-variants

The type is either none, blank, brief, full or retry.

Types Object Data Type Valid Values Configuration and Status Destination: Physical Identifier afp, hp-pcl, html, iso-6429, literal, modca, pdf, PDF, ps, PS, TEXT, text, webviewable

-start-sheet-type-format-variants
The -start-sheet-type-format-variants multi-valued attribute defines the -start-sheet document format variant. The type is either none, blank, brief, full, or retry. For more information, see the -start-sheet-type-format attribute. The lf-implies-cr value is the default that applies only if the -input-document-format attribute is set to text. See also the -input-document-format-variants attribute.
Types Object Data Type Control and Status Destination: Physical Identifier

230

System Administrators Attribute Reference

Chapter 2

Attributes

-start-sheet-type-format-version

Valid Values

PS variants: PS-L1, ps-l1, PS-L2, ps-l2, PS-DSC1, ps-dsc1, PS-DSC2, ps-dsc2, PS-DSC3, ps-dsc3 iso-6429 (text) variants: simple-text, ht, lf-implies-cr (default), cr-implies-lf, cr-overstrike, bs-overstrike, iso-10538-pif-level1, iso-10538-pif-level2, iso-10538-pif-level3, iso-10538-pif-level4, iso-10538, fft-level1v, iso-10538, fft-level2, iso-10538, fft-level2a, iso-10538, fft-level2b, iso-10538 hp-pcl variants: hp-pcl1, hp-pcl2, hp-pcl3, hp-pcl4, hp-pcl5 html variant: html-32 Other variants: ppds-level1, ppds-level2, ppds-level3, fft-level2c, sgr-underline-bold, dec-pp12, dec-pp13, line-ansi-cc, line-machine-cc, line-trc, line-sosil, line-sosi2, line-sosi3, modca-isl, modca-pt1, modca-dr2, modca-dr3, modca-fs10, modca-fs20, modca-bcdl, modca-iml, scs-sosi1, SCS-sosi1, scs-sosi2, SCS-sosi2, scs-sosi3, SCS-sosi3, BINARY, binary, CLEARTEXT, cleartext, asterx-wp, applix-wp, asterx-gr, applix-gr, asterx-ss, applix-ss

-start-sheet-type-format-version
The -start-sheet-type-format-version single-valued attribute defines the variant-independent -start-sheet document format version. The type is either none, blank, brief, full or retry. For more information, see the -start-sheet-type-format attribute.
Types Object Data Type Control and Status Document Text

-start-sheet-type-path
The -start-sheet-type-path single-valued attribute specifies the absolute path and file name of a start sheet. The type is either none, blank, brief, full or retry. The retry start sheet overrides other job sheet types when a job has a -number-of-times-tried value of 1 or greater.

HP Output Server

231

Chapter 2

Attributes

-started-printing-time

To set the -start-sheet-type-path for a physical destination, type the following command: pdset -c d -x"-start-sheet-type-path retrySheetFilepath -start-sheet-type-format format" destination

Types Object Data Type

Configuration and Status Destination: Physical Text

-started-printing-time
The -started-printing-time single-valued attribute reports the time when a job begins delivery at the physical destination.
Type Object Data Type Status Job Time (UTC)

-state
The -state single-valued attribute specifies the current condition of an object.
Type Objects Data Type Valid Values Status Destination, Queue, Server Identifier available, ready, on-request, unavailable, unknown

-submission-time
The -submission-time single-valued attribute reports the time that a delivery request becomes a job.
Type Object Status Job

232

System Administrators Attribute Reference

Chapter 2

Attributes

-supervisor-ping-interval

Data Type

Time (UTC)

-supervisor-ping-interval
The -supervisor-ping-interval single-valued attribute specifies how frequently a DSM reregisters a physical destination with a JQMs queue. Registering a physical destination with the JQM indicates that the DSM can receive a job. If you restart a JQM, it is unaware of the DSM until the DSM contacts it at the -supervisor-ping-interval. The default -supervisor-ping-interval is 60 seconds. For large installations under normal operations, consider setting the -supervisor-ping-interval to 300 (5 minutes). This higher setting reduces CPU usage because of the reduced communication between DSMs and JQMs. Setting the -supervisor-ping-interval attribute to 0 turns reregistering off. If a JQM goes down in this case, you must first restart it. Then, you must either initialize or shut down and restart any affected DSMs. This instructs the DSM to register its physical destinations with their associated queues. Affected DSMs are those that manage physical destinations receiving jobs from queues on the JQM that went down. For information about setting the retry registration interval during error conditions, see the -supervisor-retry-interval attribute.
Types Object Data Type Configuration and Status Server: DSM Integer (0, Positive)

-supervisor-retry-interval
The -supervisor-retry-interval single-valued attribute specifies how frequently a DSM retries the registration of a physical destination with a JQMs queue if a registration attempt fails. For example, if a DSM attempts to register a physical destination when a JQM is down, the registration fails. The -supervisor-ping-interval specifies the frequency of reregistration. The default -supervisor-retry-interval is 60 seconds. With a setting of 60, the DSM retries registration every 60 seconds until registration is successful.

HP Output Server

233

Chapter 2
-synchronicity

Attributes

Coordinating the settings of the -supervisor-retry-interval and the -supervisor-ping-interval attributes can help manage CPU usage. If you specify a higher setting for -supervisor-ping-interval, CPU usage is lighter during normal operations. A setting of 60 for -supervisor-retry-interval ensures that the physical is registered quickly in the event of an error condition.
Types Object Data Type Configuration and Status Server: DSM Integer

-synchronicity -synchronicity-default
The -synchronicity single-valued attribute specifies whether a client waits for the outcome of a delivery attempt. If you choose asynchronous-file-transfer, the client returns successfully after the DLM copies the job file to its spool area. If you choose synchronous, the client and the DLM remain connected and wait for the outcome of the attempt to transfer the file from the DLM to the JQM before proceeding to other tasks. The -synchronicity-default multi-valued attribute specifies the default delivery behavior for all jobs that are processed by a DLM server.
Types -synchronicity: Control -synchronicity-default: Configuration Objects -synchronicity: Job -synchronicity-default: Server (DLM) Data Type Valid Values Identifier synchronous, asynchronous-file-transfer

234

System Administrators Attribute Reference

Chapter 2

Attributes

-system-job-message

-system-job-message
The -system-job-message multi-valued attribute reports actions that delivery servers, queues, logical destinations, and physical destinations perform on a job. Because the -system-job-message attribute supports buffering, you can define a strategy to manage system job messages. Define the strategy with the following three attributes: -system-job-message-strategy -system-job-message-buffer-limit -system-job-message-buffer-type

Type Object Data Type

Status Job Text

-system-job-message-buffer-limit -system-job-message-buffer-limit-default
The -system-job-message-buffer-limit single-valued attribute defines the maximum number of messages to store in the system job message buffer. The -system-job-message-buffer-limit-default single-valued attribute defines the default maximum number of messages to store in the system job message buffer.
Types -system-job-message-buffer-limit: Control and Status -system-job-message-buffer-limit-default: Configuration and Status Objects -system-job-message-buffer-limit: Job -system-job-message-buffer-limit-default: Destination: Physical, Logical Data Type Integer

HP Output Server

235

Chapter 2

Attributes

-system-job-message-buffer-type

-system-job-message-buffer-type -system-job-message-buffer-type-default
The -system-job-message-buffer-type single-valued attribute specifies the method (buffer type) for logging system job messages. The value of the -system-job-message-buffer-limit attribute defines the number of messages to store in the buffer. The -system-job-message-buffer-type-default single-valued attribute specifies the default method for logging system job messages.
Types -system-job-message-buffer-type: Control and Status -system-job-message-buffer-type-default: Configuration and Status Objects -system-job-message-buffer-type: Job -system-job-message-buffer-type-default: Destination: Physical, Logical Data Type Valid Values Identifier limited rolling Collects messages until the message limit is reached, at which point message logging is stopped. The system job message logging mechanism constantly adds new messages to the buffer. When the size of the buffer reaches the message limit, the logging mechanism deletes the oldest message each time it adds a new message.

-system-job-message-strategy -system-job-message-strategy-default
The -system-job-message-strategy single-valued attribute controls how new messages are added to -system-job-message. If -system-job-message-strategy is not set, the default value is replace. The -system-job-message-strategy-default single-valued attribute specifies the default -system-job-message-strategy. To define a buffering method for system job messages, complete these steps: 1. Select the desired buffering method (append, buffer, or replace) with the -system-job-message-strategy or-system-job-message-strategy-default attribute.

236

System Administrators Attribute Reference

Chapter 2

Attributes
-tcp-data-port

2. 3.

Set the buffer limit with the -system-job-message-buffer-limit or -system-job-message-buffer-limit-default attribute. Select the buffer type with the -system-job-message-buffer-type or -system-job-message-buffer-type-default attribute. Buffer types include limited or rolling.

Defining a buffering method with the -system-job-message-strategy attribute replaces the -system-job-message-append and -system-job-message-append-default attributes. Setting -system-job-message-append to true is equivalent to setting -system-job-message-strategy to append. Alternatively, the -system-job-message-append value of false is equivalent to setting the -system-job-message-strategy to replace.
Types -system-job-message-strategy: Control and Status -system-job-message-strategy-default: Configuration and Status Objects -system-job-message-strategy: Job -system-job-message-strategy-default: Destination: Physical, Logical Data Type Valid Values Identifier append buffer Appends the new message to the end of the existing -system-job-message. Uses the buffer method defined by -system-job-message-buffer-type or -system-job-message-buffer-type-default. Replaces the existing -system-job-message with a new message.

replace

-tcp-data-port
The -tcp-data-port single-valued attribute defines the TCP communications port for a device. This attribute is required if the value of the -printer-connection-mode attribute is tcp. Additionally, this attribute specifies the ports of FTP destinations by assigning port numbers as values.
Types Object Configuration and Status Destination: Physical

HP Output Server

237

Chapter 2
-tcp-host

Attributes

Data Type

Integer (Positive)

-tcp-host
The -tcp-host single-valued attribute defines the host name of a device. This attribute is required if the -printer-connection-mode attributes value is tcp.
Types Object Data Type Valid Values Configuration and Status Destination: Physical Text Short host name, such as sandbox Fully qualified host name, such as sandbox.bigcompany.com IP address, such as 255.255.255.255

-tcp-status-port
The -tcp-status-port single-valued attribute specifies the TCP port that some Lexmark printers use to report status, such as paper jam or paper out. For Lexmark printers, this port is typically 9200.
Types Object Data Type Configuration and Status Destination: Physical Integer

-template
The -template single-valued attribute specifies if an object is designated as a template. Templates provide consistent, pre-defined configuration for objects. An object that has been defined as a template can only be used with the -copy-from attribute to create other objects with the template's predefined attributes and values. A template cannot be used as an active object. For example, if you created a queue and designated it as a template, it could be used to provide configuration information for new queues, but you could not use it as a queue. The default for the -template attribute is false, which indicates that the object is not a template.
Type Configuration

238

System Administrators Attribute Reference

Chapter 2

Attributes

-template-classification

Objects Data Type Valid Values

All Objects Boolean TRUE, true, FALSE, false, YES, yes, NO, no

-template-classification
The -template-classification single-valued attribute identifies the category to which a physical device template belongs. The config_device command uses this attribute when determining if a particular template should be used to configure the destination. Unless the template is a component template, this attribute should be set to static-template and the -template-type attribute should be set to standard-template.
Type Object Data Type Valid Values Configuration Destination: Physical Identifier static-template, connection-template, device-specific-template, device-option-template, printer-common-template, protocol-template

-template-component
The -template-component single-valued attribute indicates whether a physical destination template is a component template. If the value is true, the template is a component template. If the value is false, the template is not a component template.
Type Object Data Type Valid Values Configuration Destination: Physical Boolean TRUE, true, FALSE, false, YES, yes, NO, no

HP Output Server

239

Chapter 2

Attributes

-template-device-name

-template-device-name
The -template-device-name multi-valued attribute specifies the printer name for which the template is valid. The value for this attribute must match for the associated device type and destination objects to allow the config_device command to find a printer template.
Type Object Data Type Configuration Destination: Physical Text

-template-site
The -template-site multi-valued attribute specifies the site name or names for which a custom template is valid. This attribute is required if you are using custom templates (created by you or by HP Professional Services). When you use custom templates for physical destinations, you must set both the -template-site and the -template-type attributes in the custom template. When you configure the physical destination with the config_device command, you will specify the value of the -template-site attribute.
Type Object Data Type Configuration Destination: Physical Text

-template-type
The -template-type single-valued attribute specifies whether the template is a standard template (provided with HP Output Server) or a customized template (created by you or by HP Professional Services). When you use custom templates for physical destinations, you must set both the -template-site and the -template-type attributes in the custom template. When you configure the physical destination with the config_device command, you will specify the value of the -template-site attribute.
Type Object Configuration Destination: Physical

240

System Administrators Attribute Reference

Chapter 2

Attributes

-text-conversion-font

Data Type Valid Values

Identifier standard-template, custom-template

-text-conversion-font -text-conversion-font-default
The -text-conversion-font single-valued attribute specifies the name of the PostScript font to use for a text-to-PostScript translation. The PostScript font name must be directly supported by the target printer or GhostScript, although the DSM does not verify the name before translating the document. The default font is Courier. The -text-conversion-font-default attribute specifies a default value for the -text-conversion-font attribute on a logical or physical destination.
Types -text-conversion-font: Control -text-conversion-font-default: Configuration Objects -text-conversion-font: Document -text-conversion-font-default: Destinations: Logical, Physical Data Type Text

-text-conversion-font-size -text-conversion-font-size-default
The -text-conversion-font-size single-valued attribute specifies the size of the PostScript font to use for a text-to-PostScript translation. The default font size is 10 points. The -text-conversion-font-size-default attribute specifies a default value for the -text-conversion-font-size attribute on logical or physical destinations.
Types -text-conversion-font-size: Control -text-conversion-font-size-default: Configuration Objects -text-conversion-font-size: Document -text-conversion-font-size-default: Destination: Logical, Physical Data Type Integer (Positive)

HP Output Server

241

Chapter 2

Attributes

-text-conversion-line-size

-text-conversion-line-size -text-conversion-line-size-default
The -text-conversion-line-size single-valued attribute specifies the line size to use for a text-to-PostScript translation. The default line size is 125% of the value of the -text-conversion-font-size attribute, or 12.5 points. The -text-conversion-line-size-default attribute specifies a default value for the -text-conversion-line-size attribute on logical or physical destinations.
Types -text-conversion-line-size: Control -text-conversion-line-size-default: Configuration Objects -text-conversion-line-size: Document -text-conversion-line-size-default: Destinations: Logical, Physical Data Type Integer (Positive)

-text-conversion-real-font-size -text-conversion-real-font-size-default
The -text-conversion-real-font-size single-valued attribute specifies the size (in decimal values) of the PostScript font to use for a text-to-PostScript translation. The -text-conversion-real-font-size-default single-valued attribute specifies a default value for the -text-conversion-real-font-size attribute.
Type Objects Configuration -text-conversion-real-font-size: Document: Text -text-conversion-real-font-size-default: Destination: Physical Data Type Real

-text-conversion-real-line-size -text-conversion-real-line-size-default
The -text-conversion-real-line-size single-valued attribute specifies real values (not restricted to whole numbers) for line sizes in either decimal or percentage format.

242

System Administrators Attribute Reference

Chapter 2

Attributes
-top-margin

The -text-conversion-real-line-size attribute is ignored by the text-to-PostScript translation, but is not ignored by tps. NOTE: The -text-conversion-real-line-size attribute takes precedence over the -text-conversion-line-size attribute when both are specified with the job. The -text-conversion-real-line-size-default single-valued attribute specifies a default value for the -text-conversion-real-line-size attribute. The default value for the -text-conversion-real-line-size-default attribute is 12. NOTE: The -text-conversion-real-line-size -default attribute takes precedence over the -text-conversion-line-size-default attribute when both are set at either the physical or logical destination.
Type Objects Configuration -text-conversion-real-line-size: Document: Text -text-conversion-real-line-size-default: Destination: Physical Data Type Real

-top-margin -top-margin-default
The -top-margin single-valued attribute specifies the size, in points, of the top margin of a text document sent to a PostScript destination. The -top-margin-default single-valued attribute specifies the default size of the top margin.
Types -top-margin: Control -top-margin-default: Configuration Objects -top-margin: Document -top-margin-default: Destinations: Logical, Physical Data Type Integer (Positive)

HP Output Server

243

Chapter 2
-total-job-octets

Attributes

-total-job-octets
The -total-job-octets single-valued attribute specifies the total number of octets (bytes) in a job, including all documents.
Type Object Data Type Status Subjob Integer (Positive)

-track-dazel-guest
The -track-dazel-guest single-valued attribute specifies if a JQM sets the -dazel-guest attribute for jobs submitted by guest users. Guest users are users in the dazel_guest PM group. With -track-dazel-guest set to true at a JQM, that JQM sets the -dazel-guest job attribute to true for each job submitted by a guest user. With -track-dazel-guest set to true, you can list all of the jobs submitted by guest users to a particular JQM as follows: pdls -c job -a all -x"-dazel-guest true" jqmName:

Types Object Data Type Valid Values

Control Server Boolean TRUE, true, FALSE, false, YES, yes, NO, no

-transfer-method -transfer-methods-supported
The -transfer-method single-valued attribute specifies the method by which an HP Output Server server transfers files. The -transfer-methods-supported multi-valued attribute specifies the methods by which a server may transfer files, expressed in a comma-separated list. Specifying a value for this attribute is not required when you submit a job with the pdpr command. By default, the value of this attribute is referenced-data-transfer, which means that when an HP Output Server server receives a job request (to print a file, for example), the server attempts to minimize the network file transfers by first linking to or referencing the file. This is

244

System Administrators Attribute Reference

Chapter 2

Attributes

-transformer-input-format

possible when the client submitting the request and the DLM share a common spool subtree, either because they run on the same machine or can access a shared remote file system. If the server cannot link to or reference the file, it attempts to obtain a copy of the file from the client. This function is equivalent to specifying dce-rpc-pipe as the value for the -transfer-method attribute. If you submit a job and specify transfer-document-with-job-request as the value for the -transfer-method attribute, a copy of the files in the job is transferred to the DLM with the job request. If the file size of a document in the job is large, the pdpr command can dump core on the client. When this happens, the files associated with the job are not transferred to the DLM spool area on the server. To avoid dumping core on the client when you set -transfer-method to transfer-document-with-job-request, HP recommends that the file size of each document in the job not exceed 1 MB.
Type Objects Status -transfer-method: Document -transfer-methods-supported: Server: JQM Data Type Valid Values Identifier transfer-document-with-job-request, dce-rpc-pipe, referenced-data-transfer, ftam-by-client, ftam-by-server, tcp-ip-socket, pushed-previously, pushed-after

-transformer-input-format
The -transformer-input-format single-valued attribute specifies the document format that the translation program accepts.
Types Object Data Type Valid Values Control and Status Transformer Identifier Any valid document format

HP Output Server

245

Chapter 2

Attributes

-transformer-name

-transformer-name
The -transformer-name single-valued attribute specifies the name of a transformer object defined by other -transformer* attributes. The values for this attribute cannot contain embedded spaces. For more information about configuring and using transformers, see the System Administrators Guide for HP Output Server.
Types Object Data Type Control and Status Transformer Text

-transformer-output-format
The -transformer-output-format single-valued attribute specifies the format of the document that the translator program generates.
Types Object Data Type Valid Values Control and Status Transformer Identifier Any valid document format

-transformer-priority
The -transformer-priority single-valued attribute specifies a priority, allowing the transformers to be ordered. The larger the number, the higher the priority; a higher priority transformer is considered before a lower priority transformer. Transformers without a specified -transformer-priority are considered the lowest priority.
Types Object Data Type Control and Status Transformer Positive integer

-transformer-productions-excluded
The -transformer-productions-excluded multi-valued text attribute lists attribute-value pairs that exclude a transformer from being used on a document, even if the value of -transformer-productions-supported qualifies the transformer.

246

System Administrators Attribute Reference

Chapter 2

Attributes

-transformer-productions-included

The -transformer-productions-excluded attribute defines the conditions under which a transformer is selected, making the process more efficient.
Types Object Data Type Control and Status Transformer Text

-transformer-productions-included
The -transformer-productions-included multi-valued text attribute specifies attribute-value pairs that qualify a transformer to be used on a document, in addition to the value of -transformer-productions-supported. The -transformer-productions-included attribute defines the conditions under which a transformer is selected, making the process more efficient.
Types Object Data Type Control and Status Transformer Text

-transformer-productions-supported
The -transformer-productions-supported multi-valued attribute lists the productions that the transformer supports. A DSM supports a set of transformers as specified by the value of the -transformers-supported attribute. Transformer selection is the process of choosing which transformers to use for a given document. This selection process involves choosing the smallest number of translations to convert the input document format to the output document format and then applying the necessary productions to the document based on the value of the -transformer-productions-supported attribute.
Types Object Data Type Valid Values Control and Status Transformer Identifier Any attribute

HP Output Server

247

Chapter 2

Attributes

-transformer-program

-transformer-program
The -transformer-program single-valued attribute specifies the absolute path and file name of the translation program.
Types Object Data Type Control and Status Transformer Text

-transformer-program-arguments
The -transformer-program-arguments multi-valued attribute specifies the arguments (such as flags or values) that are passed to an external translation program. It supports attribute replacement and conditional replacement.
Types Object Data Type Control and Status Transformer Text

-transformer-program-description
The -transformer-program-description multi-valued attribute describes the transformer program.
Types Object Data Type Control and Status Transformer Text

-transformers-supported
The -transformers-supported multi-valued attribute lists transformer objects accessible by physical destinations within that DSM. A DSM supports a set of transformers as specified by the value of the -transformers-supported attribute. Transformer selection is the process of choosing which transformers to use for a given document. This selection process involves choosing the smallest number of translations to convert the input document

248

System Administrators Attribute Reference

Chapter 2

Attributes
-udp-port

format to the output document format and then applying the necessary productions to the document based on the value of the -transformer-productions-supported attribute.
Types Object Data Type Valid Values Control and Status Server: DSM Text pcl_to_afp, pdf_to_ps, ps_to_afp, ps_to_pcl, ps_to_pdf, ps_to_text, text_to_ps, tps pcl_filter, pcl_pjl_filter, ps_filter, ps_pjl_filter, text_filter ps_form_overlay, ps_imposition, ps_page_disable, ps_page_select, text_cr_implies_lf, text_form_feed, text_header_footer, text_lf_implies_cr, text_line_width, text_page_length, text_page_select, text_to_html With HP Web Delivery installed and configured: html_to_wv, pdf_to_wv, text_to_wv

-udp-port
The -udp-port single-valued attribute identifies the UDP port number on the host to which the device connects.
Types Object Data Type Configuration and Status Destination: Physical Integer (Positive)

-use-pjl-filter -use-pjl-filter-default -use-pjl-filters-supported

The -use-pjl-filter single-valued attribute enables or disables the pcl_pjl_filter or ps_pjl_filter transformer for a document. If the -use-pjl-filter attribute is true, the DSM filters PCL or PostScript input files with the pcl_pjl_filter or ps_pjl_filter transformers. These transformers remove PJL codes from input documents.

HP Output Server

249

Chapter 2
-use-ps-filter

Attributes

If the -use-pjl-filter attribute is false (the default), the DSM does not filter PCL or PostScript input files with the pcl_pjl_filter or ps_pjl_filter transformers. NOTE: To filter only specified PJL commands, use the -use-selective-pjl-filter attribute. The -use-pjl-filter-default single-valued attribute provides a default value for the -use-pjl-filter attribute. Set this attribute at the logical destination. The -use-pjl-filters-supported attribute identifies whether a DSM server filters PCL or PostScript documents to remove PJL codes. Set this attribute at DSM servers on which you define the pcl_pjl_filter or ps_pjl_filter transformers. You must define the pcl_pjl_filter or ps_pjl_filter transformers at the DSM server before using the -use-pjl-filter attribute. The following command defines the transformers at a DSM named dsm2: pdset -c server -x"-+transformers-supported ps_pjl_filter, pcl_pjl_filter" dsm2

Type Objects

Control -use-pjl-filter: Document -use-pjl-filter-default: Destination: Logical -use-pjl-filters-supported: Server: DSM

Data Type Valid Values

Boolean TRUE, true, FALSE, false, YES, yes, NO, no

-use-ps-filter -use-ps-filter-default
The -use-ps-filter single-valued attribute enables or disables the ps_filter transformer for a document. When -use-ps-filter is true (the default), the DSM filters input files and replaces ^D and ^T control codes with the \n characters. The -use-ps-filter-default single-valued attribute provides a default value for the -use-ps-filter attribute. This attribute is set to true by default for logical and physical destinations.

250

System Administrators Attribute Reference

Chapter 2

Attributes

-use-selective-pjl-filter

Before using the -use-ps-filter attribute, you must add the ps_filter transformer to the physical destinations managing server. The following command adds ps_filter to dsm_01s list of supported transformers: pdset -c server -x"-+transformers-supported ps_filter" dsm_01

Type Objects

Control -use-ps-filter: Document -use-ps-filter-default: Destinations: Logical, Physical

Data Type Valid Values

Boolean TRUE, true, FALSE, false, YES, yes, NO, no

-use-selective-pjl-filter -use-selective-pjl-filter-default
The -use-selective-pjl-filter multi-valued document attribute enables the pcl_selective_pjl_filter or ps_selective_pjl_filter transformer. Both pcl_selective_pjl_filter and ps_selective_pjl_filter are productions that remove specified PJL commands from a document. With -use-selective-pjl-filter set, the DSM uses pcl_selective_pjl_filter or ps_selective_pjl_filter to filter PCL or PostScript input files. The filter interprets the value of -use-selective-pjl-filter as a case-insensitive string and searches for a match. NOTE: Only PJL commands inside Universal Escape Language (UEL) sequences are tested for a match. If a match is found, the PJL command is changed so that it does not interfere with normal job processing. For example, a document may contain PJL commands that must be sent to the printer for the document to be processed correctly but may also contain the @PJL JOB NAME command. The @PJL JOB NAME command must be removed, because it interferes with normal HP Output Server job processing.

HP Output Server

251

Chapter 2

Attributes

-use-selective-pjl-filter-default

To disable the @PJL JOB NAME command in a document sent with pdpr, use the following syntax: pdpr -d printerName -x"-use-selective-pjl-filter \"job name\"" documentName NOTE: To remove all PJL commands from a job, set the -use-pjl-filter attribute to true. The -use-selective-pjl-filter-default attribute provides a default value for the -use-selective-pjl-filter attribute. For example, to disable the @PJL JOB NAME command in all documents sent to a destination, set this attribute on a logical or physical destination as follows: pdset -c d -x'-use-selective-pjl-filter-default "job name"' destinationName The -transformer-priority of the pcl_selective_pjl_filter and ps_selective_pjl_filter are set to a value that ensures the PJL filter productions are applied before any other PostScript or PCL filters. Before using -use-selective-pjl-filter, ensure that the pcl_selective_pjl_filter and ps_selective_pjl_filter transformers are added to the physical destinations managing server. To view the list of transformers configured for a DSM, type the following: pdls -c server -a transformers-supported dsmName If they are not already, add the transformers with the following command: pdset -c server -x"-+transformers-supported pcl_selective_pjl_filter, ps_selective_pjl_filter" dsmName

Types

-use-selective-pjl-filter: Control and Status -use-selective-pjl-filter-default: Configuration and Status

Objects

-use-selective-pjl-filter: Document -use-selective-pjl-filter-default: Destination: Logical, Physical (PS, PCL, Text)

Data Type

Text

252

System Administrators Attribute Reference

Chapter 2

Attributes

-use-server-features

-use-server-features
The -use-server-features multi-valued attribute instructs HP Output Server to perform feature processing itself if a device does not support the advanced features. With -use-server-features set on an advanced physical destination, the DSM performs the feature processing instead of relying on the instructions in the printers capabilities ticket. NOTE: The -use-server-features attribute is not set by default on certified advanced printer templates. To enable this functionality, you must set the attribute manually on a specific physical destination. The collate value for -use-server-features instructs HP Output Server to send the document multiple times when multiple copies are specified for the job. This is the method that HP Output Server uses to support collating for all static printers except those with -printer-model set to hp_pjl or lexmark_pjl. For these multi-function static printers, the document is sent only once and the PJL QTY command is used to generate multiple copies. The capabilities ticket for an advanced printer may also contain an invocation string to process collated copies in this way. The -use-server-features collate setting is useful if the printer is unable to handle collated copies because, for example, the printer has insufficient memory or is a low-end model. Setting -use-server-features to collate restores the collating functionality. CAUTION: Do not set this attribute if the advanced printer does support collating and uses an invocation string. In this case, with this attribute set and a request for n multiple copies, both HP Output Server and the printer will perform the collating. This results in n*n printed copies. The -use-server-features attribute applies to advanced delivery pathways only. For more information about advanced printers and advanced delivery pathways, see the System Administrators Guide for HP Output Server.
Type Object Data Type Valid Value Control and Status Destination: Physical (Printer) Identifier collate

HP Output Server

253

Chapter 2
-use-text-filter

Attributes

-use-text-filter -use-text-filter-default
The -use-text-filter single-valued attribute enables or disables the text_filter transformer for a document. The -use-text-filter-default single-valued attribute provides a default value for the -use-text-filter attribute. This attribute is set to false by default for logical and physical destinations. If neither attribute is set, the text_filter transformer will not run. When -use-text-filter is true, the DSM filters input files, removing all control characters except back space, horizontal tab, vertical tab, carriage return, line feed, and form feed. Before using the -use-text-filter attribute, you must add the text_filter transformer to the physical destinations managing server. The following command adds text_filter to dsm_01s list of supported transformers: pdset -c server -x"-+transformers-supported text_filter" dsm_01

Type Objects

Control -use-text-filter: Document -use-text-filter-default: Destinations: Logical, Physical

Data Type Valid Values

Boolean TRUE, true, FALSE, false, YES, yes, NO, no

-user-exit-predoc-arguments
The -user-exit-predoc-arguments multi-valued attribute specifies the arguments for an external script or program to execute before each document is processed or user filters are applied. It is used in conjunction with the -user-exit-predoc-program attribute. To apply a script to each document in a job, define the scripts path name and arguments by typing the following command: pdset -c d -x"-user-exit-predoc-program filePath -user-exit-predoc-arguments !{argument}!" physicalDestination

254

System Administrators Attribute Reference

Chapter 2

Attributes

-user-exit-predoc-program

Type Object Data Type

Configuration Destination: Physical Text

-user-exit-predoc-program
The -user-exit-predoc-program single-valued attribute specifies an external script or program to execute before each document is processed or user filters are applied. It is used in conjunction with the -user-exit-predoc-arguments attribute. To apply a script to each document in a job, define the scripts path name and arguments by typing the following command: pdset -c d -x"-user-exit-predoc-program filepath -user-exit-predoc-arguments !{argument}!" physicalDestination

Type Object Data Type

Configuration Destination: Physical Text

-user-exit-prejob-arguments
The -user-exit-prejob-arguments multi-valued attribute specifies the arguments for an external script or program to execute before a job is processed or user filters are applied. It is used in conjunction with the -user-exit-prejob-program attribute. To apply a script to an entire job, define the scripts path name and arguments by typing the following command: pdset -c d -x"-user-exit-prejob-program filepath -user-exit-prejob-arguments !{argument}!" physicalDestination

HP Output Server

255

Chapter 2

Attributes

-user-exit-prejob-program

Type Object Data Type

Configuration Destination: Physical Text

-user-exit-prejob-program
The -user-exit-prejob-program single-valued attribute specifies an external script or program to execute before a job is processed or user filters are applied. It is used in conjunction with the -user-exit-prejob-arguments attribute. To apply a script to an entire job, define the scripts path name and arguments by typing the following command: pdset -c d -x"-user-exit-prejob-program filepath -user-exit-prejob-arguments !{argument}!" physicalDestination

Type Object Data Type

Configuration Destination: Physical Text

-user-filter-arguments -user-filter-output-format -user-filter-output-format-variants -user-filter-output-format-version -user-filter-program

The -user-filter* attributes allow you to implement document format translations within a physical destination. A user filter reads document data from stdin and writes to stdout. Any errors that the user filter encounters can be written to stderr. In addition, a user filter can have an argument list associated with it.

256

System Administrators Attribute Reference

Chapter 2

Attributes

-user-filter-force-attr-mods

Each physical destination has a single, optional user filter associated with it. Logical destinations do not have filters associated with them. By setting the -user-filter-program attribute to the full path name of the executable, for example /home/jdoe/filter, you instruct the physical device to invoke the filter for each document it receives. Using an attribute variable substitution such as !{dazel-install-directory}! is allowed. To turn off the user filter, reset the -user-filter-program attribute. By setting the -user-filter-output-format attribute to a format that HP Output Server supports, you can inform the DSM of the format of the data output from the user filter, or you can allow the DSM to guess the format. The -user-filter-arguments and -user-filter-output-format-variants attributes are both multi-valued attributes, and the others are single-valued attributes. Attribute replacement is performed on the -user-filter-arguments attribute before these arguments are passed to the -user-filter-program attribute. For more information on the -user-filter* attributes, see the System Administrators Guide for HP Output Server.
Types Object Data Types Configuration and Status Destination: Physical -user-filter-arguments: Text -user-filter-output-format: Identifier -user-filter-output-format-variants: Identifier -user-filter-output-format-version: Text -user-filter-program: Text

-user-filter-force-attr-mods
The -user-filter-force-attr-mods single-valued attribute specifies if the DSM applies attribute changes when a user filter returns a non-zero value to standard error. If the value is true, the DSM changes the attributes that the user filter writes to file descriptor 3 when the -users-stdattr attribute is set to true. If the value is false (the default), the DSM applies no changes.
Type Object Data Type Configuration Destination: Physical Boolean

HP Output Server

257

Chapter 2
-uses-stdattr

Attributes

Valid Values

TRUE, true, FALSE, false, YES, yes, NO, no

-uses-stdattr
The -uses-stdattr single-valued attribute enables a user filter to return attribute modification strings to HP Output Server. The -uses-stdattr attribute must be set on the physical destination, if the destination meets both of the following two conditions: the destination runs a user filter the destination writes attribute modifications to file descriptor 3 (in other words, stdattr) pdset -c destination -x"-uses-stdattr true" destination .
Types Object Data Type Valid Values Configuration and Status Destination: Physical Boolean TRUE, true, FALSE, false, YES, yes, NO, no

To set the -uses-stdattr attribute for a destination, type the following command:

-verbose-specification
The -verbose-specification multi-valued attribute specifies the information to return when verbose is the -requested-attributes value. For more information, see the -requested-attributes attribute.
Types Object Data Type Valid Values Control and Status Job Identifier Any attribute

258

System Administrators Attribute Reference

Chapter 2

Attributes
-when

-when
The -when single-valued attribute specifies how to shut down a delivery server. The effects are server-specific. For more information, see the pdshutdown command in the System Administrators Command Reference.
Types Object Data Type Valid Values Control and Status Servers: DLM, JQM, DSM, CM Identifier now, after-current, after-all, abort

-width -width-default
The -width single-valued attribute specifies the line width, in number of columns, for text documents. Lines are broken after the nth column on each line. If the value is set to 0, no line wrapping occurs and text in the header and footer are space-separated rather than justified. The -width-default single-valued attribute specifies the default line width, in number of columns, for text documents. NOTE: For jobs sent through the LPR Gateway, the -width attribute is set by the W line of the LPR control file. For these jobs the -width attribute does not control a jobs output.
Types -width: Control and Status -width-default: Configuration and Status Objects -width: Document: Text -width-default: Destinations: Physical, Logical (Text) Data Type Integer

-write-only-device
The -write-only-device single-valued attribute specifies if a connection is write-only (true) or read/write (false). The default is read/write.
Types Configuration and Status

HP Output Server

259

Chapter 2
-x-image-shift

Attributes

Object Data Type Valid Values

Destination: Physical Boolean TRUE, true, FALSE, false, YES, yes, NO, no

-x-image-shift -x-image-shift-default
The -x-image-shift single-valued attribute specifies an offset, in points (1/72 inch), from the left edge of the physical page image. The number can be negative. It is used with the -plex attribute values simplex and duplex to produce binding gutters for documents. The -x-image-shift-default single-valued attribute specifies a left-edge offset if you have not set the -x-image-shift attribute. For more information, see the -plex attribute and the -sides attribute.
Types -x-image-shift: Control and Status -x-image-shift-default: Configuration Objects -x-image-shift: Documents: PS, PCL, Fax -x-image-shift-default: Destinations: Logical, Physical Data Type Real

-y-image-shift -y-image-shift-default
The -y-image-shift single-valued attribute specifies an offset, in points (1/72 inch), from the bottom edge of the physical page image. The number can be negative. Used with the -plex attribute value tumble to produce binding gutters for documents to be bound head-to-foot. The -y-image-shift-default single-valued attribute specifies a bottom-edge offset if you have not set the -y-image-shift attribute. For more information, see the -plex attribute and the -sides attribute.
Types -y-image-shift: Control and Status -y-image-shift-default: Configuration

260

System Administrators Attribute Reference

Chapter 2

Attributes

-y-image-shift-default

Objects

-y-image-shift: Documents: PS, PCL, Fax -y-image-shift-default: Destinations: Logical, Physical

Data Type

Real

HP Output Server

261

Chapter 2

Attributes

-y-image-shift-default

262

System Administrators Attribute Reference

Appendix A

Attributes by Object Class

This appendix organizes the attributes by the following object classes: capabilities destination job paging system queue server Delivery Manager (DLM) Job and Queue Manager (JQM) Destination Manager (DSM) logical destinations physical destinations

form

transformer all objects

HP Output Server

263

Appendix A
Capabilities class

Attributes by Object Class

Capabilities class
The capabilities class includes one attribute: -capabilities-name

Destination class
HP Output Server uses logical and physical destinations to represent destinations. A logical destination identifies a specific output device or set of devices in the HP Output Server environment. For example, an HP Output Server configuration could contain two logical printers, mktg and eng, that deliver to the same PostScript printer A physical destination is a software model of a hardware device. You can set attributes at both the logical and physical destination.

Logical destinations
The JQM manages logical destinations. You can set the following attributes for logical destinations: Table A-1. Logical destination attributes
-bits-per-pixel-default -black-corrections -supported -capabilities-supported -character-sets-supported -depletion-default -destination-type -encoding-methods -supported -extended-features -default -fax-classes-supported -fax-no-page-count -default -file-directory-default -bits-per-pixel-supported -bottom-margin-default -capabilities-ticket -city -depletions-supported -disabled -end-sheet-default -failed-job-retention -period-default -fax-footer-text-default -fax-phone-number-default -file-directories -supported -black-correction-default -building -character-set-default -copy-from -descriptor -encoding-method-default -end-sheets-supported -fax-class-default -fax-header-text-default -fax-phone-numbers -supported -file-filename-default

264

System Administrators Attribute Reference

Appendix A Table A-1. Logical destination attributes (continued)

-file-filenames-supported -floor -form-feed-default -ftp-directory-default -ftp-filenames-supported -ftp-operation-default -ftp-quote-cmd-pre -default -ftp-types-supported -ghostscript-options -default -impositions-supported -input-document-format -default -input-document-format -variants-supported -jes-formdef-default -job-deadline-period -job-hold-default -job-hold-mailbox-default -job-hold-username -default -length-default -lpd-hosts-supported -lpd-timeout-default -file-overwrite-default -fold-default -ftp-account-default -ftp-directories -supported -ftp-host-default -ftp-operations-supported -ftp-reply-timeout -default -ftp-user-default -header-text-default -input-content-type -default -input-document-formats -supported -input-tray-default -jes-pagedef-default -job-finishings-default -job-hold-jobname-default -job-hold-mode-default -job-priority-default -lpd-file-format-default -lpd-printer-default -mail-message-default

Attributes by Object Class

Destination class

-file-permissions-default -footer-text-default -ftp-accounts-supported -ftp-filename-default -ftp-hosts-supported -ftp-quote-cmd-post -default -ftp-type-default -ftp-users-supported -impositions-default -input-content-types -supported -input-document-format -variants-default -input-trays-supported -job-class-default -job-finishings-supported -job-hold-key-required -default -job-hold-modes-supported -left-margin-default -lpd-host-default -lpd-printers-supported -mail-protocol-default

HP Output Server

265

Appendix A
Destination class

Attributes by Object Class

Table A-1. Logical destination attributes (continued)

-mail-protocol-supported -mail-recipient-bcc -default -mail-recipients-cc -supported -mail-sender-default -maximum-tries-default -minimum-retry-interval -default -number-up-keep-scale -default -orientations-supported -output-bin-number -supported -output-document-format -default -page-sizes-supported -pager-id-type-default -pager-phone-numbers -supported -pager-system-name -default -pdf-color-output-default -printer-auto-pause -timeout -printer-resolutions -printer-x-resolutions -supported -mail-recipient-default -mail-recipients-bcc -supported -mail-return-default -mail-set-dsn-default -medium-default -modem-phone-numbers -supported -organization -output-bin-name-default -output-content-type -default -output-document-formats -supported -pager-id-number-default -pager-id-types-supported -pager-protocol-default -pager-system-names -supported -plex-default -printer-name -printer-resume-delivery -time -printer-y-resolutions -default -mail-recipients -supported -mail-recipient-cc -default -mail-return-reply-type -default -mail-subject-default -media-supported -notification-profile -default -orientation-default -output-bin-names -supported -output-content-types -supported -output-document-format -variants-supported -pager-id-numbers -supported -pager-phone-number -default -pager-protocols -supported -paused -plexes-supported -printer-realization -printer-x-resolutions -default -printer-y-resolutions -supported

266

System Administrators Attribute Reference

Appendix A Table A-1. Logical destination attributes (continued)

-punch-count-default -punch-locations -supported -queue-supported -separator-sheet-default -shinglings-supported -staple-count-default -staple-locations -supported -start-sheet-default -system-job-message -buffer-limit-default -text-conversion-font -default -top-margin-default -use-selective-pjl-filter -default -x-image-shift-default -punch-counts-supported -punch-type-default -retention-period-default -separator-sheets -supported -sides-default -staple-counts-supported -staple-type-default -start-sheets-supported -system-job-message -buffer-type-default -text-conversion-font -size-default -use-pjl-filter-default -use-text-filter-default -y-image-shift-default

Attributes by Object Class

Destination class

-punch-location-default -punch-types-supported -right-margin-default -shingling-default -sides-supported -staple-location-default -staple-types-supported -state -system-job-message -strategy-default -text-conversion-line -size-default -use-ps-filter-default -width-default

Physical destinations
The DSM manages the actual devices, referred to as physical destinations. You can set the following attributes for physical destinations: Table A-2. Physical destination attributes
-afp-device -black-correction-default -cancel-program -character-set-default -deliver-arguments -agent-termination-signal -bottom-margin-default -capabilities-supported -connection-lifetime -deliver-document -arguments -bits-per-pixel-default -cancel-arguments -capabilities-ticket -copy-from -deliver-program

HP Output Server

267

Appendix A
Destination class

Attributes by Object Class

Table A-2. Physical destination attributes (continued)

-depletion-default -disabled -encoding-method-default -end-sheet-type-format -variants -fax-class-default -fax-header-footer-font -size -fax-phone-number-default -fax-phone-number-suffix -fifo-directory -file-directory-default -file-overwrite-default -file-transfer-by-link -font-directories -ftp-directory-default -ftp-operation-default -ftp-quote-cmd-pre -default -ftp-user-default -ghostscript-program -header-text-default -input-document-format -default -descriptor -document-format-content -type -end-sheet-default -end-sheet-type-path -fax-footer-text-default -fax-header-text-default -fax-phone-number-long -distance-prefix -fax-serialize-conversion -fifo-permissions -file-directory -permissions -file-permissions-default -fold-default -footer-text-default -ftp-filename-default -ftp-password-default -ftp-reply-timeout -default -ghostscript-device -header-footer-font -impositions-default -input-document-formats -supported -device-state -document-format-printer -language -end-sheet-type-format -extended-features -default -fax-header-footer-font -fax-no-page-count -default -fax-phone-number-prefix -fax-station-id -file-base-directory -file-filename-default -file-permissions-mask -fold-supported -ftp-account-default -ftp-host-default -ftp-quote-cmd-post -default -ftp-type-default -ghostscript-options -default -header-footer-font-size -input-content-type -default -input-tray-default

268

System Administrators Attribute Reference

Appendix A Table A-2. Physical destination attributes (continued)

-input-trays-medium -jes-pagedef-default -job-finishings-supported -job-hold-mailbox-default -job-hold-username -default -lpd-host-default -lpd-timeout-default -mail-protocol-default -mail-recipient-cc -default -mail-sender-default -medium-default -modem-initialization -modem-local-area-code -modem-long-distance -prefix-default -modem-pbx-outside-suffix -modem-rings -network-probe-ending -address -network-probe-snmp -response -notification-profile -default -input-trays-xlate -job-class-default -job-hold-jobname-default -job-hold-mode-default -left-margin-default -lpd-non-root-connection -mail-message-default -mail-recipient-default -mail-return-default -mail-set-dsn-default -minimum-retry-interval -default -modem-international -prefix-default -modem-local-call-area -codes -modem-long-distance -suffix-default -modem-phone-number -default -modem-suffix-default -network-probe-retries -network-probe-starting -address -number-up-keep-scale -default

Attributes by Object Class

Destination class

-jes-formdef-default -job-finishings-default -job-hold-key-required -default -job-hold-modes-supported -length-default -lpd-printer-default -mail-program -mail-recipient-bcc -default -mail-return-reply-type -default -mail-subject-default -modem-force-long -distance -modem-international -suffix-default -modem-local-country-code -modem-pbx-outside-prefix -modem-prefix-default -network-probe-address -network-probe-snmp-query -network-probe-timeout -original-template-list

HP Output Server

269

Appendix A
Destination class

Attributes by Object Class

Table A-2. Physical destination attributes (continued)

-output-bin-name-default -output-document-format -default -pager-message-length -limit -pager-protocol-default -paused -pcl-level -physical-device-type -plex-default -poll-period -printer-device-address -printer-model -printer-ping-interval -printer-resolution -default -printer-x-resolutions -supported -ps-init-directories -ps-printer-echoes-eof -punch-count-default -qms-ftp-account -qms-ftp-user -queue-supported -retry-interval -separator-sheet-type -format -output-bin-xlate -pager-id-number-default -pager-message-number -limit -pager-system-name-defaul t -pcl-echo-support -pcl-output-bin-xlate -pjl-capabilities -poll-arguments -poll-program -printer-line-setting -printer-name -printer-read-timeout -printer-serialize -conversion-default -printer-y-resolutions -default -ps-input-trays-xlate -ps-printer-suppress-eof -punch-location-default -qms-ftp-host -qms-status-monitor-delay -retention-period-default -right-margin-default -separator-sheet-type -format-variants -output-content-type -default -pager-id-type-default -pager-phone-number -default -paging-systems-supported -pcl-input-trays-xlate -pdf-color-output-default -pjl-exclusions -poll-interval -printer-connection-mode -printer-message -printer-ping-data -printer-realization -printer-x-resolutions -default -printer-y-resolutions -supported -ps-output-bin-xlate -ps-prologue-file -punch-type-default -qms-ftp-password -qms-status-read-timeout -retry-count -separator-sheet-default -separator-sheet-type -path

270

System Administrators Attribute Reference

Appendix A Table A-2. Physical destination attributes (continued)

-shingling-default -staple-count-default -start-sheet-default -start-sheet-type-path -system-job-message -buffer-type-default -tcp-host -template-component -template-type -text-conversion-line -size-default -top-margin-default -use-selective-pjl-filter -default -user-exit-predoc -arguments -user-exit-prejob-program -user-filter-output -format-variants -user-filter-force-attr -mods -write-only-device -sides-default -staple-location-default -start-sheet-type-format -state -system-job-message -strategy-default -tcp-status-port -template-device-name -text-conversion-font -default -text-conversion-real -font-size-default -udp-port -use-server-features -user-exit-predoc-program -user-filter-arguments -user-filter-output -format-version -uses-stdattr -x-image-shift-default

Attributes by Object Class

Destination class

-sides-supported -staple-type-default -start-sheet-type-format -variants -system-job-message -buffer-limit-default -tcp-data-port -template-classification -template-site -text-conversion-font -size-default -text-conversion-real -line-size-default -use-ps-filter-default -use-text-filter-default -user-exit-prejob -arguments -user-filter-output -format -user-filter-program -width-default -y-image-shift-default

HP Output Server

271

Appendix A
Form class

Attributes by Object Class

Form class
Forms are documents with a standard, preset format and/or content. The form class contains all attributes related to the status, control, and configuration of forms. Table A-3. Form class attributes
-form-description -form-path -form-y-scaling -form-file -form-type -form-x-translation -form-name -form-x-scaling -form-y-translation

Job class
A job is a request to deliver one or more documents to one or more destinations. The JQM manages jobs. You can set attributes for a job or for individual documents within the job. Job attributes apply to the entire job, but document attributes can have different settings for each document. Attributes are parsed left to right, affecting how you place the job and document attributes.

Job attributes
Job attributes affect all of the documents in the job. If a command specifies a job attribute more than once in a command, the value on the far right is used. You can set the following attributes for jobs: Table A-4. Job attributes
-bits-per-pixel -dazel-guest -encoding-method -failed-job-retention -period -fax-footer-text -fax-header-footer -character-set -fax-page-number -completion-time -destination -end-sheet -fax-class -fax-from-extension -fax-header-text -fax-phone-number -current-job-state -document-sequence -number -extended-features -fax-comments -fax-from-person -fax-no-page-count -fax-subject

272

System Administrators Attribute Reference

Appendix A Table A-4. Job attributes (continued)

-fax-to-company -file-transfer-retry -count -ftp-account -ftp-password -ftp-reply-timeout -intervening-jobs -job-client-id -job-deadline-time -job-finishing -job-hold-key -job-hold-mode -job-identifier-on -printer -job-name -job-page-count -job-punch-count -job-retention-period -job-staple-type -job-submission-complete -lpd-file-format -lpd-timeout -mail-recipient -mail-reply-to -mail-sender -fax-to-person -file-transfer-retry -interval -ftp-host -ftp-quote-cmd-post -ftp-user -intervening-octets -job-comment -job-event-attributes -job-hold -job-hold-key-required -job-hold-username -job-message-from -administrator -job-originator -job-print-after -job-punch-location -job-retention-time -mail-recipient-bcc -job-validate -lpd-host -mail-message -mail-recipient-bcc -mail-return -mail-subject

Attributes by Object Class

Job class

-fax-to-voice-phone -fold -ftp-operation -ftp-quote-cmd-pre -header-footer-character -set -job-class -job-completion-status -job-event-class -job-hold-jobname -job-hold-mailbox -job-identifier -job-message-to-operator -job-owner -job-priority -job-punch-type -job-staple-location -job-state-on-printer -last-job-events -lpd-printer -mail-protocol -mail-recipient-cc -mail-return-reply-type -maximum-tries

HP Output Server

273

Appendix A
Job class

Attributes by Object Class

Table A-4. Job attributes (continued)

-minimum-retry-interval -modem-long-distance -prefix -modem-prefix -name-of-last-accessor -number-of-times-tried -pager-phone-number -pages-completed -printer -processing-time -remote-device -identifier -started-printing-time -system-job-message -system-job-message -strategy -verbose-specification -modem-international -prefix -modem-long-distance -suffix -modem-suffix -notification-profile -pager-id-number -pager-protocol -physical-printer -assigned -printer-name-requested -processing-time-warned -separator-sheet -submission-time -system-job-message -buffer-limit -total-job-octets -modem-international -suffix -modem-phone-number -modification-time -number-of-documents -pager-id-type -pager-system-name -previous-job-state -printer-serialize -conversion -queue-assigned -start-sheet -synchronicity -system-job-message -buffer-type -use-selective-pjl -filter

Document attributes
Document attributes affect all remaining documents that follow the attribute to its right on the command line (unless you reset the attribute). If the only setting for a document attribute is to the right of all documents on the command line, its value is not used. You can set the following attributes for documents: Table A-5. Document attributes
-black-correction -character-sets-used -bottom-margin -content-orientation -character-set -copy-count

274

System Administrators Attribute Reference

Appendix A Table A-5. Document attributes (continued)

-depletion -document-format -fax-copy-count -file-overwrite -form-feed -ftp-filename -header-text -input-document-format -input-tray-select -jes-pagedef -length -logical-page-scaling -mail-set-dsn -number-up -octet-count -output-content-type -output-document-format -version -page-select -plex -printer-y-resolutions -requested -sheet-format -start-sheet-type-format -version -document-descriptor -document-type -file-directory -file-permissions -forms -ftp-type -imposition -input-document-format -variants -input-trays-used -job-staple-count -logical-page-border -logical-page-x-offset -medium-select -number-up-border -output-bin-name -output-document-format -page-count -page-size -printer-resolutions -requested -right-margin -shingling -text-conversion-font

Attributes by Object Class

Job class

-document-filename -end-sheet-type-format -version -file-filename -footer-text -ftp-directory -ghostscript-options -input-content-type -input-document-format -version -jes-formdef -left-margin -logical-page-origin -logical-page-y-offset -media-used -number-up-keep-scale -output-bin-number -output-document-format -variants -page-number -pdf-color-output -printer-x-resolutions -requested -separator-sheet-type -format-version -sides -text-conversion-font -size

HP Output Server

275

Appendix A

Attributes by Object Class

Paging system class

Table A-5. Document attributes (continued)

-text-conversion-line -size -top-margin -use-ps-filter -x-image-shift -text-conversion-real -font-size -transfer-method -use-text-filter -y-image-shift -text-conversion-real -line-size -use-pjl-filter -width

Paging system class

A paging system simplifies sending pages. The paging system class contains all attributes related to the status, configuration, and control of paging system objects. Individual pagers belong to specific paging systems. Table A-6. Paging system class attributes
-paging-system-baud -paging-system-phone-number -paging-system-name -paging-system-protocol

Queue class
A queue is an HP Output Server object that prioritizes jobs awaiting delivery to a destination. You can set the following attributes for queues: Table A-7. Queue class attributes
-copy-from -group-by-attribute -logical-printers -assigned -physical-printers -registered -queue-warning-threshold -state -descriptor -job-order -order-by-attributes -queue-disable-threshold -reserve-by-attribute -disabled -job-order-preserved -paused -queue-name -scheduler-assigned

276

System Administrators Attribute Reference

Appendix A

Attributes by Object Class

Server class

Server class
A server in HP Output Server is a process that fulfills requests from clients and sends requests to other servers. HP Output Server servers can be divided into primary, delivery, and accessory servers. You can set the following attributes for servers: Table A-8. Server class attributes
-accounting-profile -cleanup-interval -cp-max-slaves -database-server-hostname -database-server-socket -disabled -event-date -event-server -file-transfer-retry -interval-default -lpg-job-owner-all-jobs -lpg-printcap -operator-notification -profile -printer-state -queue-task-maximum -scheduling-algorithms -supported -server-environment -variables -server-log-maximum-size -server-login-name -default -cleanup-checkjob -interval -copy-from -cp-port-number -database-server-password -database-server-user -dump -event-identifier -event-time -incomplete-job-timeout -lpg-masterlock -next-document-timeout -paused -printer-task-maximum -queue-task-ratio -server-address -server-hostname -server-log-tz-cut -server-message -cleanup-checkjob-period -limit -cp-max-proxies -database-client-max -connections -database-server-port -descriptor -event-client -event-message -file-transfer-retry -count-default -job-retention-period -limit -lpg-options -nm-dazel-data-file -pm-id-mode -printer-task-ratio -resource-name -server-cache-size -server-log-level -server-login-name -server-name

HP Output Server

277

Appendix A
Server class

Attributes by Object Class

Table A-8. Server class attributes (continued)

-server-start-enabled -server-startup -completion-time -server-uses-syslog -spooler-job-processing -time-warning-time -supervisor-retry -interval -transfer-methods -supported -when -server-start-order -server-startup-time -server-version -state -synchronicity-default -transformers-supported -server-startup-limit -server-type -server-working-directory -supervisor-ping-interval -track-dazel-guest -use-pjl-filters -supported

278

System Administrators Attribute Reference

Appendix A

Attributes by Object Class

Transformer class

Transformer class
The DSMs transformer framework converts a document from its input document format to an output document format appropriate to a specific device. This type of transformer is termed a translation or transformation. Additionally, transformers can modify a documents layout or placement without changing the documents format. This type of transformer is termed a production. Converting text to PostScript is an example of a translation; number-up and duplexing are examples of productions. Attributes in the transformer class let you configure external processes that transform documents. You can use transformer attributes to override transformations handled internally by the DSM. Table A-9. Transformer class attributes
-transformer-input-format -transformer-priority -transformer-productions -supported -transformer-program -description -transformer-name -transformer-productions -excluded -transformer-program -transformer-output -format -transformer-productions -included -transformer-program -arguments

All object classes

You can set the following attributes for all object classes: Table A-10. Attributes for all object classes
-brief-specification -list-of-managers -object-log-buffer-type -object-log-severity -options -class -managing-server -object-log-message-limit -object-log-strategy -requested-attributes -force* -message -object-log-messages -object-log-threshold -template

* This attribute does not work with the server class of objects.

HP Output Server

279

Appendix A
All object classes

Attributes by Object Class

280

System Administrators Attribute Reference

Index
A
-a switch 10 abbreviating attributes 11 aborting job state 41 accounting records 23, 2527, 58 advanced printer features capabilities of a printer 33 extended features 59 folding 77 job hold 113, 115, 116, 117 private printing 114, 115 punching 123, 125 See also the System Administrators Guide for HP Output Server server features 253 stapling 127, 128, 129 advanced templates 33 AFP devices 27 aggregation 33 all object classes, alphabetical list of attributes 279 alphanumeric pagers 179 ASCII file transfer mode 90 attachments, e-mail 141 attributes abbreviating 11 alphabetical list by all objects 279 destination class 264 forms class 272 job class (per-document) 274 job class (per-job) 272 paging system class 276 queue class 276 server class 277 transformer class 279 data types 3 default and supported 15 filtering 11 object classes 3 order of 12 precedence of 15 replacing 20 requesting 10, 210 setting 4, 6, 7, 8 time values in 3 types 2 using variables for 17 value length 19

HP Output Server

281

Index

B
base directories, for file system destinations 72 batch scheduling, for queues 213 baud rate, of paging systems 182 bi-directional connections 259 binary file transfer mode 90 bins, number of 172 bits, number of 28 borders around documents 132 number up 164 bytes, total number in subjob 244

CP 39, 40 current state of device 50 of DSM 200 customer support xxxii

D
database host name 42 maximum connections per server 41 password 43 port number 44 socket 45 user 46 dazel.ns file 161 dazel_guest PM group 244 DAZEL_PORTS environment variable 218 deadlines for delivery 110 for job processing 228 defaults 15 delivery deadlines for jobs 110 maximum number of attempts 147 number of attempts 163 descriptors, of objects 49 destination class, alphabetical list of attributes 264 device discovery IP addresses 159 SNMP queries and responses 159, 160 timeout interval 161 device drivers 91 devices managed by DSM 186 registered with queue 187 dialup destinations, connection modes 193 digital pagers 179 directories, for file system destinations 72 -discard-period attribute 109 -dLandscapeOrient1 94

C
capabilities objects 32, 33 character sets, headers and footers 95 characters, maximum to send to a pager 179 classes of jobs sent to LPR destinations 108 of objects 2 cleaning, DLM database 37 CM setting up accounting 23 writing configuration to disk 54 color output, for PDF files 186 communications port, TCP 237 conditional attribute variable replacement 20 config_host command 42, 43, 44, 45, 46 config_server command 4, 42, 43, 44, 45, 46, 139, 218 configuration attributes 3 configuration, documentation for setup xxix connections bi-directional 259 to printers 159, 193 write-only 259 control attributes 2 control languages, for printers 195 cover sheets, for faxes 61, 70

282

System Administrators Attribute Reference

Index

DLM assigning job ID 108 copying attribute values 39 events triggering notices 167 job status interval 35 logical destination 196 number of file transfer attempts 76 paused status 184 removing jobs from 98 retry intervals for file transfers 76 setting job cleanup period limit 36 setting up accounting 23 writing configuration to disk 54 -dMaxInlineImageSize 94 -dNORANGEPAGESIZE 94 document formats mapping to a printer language 52 mapping to content strings 51 -document-format* attributes 100 documents alphabetical list of attributes 274 borders 132 duplexing 189 e-mail attachment format 173 encoding 34 end sheet versions 57 file names 51 file names for file destinations 73 file permissions 74 file system directory 72 footer text 79 format of 100, 101, 174 forms format 83 forms to be applied to 84 FTP 85, 86, 90 header text 96 imposition 98 job media 147 landscape or portrait orientation 38 line width 259 margins 31, 131, 213, 243 medium 147

documents (continued) number of 163, 176 number of lines per page 132 number of printed sides 227 number up 163 number up border 164 octets 167 orientation of logical page 133 output bins 171, 172 overview 12 overwriting files 74 page count 176 page size 177 pages to deliver 176, 177 PCL, shades of black 29 resolution 198, 201 scaling for logical pages 134 separator sheets 216 shingling 226 transfer method 244 tumble duplexing 189 x offsets 260 y offsets 260 document-transfer-pending job state 40 -dPDFFixedPage 94 DSM copying attribute values 39 current state 200 device types 186 document format 174 events triggering notices 167 optional name 212 pause interval 193 paused status 184 ping interval 196, 233 retry interval 233 setting up accounting 23 transfer time to JQM 161 user filters 257 writing configuration to disk 54 -dump attribute 209 duplexing 189

HP Output Server

283

Index

-dUseCropBox 94

F
fax destinations connection modes 193 contacting remote 69 default medium 147 fax machine ID 70 font directories 78 footer text 61 header and footer font size 64 maximum number of modem rings 157 phone extension 63 phone number 66, 68, 69 PostScript conversion utility location 203 PostScript prologue files 205 separator sheets 215, 216 start sheets 229, 231 jobs cover sheet comments 61 landscape or portrait orientation 38 number of copies 61 number up 163 number up border 164 orientation of logical page 133 page count 66 page number 66 page size 177 pages to deliver 176 recipients 70, 71 scaling of logical pages 134 sender 63 setting the page count 121 tumble duplexing 189 x and y offsets 260 station ID 210 -fax-comments attribute 18, 19 FIFO scheduling for queues 213 file destinations 72, 73, 75 file transfer mode (FTP) 90 file transfers 76

E
e-mail destinations font directories 78 PostScript conversion utility location 203 messages attachments 141 bcc recipients 142 cc recipients 143 encoding 54 protocols 141 recipients 141 reply type 144 return address 143 senders 144 subject 146 encoding default 34 method 54 text documents 34 end-of-file character 204 environment variables 218 ERP_SAP_CONNECT event class 111 ERP_SAP_OMS event class 111 events 110, 161, 167 external destinations canceling a job 32 communicating with external agents 71 delivery command line arguments 47 delivery programs 48 document arguments 47 FIFO permissions 72 poll arguments 191 poll interval 192 poll program 192

284

System Administrators Attribute Reference

Index

finishing features See advanced printer features folding 77 fonts for headers and footers 96 location of for PostScript conversions 78 size for headers and footers 96 text-to-PostScript conversion 241 footers character sets 95 font size 96 for faxes 61 text for 79 form-feed characters 81 forms absolute path names 82 applying to document sent to JES printer 106, 107 applying to documents 84 description of 81 document format 83 file names 82 horizontal offsets 84 name of 82 object class 35 overlays 82 scaling factors 83 vertical offsets 84 forms class, alphabetical list of attributes 272 FTP See FTP destinations FTP destinations account 85 appending or overwriting 87 connection timeout 90 delivering commands 88, 89 directory 85 file names 86 file transfer mode 90 hosts 87 passwords 88 user name 91

G
ghostscript 94

H
headers characters for faxes 63 fonts for faxes 64 text for faxes 64 held job state 41 hold mode 116 horizontal offsets for forms 84 hosts for FTP destinations 87 IP addresses 217 names 218 object class 35 QMS FTP 206 TCP 238 HP Output Manager for SAP 111

I
IDs assigned by printer 118 for jobs 108 for pagers 177, 178 for subjobs 118 of job sender 121 IDS_ALLJOBS event class 111 imposition 98 information to return 210 initialization strings for modems 151 input trays 103, 104, 184, 203 installation, documentation for setup xxix integer, as valid attribute type 3 interrupted job state 40 intervening jobs 106 IP addresses of host 217 ranges for physical destinations 158

HP Output Server

285

Index

J
job sheets 225 -job-discard-period attribute 109 -job-discard-time attribute 110 jobs advanced printer features See advanced printer features alphabetical list of attributes 272 appending files sent to FTP destinations 87 assigning to queues 207 attribute order 12 character sets in headers and footers 95 class sent to LPR destination 108 completed pages 182 completion time 37 current job state 40 delivery attempts 163 delivery deadline 109, 110 directory containing specifications 169 document sequence 53 e-mail jobs See e-mail encoding 54 events that trigger notices 110, 161 failed-job retention period 59 fax jobs See fax history 131 holding 113 ID assigned by DLM 108 ID assigned by JQM 118 ID assigned by printer 118 job sheets 55, 214, 229 last principal to access a job 158 logical destinations 49, 193 lpd hosts 136 maximum number in queue 208 maximum number of delivery attempts 147

jobs (continued) messages assigned at delivery 108 from administrator 119 to operator 119 modem fax classes 60 name 119 number of attempts for file transfers 76 of bits 28 of documents 163 of intervening bytes 106 of intervening jobs 106 object class 35 ordering 120 overlays 37 overwriting files sent to FTP destinations 87 pager 178, 180 paging system object 181 phone extension 63 previous job state 192 principal ID 121 priority 122 processing deadline 228 processing time 202 punch count 123 location 123 type 125 queue associated with an lpd printer 137 removing from DLM or JQM 98 requested attributes 210 reserving by attribute 211 retaining 125 retry interval 76, 150 seconds DSM waits for lpd response 137 setting page count 121 specifying job hold user name 117 specifying retention at printer 116

286

System Administrators Attribute Reference

Index

jobs (continued) staple count 127 location 128 type 129 start time 122, 232 state of 40 state on a remote system 130 states 40 status 35, 109 submission time 232 submitted by dazel_guest users 47 synchronous/asynchronous delivery 234 system messages 235 time of last modification 158 validating 131 verbose information 258 -job-submission-time attribute 20 JQM cleanup interval 37 controlling memory growth 126 copying attribute values 39 dazel_guest jobs 47 delivery attempts 163 grouping jobs 95 job ordering 120 paused status 184 processing deadline 228 removing jobs from 98 reserving jobs 211 retention periods 125 scheduling algorithms 213 setting up accounting 23 shutting down 259 transfer methods 244 triggering notices of events 167

L
landscape documents 38 line settings 194 line size 242

line width 259 lines per page 132 logical destinations alphabetical list of attributes 264 appending files sent to FTP destinations 87 assigned to queues 134 building location 31 city location 35 class of job sent to LPR destination 108 copying attribute values 39 default failed-job retention period 59 descriptors of objects 49 document content format 100 DSM pause interval 193 duplexing 189 e-mail attachments 141 encoding 34, 54 end sheets 55 fax 61, 64, 67 file 73, 75 footer text 79 FTP accounts 8591 header text 96 impositions 98 input trays 103 job sheets 214, 229 location information, organization of 170 lpd hosts 136 lpd printers 137 maximum number of delivery attempts 147 medium default 147 modem fax classes 60 name 195 number of bits 28 object class 35 object state 232 output bin names 171 output format 174 page length 132 pager 178, 180, 181 paging system objects 181 paused status 184

HP Output Server

287

Index

logical destinations (continued) printing on both sides 227 queues associated with lpd printers 137 queues supported 208 requested attributes 210 resuming delivery 199 retention periods 125 retry interval 150 shades of black 29 shingling 226 specifying what type to create 198 supported media 147 timeout for connection to lpd 137 tumble duplexing 189 type of 50 width 259 -logical-printers-ready attribute 135 -logical-printers-supported attribute 135 login name for servers 220 logs object 165166 server 219, 220 syslog 224 LPR destinations 108, 136, 137 LPR Gateway lock file 138 options mapping file 139 user ID 138

masking file permissions 75 media supported by printer 147 messages e-mail 140 for any object 150 for jobs 108 for servers 221 from administrator 119 to operator 119 MIB, retrieving SNMP attributes 160 MIME protocol mapping to 51 specifying 141 -mime-document-format* attributes 99 modems attributes 151157 fax classes 60 initialization string 151 maximum number of rings 157 multi-valued attributes 18 mysql.sock 45, 46

N
namespace file 161 notices 161, 167 notification profiles 161, 167 number up 163

M
mapping input trays to a medium 104 margins bottom, for text documents 31 for PostScript documents 164 left, for text documents 131 right, for text documents 213 top, for text documents 243

O
-o switch 7, 8 object classes alphabetical list of all attributes for 279 list of 3 object logging 165, 166

288

System Administrators Attribute Reference

Index

objects classes 2 copying attribute values 39 descriptors 49 information to return 210 messages 150 re-creating objects 80 specifying class 35 specifying the managing server 146 octets number of 167 total in subjob 244 offsets horizontal, for forms 84 vertical, for forms 84 x 260 y 260 OMSCB server 111 options file 7 ordering attributes 12 orientation of the logical page 133 of the page 38, 98 output bins 171, 172, 185, 203 output device types 186 output formats default 174 user filters 256 variants 175 overlays 82 overwriting files delivered to file system destinations 74 files delivered to FTP destinations 87

P
page count 176 page imposition 98

pager destinations connection modes 193 device address 194 ID types 179 maximum message length 179 phone number 180 protocols 181 serial connection line settings 194 system object 181 pages completed 182 length 132 number of 176 selected 176 size 177 -page-select attribute 12 paging systems baud rate 182 object class 35 phone number 183 protocols 183 paper types, mapping to an input tray 104 passwords FTP 88 QMS FTP 206 paused job state 41 PCL destinations connection modes 193 control languages 195 device address 194 duplexing 189 echo command 184 font directories 78 impositions 98 input trays 103, 184, 203 job overlays for 37 level of support 185 mapping input trays 104 medium default 147 number of bits 28 output bins 185, 203

HP Output Server

289

Index

PCL destinations (continued) ping interval 196 PJL capabilities 188 PostScript conversion utility location 203 QMS FTP 205, 206 read timeout 197 separator sheets 215, 216 serial connection line settings 194 shades of black 29 shingling 226 start sheets 229, 231 tumble duplexing 189 volume of ink 48 write only 259 x offsets 260 y offsets 260 documents duplexing 189 imposition 98 landscape or portrait 38 number up 163 number up border 164 orientation of logical page 133 page size 177 pages to deliver 176 reducing volume of ink 48 resolution 198, 201 shingling 226 tumble duplexing 189 mapping 52 pcl_pjl_filter transformer 249 pcl_selective_pjl_filter transformer 251 pdcontrol command 209 pdcreate command 4 PDF color output 186 pdf_to_ps transformer 93 pdls command 9 pdmod command 4 pdpr command 4 pdq command 9 pdset command 4, 53 pending job state 40

permissions for file system directories 73 for files 74 masking for files 75 phone extension, for faxes 63 phone numbers for fax destinations 66, 68, 69 of pagers 180 of paging systems 183 physical destinations advanced printer features See advanced printer features alphabetical list of attributes 267 appending files sent to FTP destinations 87 applying attribute changes 257 class of job sent to LPR destination 108 connection attempts 212 connection mode 193 control languages 195 default medium 147 descriptors 49 device addresses 194 drivers 91 type 186 document content format 100 e-mail 140, 141 encoding 34, 54 end sheet path and file name 57 end sheet types 56 end-of-file character 204 file See file destinations file permissions mask 75 font directories 78 font size for headers and footers 96 footer fonts 96 footer text 79 FTP See FTP destinations ghostscript path name 94 header and footer fonts for faxes 64

290

System Administrators Attribute Reference

Index

physical destinations (continued) header fonts 96 header text 96 identifying the AFP device 27 impositions 98 input trays 103 IP address ranges 159, 160 job overlays 37 lpd hosts 136 mapping input trays 104 maximum number of delivery attempts 147 maximum number of modem rings 157 modem fax classes 60 initialization strings 151 name 195 number of bits 28 number of connection attempts 159 object class 35 object state 232 output bin name and number 172 output format 174 page length 132 pager 179, 180 pager IDs 178 pager protocol 181 paging system objects 181 paused status 184 PCL echo command 184 PCL support level 185 ping interval 196 PJL capabilities 188 poll program 191, 192 PostScript conversion utility 203 PostScript prologue files 205 printing on both sides 227 providing a UNIX signal 27 QMS FTP 205, 206 status 207 queues associated with lpd printers 137 queues supported 208

physical destinations (continued) requested attributes 210 reserving jobs 211 retention periods 125 retry interval 150, 212 scripts 254, 255, 256 separator sheets 215, 216 serial connection line settings 194 shades of black 29 shingling 226 SNMP queries 159 SNMP response 160 specifying what type to create 198 start sheets formats 229 paths 231 TCP communications port 237 host names 238 port 238 templates classification 239 device names 240 listing 171 type 240 timeout for connection to lpd 137 interval 161 UDP port numbers 249 unsupported PJL values 189 user filters 256, 257 width 259 write-only connections 259 -physical-printers-ready attribute 187 -physical-printers-supported attribute 187 ping data 196 ping interval for DSM 196, 233 PJL capabilities 188 control language 195 filter 249 selective filter 251

HP Output Server

291

Index

PJL ENTER command 53 PM, ID mode 190 poll program 191, 192 portrait documents 38 ports, TCP 237, 238 positioning pages 98 PostScript destinations connection modes 193 control languages 195 conversion utility location 203 device address 194 duplexing 189 end-of-file character 204 font directories 78 impositions 98 input trays 103, 184, 203 job overlays 37 mapping input trays 104 medium default 147 output bins 185, 203 ping interval 196 PJL capabilities 188 PostScript prologue files 205 QMS FTP 205, 206 read timeout 197 separator sheets 215, 216 serial connection line settings 194 start sheets 229, 231 tumble duplexing 189 write-only connections 259 y offsets 260 documents converting with ghostscript 94 filter 250 imposition 98 landscape or portrait 38 margins 164 number up 163

PostScript documents (continued) number up border 164 orientation of logical page 133 page size 177 pages to deliver 176 resolution 198, 201 scaling of logical pages 134 tumble duplexing 189 x offsets 260 locations of fonts 78 mapping to 52 prologue files 205 PostScript conversion utility 203 precedence of attributes 15 preprocessing job state 40 principal ID 121 printcap file 139 -printer attribute 49 printer connection mode 193 printer connections 37 printers connection attempts 159 ghostscript path name 94 job overlays 37 output bin names 171 searching for IP address ranges 159, 160 selecting device drivers 91 supported media 147 priorities of jobs 122 of processing for queues 213 probe command 159, 161 processing job state 40 productions See transformers ps_filter transformer 250 ps_pjl_filter transformer 249 ps_selective_pjl_filter transformer 251 ps_to_pdf transformer 93

292

System Administrators Attribute Reference

Index

Q
QMS FTP 205, 206 status 207 queues alphabetical list of attributes 276 assigned logical destinations 134 associated with lpd printer 137 copying attribute values 39 descriptors of objects 49 grouping jobs 95 limiting parallel activities 209 listing subjobs 119 maximum number of jobs 208, 210 names of 208 object class 35 object state 232 paused status 184 registered devices 187 requested attributes 210 scheduling method 169, 213 -queues-ready attribute 135 -queues-supported-by-server attribute 135 queue-task-stats value 209

R
requested attributes 9, 210 -requested-attributes attribute 9 requesting attribute values 9, 10 resolution of output 198, 201 resource collision 211 retained job state 41 retaining jobs in the database 125 retention periods 125 retry interval 150, 212, 233

S
SAPCON server 111

scheduling algorithms 213 method for queues 213 scripts executing prior to document processing 254, 255 executing prior to job processing 255, 256 separator sheets 214, 216 serial connected devices 194 -server-environment-variables attribute 218 servers alphabetical list of attributes 277 copying attribute values 39 descriptors of objects 49 disabling startup 221 enabling startup 221 events, triggering notices of 167 host names 218 IP address of host 217 logging 219 login name 220 maximum size for log files 219 message 221 name 221 object class 35 object state 232 requested attributes 210 setting environment variables 218 setting up accounting 23 specifying managed objects 146 start order 222 starting 222 startup time and date 223, 224 timestamps and time zones 220 types 224 version number 225 working directory 225 writing configuration information to disk 54 shingling 226 -sides-supported attribute 228 slave proxies 39 SNMP queries 159, 160 start sheets 229, 230, 231

HP Output Server

293

Index

startup time for servers 222, 223 state of an object 232 of device 50 of DSM 200 status of job 40, 109 of the DSM 200 subjobs ID 118 listing 119 object class 35 submission time 232 support xxxii switches -a 10 -o 7, 8 -x 6, 8, 10 syslog 224 system objects, for pagers 181 System V options 139

text destinations connection modes 193 device address 194 font directories 78 PostScript conversion utility location 203 separator sheets 215, 216 serial connection line settings 194 start sheets 229, 231 write only 259 documents bottom margin 31 left margin 131 right margin 213 encoding 34 files, number of lines per page 132 text_filter transformer 254 time of submission 232 to process a job 202 time stamps and time zones for server log files 220 time, format for attribute type 4 training xxxii transfer method 244 transfer time, between DSM and JQM 161 transferring job state 40 -transformer-priority attribute 252 transformers alphabetical list of attributes 279 arguments 248 input format 245 name 246 object class 35 output format 246 pdf_to_ps 93 priority 246 productions 246, 247 program 248 program descriptor 248 ps_to_pdf 93 supported 248

T
TCP communications port 237 connections 212 hosts 238 ports 238 -template attribute 238 templates advanced 33 classification 239 device names 240 types 240

294

System Administrators Attribute Reference

Index

translations See transformers typographic conventions xxxi

U
UDP connections host names 194 port number 249 UEL control language 195 UEL sequences 251 Universal Escape Language 251 unknown job state 40 user filters arguments 256 attribute changes 257 format version 256 output format 256 program 256 uses stdattr 258 variants 256 UTC 4

variables conditional replacement 20 replacing 20 using in attributes 17 variants of output formats 175 of user filters 256 verbose specification 258 version numbers, of servers 225 volume of ink, reducing 48

W
write-only connections 259

X
x offsets 260 -x switch 6, 8, 10

Y
y offsets 260

V
validating, jobs 131 values attribute length 19 for the -requested-attributes attribute 9

Z
Zulu time format 4

HP Output Server

295

Index

296

System Administrators Attribute Reference