3    Administrative Commands

 

pdclean(8)

NAME

pdclean - removes all print jobs from a queue or spooler

SYNOPSIS

pdclean [-c class_name] [-m message_text] [-x extended_attribute_string...] [-X attribute_filename...] [server_name:] [queue_name]

OPTIONS

-c class_name

Specifies the class or type of object from which you are removing jobs. The following values are allowed: server or queue.

-m message_text

Includes a message about the specified object.

-x extended_attribute_string_

Specifies one or more attribute=value pairs to be used by the utility.

You cannot set object attributes with the -x option. You can use the following command line attributes: attributes, class, message.

-X attribute_filename

Specifies an attribute file for the utility to read. When the utility runs, it processes the attribute data at the current point in the command line, as though you had specified it with the -x option.

OPERANDS

The value you supply as an operand depends on the object class given with the -c class_name option or the class=class_name command attribute.

spooler_name

When the class specified is server, server_name is the name of the spooler to be cleaned.

[server_name:]queue_name

When the class specified is queue, the value of queue_name is the name of the queue to be cleaned.

DESCRIPTION

The pdclean utility deletes all of the jobs on the spooler or queue you specify. Using pdclean is similar to entering a pdls command on the queue or spooler, followed by a pddelete of all the jobs found. The pdclean command deletes jobs that are in a retained, completed, currently processing, or printing state.

The following apply when using this utility:

Before using pdclean, you must disable the queue or spooler. You cannot enable the queue or spooler during the pdclean operation.

The pdclean command is an asynchronous command. It returns control to your shell before the clean operation is complete.

You must back up or resubmit to another queue or spooler any jobs that you do not want to delete. If resubmitting jobs is not possible, notify all users to retain a copy of their job.

In some cases it can be too late to delete a job that is already printing on the associated physical printer.

You cannot use pdclean delete jobs from a supervisor.

Deleting jobs from a spooler:

Deleting jobs from a queue:

ACCESS LEVEL: Operator

EXAMPLES

  1. Remove all jobs from the spooler named bobspl:

    pdclean -c server bob_spl
    

  2. Remove all jobs from the queue named central_q on the spooler named blue_spl. The command removes all jobs, including those in the retained state.

    plclean -c queue blue_spl:central_q
    

FILES

/var/pd/odb

object database directories

/var/spool/pd

spool directories

SEE ALSO

Commands: pdcreate(8), pddisable(8), pdenable(8), pdls(1), pdset(1), pdsplr(8), pdspvlpr(8)  

pdcreate(8)

NAME

pdcreate - creates a printer, queue, or initial-value object

SYNOPSIS

pdcreate [-c class_name] [-m message_text] [-g] [-r requested_attributes] [-s style_name] [-x extended_attribute_string...] [-X attribute_filename ...] object_instance...

OPTIONS

-c class_name

Specifies the class or type of object you are creating.

You can use the following values for class_name:

printer (default)
queue
initial-value-job
initial-value-document

If you use the -x string option or the -X file option, the equivalent attribute is class_type=class_name.

-g

Omits line or column headings when requesting attributes with the -r option.

If you use the -x string option or the -X file option, the equivalent attribute is heading=no.

-m message_text

Includes a message about the object that you are creating. For example, if you are creating a queue, the message might be:

-m "blue_q will soon be accepting jobs."

-r requested_attributes

Specifies attributes to write to standard output.

You can use the following values for requested_attributes:

all - Writes all object attributes to output.
verbose - Writes an expanded set of attributes to output.
brief - Writes a subset of the verbose list attributes to output.
none (default) - Does not write any attributes to output.

-s style_name

Specifies how output requested with the -r option is to be formatted.

You can use the following values for style_name:

column (default) - Displays the requested attributes in columns.
line - Displays each attribute value on a separate line.

To use the -x string option or the -X file option, the comparable attribute value is style=style_name.

-x extended_attributes_string

Specifies one or more attribute_type=value pairs to be used by the utility.

You can use all read/write object attributes. Some attributes, such as printer-name, become read only after you initially set them.

You can use the following command-line attributes:

requested-attributes
class
copy-from
message
headings
style

Follow the syntax rules for attribute value strings listed in the Advanced Printing Software Command Reference Guide.

-X attribute_filename

Identifies an attribute file that the utility reads. When the utility runs, it processes at the current point in the command line as though you had specified it with the -x option.

An attribute file is a file that contains attribute type=value pairs. When creating printers, you can specify a printer attribute file (PAF) to set attributes to values appropriate for the model printer you are installing.

If you do not include the path, the utility uses the path in the PDPATH environment variable. The path for the printer attribute files is /usr/pd/share/cap.

You can specify any object attribute with the utility, as long as it is valid for the object class.

You can also use the following command attributes:

requested-attributes
class
message
headings
style

OPERANDS

The value you supply as the operand depends on the value of the -c class_name option or the class=class_name attribute.

If you omit the [server-name:] portion of the operand, the pdcreate utility performs the request on the default server, the spooler that supports the printer named in the PDPRINTER environment variable.

[server_name:]printer_name

When the object class is printer, the value of printer_name specifies the name of a new printer object.

[server_name:]queue_name

When the object class is queue, the value of queue_name is the name of the queue you are creating, and the value for server_name is optional.

[server_name:]ivjob_name

When the object class is initial-value-job, the value of ivjob_name is the name of the initial-value-job object you are creating, and the value for server_name is optional. The object can be used to provide default attributes for jobs submitted to a logical printer. Users can submit jobs that specify an initial-value-job object for attribute defaults.

[server_name:]ivdoc_name

When the object class is initial-value-document, the value of ivdoc_name is the name of a new initial-value-document object, and the value for server_name is optional. The object can be used to provide default attributes for the documents that pass through an associated logical printer. Users can specify an initial-value-document object for document attribute defaults when they submit print jobs.

DESCRIPTION

The pdcreate utility creates logical printers, physical printers, queues, initial-value-job objects, and initial-value-document objects in the Advanced Printing Software system.

Upon receiving the create request, the server creates the new object in a permanent server database that remains intact across server restarts. The server stores new printer names and queue names in the local name file.

For Network Information Server (NIS), you must manually add new printer and queue objects to the NIS name space database (printers.conf.byname) and communicate this change to all NIS servers operating in the same domain.

