|
Packit |
2fc92b |
.\"
|
|
Packit |
2fc92b |
.\" lpadmin man page for CUPS.
|
|
Packit |
2fc92b |
.\"
|
|
Packit |
2fc92b |
.\" Copyright 2007-2016 by Apple Inc.
|
|
Packit |
2fc92b |
.\" Copyright 1997-2006 by Easy Software Products.
|
|
Packit |
2fc92b |
.\"
|
|
Packit |
2fc92b |
.\" These coded instructions, statements, and computer programs are the
|
|
Packit |
2fc92b |
.\" property of Apple Inc. and are protected by Federal copyright
|
|
Packit |
2fc92b |
.\" law. Distribution and use rights are outlined in the file "LICENSE.txt"
|
|
Packit |
2fc92b |
.\" which should have been included with this file. If this file is
|
|
Packit |
2fc92b |
.\" file is missing or damaged, see the license at "http://www.cups.org/".
|
|
Packit |
2fc92b |
.\"
|
|
Packit |
2fc92b |
.TH lpadmin 8 "CUPS" "29 March 2016" "Apple Inc."
|
|
Packit |
2fc92b |
.SH NAME
|
|
Packit |
2fc92b |
lpadmin \- configure cups printers and classes
|
|
Packit |
2fc92b |
.SH SYNOPSIS
|
|
Packit |
2fc92b |
.B lpadmin
|
|
Packit |
2fc92b |
[
|
|
Packit |
2fc92b |
.B \-E
|
|
Packit |
2fc92b |
] [
|
|
Packit |
2fc92b |
.B \-U
|
|
Packit |
2fc92b |
.I username
|
|
Packit |
2fc92b |
] [
|
|
Packit |
2fc92b |
\fB\-h \fIserver\fR[\fB:\fIport\fR]
|
|
Packit |
2fc92b |
]
|
|
Packit |
2fc92b |
.B \-d
|
|
Packit |
2fc92b |
.I destination
|
|
Packit |
2fc92b |
.br
|
|
Packit |
2fc92b |
.B lpadmin
|
|
Packit |
2fc92b |
[
|
|
Packit |
2fc92b |
.B \-E
|
|
Packit |
2fc92b |
] [
|
|
Packit |
2fc92b |
.B \-U
|
|
Packit |
2fc92b |
.I username
|
|
Packit |
2fc92b |
] [
|
|
Packit |
2fc92b |
\fB\-h \fIserver\fR[\fB:\fIport\fR]
|
|
Packit |
2fc92b |
]
|
|
Packit |
2fc92b |
.B \-p
|
|
Packit |
2fc92b |
.I destination
|
|
Packit |
2fc92b |
[
|
|
Packit |
2fc92b |
.B \-R
|
|
Packit |
2fc92b |
.I name-default
|
|
Packit |
2fc92b |
]
|
|
Packit |
2fc92b |
.I option(s)
|
|
Packit |
2fc92b |
.br
|
|
Packit |
2fc92b |
.B lpadmin
|
|
Packit |
2fc92b |
[
|
|
Packit |
2fc92b |
.B \-E
|
|
Packit |
2fc92b |
] [
|
|
Packit |
2fc92b |
.B \-U
|
|
Packit |
2fc92b |
.I username
|
|
Packit |
2fc92b |
] [
|
|
Packit |
2fc92b |
\fB\-h \fIserver\fR[\fB:\fIport\fR]
|
|
Packit |
2fc92b |
]
|
|
Packit |
2fc92b |
.B \-x
|
|
Packit |
2fc92b |
.I destination
|
|
Packit |
2fc92b |
.SH DESCRIPTION
|
|
Packit |
2fc92b |
\fBlpadmin\fR configures printer and class queues provided by CUPS.
|
|
Packit |
2fc92b |
It can also be used to set the server default printer or class.
|
|
Packit |
2fc92b |
.LP
|
|
Packit |
2fc92b |
When specified before the \fI-d\fR, \fI-p\fR, or \fI-x\fR options, the \fI-E\fR option forces encryption when connecting to the server.
|
|
Packit |
2fc92b |
.LP
|
|
Packit |
2fc92b |
The first form of the command (\fI-d\fR) sets the default printer or class to \fIdestination\fR.
|
|
Packit |
2fc92b |
Subsequent print jobs submitted via the
|
|
Packit |
2fc92b |
.BR lp (1)
|
|
Packit |
2fc92b |
or
|
|
Packit |
2fc92b |
.BR lpr (1)
|
|
Packit |
2fc92b |
commands will use this destination unless the user specifies otherwise with the
|
|
Packit |
2fc92b |
.BR lpoptions (1)
|
|
Packit |
2fc92b |
command.
|
|
Packit |
2fc92b |
.LP
|
|
Packit |
2fc92b |
The second form of the command (\fI-p\fR) configures the named printer or class. The additional options are described below.
|
|
Packit |
2fc92b |
.LP
|
|
Packit |
2fc92b |
The third form of the command (\fI-x\fR) deletes the printer or class \fIdestination\fR.
|
|
Packit |
2fc92b |
Any jobs that are pending for the destination will be removed and any job that is currently printed will be aborted.
|
|
Packit |
2fc92b |
.SH OPTIONS
|
|
Packit |
2fc92b |
The following options are recognized when configuring a printer queue:
|
|
Packit |
2fc92b |
.TP 5
|
|
Packit |
2fc92b |
\fB\-c \fIclass\fR
|
|
Packit |
2fc92b |
Adds the named \fIprinter\fR to \fIclass\fR.
|
|
Packit |
2fc92b |
If \fIclass\fR does not exist it is created automatically.
|
|
Packit |
2fc92b |
.TP 5
|
|
Packit |
2fc92b |
\fB\-i \fIppd-file\fR
|
|
Packit |
2fc92b |
.TP 5
|
|
Packit |
2fc92b |
\fB\-P \fIppd-file\fR
|
|
Packit |
2fc92b |
Specifies a PostScript Printer Description (PPD) file to use with the printer.
|
|
Packit |
2fc92b |
.TP 5
|
|
Packit |
2fc92b |
\fB\-m \fImodel\fR
|
|
Packit |
2fc92b |
Sets a standard PPD file for the printer from the \fImodel\fR directory or using one of the driver interfaces.
|
|
Packit |
2fc92b |
Use the \fI-m\fR option with the
|
|
Packit |
2fc92b |
.BR lpinfo (8)
|
|
Packit |
2fc92b |
command to get a list of supported models.
|
|
Packit |
2fc92b |
The model "raw" clears any existing PPD file and the model "everywhere" queries the printer referred to by the specified IPP \fIdevice-uri\fR.
|
|
Packit |
2fc92b |
.TP 5
|
|
Packit |
2fc92b |
\fB\-o cupsIPPSupplies=true\fR
|
|
Packit |
2fc92b |
.TP 5
|
|
Packit |
2fc92b |
\fB\-o cupsIPPSupplies=false\fR
|
|
Packit |
2fc92b |
Specifies whether IPP supply level values should be reported.
|
|
Packit |
2fc92b |
.TP 5
|
|
Packit |
2fc92b |
\fB\-o cupsSNMPSupplies=true\fR
|
|
Packit |
2fc92b |
.TP 5
|
|
Packit |
2fc92b |
\fB\-o cupsSNMPSupplies=false\fR
|
|
Packit |
2fc92b |
Specifies whether SNMP supply level (RFC 3805) values should be reported.
|
|
Packit |
2fc92b |
.TP 5
|
|
Packit |
2fc92b |
\fB\-o job\-k\-limit=\fIvalue\fR
|
|
Packit |
2fc92b |
Sets the kilobyte limit for per-user quotas.
|
|
Packit |
2fc92b |
The value is an integer number of kilobytes; one kilobyte is 1024 bytes.
|
|
Packit |
2fc92b |
.TP 5
|
|
Packit |
2fc92b |
\fB\-o job\-page\-limit=\fIvalue\fR
|
|
Packit |
2fc92b |
Sets the page limit for per-user quotas.
|
|
Packit |
2fc92b |
The value is the integer number of pages that can be printed; double-sided pages are counted as two pages.
|
|
Packit |
2fc92b |
.TP 5
|
|
Packit |
2fc92b |
\fB-o job\-quota\-period=\fIvalue\fR
|
|
Packit |
2fc92b |
Sets the accounting period for per-user quotas.
|
|
Packit |
2fc92b |
The value is an integer number of seconds; 86,400 seconds are in one day.
|
|
Packit |
2fc92b |
.TP 5
|
|
Packit |
2fc92b |
\fB\-o job\-sheets\-default=\fIbanner\fR
|
|
Packit |
2fc92b |
.TP 5
|
|
Packit |
2fc92b |
\fB\-o job\-sheets\-default=\fIbanner\fB,\fIbanner\fR
|
|
Packit |
2fc92b |
Sets the default banner page(s) to use for print jobs.
|
|
Packit |
2fc92b |
.TP 5
|
|
Packit |
2fc92b |
\fB\-o \fIname\fB=\fIvalue\fR
|
|
Packit |
2fc92b |
Sets a PPD option for the printer.
|
|
Packit |
2fc92b |
PPD options can be listed using the \fI-l\fR option with the
|
|
Packit |
2fc92b |
.BR lpoptions (1)
|
|
Packit |
2fc92b |
command.
|
|
Packit |
2fc92b |
.TP 5
|
|
Packit |
2fc92b |
\fB\-o \fIname\fB-default=\fIvalue\fR
|
|
Packit |
2fc92b |
Sets a default server-side option for the destination.
|
|
Packit |
2fc92b |
Any print-time option can be defaulted, e.g., "-o number-up-default=2" to set the default "number-up" option value to 2.
|
|
Packit |
2fc92b |
.TP 5
|
|
Packit |
2fc92b |
\fB\-o port\-monitor=\fIname\fR
|
|
Packit |
2fc92b |
Sets the binary communications program to use when printing, "none", "bcp", or "tbcp".
|
|
Packit |
2fc92b |
The default program is "none".
|
|
Packit |
2fc92b |
The specified port monitor must be listed in the printer's PPD file.
|
|
Packit |
2fc92b |
.TP 5
|
|
Packit |
2fc92b |
\fB\-o printer-error-policy=\fIname\fR
|
|
Packit |
2fc92b |
Sets the error policy to be used when the printer backend is unable to send the job to the printer.
|
|
Packit |
2fc92b |
The name must be one of "abort-job", "retry-job", "retry-current-job", or "stop-printer".
|
|
Packit |
2fc92b |
The default error policy is "stop-printer" for printers and "retry-current-job" for
|
|
Packit |
2fc92b |
classes.
|
|
Packit |
2fc92b |
.TP 5
|
|
Packit |
2fc92b |
\fB\-o printer\-is\-shared=true\fR
|
|
Packit |
2fc92b |
.TP 5
|
|
Packit |
2fc92b |
\fB\-o printer\-is\-shared=false\fR
|
|
Packit |
2fc92b |
Sets the destination to shared/published or unshared/unpublished.
|
|
Packit |
2fc92b |
Shared/published destinations are publicly announced by the server on the LAN based on the browsing configuration in \fIcupsd.conf\fR, while unshared/unpublished destinations are not announced.
|
|
Packit |
2fc92b |
The default value is "true".
|
|
Packit |
2fc92b |
.TP 5
|
|
Packit |
2fc92b |
\fB\-o printer-op-policy=\fIname\fR
|
|
Packit |
2fc92b |
Sets the IPP operation policy associated with the destination.
|
|
Packit |
2fc92b |
The name must be defined in the \fIcupsd.conf\fR in a Policy section.
|
|
Packit |
2fc92b |
The default operation policy is "default".
|
|
Packit |
2fc92b |
.TP 5
|
|
Packit |
2fc92b |
\fB\-R \fIname\fB\-default\fR
|
|
Packit |
2fc92b |
Deletes the named option from \fIprinter\fR.
|
|
Packit |
2fc92b |
.TP 5
|
|
Packit |
2fc92b |
\fB\-r \fIclass\fR
|
|
Packit |
2fc92b |
Removes the named \fIprinter\fR from \fIclass\fR.
|
|
Packit |
2fc92b |
If the resulting class becomes empty it is removed.
|
|
Packit |
2fc92b |
.TP 5
|
|
Packit |
2fc92b |
\fB-u allow:\fR{\fIuser\fR|\fB@\fIgroup\fR}{\fB,\fIuser\fR|\fB,@\fIgroup\fR}*
|
|
Packit |
2fc92b |
.TP 5
|
|
Packit |
2fc92b |
\fB-u deny:\fR{\fIuser\fR|\fB@\fIgroup\fR}{\fB,\fIuser\fR|\fB,@\fIgroup\fR}*
|
|
Packit |
2fc92b |
.TP 5
|
|
Packit |
2fc92b |
\fB\-u allow:all\fR
|
|
Packit |
2fc92b |
.TP 5
|
|
Packit |
2fc92b |
\fB\-u deny:none\fR
|
|
Packit |
2fc92b |
Sets user-level access control on a destination.
|
|
Packit |
2fc92b |
Names starting with "@" are interpreted as UNIX groups.
|
|
Packit |
2fc92b |
The latter two forms turn user-level access control off.
|
|
Packit |
2fc92b |
Note: The user 'root' is not granted special access - using "-u allow:foo,bar" will allow users 'foo' and 'bar' to access the printer but NOT 'root'.
|
|
Packit |
2fc92b |
.TP 5
|
|
Packit |
2fc92b |
\fB\-v "\fIdevice-uri\fB"\fR
|
|
Packit |
2fc92b |
Sets the \fIdevice-uri\fR attribute of the printer queue.
|
|
Packit |
2fc92b |
Use the \fI-v\fR option with the
|
|
Packit |
2fc92b |
.BR lpinfo (8)
|
|
Packit |
2fc92b |
command to get a list of supported device URIs and schemes.
|
|
Packit |
2fc92b |
.TP 5
|
|
Packit |
2fc92b |
\fB\-D "\fIinfo\fB"\fR
|
|
Packit |
2fc92b |
Provides a textual description of the destination.
|
|
Packit |
2fc92b |
.TP 5
|
|
Packit |
2fc92b |
.B \-E
|
|
Packit |
2fc92b |
Enables the destination and accepts jobs; this is the same as running the
|
|
Packit |
2fc92b |
.BR cupsaccept (8)
|
|
Packit |
2fc92b |
and
|
|
Packit |
2fc92b |
.BR cupsenable (8)
|
|
Packit |
2fc92b |
programs on the destination.
|
|
Packit |
2fc92b |
.TP 5
|
|
Packit |
2fc92b |
\fB\-L "\fIlocation\fB"\fR
|
|
Packit |
2fc92b |
Provides a textual location of the destination.
|
|
Packit |
2fc92b |
.SH CONFORMING TO
|
|
Packit |
2fc92b |
Unlike the System V printing system, CUPS allows printer names to contain any printable character except SPACE, TAB, "/", or "#".
|
|
Packit |
2fc92b |
Also, printer and class names are \fInot\fR case-sensitive.
|
|
Packit |
2fc92b |
Finally, the CUPS version of \fBlpadmin\fR may ask the user for an access password depending on the printing system configuration.
|
|
Packit |
2fc92b |
This differs from the System V version which requires the root user to execute this command.
|
|
Packit |
2fc92b |
.SH NOTES
|
|
Packit |
2fc92b |
The CUPS version of \fBlpadmin\fR does not support all of the System V or Solaris printing system configuration options.
|
|
Packit |
2fc92b |
.SH EXAMPLE
|
|
Packit |
2fc92b |
Create an IPP Everywhere print queue:
|
|
Packit |
2fc92b |
.nf
|
|
Packit |
2fc92b |
|
|
Packit |
2fc92b |
lpadmin -p myprinter -E -v ipp://myprinter.local/ipp/print -m everywhere
|
|
Packit |
2fc92b |
|
|
Packit |
2fc92b |
.fi
|
|
Packit |
2fc92b |
.SH SEE ALSO
|
|
Packit |
2fc92b |
.BR cupsaccept (8),
|
|
Packit |
2fc92b |
.BR cupsenable (8),
|
|
Packit |
2fc92b |
.BR lpinfo (8),
|
|
Packit |
2fc92b |
.BR lpoptions (1),
|
|
Packit |
2fc92b |
CUPS Online Help (http://localhost:631/help)
|
|
Packit |
2fc92b |
.SH COPYRIGHT
|
|
Packit |
2fc92b |
Copyright \[co] 2007-2017 by Apple Inc.
|