.\"
-.\" "$Id: lpadmin.man 5970 2006-09-19 20:11:08Z mike $"
+.\" lpadmin man page for CUPS.
.\"
-.\" lpadmin man page for the Common UNIX Printing System (CUPS).
+.\" Copyright 2007-2017 by Apple Inc.
+.\" Copyright 1997-2006 by Easy Software Products.
.\"
-.\" Copyright 1997-2006 by Easy Software Products.
+.\" Licensed under Apache License v2.0. See the file "LICENSE" for more information.
.\"
-.\" These coded instructions, statements, and computer programs are the
-.\" property of Easy Software Products and are protected by Federal
-.\" copyright law. Distribution and use rights are outlined in the file
-.\" "LICENSE.txt" which should have been included with this file. If this
-.\" file is missing or damaged please contact Easy Software Products
-.\" at:
-.\"
-.\" Attn: CUPS Licensing Information
-.\" Easy Software Products
-.\" 44141 Airport View Drive, Suite 204
-.\" Hollywood, Maryland 20636 USA
-.\"
-.\" Voice: (301) 373-9600
-.\" EMail: cups-info@cups.org
-.\" WWW: http://www.cups.org
-.\"
-.TH lpadmin 8 "Common UNIX Printing System" "13 July 2006" "Easy Software Products"
+.TH lpadmin 8 "CUPS" "1 November 2017" "Apple Inc."
.SH NAME
lpadmin \- configure cups printers and classes
.SH SYNOPSIS
.B lpadmin
-[ -E ] [-U
+[
+.B \-E
+] [
+.B \-U
.I username
-] [ -h
-.I server[:port]
-] -d
+] [
+\fB\-h \fIserver\fR[\fB:\fIport\fR]
+]
+.B \-d
.I destination
.br
.B lpadmin
-[ -E ] [-U
+[
+.B \-E
+] [
+.B \-U
.I username
-] [ -h
-.I server[:port]
-] -p
-.I printer option(s)
+] [
+\fB\-h \fIserver\fR[\fB:\fIport\fR]
+]
+.B \-p
+.I destination
+[
+.B \-R
+.I name-default
+]
+.I option(s)
.br
.B lpadmin
-[ -E ] [-U
+[
+.B \-E
+] [
+.B \-U
.I username
-] [ -h
-.I server[:port]
-] -x
+] [
+\fB\-h \fIserver\fR[\fB:\fIport\fR]
+]
+.B \-x
.I destination
.SH DESCRIPTION
-\fIlpadmin\fR configures printer and class queues provided by
-CUPS. It can also be used to set the server default printer or
-class.
+\fBlpadmin\fR configures printer and class queues provided by CUPS.
+It can also be used to set the server default printer or class.
.LP
-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.
+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.
.LP
-The first form of the command (\fI-d\fR) sets the default printer
-or class to \fIdestination\fR. Subsequent print jobs submitted
-via the \fIlp(1)\fR or \fIlpr(1)\fR commands will use this
-destination unless the user specifies otherwise with the
-\fIlpoptions(1)\fR command.
+The first form of the command (\fI-d\fR) sets the default printer or class to \fIdestination\fR.
+Subsequent print jobs submitted via the
+.BR lp (1)
+or
+.BR lpr (1)
+commands will use this destination unless the user specifies otherwise with the
+.BR lpoptions (1)
+command.
.LP
-The second form of the command (\fI-p\fR) configures the named
-printer. The additional options are described below.
+The second form of the command (\fI-p\fR) configures the named printer or class. The additional options are described below.
.LP
-The third form of the command (\fI-x\fR) deletes the printer or
-class \fIdestination\fR. Any jobs that are pending for the
-destination will be removed and any job that is currently printed
-will be aborted.
-.SH CONFIGURATION OPTIONS
-The following options are recognized when configuring a printer
-queue:
-.TP 5
--c class
-.br
-Adds the named \fIprinter\fR to \fIclass\fR. If \fIclass\fR does
-not exist it is created automatically.
+The third form of the command (\fI-x\fR) deletes the printer or class \fIdestination\fR.
+Any jobs that are pending for the destination will be removed and any job that is currently printed will be aborted.
+.SH OPTIONS
+The following options are recognized when configuring a printer queue:
.TP 5
--i interface
-.br
-Sets a System V style interface script for the printer. This
-option cannot be specified with the \fI-P\fR option (PPD file)
-and is intended for providing support for legacy printer drivers.
+\fB\-c \fIclass\fR
+Adds the named \fIprinter\fR to \fIclass\fR.
+If \fIclass\fR does not exist it is created automatically.
.TP 5
--m model
-.br
-Sets a standard System V interface script or PPD file from the
-\fImodel\fR directory.
+\fB\-P \fIppd-file\fR
+Specifies a PostScript Printer Description (PPD) file to use with the printer.
.TP 5
--o name=value
-.br
-Sets a PPD or server option for the printer. PPD options can be
-listed using the \fI-l\fR option with the \fIlpoptions(1)\fR
-command.
+\fB\-m \fImodel\fR
+Sets a standard PPD file for the printer from the \fImodel\fR directory or using one of the driver interfaces.
+Use the \fI-m\fR option with the
+.BR lpinfo (8)
+command to get a list of supported models.
+The model "raw" clears any existing PPD file and the model "everywhere" queries the printer referred to by the specified IPP \fIdevice-uri\fR.
.TP 5
--o job-k-limit=value
-.br
-Sets the kilobyte limit for per-user quotas. The value is an
-integer number of kilobytes; one kilobyte is 1024 bytes.
+\fB\-o cupsIPPSupplies=true\fR
.TP 5
--o job-page-limit=value
-.br
-Sets the page limit for per-user quotas. The value is the integer
-number of pages that can be printed; double-sided pages are
-counted as two pages.
+\fB\-o cupsIPPSupplies=false\fR
+Specifies whether IPP supply level values should be reported.
.TP 5
--o job-quota-period=value
-.br
-Sets the accounting period for per-user quotas. The value is an
-integer number of seconds; 86,400 seconds are in one day.
+\fB\-o cupsSNMPSupplies=true\fR
.TP 5
--o job-sheets-default=banner
+\fB\-o cupsSNMPSupplies=false\fR
+Specifies whether SNMP supply level (RFC 3805) values should be reported.
.TP 5
--o job-sheets-default=banner,banner
-.br
+\fB\-o job\-k\-limit=\fIvalue\fR
+Sets the kilobyte limit for per-user quotas.
+The value is an integer number of kilobytes; one kilobyte is 1024 bytes.
+.TP 5
+\fB\-o job\-page\-limit=\fIvalue\fR
+Sets the page limit for per-user quotas.
+The value is the integer number of pages that can be printed; double-sided pages are counted as two pages.
+.TP 5
+\fB-o job\-quota\-period=\fIvalue\fR
+Sets the accounting period for per-user quotas.
+The value is an integer number of seconds; 86,400 seconds are in one day.
+.TP 5
+\fB\-o job\-sheets\-default=\fIbanner\fR
+.TP 5
+\fB\-o job\-sheets\-default=\fIbanner\fB,\fIbanner\fR
Sets the default banner page(s) to use for print jobs.
.TP 5
--o port-monitor=name
-.br
-Sets the binary communications program to use when printing,
-"none", "bcp", or "tbcp". The default program is "none".
+\fB\-o \fIname\fB=\fIvalue\fR
+Sets a PPD option for the printer.
+PPD options can be listed using the \fI-l\fR option with the
+.BR lpoptions (1)
+command.
.TP 5
--o printer-error-policy=name
-.br
-Sets the error policy to be used when the printer backend is
-unable to send the job to the printer. The name must be one of
-"abort-job", "retry-job" or "stop-printer". The default error
-policy is "stop-printer".
+\fB\-o \fIname\fB-default=\fIvalue\fR
+Sets a default server-side option for the destination.
+Any print-time option can be defaulted, e.g., "-o number-up-default=2" to set the default "number-up" option value to 2.
.TP 5
--o printer-is-shared=true/false
-.br
-Sets the printer to shared/published or unshared/unpublished.
-Shared/published printers are publically announced by the server
-on the LAN based on the browsing configuration in
-\fBcupsd.conf\fR, while unshared/unpublished printers are not
-announced. The default value is "true".
+\fB\-o port\-monitor=\fIname\fR
+Sets the binary communications program to use when printing, "none", "bcp", or "tbcp".
+The default program is "none".
+The specified port monitor must be listed in the printer's PPD file.
.TP 5
--o printer-op-policy=name
-.br
-Sets the IPP operation policy associated with the printer. The
-name must be defined in the \fBcupsd.conf\fR in a Policy section.
+\fB\-o printer-error-policy=\fIname\fR
+Sets the error policy to be used when the printer backend is unable to send the job to the printer.
+The name must be one of "abort-job", "retry-job", "retry-current-job", or "stop-printer".
+The default error policy is "stop-printer" for printers and "retry-current-job" for
+classes.
+.TP 5
+\fB\-o printer\-is\-shared=true\fR
+.TP 5
+\fB\-o printer\-is\-shared=false\fR
+Sets the destination to shared/published or unshared/unpublished.
+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.
+The default value is "true".
+.TP 5
+\fB\-o printer-op-policy=\fIname\fR
+Sets the IPP operation policy associated with the destination.
+The name must be defined in the \fIcupsd.conf\fR in a Policy section.
The default operation policy is "default".
.TP 5
--r class
-.br
-Removes the named \fIprinter\fR from \fIclass\fR. If the
-resulting class becomes empty it is removed.
+\fB\-R \fIname\fB\-default\fR
+Deletes the named option from \fIprinter\fR.
.TP 5
--u allow:user,user,@group
+\fB\-r \fIclass\fR
+Removes the named \fIprinter\fR from \fIclass\fR.
+If the resulting class becomes empty it is removed.
.TP 5
--u deny:user,user,@group
+\fB-u allow:\fR{\fIuser\fR|\fB@\fIgroup\fR}{\fB,\fIuser\fR|\fB,@\fIgroup\fR}*
.TP 5
--u allow:all
+\fB-u deny:\fR{\fIuser\fR|\fB@\fIgroup\fR}{\fB,\fIuser\fR|\fB,@\fIgroup\fR}*
.TP 5
--u deny:none
-.br
-Sets user-level access control on a printer. Names starting with
-"@" are interpreted as UNIX groups. The latter two forms turn
-user-level access control off.
+\fB\-u allow:all\fR
.TP 5
--v "device-uri"
-.br
-Sets the \fIdevice-uri\fR attribute of the printer queue. If
-\fIdevice-uri\fR is a filename it is automatically converted to
-the form \fIfile:///file/name\fR. Use the \fIlpinfo(8)\fR command
-to get a list of supported device URIs and schemes.
+\fB\-u deny:none\fR
+Sets user-level access control on a destination.
+Names starting with "@" are interpreted as UNIX groups.
+The latter two forms turn user-level access control off.
+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'.
.TP 5
--D "info"
-.br
-Provides a textual description of the printer.
+\fB\-v "\fIdevice-uri\fB"\fR
+Sets the \fIdevice-uri\fR attribute of the printer queue.
+Use the \fI-v\fR option with the
+.BR lpinfo (8)
+command to get a list of supported device URIs and schemes.
.TP 5
--E
-.br
-Enables the printer and accepts jobs; this is the same as running the
-\fIaccept(8)\fR and \fIcupsenable(8)\fR programs on the printer.
+\fB\-D "\fIinfo\fB"\fR
+Provides a textual description of the destination.
.TP 5
--L "location"
-.br
-Provides a textual location of the printer.
+.B \-E
+Enables the destination and accepts jobs; this is the same as running the
+.BR cupsaccept (8)
+and
+.BR cupsenable (8)
+programs on the destination.
.TP 5
--P ppd-file
-.br
-Specifies a PostScript Printer Description file to use with the
-printer. If specified, this option overrides the \fI-i\fR option
-(interface script).
-.SH COMPATIBILITY
-Unlike the System V printing system, CUPS allows printer names to
-contain any printable character except SPACE, TAB, "/", or "#".
+\fB\-L "\fIlocation\fB"\fR
+Provides a textual location of the destination.
+.SH DEPRECATED OPTIONS
+The following \fBlpadmin\fR options are deprecated:
+.TP 5
+\fB\-i \fIfilename\fR
+This option historically has been used to provide either a System V interface script or (as an implementation side-effect) a PPD file.
+Since interface scripts are no longer supported, the \fI-P\fR option is preferred for providing a PPD file for a printer.
+.SH CONFORMING TO
+Unlike the System V printing system, CUPS allows printer names to contain any printable character except SPACE, TAB, "/", or "#".
Also, printer and class names are \fInot\fR case-sensitive.
-Finally, the CUPS version of \fIlpadmin\fR may ask the user for
-an access password depending on the printing system
-configuration. This differs from the System V version which
-requires the root user to execute this command.
-.SH LIMITATIONS
-The CUPS version of \fIlpadmin\fR does not support all of the
-System V or Solaris printing system configuration options.
+Finally, the CUPS version of \fBlpadmin\fR may ask the user for an access password depending on the printing system configuration.
+This differs from the System V version which requires the root user to execute this command.
+.SH NOTES
+The CUPS version of \fBlpadmin\fR does not support all of the System V or Solaris printing system configuration options.
+Interface scripts are not supported for security reasons.
+.SH EXAMPLE
+Create an IPP Everywhere print queue:
+.nf
+
+ lpadmin -p myprinter -E -v ipp://myprinter.local/ipp/print -m everywhere
+
+.fi
.SH SEE ALSO
-\fIaccept(8)\fR, \fIcupsenable(8)\fR, \fIlpinfo(8)\fR,
-\fIlpoptions(1)\fR,
-.br
-http://localhost:631/help
+.BR cupsaccept (8),
+.BR cupsenable (8),
+.BR lpinfo (8),
+.BR lpoptions (1),
+CUPS Online Help (http://localhost:631/help)
.SH COPYRIGHT
-Copyright 1997-2006 by Easy Software Products, All Rights Reserved.
-.\"
-.\" End of "$Id: lpadmin.man 5970 2006-09-19 20:11:08Z mike $".
-.\"
+Copyright \[co] 2007-2017 by Apple Inc.
projects / thirdparty / cups.git / blobdiff