You can set the values of attributes in the pdcreate request.

The initial state of the new object is disabled. Use the pdenable utility to enable the new object.

Creating a physical printer:

Creating a queue:

Creating an initial-value-job object

Creating an initial-value-document object

Examples

  1. Create a queue on spooler big_spl and name it xps_q:

    pdcreate -c queue big_spl:xps_q
     
     
    

  2. Create a physical printer, xps_pp, on the supervisor, big_sup. Use a supplied printer attribute file for the Xerox model 4517 PostScript printer. Associate the physical printer with the queue created in example 1. Specify the printer's network address, job separator sheets that are supported and ready, and the media that is supported and ready.

    pdcreate -c printer -X /usr/pd/share/cap/Xerox_4517_Level2PS.paf \
    -x printer-address=myprinter.xyz.com \
    -x associated-queue=xps_q \
    -x "job-sheets-supported=none job-copy-start job-copy-wrap" \
    -x "job-sheets-ready=none job-copy-start job-copy-wrap" \
    -x "media-supported=iso-a4-white a-white" \
    -x "media-ready=a-white" \
    big_sup:xps_pp
     
     
    

  3. Create a logical printer named dngbat on spooler big_spl. Associate it with the queue xps_q to make a complete working printer with logical printer, physical printer, and queue objects tied together. Because printer is the default object class for pdcreate, the class need not be specified. Like the physical printer created in example 2, the media that this printer supports is iso-a4-white and a-white.

    pdcreate -x "media-supported=iso-a4-white a-white \
    -x associated-queue=xps_q big_spl:dngbat
     
     
    

  4. Create an initial-value-job object for printer dngbat that specifies job-start separator pages.

    pdcreate -c i-v-j -x job-sheets=job-copy-start \
    big_spl:dngbat_ivj
    

FILES

/var/pd/odb

server object database directory

/usr/pd/scripts/Makefile.printers

pushes printer name map to NIS database

/etc/printers.conf

local file name

