lpadmin(1M)lpadmin(1M)NAMElpadmin - configure the LP spooling system
SYNOPSIS
[options]
DESCRIPTION
configures LP spooling systems to describe printers, classes and
devices. It is used to add and remove destinations, change membership
in classes, change devices for printers, change printer interface pro‐
grams, and to change the system default destination.
Exactly one of the or options must be present for every legal invoca‐
tion of
Names a printer to which all of the options below refer.
If printer does not exist, it will be created.
Removes destination
dest from the LP system. If dest is a printer
and is the only member of a class, the class is
deleted, too. No other options are allowed with
Makes existing destination
dest the new system default destination. If dest
is not supplied, there is no system default des‐
tination. No other options are allowed with
See the section below for more information on this
option.
The following options are only useful with and can appear in any order.
For ease of discussion, the printer is referred to below as printer P.
Inserts printer
P into the specified class. class is created if
it does not already exist.
Copies an existing
printer's interface program to be the new inter‐
face program for printer P.
Sets the default priority for printer
P associated with If omitted, the default prior‐
ity is set to 0.
Indicates that the device associated with printer
P is hardwired. This option is assumed when cre‐
ating a new printer unless the option is speci‐
fied.
Establishes a new interface program for printer
P. interface is the pathname of the new program.
Indicates that the device associated with printer
P is a login terminal. The LP scheduler (see
lpsched(1M)) disables all login terminals auto‐
matically each time it is started. Before re-
enabling printer P, its current device should be
established using
Selects a model interface program for printer
P. model is one of the model interface names
supplied with the LP software (see below).
Removes printer
P from the specified class. If printer P is the
last member of the class, the class is removed.
Associates a new
device with printer P. device is the pathname of
a file that is writable by the LP administrator
lp. Note that there is nothing to stop an admin‐
istrator from associating the same device with
more than one printer.
Restricts users to canceling only their own requests.
Default is to not restrict the cancel command.
Uses three-digit request numbers associated with
the printer directory. Use this option while
configuring remote printer queues to BSD systems.
The following options are only useful with and can appear in any order.
They are provided with systems that provide remote spooling.
The name of the remote machine is
machine.
The name of the printer or printer class to use on the remote
machine is
printer.
Specifies that the local command
remcancel is used to cancel requests to remote
printers. To ensure that the correct command is
used, specify the full path name.
Specifies that the local model
remcancel is used to cancel requests to remote
printers.
Specifies that the command
remstatus is used to obtain the status of
requests to remote printers. To ensure that the
correct command is used, specify the full path
name.
Specifies that the model
remstatus is used to obtain the status of
requests to remote printers.
Restrictions
When creating a new printer, the option and one of the or options must
be specified. Only one of the or options can be specified. The and
key letters are mutually exclusive. Printer and class names must not
exceed 250 characters and must consist entirely of the characters and
(underscore). The character set limitation is not applicable for the
printer name passed as an argument to the option. It is recommended
that printer and class names consist of a maximum of 14 characters to
ensure compatibility with other products that work with the LP spooling
system.
For a remote printer, only one of or can be specified. If neither of
them is specified, the default remote cancel model is used. Similarly,
only one of or can be specified. If neither of them is specified, the
default remote status model is used.
All local printers use four-digit request numbers. All remote printers
use three-digit request numbers for contact with BSD systems.
Enabling and Disabling Email Notification
Email notification is enabled by default. To modify or query the email
notification status, use with the following options:
Following is a description of each of these options:
Print the email notification status.
Enable email notification.
Disable email notification.
This email notification setting is ignored if the
print request is queued using the command and the
or option. See lp(1).
Models
Model interface programs are supplied with the LP software. They are
shell procedures, C programs, or other executable programs that inter‐
face between and devices. All printer models reside in directory and
can be used without modification with All cancel models reside in
directory and can be used without modification with All status models
reside in directory and can be used without modification with Models
should have 644 permission if owned by and or 664 permission if owned
by and Model file names must not exceed 14 characters. Alternatively,
LP administrators can modify copies of models then use to associate
them with printers.
The LP model interface program does the actual printing on the device
that is currently associated with the printer. The LP spooler sets
standard input to and standard output and standard error output to the
device specified in the option of The interface program is then invoked
for printer P from the directory as follows:
where arguments are as follows:
id request id returned by
user login name of the user who made the request.
title optional title specified with the option of
copies number of copies to be printed.
options blank-separated list of class-dependent or
printer-dependent options specified with the
option of Options from a BSD system have the
character sequence BSD attached to the beginning
of the option (for example, BSDl).
file full pathname of the file to be printed.
Given the command line arguments and the output directed to the device,
interface programs can format their output in any way they choose.
When printing is completed, it is the responsibility of the interface
program to exit with a code indicative of the success of the print job.
Only return values of indicating that the job completed successfully,
or values of positive through indicating that some error was encoun‐
tered that does not affect future print jobs should be used. Negative
values and positive values greater than 127 are reserved for system use
and should not be used by interface programs. notifies users by mail
when there is an error in printing the request. If problems are
detected that are likely to affect future print jobs, the interface
program should return a error value. This will make disable the
printer so that other pending print requests are not lost.
The cancel and status model interface programs perform the actual com‐
munication with the remote system to cancel requests or get the status
of requests. See rcancel(1M) and rlpstat(1M) for command line argu‐
ments.
EXTERNAL INFLUENCES
Environment Variables
determines the language in which messages are displayed.
If is not specified or is set to the empty string, a default of "C"
(see lang(5)) is used instead of
If any internationalization variable contains an invalid setting,
behaves as if all internationalization variables are set to "C" (see
environ(5)).
EXAMPLES
Assuming an existing Hewlett-Packard laserjet printer named it will use
the model interface through after the command:
Assuming a printer on a remote system the command:
causes the spool system to use the local line printer and the model The
spool system also uses the model to cancel remote requests and to get
status from In addition, the remote system name and the remote printer
are used.
The following command performs the same operation as above.
Here the default remote cancel model and the default remote status
model are used.
WARNINGS
When installing remote printers, use the option instead of to specify
the method used to cancel remote requests. The option should be used
instead of to specify the method used for displaying remote status.
classes must not include remote printers. HP-UX systems do not have
the ability to distribute print jobs in this way. Printing to a class
of printers on a remote system for example) must be accomplished by
creating the class on the remote system, then identifying that class by
using a command resembling the following (although you might have to
change some of the specific values shown in the example):
FILESSEE ALSOenable(1), lp(1), lpstat(1), nroff(1), accept(1M), lpana(1M),
lpsched(1M), rcancel(1M), rlp(1M), rlpdaemon(1M), rlpstat(1M).
lpadmin(1M)