/usr/pd/share/cap/*.paf

printer attribute files

SEE ALSO

Commands: pdsplr(8), pdspvr(8), pdspvlpr(8), pddelete(8), pdset(1), pdls(1), pdenable(8), pddisable(8)  

pddelete(8)

NAME

pddelete - deletes a print object

SYNOPSIS

pddelete [-c class_name] [-m message_text] [-x extended_attribute_string...] [-X attribute_filename...] object_instance...

OPTIONS

-c class_name

Specifies the class, or type of the object.

The values are:

printer (default)

job

queue

initial-value-document

initial-value-job

server

If you use the -x string option or the -X file option, the equivalent attribute is: class-type=class_name.

-m message_text

Includes a message about the object. For example, when a printer is to be deleted, the message attached to the printer might be:

-m "Printer1 no longer available."

In most cases, it is not meaningful to store a message on an object being deleted, unless you expect the deletion process to take a significant amount of time.

If you use the -x extended_attributes_string option or the -X attribute_filename option in the pddelete command, the equivalent command attribute type and value are the following:

-x extended attribute string

Specifies one or more attribute_type=value pairs to be used by the utility.

-X extended filename

Specifies an attribute file to be read by the utility. When the utility runs, it processes the attribute data at the current point in the command line as though it had been specified with the -x option.

Object attributes cannot be specified in the -X option of the pddelete utility. Refer to the -x section for a list of the command attributes that can be used.

OPERANDS

The value of the operand depends on the value of the -c class_name options or the class=class_nameattribute.

Before you delete the a server object, consider using the pdls command to produce a report about every object associated with it. By documenting your object database contents and the relationship between objects, you can simplify the task of creating the server again.

If [server_name:] is omitted in any operand, the pddelete utility issues the request to the spooler that supports the printer named in the PDPRINTER environment variable.

[server_name:]printer_name

When class is printer, the value of printer_name specifies the name of the printer to be deleted. The value for server_name is optional. The printer to be deleted can be a logical or a physical printer.

server_name

When class is server, the value of server_name is the name of the server to be deleted. The server to be deleted can be a supervisor or a spooler.

[server_name:]job_id

When class is job, the value of job_id is the unique identifier that points to the job to be deleted.

[server_name:]queue_name

When class is queue, the value of queue_name is the name of the queue to be deleted.

[server_name:]ivjob_name

When class is initial-value-job, the value of ivjob_name is the name of the initial-value-job object to be deleted.

[server_name:]ivdoc_name

When class equals initial-value-document, the value of ivdoc is the name of the initial-value-document object to be deleted.

Description

Use the pddelete utility to delete a printer, job, queue, document object, or server.

The following items should be considered when using this utility:

Deleting a logical printer:

Deleting a physical printer:

Deleting a spooler:

Deleting a supervisor:

Deleting a job:

Deleting a queue:

Deleting an initial-value-job object:

Deleting an initial-value-document object:

EXAMPLES

  1. Delete the printer named sams_printer. Notice the -c class_name option is not needed because the default class is printer.

    pddelete sams_printer
    

  2. Delete the initial-value-job object ivj1 from spooler big_spl.

    pddelete -c initial-value-job big_spl:ivj1
    

  3. Delete the queue called central_q from the default spooler.

    pddelete -c queue central_q
    

FILES

/var/pd/odb - object database directories

/var/yp/Makefile.printers - pushes printer name map in NIS environment

/etc/printer.conf - local name file

SEE ALSO

pdsplr(8), pdspvr(8), pdspvlpr(8), pdcreate(8), pdset(1), pdls(1), pdenable(8), pddisable(8), pdrm(1), pdclean(8)  

pddisable(8)

NAME

pddisable - disable a printer, server, or queue

SYNOPSIS

pddisable [-c class_name] [-m message_text] [-x extended_attribute_string....] [-X attribute_filename...] object_instance...

OPTIONS

-c class_name

Specifies the class or type of object. The following values are allowed: printer, server, and queue.

The default class is printer.

If you use the -x string option or the -X file option, the equivalent attribute is: class_type=class_name

-m message_text

Includes a message about the specified object.

-x extended_attribute_string

Specifies one or more attribute_type=value pairs to be used by the utility.

You can not specify object attributes with this command. You can specify the client attributes attributes, class, and message.

-X attributes_filename

Specifies an attribute file to be read by the utility. When the utility runs, it inserts, at the current point in the command line, the attribute data it finds in the file.

You can not specify object attributes with this command. You can specify the client attributes attributes, class, and message.

OPERANDS

The value you specify as the operand depends on the value of class_name.

[server_name:]printer_name

When the object class is printer, the value of printer_name specifies the name of the logical or physical printer to be disabled. The value for server_name is optional.

When you disable a logical printer, new print job requests are not accepted and the name of the printer is removed from the logical-printer-ready attribute for the associated queue and spooler.

When you disable a physical printer, the printer will not be available to print new jobs; however, any jobs currently printing or processing at the printer are completed. The name of the printer is removed from the physical-printers-ready attribute on the supervisor. If a queue is associated with the printer, the physical-printers-ready attributes for the queue and spooler are also updated.

[server_name:]queue_name

When the object class is queue, the value of queue_name is the name of the queue to be disabled. The value of server_name is optional.

The printer-state of associated logical printers is not changed.

Issuing a pdpr command for any logical printer associated with the queue returns an error.

server_name

When the object class is server, the value of server_name is the name of the server to be disabled.

When the server is a spooler, all new jobs will be rejected but previously submitted jobs will be scheduled and delivered to physical printers.

When the server is a supervisor, all new jobs will be rejected but jobs already being processed by the supervisor will continue to completion.

DESCRIPTION

Use the pddisable utility to disable a supervisor or spooler server, a physical or logical printer, or a queue. Until the object is once again enabled, print jobs submitted by the pdpr or pdresubmit utility will not be accepted.

The disabled server, queue, or printer object will continue to respond to other command-line operations.

ACCESS LEVEL: Operator

EXAMPLES

  1. Disable printer1 and printer2.

    pddisable printer1 printer2
    

  2. Disable the spooler blue_spl and post a message that can be retrieved using the pdls utility.

    pddisable -c server -m "No more printing allowed" blue_spl
    

  3. Disable the supervisor blue_sup and post a message that can be retrieved using the pdls utility.

    pddisable -c server -m "Reconfiguring physical printer" blue_sup
    

You must specify server-name if the printer or queue is not represented in the name space.

SEE ALSO

Commands: pdenable(8), pdpause(1), pdresume(1), pdpr(1), pdls(1), pdresubmit(1)  

pdenable(8)

NAME

pdenable - enables a printer, server, or queue

SYNOPSIS

pdenable [-c class_name] [-m message_text] [-x extended_attribute_string...] [-X attribute_filename...] object_instance...

OPTIONS

-c class_name

Specifies the class or type of object. The values allowed are printer, server, and queue.

If you use the -x string option or the -X file option, the equivalent attribute is:

class_type=class_name

-m message_text

Includes a message about the specified object.

-x extended_attribute_string

Specifies one or more attribute_type=value pairs to be used by the utility.

You cannot specify object attributes in the -x option. Command attributes that can be used are attributes, class, and message.

-X attributte_filename

Specifies an attribute file to be read by the utility. When the utility executes, it processes the attribute data included in the file at the current point in the command line.

OPERANDS

The value you specify as the operand depends on the value of class_name.

[server_name:]printer_name

When class is printer, the value of printer_name specifies the name of the logical or physical printer to be enabled.

[server_name:]queue_name

When class is queue, the value of the queue_name is the name of the queue to be enabled.

server_name

When class is server, the server_name is the name of the spooler or supervisor process to be enabled.

You must specify the server_name if the printer or queue is not represented in the name space.

DESCRIPTION

Use the pdenable utility to enable a physical or logical printer, supervisor or spooler server, or a queue. When enabled, these objects can accept jobs for printing.

Enabling a logical printer:

Enabling a physical printer:

EXAMPLES

  1. Enable the printer named printer1 on the default server.

    pdenable printer1
    

  2. Enable the server called blue_spl with a message included that can be retrieved by the pdls utility.

    pdenable -c server -x message="Ready to go" blue_spl
    

SEE ALSO

Commands: pddisable(8), pdpause(1), pdresume(1), pdls(1)  

pdldappw(8)

NAME

pdldappw - sets LDAP username and password for use by Advanced Pritning Software

SYNOPSIS

pdldappw [-f] [-v]

OPTIONS

-f

Forces the username and password to be stored, even if an LDAP server cannot be accessed.

-v

Verbose mode, prints more detailed diagnostics.

DESCRIPTION

The pdldappw command stores the username and password to be used by Advanced Printing Software spoolers and supervisors to access an LDAP server. The pdldappw command must be run by an administrator on the machines where the servers are run, so the information can be supplied to the servers that the spoolers and supervisors reside on.

Only the root user is allowed to run pdldappw. The apx.conf file must be created before pdldappw is run to identify which LDAP server to use.

In normal operation, pdldappw will test the username and password on the LDAP server defined in the pax.conf file. It will store only the username and password for later use if they can be successfully used on the current LDAP database. Use the -f option to force the username and password to be stored if the LDAP server test fails.

Later, when an Advanced Printing Software server attempts to update the LDAP server and the username and password are valid, the updates will occur as desired. If the username and password are unavailable or invalid, the requested LDAP operation will fail and a message will be entered in the print log file requesting that pdldappw be run to set the LDAP password.

ACCESS LEVEL: Administrator (root user)

EXAMPLES

Enter the LDAP username and password to be used by the Advanced Printing Software servers:

root>pdldappw
Contents of configuration file /var/pd/config/apx.conf: 
name_services = ldap file
LDAP_paths = o=mygroup
LDAP_hosts = myhost.mycompany.com(389)
LDAP username: LDAP Printmanager
LDAP password

Enter the password a second time to verify it.

SEE ALSO

Commands: pdpr(1), pdls(1), pdrm(1), pdresubmit(1), pdmod(1)

See your LDAP server documentation for information on how to define and maintain the username and password.  

pdmakedb(8)

NAME

pdmakedb - creates print system server database

SYNOPSIS

pdmakedb [-A access_control_list] [-D source_ODB_directory] [-d ODB_directory] [-h] [-n server_name] [-O source_OID_directory] [-R server_runtime_directory] [-r authentication_type] [-s spool_directory] [-t server_type] [-v]

OPTIONS

-A access_control_list

Creates a server access-control-list attribute with the value that the access-control-list parameter specifies.

The format of the access-control-list parameter is:

{name[ name-type]}

where:

name and name-type are valid values for access-control-list as described in the Advanced Printing Software System Administration and Operation Guide.

The -A option default for name-type is group. The -A option does not include the privilege-level component of access-control-list because the option itself specifies the privilege level as administrator.

If you do not specify the -A option, the utility creates a default ACL with two values:

  1. {name-type=users privilege-level=end-user}

  2. {name=sysadmin; name-type=group privilege-level=administrator}

When you create a server, the server sets the two values for its ACL . If the domain does not include a group with the name sysadmin, the local-root user must set the server's ACL to the locally correct value.

The -A option specifies the initial administrator of the server object. You can add other values for administrators as well as operators and users after the server is running and responding to client requests. The local-root user can always act as a print system administrator.

-D source_ODB_directory

Specifies the location of a source object database template.

The installation procedure installs the object database template. It serves as the template to create an object database. If an ODB source does not exist in the location that the source_ODB_directory specifies, or if the database is not empty, pdmakedb displays an error message and exits.

If you do not specify the -D option, the source_ODB_directory name defaults to /usr/pd/share/odb.

-d destination_ODB_directory

Specifies the location for object database. The object database is a directory that contains several data files. Conceptually, you can think of the database as a single entity.

The pdmakedb utility creates the object database in the directory you specify with the -d option. The name of the database depends on the -n option.

If you do not specify the -d option, the utility creates the directory for the object database files in the default directory, /var/pd/odb.

-h

Displays a help message.

If you specify the -h option, pdmakedb displays the help message only and does not do anything else, even if you have specified other options.

-n server_name

Specifies the name of the database.

This name will become the name of the server. The name must be a valid UNIX file name.

If you do not specify the -n option, the utility uses a default name. The default name is derived from the name of the host on which the pdmakedb utility is running and on whether the database type is a supervisor database or a spooler database. The format for the default name is <hostname>_spl for spoolers and <hostname>_sup for supervisors.

If you use the pdmakedb option to create a spooler database on host achilles, and you do not specify the -n option, the database name is achilles_spl. If you create a supervisor database, the name is achilles_sup. Use the -t option to determine whether the server is a spooler or a supervisor database.

If the database specified with the -n option already exists, or if you do not specify a server name and a server with the default name already exists, pdmakedb displays an error message and exits.

-O source_OID_directory

Specifies the location of the OID database.

The utility and the servers use the Object Identifier Database (OID) to validate the characteristics of object attributes. You can specify a pathname that references a valid OID for source-OID-directory.

If you do not specify the -O option, the source_OID_directory pathname defaults to /usr/pd/share/oid.

-R server_runtime_directory

Specifies the location of the server's runtime directory.

If you do not specify the -R option, the runtime directory defaults to /var/spool/pd/server_name.

-r authenticate_type

Specifies the RPC authentication type the server will use.

The values for authentication_type are NONE and SYS. The default is SYS.

-s spool_directory

Specifies where the server stores documents that it is going to print.

You can specify any valid directory pathname for spool_directory. The directory to which spool_directory points does not have to exist at the time you run pdmakedb. The server creates the directory (if possible) when it starts, although the server does not attempt to create any parent directories, if they do not exist.

If you do not specify the -s option, the utility creates the default directory /var/spool/pd/server_name, where

server_name is the name that you specify with the -n option.

-t server_type

Specifies the type of object database to create: a spooler database or a supervisor database.

Each type of database contains objects that the other type cannot contain. For example, only spooler databases contain logical printers and queues; only supervisor databases contain physical printers.

You must create an object database of the appropriate type for the type of server that will use the database. The values for server-type are SPL for spooler and SUP for supervisor. The default is SPL.

-v

Displays informational messages during validation of command-line attributes.

For example, if you specify the -A, -r, and-v options on the command line, the utility displays the following messages:

Validating requested server attributes
Checking attribute:  access-control-list
Checking attribute:  cfg-rpc-auth-type
All requested server attributes are valid
 
 

The pdmakedb utility also displays the values of all the server attributes, after pdmakedb has finished creating the object database. For example:

Current server attributes are:
achilles_spl: server-state = ready
achilles_spl: server-internal-state = 2
achilles_spl: object-classes-supported = server
achilles_spl: enabled = FALSE
achilles_spl: conformance-levels-supported = level-1
                                             level-1M
                                             level-2
                                             level-2M
achilles_spl: cfg-src-odb-path = /usr/pd/share/odb
achilles_spl: cfg-src-oid-path = /usr/pd/share/oid
achilles_spl: cfg-server-runtime-dir = /var/spool/pd/achilles_spl
achilles_spl: cfg-acct-log-file-path = /var/pd/acct/achilles_spl:
achilles_spl: access-control-list = administrator:sysadmin
achilles_spl: cfg-rpc-auth-type = SYS
achilles_spl: cfg-max-log-backups = 4
achilles_spl: cfg-days-to-keep-acct-logs = 3
achilles_spl: cfg-safe-size-for-acct-logs = 1000000
achilles_spl: cfg-time-for-new-acct-log = 02:07:00

If you do not specify the -v option, pdmakedb only displays error messages.

DESCRIPTION

The pdmakedb utility creates an object database for an Advanced Printing Software server. You must create an object database before starting a spooler or supervisor server for the first time.

The pdmakedb utility creates an object database that contains a single server object. It adds default server attributes plus user-specified attributes to the server object when it creates the database.

You can use pdmakedb to create a new object database only. The utility displays an error message and exits if the database already exists.

ACCESS LEVEL: Administrator

FILES

/usr/pd/share/oid

default OID database

/usr/pd/share/odb

source object database template

/var/pd/odb

default object database template directory

/var/spool/pd/server_name

default spool directory

EXAMPLES

Create a spooler database named achilles_spl. The initial server access-control-list will allow all members of the operator group to serve as print system administrator.

pdmakedb -v -n achilles_spl
	-A '{operator}
	-t SPL

SEE ALSO

Commands: pdmakedb(8), pdmoddb(8), pdshowdb(8), pdsplr(8), pdspvr(8), pdspvlpr(8)  

pdmoddb(8)

NAME

pdmoddb - modifies a print system server database

SYNOPSIS

pdmoddb [-A access_control_list] [-d ODB_directory] [-h ] -n server_name [-O OID_directory] [-R server_runtime_directory] [-r authentication_type] [-s spool_directory] [-v]

OPTIONS

-A access_control_list

Modifies a server access-control-list attribute with the value that the access-control-list parameter specifies.

The format of the access-control-list parameter is:

{name [name-type]}

where:

name and name-type are valid values for access-control-list in the Advanced Printing Software Administration and Operation Guide.

The default for name-type is group. The -A option does not include the privilege-level component of access-control-list because the option itself specifies the privilege level as administrator.

The -A option specifies the initial administrator of the server object. You can add other values for administrators as well as operators and users after the server is running.

-d ODB_directory

Specifies the path of the object database directory.

The spooler and supervisor processes use an object database (ODB) to store information about printers and print jobs in your configuration. The object database is a directory that contains several data files. Conceptually, you can think of the database as a single entity. Specify the ODB path with the -d option so that the pdmoddb utility can find your object database. Your user ID must have permission to write to the ODB path. If the directory does not exist, or you do not have write permission, the utility displays an error message and exits.

If you do not specify the -d option, the utility modifies the named object database in the default directory, /var/pd/odb.

-h

Displays a help message.

If you specify the -h option, pdmoddb displays the help message only and does not do anything else, even if you have specified other options.

-n server_name

Specifies the name of the object database you want to modify.

-O OID_directory

Modifies the location of the Object Identifier database.

To change the location where a server accesses the OID database, first use cp or tar to make a copy of the contents of /usr/pd/share/oid. Then, use the -O option to specify the new location and to store that location in the server's object database.

-R server_runtime_directory

Modifies the location of the server's runtime directory.

When the server starts, it uses its runtime directory. The server interprets all relative paths as relative to its runtime directory.

You can specify any valid UNIX directory pathname as the runtime directory.

-r authenticate_type

Specifies the RPC authentication type the server will use.

See the Advanced Printing Software Command Reference Guide for a description of RPC authentication types. The values for authentication_type are NONE and SYS. The default is SYS, which selects standard UNIX authentication.

-s spool_directory

Modifies the directory path the server uses to store documents prior to printing. You can specify any valid directory pathname for spool_directory.

-v

Displays informational messages during validation of command-line attributes.

For example, if you specify the -A,-r, and -v options on the command line, the utility displays the following messages:

Validating requested server attributes
Checking attribute:  access-control-list
Checking attribute:  cfg-rpc-auth-type
All requested server attributes are valid
 
 

The pdmoddb utility also displays the values of all the server attributes, after pdmakedb has finished creating the object databse. For example:

Current server attributes are:
achilles_spl: server-state = ready
achilles_spl: server-internal-state = 2
achilles_spl: object-classes-supported = server
achilles_spl: enabled = FALSE
achilles_spl: conformance-levels-supported = level-1
                                             level-1M
                                             level-2
                                             level-2M
achilles_spl: cfg-src-odb-path = /usr/pd/share/odb
achilles_spl: cfg-src-oid-path = /usr/pd/share/oid
achilles_spl: cfg-server-runtime-dir = /var/spool/pd/achilles_spl
achilles_spl: cfg-acct-log-file-path = /var/pd/acct/achilles_spl:
achilles_spl: access-control-list = administrator:sysadmin
achilles_spl: cfg-rpc-auth-type = SYS
achilles_spl: cfg-max-log-backups = 4
achilles_spl: cfg-days-to-keep-acct-logs = 3
achilles_spl: cfg-safe-size-for-acct-logs = 1000000
achilles_spl: cfg-time-for-new-acct-log = 02:07:00

If you do note specify the -v option, pdmoddb only displays error messages.

DESCRIPTION

The pdmoddb utility modifies a print server object database when the associated spooler or supervisor process is not already running. It is provided as a tool for configuring server directories and other server parameters that cannot be modified while the server is running. For all other modifications, use the pdset utility.

There is a special syntax for setting the attributes to their default values. For the options: -a, -A, -e, -O, -r, -R, and -s, if the value specified is an equals sign (=), pdmod sets the attribute to its default value. The default syntax is not allowd for the -d and -n options.

ACCESS LEVEL: Administrator

FILES

/usr/pd/share/oid

default OID database path

/usr/pd/share/odb

source ODB template

/var/pd/odb

default object database path

/var/spool/pd/*

default spool directory path

EXAMPLES

The following example changes the spool directory of spooler achilles_spl to /var/spool/alt/achilles_spl

pdmoddb -v -n achilles_spl

SEE ALSO

Commands: pdmakedb(8), pdset(1), pdshowdb(8), pdsplr(8), pdspvr(8), pdspvlpr(8)  

pdprintadmin(8)

NAME

pdprintadmin - Advanced Printing Graphical User Interface

SYNOPSIS

/user/pd/bin/pdprintadmin [-sl status_line ]

OPTIONS

sl status_lines

Specifies the number of lines to display in the status area located at the bottom of the pdprintadmin window.

DESCRIPTION

The pdprintadmin utility is a CDE graphical user interface utility that allows you to perform many print system administration tasks on a local or remote system.

Help is available by using the Help button.

The pdprintadmin utility allows you to perform the following administrative tasks:

ACCESS LEVEL: Users with appropriate access rights can use pdprintadmin to create, delete, and modify print object. Users without the required rights have read-only permissions (where applicable).

NOTES

The pdprintadmin utility communicates with running server processes. Those processes modify database and namespace files on the server system; that is, the host on which the spooler or supervisor process is running. pdprintadmin does not modify or update global networked databases such as NIS.

ENVIRONMENT VARIABLES

PDPRINTER

Specifies your default logical printer. Also, implicitly specifies a default spooler as the one that hosts your default logical printer.

FILES

On startup, pdprintadmin uses the following resources:

/dtb-add-device-paf-file-seln.directory

Values: Valid directory path. The default is: /usr/pd/share/cap.

Description: Selects the default PAF directory to display when adding a new print device.

/dtb-add-device-paf-file-seln.pattern

Values: Valid pattern. The default is *.paf.

Description: Valid pattern. The printer attribute file browser window uses the specified pattern to filter the file list.

statusLines

Values: Integer value. Default value is 3 lines.

Description: The number of lines in the status window at the bottom of each application window.

rpcTimeout

Values: Integer value. Default value is 15 seconds.

Description: The number of seconds to wait when querying for objects (per server).

SEE ALSO

Commands: pdprint(1), pdprintinfo(1)

The pdprintadmin Help option on the Workspace menu or the CDE control panel.  

pdpromote(8)

NAME

pdpromote - promotes a print job to the top of its queue

SYNOPSIS

pdpromote [-m message_text] [-x extended_attribute_string...] [-X attribute_filename...] job_identifier

OPTIONS

-m message_text

Includes a message about the job.

If you use the -x string option or the -X file option, the equivalent command attribute type and value are:

For initial-value-document, document, printer, queue, and server objects

message=message_text

For jobs:

job-message-from-administrator=message_text

Users can view a message by issuing a pdls command specifying the job and including the following option: -r message or -r job-message-from-administrator.

-x extended_attributes_string

Specifies one or more attribute_type=value pairs to be used by the utility.

You cannot set most job or document attributes with the -x option. You can set the following client attributes:

attributes (to specify an attribute file)

job-message-from-administrator

Follow the syntax rules for attribute value strings described in the Advanced Printing Software Command Reference Guide.

-X attribute_filename

Specifies an attributes file for the utility to read. When the utility runs, it processes the attribute definition at the current point in the command line, as though you had specified it with the -x option.

If you do not include the path, the utility searches the path specified in the PDPATH environment variable.

You cannot set object attributes with the -X option. You can set the following client attributes:

attributes (to specify another attribute file)

job-message-from-administrator

OPERANDS

[server_name:]job_id

The value of job_id is a unique identifier that refers to the specific job that you want to promote.

If you omit the server name, the utility submits the request to the spooler that supports the printer named in the PDPRINTER environment variable.

You can specify only one job in job_id. The utility assigns the job you are promoting to the first physical printer available that can accommodate the job requirements. The promote operation fails if a supervisor has already begun to process the job or if the job is in a retained or completed state.

DESCRIPTION

The pdpromote utility moves a print job to the top of its queue. As long as all job and document attributes are satisfied, the job will be the next one selected from the queue for printing.

ACCESS LEVEL: Operator

EXAMPLES

Promote job 1000 on blue_spl and include a message explaining why you are promoting the job:

pdpromote -m "The CEO needs this right away" blue_spl:1000 

SEE ALSO

pdpr(1), pdls(1), pdq(1), pdrm(1)  

pdshowdb(8)

NAME

pdshowdb - displays a print server object database

SYNOPSIS

pdshowdb [-d ODB_directory] [-e] [-h] [-n server_name]

OPTIONS

-d ODB_directory

Specifies the location of the object database. You must have read permission for the ODB pathname. If you do not specify the -d option, the utility looks for the object database files in the /var/pd/odb directory.If the directory does not exist or you do not have read permission, pdshowdb displays an error message and exits.

-e

Displays only the server executable pathname.

-h

Displays a help message.

If you specify the -h option, pdshowdb displays the help message only and does not do anything else, even if you have specified other options.

-n server_name

Specifies the name of the database. This name is also the name of the server.

If you do not specify the -n option, the utility uses a default name. The default name is derived from the name of the host on which pdshowdb is running. The format for the default name is <hostname>_spl.

If the database specified by the -n option does not exist or if you do not specify a server name and a server with the default name does not exist, pdshowdb displays an error message and exits.

DESCRIPTION

The pdshowdb utility can be used to display the contents of an existing server database when the server process associated with the database is not running. The utility forms a full object database path by combining the values of ODB_directory and server_name or their defaults. It queries the database and displays server object attributes on standard output. For example, if you run pdshowdb with -n myserver and -d /usr/local/pd, the utility will show the object database in /usr/local/pd/myserver.

The pdshowdb utility displays an error message and exits if the database you specify does not exist or if the server that uses the database is running.

ACCESS LEVEL: Administrator

EXAMPLES

pdshowdb -n achilles_spl -d /usr/local/pd/odb

FILES

/var/pd/odb

object database directory

SEE ALSO

pdmakedb(8), pdmoddb(8), pdsplr(8), pdspvr(8), pdspvlpr(8)  

pdshutdown(8)

NAME

pdshutdown - shut down a print spooler or supervisor

SYNOPSIS

pdshutdown [-c class_name] [-m message_text] [-w when_time] [-x extended_attribute_string...] [-X attribute_filename...] server_name...

Options

-c class_name

Specifies the class or type of object. The only valid class for this operation is server, the default.

-m message_text

Displays a message about the server which you are shutting down. For example, when a spooler is to be shutdown, the message might be:

-m "spooler ginger_sp1 is shutting down"

If you use the -x extended-attributes-string option or the -X attribute_filename option in the equivalent command attribute type and value is message=message_text.

Users can view the message by issuing a pdls command specifying the name of the server and -r message option.

-w when_time

Specifies how much processing can occur before the server can be shut down.

The following values are allowed:

now

If the server is a spooler, it is shut down immediately. Jobs already submitted to supervisors complete printing. The states of the jobs are not updated until the spooler is restarted.

If the server is a supervisor, it cancels active jobs and shuts down after all jobs on all associated physical printers are stopped. These jobs are restarted when the physical printers are operational again.

after-current (default)

If the server is a spooler, it stops submitting new jobs to supervisors and shuts down after jobs that are currently printing have completed.

If the server is a supervisor, it shuts down after all currently printing jobs are completed.

after-all

If the server is a spooler, it stops accepting new jobs and shuts down after all currently printing jobs are completed.

If the server is a supervisor, it stops accepting new jobs and shuts down after all currently printing jobs are completed. This is equivalent to after-current.

If you use the -x string option or the -X file option, the equivalent attribute is when=when_time.

-x extended_attribute_string

Specifies one or more attribute_type=value pairs to be used by the utility.

You cannot use object attributes with this option. You can use the following command attributes: attributes, class, message, and when.

Follow the syntax rules for attribute value strings listed in the Advanced Printing Software Command Reference Guide.

-X attribute_filename

Specifies an attribute file. When the utility runs, the attribute's file is processed at the current point in the command line, as though it had been specified with the -x option.

OPERANDS

server_name

The value of server_name is the name of the specific spooler or supervisor to be shut down.

DESCRIPTION

Use the pdshutdown utility to stop a specified spooler or supervisor server process in the Advanced Printing Software environment.

If the server is a spooler, this operation causes the spooler to disable itself so that no new jobs can be accepted. The value of the when_time argument determines exactly when and how the spooler shuts down. When the spooler is restarted, it has the same objects and attributes that it had before shutdown.

If the server is a supervisor, this operation causes the supervisor to disable itself and reject new jobs. The value of the when_time argument determines exactly when and how the supervisor shuts down.

ACCESS LEVEL: Operator

NOTES

The pdshutdown utility is an asynchronous command. Control is returned to your shell before the server shuts down. If you include a pdshutdown command in a shell script, you might need to follow it with a check for a running server process before proceeding to other commands in the script.

A shutdown operation cannot complete when there are printers paused in the process of printing a job unless the -w now option is specified. If you issue a pdshutdown command and the server fails to stop, try issuing the command again with the -w now option.

EXAMPLES

  1. Shut down the server named ginger after jobs that are being printed have completed:

    pdshutdown ginger
     
     
    

  2. Shut down the spooler fred_spl after all currently printing jobs have completed:

    pdshutdown -w after-all fred_spl
     
     
    

FILES

/sbin/init.d/apx

startup/shutdown script

SEE ALSO

Commands: pdls(1), pdset(1), pdcreate(8), pddelete(8), pdenable(8), pddisable(8), pdpause(1), pdresume(1), pdsplr(8), pdspvr(8), pdspvlpr(8)  

pdsplr(8)

NAME

pdsplr - Advanced Printing Software spooler

SYNOPSIS

/usr/pd/lib/pdsplr [-a] [-c ] [-F] [-e email_address] [-d ODB_directory] spooler_name

OPTIONS

-a

Forces the administrator to acknowledge that attribute values of server objects are correct, thereby preventing server startups with a possibly corrupt database.

The -a option is required only for server startups that take place after the server has had to repair the object database as part of a crash recovery.

-c

Forces a database integrity check at startup after a normal shutdown.

The server automatically checks the database integrity when it restarts after having terminated abnormally; for example, after a power outage. However, by default, it omits this check if the server was shut down normally.

You can use the -c option to force a database integrity check if you suspect a corrupt object database.

-F

Runs the process in the foreground.

By default, the spooler process runs in the background.

-e email_address

Specifies an e-mail address for the spooler to use when it encounters startup errors.

The spooler process sends an e-mail message to the specified address with details of a failed startup. Startup and shutdown information is always recorded in the system log files.

-d ODB_directory

Specifies the location of the object database.

If you do not specify the -d option, the spooler uses a default database path, /var/pd/odb.

Do not specify the name of the database file; specify only the directory pathname as part of the destination ODB. The name of the spooler database file comes from the spooler_name argument to pdsplr.

This option is required only when you have used the -d option as part of the pdmakedb operation to create the spooler database in a nondefault location.

Description

The pdsplr program is the Advanced Printing Software spooler server process.

A spooler server process manages print jobs in a network environment. It listens for and services client RPC requests. It schedules jobs for printing when suitable printers are available and reports status to users and administrators as appropriate. A spooler works with one or more supervisor server processes to distribute jobs to output devices.

A spooler process manages a persistent named server database. The database contains information about printers, queues, and initial value objects supported by the spooler and about the print jobs it processes. Prior to running a spooler for the first time, you must use the pdmakedb utility to create an initialized server database.

Upon startup, a spooler process registers itself in the local file name space (/etc/printers.conf) and with the host's RPC port mapper. Client utilities can then be used to manage the spooler process and its database over the network.

ACCESS LEVEL: Administrator

EXAMPLES

  1. This command line starts a spooler named odysseus_spl with the default location for the ODB and no e-mail notification for errors:

    /usr/pd/lib/pdsplr odysseus_spl
    

  2. This command line starts a spooler named odysseus_spl and specifies that the associated ODB is in the /usr/local/odb directory:

    /usr/pd/lib/pdsplr -d /usr/local/odb odysseus_spl
    

  3. This command line starts a spooler named odysseus_spl and specifies that the user telemachus should receive an e-mail message if there are any errors during startup:

    /usr/pd/lib/pdsplr -e telemachus@ithaca.gov odysseus_spl
    

FILES

/usr/pd/lib/pdsplr

spooler executable

/usr/pd/lib/pdspvr

supervisor executable

/usr/pd/share/oid

OID database path

/usr/pd/share/odb

source ODB template

/var/pd/odb

default object database directory

/etc/printers.conf

local name file

SEE ALSO

Commands: pdspvr(8), pdspvlpr(8), pdmakedb(8), pdmoddb(8), pdshowdb(8), pdshutdown(8)  

pdspvlpr(8)

NAME

pdspvlpr - Advanced Printing Software LPD Outbound Gateway Supervisor

SYNOPSIS

/usr/pd/lib/pdspvlpr [-a ] [-c ] [-F ] [-e email_address] [-d ODB_directory] supervisor_name

OPTIONS

-a

Forces the administrator to acknowledge that attribute values of server objects are correct, thereby preventing server startups with a possibly corrupt database.

The -a option is required only for server startups that take place after the server has had to repair the object database as part of a crash recovery.

-c

Forces a database integrity check at startup after a normal shutdown.

The server automatically checks the database integrity when it restarts after having terminated abnormally; for example, after a power outage. However, by default, it omits this check if the server was shut down normally.

You can use the -c option to force a database integrity check if you suspect a corrupt object database.

-F

Runs the process in the foreground.

By default, the outbound gateway supervisor process runs in the background.

-e email_address

Specifies the e-mail address for the LPD outbound gateway supervisor to use when it encounters start-up errors.

The supervisor sends an e-mail message to the specified address with details of a failed start-up. Startup and shutdown are recorded in the system log files.

-d ODB_directory

Specifies the location of the object database.

If you do not specify the -d option, the supervisor uses a default database path in /var/pd/odb.

Do not specify the name of the database file; specify only the ODB directory parameter. The name of the supervisor database file comes from the supervisor-name argument to pdspvr.

This option is required only when you have used the -d option as part of the pdmakedb operation to create the supervisor database in a nondefault location.

DESCRIPTION

The LPD outbound gateway supervisor accepts print jobs from an Advanced Printing Software spooler and converts them into LPD print requests. The outbound gateway supervisor forwards print jobs to LPD printers or to any host supporting LPD-based printing. It uses Line Printer Daemon Protocol as outlined in RFC-1179, to communicate with a remote lpd daemon or with lpd-compliant network printers. In addition, the outbound gateway supervisor supports LPD extensions defined by Xerox Corporation and SunSoft. For information about using these extensions, refer to the Advanced Printing Software System Administration Guide.

An outbound gateway supervisor process manages its own named server database. The database contains information about the printers supported by the supervisor and about jobs being processed. Prior to running a gateway supervisor for the first time, you must use the pdmakedb utility to create an initialized server database.

Upon startup, an outbound gateway supervisor registers itself in the local file name space (/etc/printers.conf) and with the host's RPC port mapper. Client utilities can then be used to manage the gateway process and its database over the network.

ACCESS LEVEL: Administrator

NOTES

The LPD outbound gateway supervisor allows you to create 100 physical printer objects, each supporting the use of a remote LPD-based printer. If you need more than this number, you should run multiple outbound gateway supervisor processes with different names and divide your physical printer objects among them.

Use the pdcreate utility to create physical printer objects. To use a supported printer model, use the pdcreate -X option to specify the Printer Attribute File appropriate for the printer model. When you create a physical printer object, you must specify how the outbound gateway is to connect to the printer device by supplying a value to the printer-address attribute. The general format of an outbound gateway printer address is:

<remotehost>,<printername>,<protocol conformance>

Where remote host is the name of the host running the lpd software, printer_name is the name of the lpd printer queue on that host, and protocol conformance is one of the following:

1179 - Standard RFC1179 LPD protocol

Solaris - Sun Solaris extensions

DigitalUNIX - Compaq extensions

Xerox - Xerox extensions

EXAMPLES

  1. This command line starts an outbound gateway named odysseus_obg:

    /usr/pd/lib/pdspvlpr odysseus_obg
     
     
    

  2. This command line starts an outbound gateway odysseus_obg and specifies that the associated ODB is in the /usr/local/odb directory:

    /usr/pd/lib/pdspvlpr -d /usr/local/odb odysseus_obg
     
     
    

  3. This command line starts an outbound gateway named odysseus_obg and specifies that the user telemachus should receive an e-mail message if there are any errors during startup:

    /usr/pd/lib/plspvlpr -e telemachus@ithaca.gov odysseus_obg
     
     
    

Files

/usr/pd/lib/pdspvlpr

LPD outbound gateway supervisor

/usr/pd/share/oid

OID database path

/usr/pd/share/odb

source ODB template

/var/spool/pd/*

spool directories

/usr/pd/share/cap/*.paf

printer attribute files

/etc/printers.conf

local name file

See Also

Commands: pdsplr(8), pdspvr(8), pdmakedb(8), pdmoddb(8), pdshowdb(8), pdshutdown(8), pdcreate(8)  

pdspvr(8)

NAME

pdspvr - Advanced Printing Software Supervisor

SYNOPSIS

/usr/pd/lib/pdspvr [-a ] [-c] [-F] [-e email_address] [d ODB_directory] supervisor_name

Options

-a

Forces the administrator to acknowledge that attribute values of server objects are correct, thereby preventing server startups with a possibly corrupt database.

The -a option is required only for server startups that take place after the server has had to repair the object database as part of a crash recovery.

-c

Forces a database integrity check at startup after a normal shutdown.

The server automatically checks the database integrity when it restarts after having terminated abnormally; for example, after a power outage. However, by default, it omits this check if the server was shut down normally.

You can use the -c option to force a database integrity check if you suspect a corrupt object database.

-F

Runs the process in the foreground.

By default, the supervisor process runs in the background.

-e email_address

Specifies an e-mail address for the supervisor to use when it encounters startup errors.

The supervisor sends an e-mail message to the specified address with details of a failed startup. Startup and shutdown information is always recorded in the system log files.

-d ODB_directory

Specifies the location of the object database.

If you do not specify the -d option, the supervisor looks for its database in /var/pd/odb.

Do not specify the name of the database file; specify only the directory pathname as part of the destination ODB-directory parameter. The name of the supervisor database file comes from the supervisor-name argument to pdspvr.

This option is required only when you have used the -d option as part of the pdmakedb operation to create the supervisor database in a nondefault location.

DESCRIPTION

The pdspvr program is the primary supervisor server process supplied with Advanced Printing Software.

The supervisor supports printers connected to a host by serial, parallel, TCP/IP-socket, and PrintServer connections. The supervisor directly controls all aspects of printing a job. The supervisor receives data and instructions from its associated spooler server process and is responsible for receiving and executing management requests that apply to the supervisor or to physical printers.

Any networked system with one or more attached printers can run a supervisor server process. As a general guideline, one server process can manage 50 physical printers. To support substantially more printers, a site should divide the printers among two or more supervisor server processes.

A supervisor process manages its own named server database. The database contains information about the printers supported by the supervisor and about jobs being processed. Prior to running a supervisor for the first time, you must use the pdmakedb utility to create an initialized server object database.

Upon startup, a supervisor process registers itself in the local file name space (/etc/printers.conf) and with the host's RPC port mapper. Client utilities can then be used to manage the supervisor process and its database over the network.

ACCESS LEVEL: Administrator

EXAMPLES

  1. This command line starts a supervisor named odysseus_sup:

    /usr/pd/lib/pdspvr odysseus_sup
    

  2. This command line starts a supervisor named odysseus_sup and specifies that the associated ODB is in the /usr/local/odb directory:

    /usr/pd/lib/pdspvr -d /usr/local/odb odysseus_sup
    

  3. This command line starts a supervisor named odysseus_sup and specifies that the user telemachus should receive an e-mail message if there are errors during startup:

    /usr/pd/lib/pdspvr -e telemachus@ithaca.gov odysseus_sup
    

Files

/usr/pd/lib/pdspvr

supervisor executable

/usr/pd/lib/pdsplr

spooler executable

/usr/pd/share/oid

OID database path

/usr/pd/share/odb

source ODB template

/var/pd/odb

default object database directory

/usr/pd/share/cap/*.paf

printer attribute files

/etc/printers.conf

local file name

SEE ALSO

Commands: pdsplr(8), pdspvlpr(8), pdmakedb(8), pdmoddb(8), pdshowdb(8), pdshutdown(8)